diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/oceanbasepro | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/oceanbasepro')
| -rw-r--r-- | data/en_us/oceanbasepro/2019-09-01/api-docs.php | 41643 |
1 files changed, 41643 insertions, 0 deletions
diff --git a/data/en_us/oceanbasepro/2019-09-01/api-docs.php b/data/en_us/oceanbasepro/2019-09-01/api-docs.php new file mode 100644 index 0000000..a9ba55e --- /dev/null +++ b/data/en_us/oceanbasepro/2019-09-01/api-docs.php @@ -0,0 +1,41643 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'OceanBasePro', + 'version' => '2019-09-01', + ], + 'directories' => [ + [ + 'id' => 191859, + 'title' => 'Tag Management', + 'type' => 'directory', + 'children' => [ + 'ModifyTagValueName', + 'ModifyTagName', + 'DescribeTagValues', + 'DeleteTagValue', + 'DeleteTag', + 'CreateTagValue', + 'CreateTag', + 'ModifyInstanceTags', + 'DescribeTenantTags', + 'ModifyTenantTags', + 'DescribeInstanceTags', + ], + ], + [ + 'id' => 134089, + 'title' => 'Cluster management', + 'type' => 'directory', + 'children' => [ + 'CreateInstance', + 'DescribeInstance', + 'DescribeInstances', + 'DescribeInstanceTopology', + 'DescribeAvailableSpec', + 'DescribeAvailableZone', + 'DescribeInstanceCreatableZone', + 'ModifyInstanceName', + 'ModifyInstanceSpec', + 'ModifyInstanceNodeNum', + 'ModifyInstanceTemporaryCapacity', + 'SwitchoverInstance', + 'RemoveStandbyInstance', + 'DeleteInstances', + 'DescribeInstanceSummary', + 'DescribeStandbyCreateMode', + ], + ], + [ + 'id' => 134094, + 'title' => 'Tenant management', + 'type' => 'directory', + 'children' => [ + 'DescribeTenantReadableScn', + 'CreateTenant', + 'CreateTenantReadOnlyConnection', + 'CreateTenantSecurityIpGroup', + 'DescribeTenants', + 'DescribeInstanceTenantModes', + 'DescribeTenant', + 'DescribeAvailableCpuResource', + 'DescribeAvailableMemResource', + 'DescribeCharset', + 'DescribeInstanceAvailableZones', + 'DescribeTenantZonesRead', + 'DescribeTimeZones', + 'DescribeTenantSecurityIpGroups', + 'DescribeZones', + 'ModifyTenantPrimaryZone', + 'ModifyTenantResource', + 'ModifyTenantSecurityIpGroup', + 'DeleteTenants', + 'DeleteTenantSecurityIpGroup', + ], + ], + [ + 'id' => 134110, + 'title' => 'Tenant user management', + 'type' => 'directory', + 'children' => [ + 'CreateTenantUser', + 'DescribeTenantUsers', + 'DescribeTenantUserRoles', + 'ModifyTenantUserDescription', + 'ModifyTenantUserPassword', + 'ModifyTenantUserRoles', + 'DeleteTenantUsers', + ], + ], + [ + 'id' => 134118, + 'title' => 'Database management', + 'type' => 'directory', + 'children' => [ + 'CreateDatabase', + 'DescribeDatabases', + 'ModifyDatabaseDescription', + 'ModifyTenantUserStatus', + 'ModifyDatabaseUserRoles', + 'DeleteDatabases', + ], + ], + [ + 'id' => 134125, + 'title' => 'Parameter management', + 'type' => 'directory', + 'children' => [ + 'DescribeParameters', + 'DescribeParametersHistory', + 'ModifyParameters', + ], + ], + [ + 'id' => 181884, + 'title' => 'Session management', + 'type' => 'directory', + 'children' => [ + 'DescribeSessionList', + 'BatchKillSessionList', + 'BatchKillProcessList', + 'DescribeProcessStatsComposition', + 'KillProcessList', + ], + ], + [ + 'id' => 134137, + 'title' => 'Diagnostic management', + 'type' => 'directory', + 'children' => [ + 'DescribeOasAnomalySQLList', + 'DescribeSampleSqlRawTexts', + 'DescribeOasSQLDetails', + 'DescribeOasSQLPlans', + 'DescribeSQLSamples', + 'DescribeOasSQLHistoryList', + 'DescribeOasTopSQLList', + 'DescribeOasSlowSQLList', + 'DescribeOutlineBinding', + 'DescribeRecommendIndex', + 'DescribeSQLTuningAdvices', + 'DescribeSqlAuditStat', + 'CreateOasOutlineTask', + ], + ], + [ + 'id' => 134129, + 'title' => 'Security settings', + 'type' => 'directory', + 'children' => [ + 'ModifyInstanceSSL', + 'DescribeInstanceSSL', + 'CreateSecurityIpGroup', + 'DescribeSecurityIpGroups', + 'DescribeTenantSecurityConfigs', + 'DescribeTenantEncryption', + 'DescribeInstanceSecurityConfigs', + 'ModifySecurityIps', + 'ModifyTenantEncryption', + 'DeleteSecurityIpGroup', + 'DescribeBackupEncryptedString', + ], + ], + [ + 'id' => 134134, + 'title' => 'Metrics management', + 'type' => 'directory', + 'children' => [ + 'DescribeMetricsDataV2', + 'DescribeMetricsData', + 'DescribeNodeMetrics', + 'DescribeTenantMetrics', + ], + ], + [ + 'id' => 166104, + 'title' => 'Data migration', + 'type' => 'directory', + 'children' => [ + 'CreateProject', + 'StartProject', + 'StopProject', + 'ResumeProject', + 'ReleaseProject', + 'DeleteProject', + 'ListProjects', + 'DescribeProject', + 'DescribeProjectSteps', + 'DescribeProjectStepMetric', + 'DescribeProjectProgress', + 'DescribeProjectComponents', + 'ListProjectFullVerifyResult', + 'StartProjectsByLabel', + 'StopProjectsByLabel', + 'GetUploadOssUrl', + 'ListWorkerInstances', + 'CreateMySqlDataSource', + 'CreateOceanBaseDataSource', + 'ListDataSource', + 'CreateLabel', + 'ListAllLabels', + 'CreateOmsMysqlDataSource', + 'ReleaseWorkerInstance', + 'CancelProjectModifyRecord', + 'RetryProjectModifyRecords', + 'StopProjectModifyRecords', + 'ListProjectModifyRecords', + 'CreateProjectModifyRecords', + 'UpdateProjectConfig', + 'DeleteDataSource', + 'CreateRdsPostgreSQLDataSource', + ], + ], + [ + 'id' => 188965, + 'title' => 'Backup and restoration management', + 'type' => 'directory', + 'children' => [ + 'DescribeBackupSetDownloadLink', + 'DescribeDataBackupSet', + 'CreateBackupSetDownloadLink', + 'DescribeRestorableTenants', + ], + ], + [ + 'id' => 192529, + 'title' => 'Not translated (other)', + 'type' => 'directory', + 'children' => [ + 'DescribeAnomalySQLList', + 'DescribeSQLDetails', + 'DescribeSQLPlans', + 'DescribeSQLHistoryList', + 'DescribeTopSQLList', + 'DescribeSlowSQLList', + 'DescribeSlowSQLHistoryList', + ], + ], + [ + 'id' => 195786, + 'title' => 'others', + 'type' => 'directory', + 'children' => [ + 'DescribeProxyService', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + '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' => 'Tag group 1', + 'title' => '标签组名称', + ], + ], + [ + 'name' => 'Value', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the tag.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Tag 1', + 'title' => '标签名称', + ], + ], + [ + 'name' => 'NewValue', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The new name of the tag.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Tag 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' => '请求ID', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"update tag-value name success\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', + 'title' => 'ModifyTagValueName', + 'summary' => 'You can call this operation to rename a tag.', + ], + 'ModifyTagName' => [ + 'methods' => [ + 'post', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + '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' => 'Tag group 1', + 'title' => '标签组名称', + ], + ], + [ + 'name' => 'NewKey', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The new name of the tag group.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Tag group 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' => '请求ID', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"update tag name success\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', + 'title' => 'ModifyTagName', + ], + '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' => '"{\\"Tag group 2\\":[\\"Tag 2-1\\",\\"Tag 2-2\\"],\\"Tag group 1\\":[\\"Tag 1-1\\"]}"', + 'title' => '标签组与标签的映射关系', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', + 'title' => '请求ID', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Map\\": \\"\\\\\\"{\\\\\\\\\\\\\\"标签组2\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"标签值2-1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"标签值2-2\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"标签组1\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"标签值1-1\\\\\\\\\\\\\\"]}\\\\\\"\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', + 'title' => 'DescribeTagValues', + 'summary' => 'You can call this operation to query tags.', + ], + 'DeleteTagValue' => [ + 'methods' => [ + 'post', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + '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' => 'Tag group 1', + 'title' => '标签组名称', + ], + ], + [ + 'name' => 'Value', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the tag.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Tag 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' => '请求ID', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"delete tag-value success\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', + 'title' => 'DeleteTagValue', + 'summary' => 'You can call this operation to delete a tag from a tag group.', + ], + 'DeleteTag' => [ + 'methods' => [ + 'post', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + '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' => 'Tag group 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' => '请求ID', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"delete tag success\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', + 'title' => 'DeleteTag', + 'summary' => 'You can call this operation to delete a tag group.', + ], + 'CreateTagValue' => [ + 'methods' => [ + 'post', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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' => 'Tag 1', + 'title' => '标签名称', + ], + ], + [ + 'name' => 'Key', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the tag group.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Tag group 1', + 'title' => '标签组名称', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The identifier of the client.', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The tag creation result.', + 'type' => 'string', + 'example' => 'create tag value success', + 'title' => '标签创建情况', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', + 'title' => '请求ID', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"create tag value success\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', + 'title' => 'CreateTagValue', + 'summary' => 'You can call this operation to create a tag.', + ], + 'CreateTag' => [ + 'methods' => [ + 'post', + 'put', + ], + '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' => 'Tag group 1', + 'title' => '标签组名称', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The identifier of the client.', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The tag group creation result.', + 'type' => 'string', + 'example' => 'Create tag success', + 'title' => '标签组创建情况', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', + 'title' => '请求 ID', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Create tag success\\",\\n \\"RequestId\\": \\"4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908\\"\\n}","type":"json"}]', + 'title' => 'CreateTag', + 'summary' => 'You can call this operation to create a tag group.', + ], + 'ModifyInstanceTags' => [ + 'summary' => 'You can call this operation to modify the tags of a cluster.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => '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' => '请求ID', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Message' => [ + 'title' => '打标情况', + 'description' => 'The tag modification result.', + 'type' => 'string', + 'example' => 'done', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Message\\": \\"add resource tag relation success\\"\\n}","type":"json"}]', + 'title' => 'ModifyInstanceTags', + ], + 'DescribeTenantTags' => [ + 'summary' => 'You can call this operation to query the tags of tenants in a cluster.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantIds', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户id的json串', + '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' => '请求ID', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'TagResources' => [ + 'title' => '标签列表', + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned response.', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'title' => '资源id', + 'description' => 'The ID of the resource.', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => 'The type of the resource.', + 'type' => 'string', + 'example' => 'instance', + ], + 'Tag' => [ + 'title' => '资源标签', + 'description' => 'The tag of the resource.', + 'type' => 'string', + 'example' => '[{"Key": "xxx", "Value", "xxx"},{}]', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceId\\": \\"ob317v4uif****\\",\\n \\"ResourceType\\": \\"instance\\",\\n \\"Tag\\": \\"[{\\\\\\"Key\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"Value\\\\\\", \\\\\\"xxx\\\\\\"},{}]\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeTenantTags', + ], + 'ModifyTenantTags' => [ + 'summary' => 'You can call this operation to modify the tags of a tenant.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户id', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't33h8y08k****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'schema' => [ + 'title' => '标签值', + 'description' => 'The tags.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"Key": "xxx", "Value", "xxx"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Message' => [ + 'title' => '打标情况', + 'description' => 'The tag modification result.', + 'type' => 'string', + 'example' => 'done', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Message\\": \\"done\\"\\n}","type":"json"}]', + 'title' => 'ModifyTenantTags', + ], + 'DescribeInstanceTags' => [ + 'summary' => 'You can call this operation to query the tags of clusters.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceIds', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id列表', + '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' => '请求ID', + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'TagResources' => [ + 'title' => '标签列表', + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned response.', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'title' => '资源id', + 'description' => 'The resource ID.', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => 'The type of the resource.', + 'type' => 'string', + 'example' => 'instance', + ], + 'Tag' => [ + 'title' => '资源标签', + 'description' => 'The tag of the resource.', + 'type' => 'string', + 'example' => '[{"Key": "xxx", "Value", "xxx"},{}]', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'CreateInstance' => [ + 'summary' => 'You can call this operation to create an OceanBase cluster.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ChargeType', + 'in' => 'formData', + 'schema' => [ + 'title' => '实例的付费方式。取值范围： PrePay：包年包月。选择该类付费方式时，您必须确认自己的账号支持余额支付/信用支付，否则将返回 InvalidPayMethod的错误提示。 PostPay（默认）：按量付费。其默认按小时来计费', + 'description' => 'The billing method of the instance. Valid values: '."\n" + .'- PrePay: the subscription billing method. You must ensure that the remaining balance or credit balance of your account can cover the cost of the subscription. Otherwise, you will receive an InvalidPayMethod error. '."\n" + .'- PostPay: the pay-as-you-go billing method. This is the default value. By default, fees are charged on an hourly basis.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'PrePay' => 'PrePay', + 'PostPay' => 'PostPay', + ], + 'example' => 'PrePay', + 'enum' => [ + 'PrePay', + 'PostPay', + ], + ], + ], + [ + 'name' => 'Series', + 'in' => 'formData', + 'schema' => [ + 'title' => '实例的系列 - normal（默认）：标准集群版（云盘） - normal_ssd：标准集群版（本地盘） - history：历史库集群版, normal_kv: obkv集群, normal_hg: 信创集群(需要添加白名单开放)。', + 'description' => 'The series of the OceanBase cluster. Valid values: '."\n" + .'- normal: Standard Cluster Edition (Cloud Disk). This is the default value.'."\n" + .'- normal_ssd: Standard Cluster Edition (Local Disk).'."\n" + .'- history: History Database Cluster Edition.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Normal', + 'enum' => [ + 'normal', + 'normal_ssd', + 'history', + 'normal_kv', + 'normal_hg', + ], + ], + ], + [ + 'name' => 'Zones', + 'in' => 'formData', + 'schema' => [ + 'title' => '实例所属的可用区ID。更多详情，请参见DescribeZones获取可用区列表。', + 'description' => 'The ID of the zone to which the instance belongs. '."\n" + .'For more information about how to obtain the list of zones, see [DescribeZones](~~25610~~). ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群规格信息。<br> 当前支持以下套餐：<br> - 4C16GB：4核 16GB<br> - 8C32GB：8核 32GB<br>- 14C70GB：14核 70GB<br> - 24C120GB：24核 120GB<br> - 30C180GB：30核 180GB<br> - 62C400GB：62核 400GB<br> - 104C600GB：104核 600GB<br> - 16C70GB：16核 70GB<br> - 32C160GB：32核 160GB<br> - 64C380GB：64核 380GB<br> - 20C32GB：20核 32GB <br> - 40C64GB：40核 64GB<br> - 16C32GB：16核 32GB<br> - 32C70GB：32核 70GB<br> - 64C180GB：64核 180GB<br> - 32C180GB：32核 180GB<br> - 64C400GB：64核 400GB。', + 'description' => 'The specifications of the cluster. '."\n" + .'You can specify one of the following four plans: '."\n" + .' - 8C32GB: indicates 8 CPU cores and 32 GB of memory. '."\n" + .' - 14C70GB: indicates 14 CPU cores and 70 GB of memory. This is the default value.'."\n" + .'- 30C180GB: indicates 30 CPU cores and 180 GB of memory. '."\n" + .'- 62C400GB: indicates 62 CPU cores and 400 GB of memory.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + '64C380GB' => '64C380GB', + '64C400GB' => '64C400GB', + '32C70GB' => '32C70GB', + '14C70GB' => '14C70GB', + '16C32GB' => '16C32GB', + '4C16GB' => '4C16GB', + '32C160GB' => '32C160GB', + '8C32GB' => '8C32GB', + '16C70GB' => '16C70GB', + '24C120GB' => '24C120GB', + '32C180GB' => '32C180GB', + '30C180GB' => '30C180GB', + '40C64GB' => '40C64GB', + '62C400GB' => '62C400GB', + '20C32GB' => '20C32GB', + '104C600GB' => '104C600GB', + '64C180GB' => '64C180GB', + ], + 'example' => '14C70GB', + 'enum' => [ + '8C32GB', + '14C70GB', + '30C180GB', + '62C400GB', + '16C70GB', + '24C120GB', + '32C160GB', + '64C380GB', + '20C32GB', + '40C64GB', + '4C16GB', + '32C180GB', + '64C400GB', + '16C32GB', + '32C70GB', + '64C180GB', + '64C400GB', + '8C32G', + '14C70G', + '30C180G', + '62C400G', + '16C70G', + '24C120G', + '32C160G', + '64C380G', + '20C32G', + '40C64G', + '4C16G', + '32C180G', + '64C400G', + '16C32G', + '32C70G', + '64C180G', + '104C600G', + ], + ], + ], + [ + 'name' => 'DiskSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '存储空间大小，单位GB。 存储空间的限制根据集群规格不同而不同，具体如下： - 8C32GB：100GB~10000GB - 14C70GB：200GB~10000GB - 30C180GB：400GB~10000GB - 62C400G：800GB-10000GB。 各套餐的存储空间默认值为其最小值。', + 'description' => 'The size of the storage space,in GB. '."\n" + .'The limits on the storage space vary with the cluster specifications: '."\n" + .'- 8C32GB: 100 GB to 10000 GB '."\n" + .'- 14C70GB: 200 GB to 10000 GB '."\n" + .'- 30C180GB: 400 GB to 10000 GB '."\n" + .'- 62C400GB: 800 GB to 10000 GB '."\n" + .'The preceding minimum storage space sizes are the default storage space sizes of the corresponding cluster specification plans. ', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '200', + ], + ], + [ + 'name' => 'Period', + 'in' => 'formData', + 'schema' => [ + 'title' => '购买资源的时长，单位由PeriodUnit指定。当参数InstanceChargeType取值为PrePaid时才生效且为必选值。 取值范围： PeriodUnit=Month时，Period取值：{“1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”}。 PeriodUnit=Year时，Period取值：{“1”, “2”, “3”}。', + 'description' => 'The valid duration of the purchased resources. The unit is specified by the PeriodUnit parameter. '."\n" + .'This parameter is valid and required only when the InstanceChargeType parameter is set to PrePaid. '."\n" + .'Valid values: '."\n" + .'- When the PeriodUnit parameter is set to Month: "1", "2", "3", "4", "5", "6", "7", "8", "9". '."\n" + .'- When the PeriodUnit parameter is set to Year: "1", "2", "3".', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'formData', + 'schema' => [ + 'title' => '购买资源的时长。'."\n" + .'包年包月取值范围：Month 或者 Year。'."\n" + .'默认值：包年包月为 Month，按量计费，默认周期为 Hour。', + 'description' => 'The unit of the valid duration of the purchased resources. '."\n" + .'Valid value for subscription: Month or Year.'."\n" + .'Default value: Month for subscription, and Hour for pay-as-you-go.', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否要自动续费。当参数ChargeType取值PrePaid时生效。取值范围： true：自动续费。 false（默认）：不自动续费。', + 'description' => 'Specifies whether to enable automatic renewal. '."\n" + .'This parameter is valid only when the ChargeType parameter is set to PrePaid. Valid values: '."\n" + .'- true: enables automatic renewal for the instance. '."\n" + .'- false: disables automatic renewal for the instance. This is the default value. ', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AutoRenewPeriod', + 'in' => 'formData', + 'schema' => [ + 'title' => '每次自动续费的时长，当参数 AutoRenew 取值 True 时，该参数为必填参数。'."\n" + .'PeriodUnit 为 Year 时，AutoRenewPeriod 取值范围为 {"1", "2", "3"}。'."\n" + .'PeriodUnit 为 Month 时，AutoRenewPeriod 取值范围为 {"1", "2", "3", "6", "12"}。', + 'description' => 'The automatic renewal period of the instance. This parameter is required when the AutoRenew parameter is set to true. Valid values: '."\n" + .'- If the PeriodUnit parameter is set to Year: "1", "2", and "3". '."\n" + .'- If the PeriodUnit parameter is set to Month: "1", "2", "3", "6", and "12".', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '实例所在的企业资源组ID', + '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' => '集群名称, 最大长度为20字符。', + 'description' => 'The name of the OceanBase cluster. '."\n" + .'It must be 1 to 20 characters in length. '."\n" + .'If this parameter is not specified, the value is the instance ID of the cluster by default.', + 'type' => 'string', + 'required' => false, + 'example' => 'amap_aos_tx_ob', + 'maxLength' => 64, + 'minLength' => 0, + ], + ], + [ + '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' => '3F', + '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' => [ + 'title' => 'cpu架构', + 'type' => 'string', + 'example' => 'x86', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The request ID. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Data' => [ + 'title' => '返回数据', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => '实例ID', + 'description' => 'Instance ID.', + 'type' => 'string', + 'example' => 'i-bp67acfmxazb4p****', + ], + 'OrderId' => [ + 'title' => '订单ID。该参数只有创建包年包月ECS实例（请求参数InstanceChargeType=PrePaid）时有返回值。', + 'description' => 'Order ID. The ID of the order that you have placed.'."\n" + .'This parameter returns a value after you create a pre-paid or post-paid cluster.', + 'type' => 'string', + 'example' => '1234567890', + ], + 'ResourceGroupId' => [ + 'title' => '资源组ID', + 'description' => 'Resource group ID.', + 'type' => 'string', + 'example' => 'rg-***************', + ], + 'DryRunResult' => [ + 'title' => '预检查请求的结果. 如果DryRun填写为true, 当预检查请求通过, 则DryRunResult返回true, 否则返回相应的错误码信息.', + 'description' => 'The result of the dry-run request.'."\n" + ."\n" + .'If the DryRun parameter is set to true and the dry run succeeds, the DryRunResult parameter returns true. Otherwise, an error code is returned.'."\n" + .'If the DryRun parameter is set to false, no dry run is performed and the DryRunResult parameter returns false.', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Instance.Order.CreateFailed', + 'errorMessage' => 'Instance.Order.CreateFailed', + ], + [ + 'errorCode' => 'InstanceName.ModifyFailed', + 'errorMessage' => 'InstanceName.ModifyFailed', + ], + [ + 'errorCode' => 'InstanceClass.InvalidValue', + 'errorMessage' => 'InstanceClass.InvalidValue', + ], + [ + 'errorCode' => 'InstanceType.Unsupport', + 'errorMessage' => 'InstanceType.Unsupport', + ], + [ + 'errorCode' => 'ZoneList.Unsupport', + 'errorMessage' => 'ZoneList.Unsupport', + ], + [ + 'errorCode' => 'InstanceId.Invalid', + 'errorMessage' => 'InstanceId.Invalid', + ], + [ + 'errorCode' => 'InstanceId.Missing', + 'errorMessage' => 'InstanceId.Missing', + ], + [ + 'errorCode' => 'Instance.Name.Missing', + 'errorMessage' => 'Instance.Name.Missing', + ], + [ + 'errorCode' => 'ListCluster.Fail', + 'errorMessage' => 'ListCluster.Fail', + ], + [ + 'errorCode' => 'GetCluster.Fail', + 'errorMessage' => 'GetCluster.Fail', + ], + [ + 'errorCode' => 'ListClusterGroup.Fail', + 'errorMessage' => 'ListClusterGroup.Fail', + ], + [ + 'errorCode' => 'GetClusterGroup.Fail', + 'errorMessage' => 'GetClusterGroup.Fail', + ], + [ + 'errorCode' => 'ListInstance.Fail', + 'errorMessage' => 'ListInstance.Fail', + ], + [ + 'errorCode' => 'GetInstance.Fail', + 'errorMessage' => 'GetInstance.Fail', + ], + [ + 'errorCode' => 'ListTenant.Fail', + 'errorMessage' => 'ListTenant.Fail', + ], + [ + 'errorCode' => 'GetTenant.Fail', + 'errorMessage' => 'GetTenant.Fail', + ], + [ + 'errorCode' => 'Instance.ListAliyunInstance.Fail', + 'errorMessage' => 'Instance.ListAliyunInstance.Fail', + ], + [ + 'errorCode' => 'Instance.GetAliyunInstance.Fail', + 'errorMessage' => 'Instance.GetAliyunInstance.Fail', + ], + [ + 'errorCode' => 'ListZone.Fail', + 'errorMessage' => 'ListZone.Fail', + ], + [ + 'errorCode' => 'ListObServer.Fail', + 'errorMessage' => 'ListObServer.Fail', + ], + [ + 'errorCode' => 'GetObServer.Fail', + 'errorMessage' => 'GetObServer.Fail', + ], + [ + 'errorCode' => 'CreateInstanceParameters.Error', + 'errorMessage' => 'CreateInstanceParameters.Error', + ], + [ + 'errorCode' => 'CreateInstance.Fail', + 'errorMessage' => 'CreateInstance.Fail', + ], + [ + 'errorCode' => 'InstanceClassSpecification.Invalid', + 'errorMessage' => 'InstanceClassSpecification.Invalid', + ], + [ + 'errorCode' => 'InstanceOrder.NotAvailable', + 'errorMessage' => 'InstanceOrder.NotAvailable', + ], + [ + 'errorCode' => 'InstanceNodeNum.Invalid', + 'errorMessage' => 'InstanceNodeNum.Invalid', + ], + [ + 'errorCode' => 'InstanceLogSize.Invalid', + 'errorMessage' => 'InstanceLogSize.Invalid', + ], + [ + 'errorCode' => 'Instance.ExpandLogDisk.NotSupport', + 'errorMessage' => 'Instance.ExpandLogDisk.NotSupport', + ], + [ + 'errorCode' => 'InstanceStatus.Invalid', + 'errorMessage' => 'InstanceStatus.Invalid', + ], + [ + 'errorCode' => 'InstanceDataSize.Invalid', + 'errorMessage' => 'InstanceDataSize.Invalid', + ], + [ + 'errorCode' => 'StandbyInstance.StillOnline', + 'errorMessage' => 'StandbyInstance.StillOnline', + ], + [ + 'errorCode' => 'InstanceServiceName.Missing', + 'errorMessage' => 'InstanceServiceName.Missing', + ], + [ + 'errorCode' => 'PrimaryInstanceStatus.Invalid', + 'errorMessage' => 'PrimaryInstanceStatus.Invalid', + ], + [ + 'errorCode' => 'StandbyInstanceStatus.Invalid', + 'errorMessage' => 'StandbyInstanceStatus.Invalid', + ], + [ + 'errorCode' => 'StandbyInstance.NotSupport', + 'errorMessage' => 'StandbyInstance.NotSupport', + ], + [ + 'errorCode' => 'StandbyInstance.Disconnect.NotAllowed', + 'errorMessage' => 'StandbyInstance.Disconnect.NotAllowed', + ], + [ + 'errorCode' => 'InstanceDiskSize.Invalid', + 'errorMessage' => 'InstanceDiskSize.Invalid', + ], + [ + 'errorCode' => 'CreateInstance.Spec.NotSupport', + 'errorMessage' => 'CreateInstance.Spec.NotSupport', + ], + [ + 'errorCode' => 'MissingParameterDiskSize', + 'errorMessage' => 'MissingParameterDiskSize', + ], + [ + 'errorCode' => 'CreateInstance.ReplicaMode.InvalidValue', + 'errorMessage' => 'CreateInstance.ReplicaMode.InvalidValue', + ], + [ + 'errorCode' => 'CreateInstance.DeployType.InvalidValue', + 'errorMessage' => 'CreateInstance.DeployType.InvalidValue', + ], + [ + 'errorCode' => 'ConfigError', + 'errorMessage' => 'ConfigError', + ], + ], + 500 => [ + [ + 'errorCode' => 'Instance.Order.CreateFailed', + 'errorMessage' => 'Instance.Order.CreateFailed', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"i-bp67acfmxazb4p****\\",\\n \\"OrderId\\": \\"1234567890\\",\\n \\"ResourceGroupId\\": \\"rg-***************\\",\\n \\"DryRunResult\\": false\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateInstanceResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n <Data>\\n <InstanceId>i-bp67acfmxazb4p****</InstanceId>\\n <OrderId>1234567890</OrderId>\\n <ResourceGroupId>rg-***************</ResourceGroupId>\\n </Data>\\n</CreateInstanceResponse>","errorExample":""}]', + 'title' => 'CreateInstance', + ], + 'DescribeInstance' => [ + 'summary' => 'You can call this operation to query the detailed information 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' => 'OceanBase 集群 ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。<br>起始值：1， 默认值：1', + 'description' => 'The number of the page to return.'."\n" + .'- Pages start from page 1.'."\n" + .'- Default value: 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 ID。', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Instance' => [ + 'title' => 'OceanBase 集群信息。', + 'description' => 'The information of the OceanBase cluster. ', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => 'OceanBase 集群 ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'InstanceName' => [ + 'title' => 'OceanBase 集群名称。', + 'description' => 'The name of the OceanBase cluster. ', + 'type' => 'string', + 'example' => 'ob4test', + ], + 'InstanceClass' => [ + 'title' => '集群规格信息。<br> 当前支持以下套餐：<br> - 4C16GB：4核 16GB<br> - 8C32GB：8核 32GB<br>- 14C70GB：14核 70GB<br> - 24C120GB：24核 120GB<br> - 30C180GB：30核 180GB<br> - 62C400GB：62核 400GB<br> - 104C600GB：104核 600GB<br> - 16C70GB：16核 70GB<br> - 32C160GB：32核 160GB<br> - 64C380GB：64核 380GB<br> - 20C32GB：20核 32GB <br> - 40C64GB：40核 64GB<br> - 16C32GB：16核 32GB<br> - 32C70GB：32核 70GB<br> - 64C180GB：64核 180GB<br> - 32C180GB：32核 180GB<br> - 64C400GB：64核 400GB。', + 'description' => 'The specifications of the cluster. You can specify one of the following four plans: '."\n" + .'- 8C32G: indicates 8 CPU cores and 32 GB of memory. '."\n" + .'- 14C70G: indicates 14 CPU cores and 70 GB of memory. '."\n" + .'- 30C180G: indicates 30 CPU cores and 180 GB of memory. '."\n" + .'- 62C400G: indicates 62 CPU cores and 400 GB of memory. ', + 'type' => 'string', + 'example' => '14C70G', + ], + 'Series' => [ + 'title' => '实例的系列 - normal（默认）：标准集群版（云盘） - normal_ssd：标准集群版（本地盘） - history：历史库集群版, normal_kv: obkv集群, normal_hg: 信创集群。', + 'description' => 'The series of the instance. Valid values:'."\n" + ."\n" + .'- normal: Standard Cluster Edition (Cloud Disk). This is the default value.'."\n" + ."\n" + .'- normal_ssd: Standard Cluster Edition (Local Disk)'."\n" + ."\n" + .'- history: History Database Cluster Edition', + 'type' => 'string', + 'example' => 'Normal', + ], + 'PayType' => [ + 'title' => 'OceanBase 集群的付费类型 <br>- PREPAY：预付费 <br>- POSTPAY：按量付费', + 'description' => 'The billing method of the OceanBase cluster. Valid values: '."\n" + .'- PREPAY: the subscription billing method. '."\n" + .'- POSTPAY: the pay-as-you-go billing method. ', + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'CreateTime' => [ + 'title' => '集群的创建时间（UTC时间）。', + 'description' => 'The time in UTC when the cluster was created. ', + 'type' => 'string', + 'example' => '2021-10-19T07:13:41Z', + ], + 'ExpireTime' => [ + 'title' => '集群过期时间（UTC格式）。', + 'description' => 'The time in UTC when the cluster expires. ', + 'type' => 'string', + 'example' => '2021-10-17T16:00:00Z', + ], + 'Version' => [ + 'title' => 'OBServer 版本信息。', + 'description' => 'The version of OceanBase Database.', + 'type' => 'string', + 'example' => '2.2.77', + ], + 'DeployType' => [ + 'title' => '集群的部署类型。<br> - multiple：多机房 <br>- single：单机房 <br>- dual：双机房', + 'description' => 'The deployment type of the cluster. Valid values: '."\n" + .'- multiple: multi-IDC deployment '."\n" + .'- single: single-IDC deployment '."\n" + .'- dual: dual-IDC deployment ', + 'type' => 'string', + 'example' => 'multiple', + ], + 'DeployMode' => [ + 'title' => '集群的数据副本模式。 单机房为n，双机房为n-n，多机房为n-n-n，其中n为各机房的observer节点数。', + 'description' => 'The data replica distribution mode of the cluster. Valid values: '."\n" + .'- n: indicates the single-IDC mode. '."\n" + .'- n-n: indicates the dual-IDC mode. '."\n" + .'- n-n-n: indicates the multi-IDC mode. '."\n" + ."\n" + .'> <br>The integer n represents the number of OBServer nodes in each IDC. ', + 'type' => 'string', + 'example' => '1-1-1', + ], + 'DiskType' => [ + 'title' => '集群部署的存储类型。默认为cloud_essd_pl1：ESSD云盘。', + 'description' => 'The type of the storage disk where the cluster is deployed. '."\n" + ."\n" + .'The default value is cloud_essd_pl1, which indicates an ESSD cloud disk. ', + 'type' => 'string', + 'example' => 'cloud_essd_pl1', + ], + 'MaintainTime' => [ + 'title' => '集群的每天例行维护时间，UTC时间。', + 'description' => 'The period in UTC for the daily routine maintenance of the cluster.', + 'type' => 'string', + 'example' => '19:00Z-20:00Z', + ], + 'DataMergeTime' => [ + 'title' => '集群的数据合并时间。', + 'description' => 'The time when the major compaction of cluster data is performed. ', + 'type' => 'string', + 'example' => '02:00', + ], + 'AutoRenewal' => [ + 'title' => '是否开启自动续费。该参数只在预付费（PREPAY）集群有意义。', + 'description' => 'Indicates whether automatic renewal is enabled. '."\n" + ."\n" + .'This parameter is valid only for clusters whose billing methods are set to PREPAY. ', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsTrustEcs' => [ + 'title' => '是否使用可信ecs', + 'description' => 'Indicates whether trusted ECS instances are used. ', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Status' => [ + 'title' => '集群状态。 <br>- PENDING_CREATE: 创建中 <br>- ONLINE: 运行中 <br>- TENANT_CREATING：租户创建中 <br>- TENANT_SPEC_MODIFYING：租户规格修改中 <br>- EXPANDING: 节点扩容中 <br>- REDUCING: 节点缩容中 <br>- SPEC_UPGRADING:套餐规格扩容中 <br>- DISK_UPGRADING:存储规格扩容中 <br>- WHITE_LIST_MODIFYING: 修改白名单中 <br>- PARAMETER_MODIFYING: 修改参数中 <br>- SSL_MODIFYING: SSL变更中 <br>- PREPAID_EXPIRE_CLOSED: 预付费集群欠费中 <br>- ARREARS_CLOSED: 后付费集群欠费中 <br>- PENDING_DELETE: 删除中。 集群一般为运行中的状态（ONLINE）。', + 'description' => 'The status of the cluster. Valid values: '."\n" + .' - PENDING_CREATE: The cluster is being created. '."\n" + .' - ONLINE: The cluster is running. '."\n" + .' - TENANT_CREATING: The tenant is being created. '."\n" + .'- TENANT_SPEC_MODIFYING: The tenant specifications are being modified. '."\n" + .'- EXPANDING: Nodes are being added to the cluster to increase its capacity. '."\n" + .'- REDUCING: Nodes are being removed from the cluster to reduce its capacity. '."\n" + .'- SPEC_UPGRADING: The service plan is being upgraded. '."\n" + .'- DISK_UPGRADING: The storage space is being expanded. '."\n" + .'- WHITE_LIST_MODIFYING: The whitelist is being modified. '."\n" + .'- PARAMETER_MODIFYING: Parameters are being modified. '."\n" + .'- SSL_MODIFYING: The SSL certificate is being changed. '."\n" + .'- PREPAID_EXPIRE_CLOSED: The payment is overdue. This parameter is valid for a cluster whose billing method is set to PREPAY. '."\n" + .'- ARREARS_CLOSED: The payment is overdue. This parameter is valid for a cluster whose billing method is set to POSTPAY. '."\n" + .'- PENDING_DELETE: The cluster is being deleted. '."\n" + .'Generally, the cluster is in the ONLINE state. ', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'Resource' => [ + 'title' => '集群的资源信息', + 'description' => 'The information about cluster resources. ', + 'type' => 'object', + 'properties' => [ + 'Cpu' => [ + 'title' => '集群的CPU资源信息', + 'description' => 'The information about the CPU resources of the cluster. ', + 'type' => 'object', + 'properties' => [ + 'TotalCpu' => [ + 'title' => '集群总CPU，单位：核数', + 'description' => 'The total number of CPU cores of the cluster. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + 'UsedCpu' => [ + 'title' => '集群已使用的CPU，单位：核数', + 'description' => 'The number of CPU cores used in the cluster. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'UnitCpu' => [ + 'title' => '集群中每个副本节点的CPU，单位：核数', + 'description' => 'The number of CPU cores of each replica node in the cluster.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'OriginalTotalCpu' => [ + 'title' => '原始CPU', + 'description' => 'The number of original CPU cores in the cluster.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + ], + ], + 'Memory' => [ + 'title' => '集群的内存资源信息', + 'description' => 'The information about the memory resources of the cluster. ', + 'type' => 'object', + 'properties' => [ + 'TotalMemory' => [ + 'title' => '集群总内存，单位：GB', + 'description' => 'The total memory size of the cluster, in GB. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '70', + ], + 'UsedMemory' => [ + 'title' => '集群已使用的内存，单位：GB', + 'description' => 'The size of used memory in the cluster, in GB. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'UnitMemory' => [ + 'title' => '集群中每个副本的内存，单位：GB', + 'description' => 'The memory size of each replica node in the cluster, in GB.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'OriginalTotalMemory' => [ + 'title' => '原始内存', + 'description' => 'The original memory size of the cluster, in GB.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '72', + ], + ], + ], + 'DiskSize' => [ + 'title' => '集群的存储资源信息', + 'description' => 'The information about the storage resources of the cluster. ', + 'type' => 'object', + 'properties' => [ + 'TotalDiskSize' => [ + 'title' => '集群总存储空间，单位：GB', + 'description' => 'The total storage space of the cluster, in GB. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'UsedDiskSize' => [ + 'title' => '集群已使用的存储空间，单位：GB', + 'description' => 'The size of used storage space of the cluster, in GB. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'UnitDiskSize' => [ + 'title' => '集群每个副本的存储空间，单位：GB', + 'description' => 'The storage space of each replica node in the cluster, in GB.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'DataUsedSize' => [ + 'description' => 'The size of the data disk, in GB. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '200', + ], + 'MaxDiskUsedPercent' => [ + 'description' => 'The maximum disk usage, in percentage. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.14', + ], + 'MaxDiskUsedObServer' => [ + 'description' => 'The maximum disk usage of the OBServer node.', + 'type' => 'array', + 'items' => [ + 'description' => 'The maximum disk usage of the OBServer node.', + 'type' => 'string', + 'example' => 'i-bp1fhj23fs32dfbg4****', + ], + ], + 'OriginalTotalDiskSize' => [ + 'title' => '原始磁盘', + 'description' => 'The original size of the disk.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'MaxDiskSize' => [ + 'title' => '最大可创建磁盘大小', + 'description' => 'The maximum disk size that can be created.', + 'type' => 'number', + 'format' => 'double', + 'example' => '80000', + ], + ], + ], + 'UnitCount' => [ + 'title' => '集群的资源Unit数量。', + 'description' => 'The number of resource units in the cluster. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'LogDiskSize' => [ + 'title' => '集群的日志盘资源信息', + 'description' => 'The information about the log disk space of the cluster.', + 'type' => 'object', + 'properties' => [ + 'TotalDiskSize' => [ + 'title' => '集群总日志盘空间，单位GB。', + 'description' => 'The total log disk space of the cluster, in GB. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '400', + ], + 'UnitDiskSize' => [ + 'title' => '集群每个副本的日志存储空间，单位：GB', + 'description' => 'The log disk space of each replica node in the cluster. Unit: GB.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'LogAssignedSize' => [ + 'description' => 'The allocated disk space for log storage, in GB.', + 'type' => 'string', + 'example' => '0.0', + ], + 'MaxLogAssignedObServer' => [ + 'description' => 'The maximum storage space allocated for.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of the OBServer nodes that are allocated the maximum log storage space.', + 'type' => 'string', + 'example' => '["i-bp1g****","i-bp11****","i-bp19****"]', + ], + ], + 'MaxLogAssignedPercent' => [ + 'description' => 'The maximum percentage of space allocated for log storage.', + 'type' => 'string', + 'example' => '6.68', + ], + 'OriginalTotalDiskSize' => [ + 'title' => '日志盘原始大小', + 'description' => 'The original size of the disk.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + 'CapacityUnit' => [ + 'description' => 'The information about capacity units.', + 'type' => 'object', + 'properties' => [ + 'MaxCapacityUnit' => [ + 'description' => 'The maximum number of capacity units.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'MinCapacityUnit' => [ + 'description' => 'The minimum number of capacity units.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'UsedCapacityUnit' => [ + 'description' => 'The number of used capacity units.', + 'type' => 'string', + 'example' => '2', + ], + ], + ], + ], + ], + 'AutoUpgradeObVersion' => [ + 'title' => '是否开启自动升级 OBServer 版本。', + 'description' => 'Indicates whether automatic upgrade of the OBServer version is enabled. ', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ObRpmVersion' => [ + 'title' => 'OBServer 详细版本信息。', + 'description' => 'The detailed information of the OBServer version. ', + 'type' => 'string', + 'example' => '2.2.77-20210526202046', + ], + 'IsLatestObVersion' => [ + 'title' => 'OBServer版本是否为最新版本。', + 'description' => 'Indicates whether the OBServer version is the latest. ', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AvailableZones' => [ + 'title' => '可用区列表。', + 'description' => 'The list of zones. ', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of zones. ', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + ], + 'EnableUpgradeLogDisk' => [ + 'title' => '是否允许升级日志盘规格。', + 'description' => 'Indicates whether the log disk specifications can be upgraded. ', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Zones' => [ + 'description' => 'The ID of the zone to which the instance belongs.'."\n" + .'<props="intl">For more information about how to obtain the list of zones, see [DescribeZones](https://www.alibabacloud.com/help/en/apsaradb-for-oceanbase/latest/api-oceanbasepro-2019-09-01-describezones).</props>', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the zone to which the instance belongs.'."\n" + .'<props="intl">For more information about how to obtain the list of zones, see [DescribeZones](https://www.alibabacloud.com/help/en/apsaradb-for-oceanbase/latest/api-oceanbasepro-2019-09-01-describezones).</props>', + 'type' => 'string', + 'example' => 'cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j', + ], + ], + 'InstanceRole' => [ + 'title' => '实例角色', + 'description' => 'The role of the instance.', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'NodeNum' => [ + 'description' => 'The number of nodes in the cluster. If the cluster is deployed in n-n-n mode, the number of nodes in the cluster equals n × 3.', + 'type' => 'integer', + 'example' => '6', + 'format' => 'int64', + ], + 'ReplicaMode' => [ + 'description' => 'The number of full-featured replicas. Return value: 3 or 2.'."\n" + .'- 3: three full-featured replicas.'."\n" + .'- 2: two full-featured replicas.'."\n" + ."\n" + .'An OceanBase cluster deployed in three-zone mode supports only three full-featured replicas. An OceanBase cluster deployed in two-zone mode supports only two full-featured replicas. An OceanBase cluster deployed in one single zone supports two or three full-featured replicas.', + 'type' => 'string', + 'example' => '2F1A', + ], + 'IsolationOptimization' => [ + 'title' => '是否开启Cgroup', + 'description' => 'Specifies whether to enable the control group feature.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'EnableIsolationOptimization' => [ + 'title' => '是否允许开通隔离优化', + 'description' => 'Specifies whether to enable isolation optimization.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'InTempCapacityStatus' => [ + 'description' => 'Specifies whether to indicate the temporary status of the capacity.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'DataDiskAutoScale' => [ + 'title' => '是否开启数据自动协调', + 'description' => 'Specifies whether to enable automatic scaling of the data disk.'."\n" + .'> <br>This parameter is deprecated.', + 'type' => 'boolean', + 'example' => '-', + ], + 'TenantCreatable' => [ + 'description' => 'Specifies whether a tenant can be created.', + 'type' => 'object', + 'properties' => [ + 'EnableCreateTenant' => [ + 'title' => '集群是否允许创建租户', + 'description' => 'Specifies whether a tenant can be created.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DisableCreateTenantReason' => [ + 'title' => '集群不允许创建租户的原因', + 'description' => 'The reason why you cannot create a tenant in the cluster.', + 'type' => 'string', + 'example' => 'CPU_NOT_ENOUGH, MEMORY_NOT_ENOUGH, TENANT_COUNT_EXCEEDS_LIMIT', + ], + ], + ], + 'DataDiskAutoScaleConfig' => [ + 'title' => '数据盘自动协调配置', + 'description' => 'Specifies parameters for the automatic scaling of the data disk.', + 'type' => 'object', + 'properties' => [ + 'AutoScale' => [ + 'title' => '是否开启', + 'description' => 'Specifies whether to enable the automatic scaling of the data disk.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Upperbound' => [ + 'title' => '扩容上限', + 'description' => 'The maximum space, in GB, to which the data disk can be scaled.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16', + ], + 'UpperThreshold' => [ + 'title' => '日常扩容阈值', + 'description' => 'The maximum usage of the data disk, in percentage, that triggers the scaling of the data disk for daily use.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '80', + ], + 'UpperMergeThreshold' => [ + 'title' => '合并扩容阈值', + 'description' => 'The maximum usage of the data disk, in percentage, that triggers the scaling of the data disk for major compactions.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90', + ], + 'MaxDiskSize' => [ + 'title' => '磁盘最大值', + 'description' => 'The maximum size of the disk, in GB.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '80000', + ], + 'ScaleStepInNormal' => [ + 'title' => '日常扩容步长', + 'description' => 'The size of scaling step during daily use.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'ScaleStepInMerge' => [ + 'title' => '合并扩容步长', + 'description' => 'The size of scaling step during a major compaction.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'UpperScaleStrategy' => [ + 'title' => '扩容策略（RAW/PERCENTAGE）', + 'description' => 'The scale-out strategy. Valid values: RAW and PERCENTAGE.', + 'type' => 'string', + 'example' => 'RAW', + ], + 'UpperScaleStep' => [ + 'title' => '扩容步长', + 'description' => 'The step size of the scale-out.', + 'type' => 'string', + 'example' => '5', + ], + ], + ], + 'EnableProxyService' => [ + 'description' => 'Specifies whether to enable the proxy service.'."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ProxyServiceStatus' => [ + 'title' => '代理服务状态', + 'description' => 'The status of the proxy service.', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'ProxyClusterId' => [ + 'title' => '代理集群 ID', + 'description' => 'The ID of the proxy cluster.'."\n" + .'> This parameter returns a value only if you set the **EnableProxyService** parameter to true.', + 'type' => 'string', + 'required' => false, + 'example' => 'proxy-56****a6tg2o', + ], + 'CpuArchitecture' => [ + 'title' => '集群的 CPU 架构', + 'description' => 'The CPU architecture of the cluster.', + 'type' => 'string', + 'example' => 'X86', + 'enum' => [ + 'X86', + 'ARM', + ], + ], + 'ReadOnlyResource' => [ + 'title' => '集群的资源信息', + 'description' => 'The information about cluster resources.', + 'type' => 'object', + 'properties' => [ + 'Cpu' => [ + 'title' => '集群的CPU资源信息', + 'description' => 'The information about the CPU resources of the cluster.', + 'type' => 'object', + 'properties' => [ + 'TotalCpu' => [ + 'title' => '集群总CPU，单位：核数', + 'description' => 'The total number of CPU cores of the cluster.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + 'UsedCpu' => [ + 'title' => '集群已使用的CPU，单位：核数', + 'description' => 'The number of CPU cores used by the cluster.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'UnitCpu' => [ + 'title' => '集群中每个副本节点的CPU，单位：核数', + 'description' => 'The number of CPU cores of each replica node in the cluster.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'OriginalTotalCpu' => [ + 'title' => '原始CPU', + 'description' => 'The number of original CPU cores in the cluster.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + ], + ], + 'Memory' => [ + 'title' => '集群的内存资源信息', + 'description' => 'The information about the memory resources of the cluster.', + 'type' => 'object', + 'properties' => [ + 'TotalMemory' => [ + 'title' => '集群总内存，单位：GB', + 'description' => 'The total memory size of the cluster, in GB.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '70', + ], + 'UsedMemory' => [ + 'title' => '集群已使用的内存，单位：GB', + 'description' => 'The size of memory used by the cluster, in GB.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'UnitMemory' => [ + 'title' => '集群中每个副本的内存，单位：GB', + 'description' => 'The memory size of each replica node in the cluster, in GB.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'OriginalTotalMemory' => [ + 'title' => '原始内存', + 'description' => 'The original memory size of the cluster.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '72', + ], + ], + ], + 'DiskSize' => [ + 'title' => '集群的存储资源信息', + 'description' => 'The information about the storage resources of the cluster.', + 'type' => 'object', + 'properties' => [ + 'TotalDiskSize' => [ + 'title' => '集群总存储空间，单位：GB', + 'description' => 'The total storage space of the cluster, in GB.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'UsedDiskSize' => [ + 'title' => '集群已使用的存储空间，单位：GB', + 'description' => 'The size of used storage space of the cluster, in GB.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'UnitDiskSize' => [ + 'title' => '集群每个副本的存储空间，单位：GB', + 'description' => 'The storage space of each replica node in the cluster, in GB.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'DataUsedSize' => [ + 'description' => 'The size of the data disk, in GB.', + 'type' => 'number', + 'format' => 'double', + 'example' => '200', + ], + 'MaxDiskUsedPercent' => [ + 'description' => 'The maximum disk usage, in percentage.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.14', + ], + 'MaxDiskUsedObServer' => [ + 'description' => 'The maximum disk usage of the OBServer node.', + 'type' => 'array', + 'items' => [ + 'description' => 'The maximum disk usage of the OBServer node.', + 'type' => 'string', + 'example' => 'i-bp1fhj23fs32dfbg4****', + ], + ], + 'OriginalTotalDiskSize' => [ + 'title' => '原始磁盘', + 'description' => 'The original size of the disk.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'MaxDiskSize' => [ + 'title' => '最大可创建磁盘大小', + 'description' => 'The maximum disk size that can be created.', + 'type' => 'number', + 'format' => 'double', + 'example' => '80000', + ], + ], + ], + 'UnitCount' => [ + 'title' => '集群的资源Unit数量。', + 'description' => 'The number of resource units in the cluster.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'LogDiskSize' => [ + 'title' => '集群的日志盘资源信息', + 'description' => 'The information about the log disk space of the cluster.', + 'type' => 'object', + 'properties' => [ + 'TotalDiskSize' => [ + 'title' => '集群总日志盘空间，单位GB。', + 'description' => 'The information about the log disk space of the cluster.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '400', + ], + 'UnitDiskSize' => [ + 'title' => '集群每个副本的日志存储空间，单位：GB', + 'description' => 'The log disk space of each replica node in the cluster, in GB.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'LogAssignedSize' => [ + 'description' => 'The allocated disk space for log storage, in GB.', + 'type' => 'string', + 'example' => '0.0', + ], + 'MaxLogAssignedObServer' => [ + 'description' => 'The maximum storage space allocated for.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of the OBServer nodes that are allocated the maximum log storage space.', + 'type' => 'string', + 'example' => '["i-bp1g****","i-bp11****","i-bp19****"]', + ], + ], + 'MaxLogAssignedPercent' => [ + 'description' => 'The maximum percentage of space allocated for log storage.', + 'type' => 'string', + 'example' => '6.68', + ], + ], + ], + 'CapacityUnit' => [ + 'description' => 'The information about capacity units.', + 'type' => 'object', + 'properties' => [ + 'MaxCapacityUnit' => [ + 'description' => 'The maximum number of capacity units.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'MinCapacityUnit' => [ + 'description' => 'The minimum number of capacity units.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'UsedCapacityUnit' => [ + 'description' => 'The number of used capacity units.', + 'type' => 'string', + 'example' => '2', + ], + ], + ], + ], + ], + 'UnitSpec' => [ + 'title' => '代理服务的单元规格', + 'description' => 'The unit specification of the proxy service.', + 'type' => 'string', + 'example' => '2C4G', + ], + 'SharedUnitNumLimit' => [ + 'title' => '共享模式代理服务的单元数量上限', + 'description' => 'The maximum number of units of the proxy service in shared mode.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ExclusiveUnitNumLimit' => [ + 'title' => '独占模式代理服务的单元数量上限', + 'description' => 'The maximum number of units of the proxy service in exclusive mode.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EnableReadOnlyReplica' => [ + 'description' => 'Indicates whether read-only replicas are supported.', + 'type' => 'boolean', + 'example' => 'true'."\n", + ], + 'EnableReadOnlyReplicaManagement' => [ + 'description' => 'Indicates whether read-only replicas can be purchased for the cluster.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'PrimaryInstance' => [ + 'title' => "\n" + .'主实例Id', + 'description' => 'The ID of the primary cluster.', + 'type' => 'string', + 'example' => 'ob3h8ytroxxxxx', + ], + 'PrimaryRegion' => [ + 'title' => '主实例Region', + 'description' => 'The region of the primary cluster.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'SpecType' => [ + 'title' => '规格类型', + 'description' => 'The specification type.', + 'type' => 'string', + 'example' => 'dedicatedspec', + ], + 'AllowModifyInternetAddressConnectionLimit' => [ + 'title' => '是否允许修改公网最大连接数', + 'description' => 'Indicates whether the maximum number of public connections can be modified.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'AllowCreateProxySqlFirewallRule' => [ + 'title' => '是否允许使用 ODP SQL 防火墙', + 'description' => 'Indicates whether the OceanBase Database Proxy (ODP) SQL firewall is supported.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Iops' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'InstanceType' => [ + 'title' => '实例类型', + 'type' => 'string', + ], + 'MigrationInfo' => [ + 'title' => '切换到云市场信息', + 'type' => 'object', + 'properties' => [ + 'Migratable' => [ + 'title' => '是否可切换', + 'type' => 'boolean', + ], + 'CheckResult' => [ + 'title' => '如果不支持切换，此处有详细原因', + 'type' => 'object', + 'properties' => [ + 'Level' => [ + 'title' => '结果等级', + 'type' => 'string', + ], + 'Code' => [ + 'title' => '检查项代码', + 'type' => 'string', + ], + 'CodeName' => [ + 'title' => '检查项文案', + 'type' => 'string', + ], + 'Module' => [ + 'title' => '模块名', + 'type' => 'string', + ], + 'ModuleName' => [ + 'title' => '模块名文案', + 'type' => 'string', + ], + 'SubModule' => [ + 'title' => '子模块名', + 'type' => 'string', + ], + 'SubModuleName' => [ + 'title' => '子模块文案', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Instance\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"InstanceName\\": \\"ob4test\\",\\n \\"InstanceClass\\": \\"14C70G\\",\\n \\"Series\\": \\"Normal\\",\\n \\"PayType\\": \\"PREPAY\\",\\n \\"CreateTime\\": \\"2021-10-19T07:13:41Z\\",\\n \\"ExpireTime\\": \\"2021-10-17T16:00:00Z\\",\\n \\"Version\\": \\"2.2.77\\",\\n \\"DeployType\\": \\"multiple\\",\\n \\"DeployMode\\": \\"1-1-1\\",\\n \\"DiskType\\": \\"cloud_essd_pl1\\",\\n \\"MaintainTime\\": \\"19:00Z-20:00Z\\",\\n \\"DataMergeTime\\": \\"02:00\\",\\n \\"AutoRenewal\\": true,\\n \\"IsTrustEcs\\": true,\\n \\"Status\\": \\"ONLINE\\",\\n \\"Resource\\": {\\n \\"Cpu\\": {\\n \\"TotalCpu\\": 14,\\n \\"UsedCpu\\": 10,\\n \\"UnitCpu\\": 10,\\n \\"OriginalTotalCpu\\": 14\\n },\\n \\"Memory\\": {\\n \\"TotalMemory\\": 70,\\n \\"UsedMemory\\": 10,\\n \\"UnitMemory\\": 10,\\n \\"OriginalTotalMemory\\": 72\\n },\\n \\"DiskSize\\": {\\n \\"TotalDiskSize\\": 200,\\n \\"UsedDiskSize\\": 100,\\n \\"UnitDiskSize\\": 200,\\n \\"DataUsedSize\\": 200,\\n \\"MaxDiskUsedPercent\\": 0.14,\\n \\"MaxDiskUsedObServer\\": [\\n \\"i-bp1fhj23fs32dfbg4****\\"\\n ],\\n \\"OriginalTotalDiskSize\\": 200,\\n \\"MaxDiskSize\\": 80000\\n },\\n \\"UnitCount\\": 1,\\n \\"LogDiskSize\\": {\\n \\"TotalDiskSize\\": 400,\\n \\"UnitDiskSize\\": 200,\\n \\"LogAssignedSize\\": \\"0.0\\",\\n \\"MaxLogAssignedObServer\\": [\\n \\"[\\\\\\"i-bp1g****\\\\\\",\\\\\\"i-bp11****\\\\\\",\\\\\\"i-bp19****\\\\\\"]\\"\\n ],\\n \\"MaxLogAssignedPercent\\": \\"6.68\\",\\n \\"OriginalTotalDiskSize\\": 200\\n },\\n \\"CapacityUnit\\": {\\n \\"MaxCapacityUnit\\": 4,\\n \\"MinCapacityUnit\\": 1,\\n \\"UsedCapacityUnit\\": \\"2\\"\\n }\\n },\\n \\"AutoUpgradeObVersion\\": true,\\n \\"ObRpmVersion\\": \\"2.2.77-20210526202046\\",\\n \\"IsLatestObVersion\\": true,\\n \\"AvailableZones\\": [\\n \\"cn-hangzhou-i\\"\\n ],\\n \\"EnableUpgradeLogDisk\\": false,\\n \\"Zones\\": [\\n \\"cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j\\"\\n ],\\n \\"InstanceRole\\": \\"NORMAL\\",\\n \\"NodeNum\\": 6,\\n \\"ReplicaMode\\": \\"2\\",\\n \\"IsolationOptimization\\": false,\\n \\"EnableIsolationOptimization\\": false,\\n \\"InTempCapacityStatus\\": false,\\n \\"DataDiskAutoScale\\": true,\\n \\"TenantCreatable\\": {\\n \\"EnableCreateTenant\\": true,\\n \\"DisableCreateTenantReason\\": \\"CPU_NOT_ENOUGH、 MEMORY_NOT_ENOUGH、TENANT_COUNT_EXCEEDS_LIMIT\\"\\n },\\n \\"DataDiskAutoScaleConfig\\": {\\n \\"AutoScale\\": true,\\n \\"Upperbound\\": 16,\\n \\"UpperThreshold\\": 80,\\n \\"UpperMergeThreshold\\": 90,\\n \\"MaxDiskSize\\": 80000,\\n \\"ScaleStepInNormal\\": 50,\\n \\"ScaleStepInMerge\\": 100,\\n \\"UpperScaleStrategy\\": \\"RAW\\",\\n \\"UpperScaleStep\\": \\"5\\"\\n },\\n \\"EnableProxyService\\": true,\\n \\"ProxyServiceStatus\\": \\"ONLINE\\",\\n \\"ProxyClusterId\\": \\"proxy-56****a6tg2o\\",\\n \\"CpuArchitecture\\": \\"X86\\",\\n \\"ReadOnlyResource\\": {\\n \\"Cpu\\": {\\n \\"TotalCpu\\": 14,\\n \\"UsedCpu\\": 10,\\n \\"UnitCpu\\": 10,\\n \\"OriginalTotalCpu\\": 14\\n },\\n \\"Memory\\": {\\n \\"TotalMemory\\": 70,\\n \\"UsedMemory\\": 10,\\n \\"UnitMemory\\": 10,\\n \\"OriginalTotalMemory\\": 72\\n },\\n \\"DiskSize\\": {\\n \\"TotalDiskSize\\": 200,\\n \\"UsedDiskSize\\": 100,\\n \\"UnitDiskSize\\": 200,\\n \\"DataUsedSize\\": 200,\\n \\"MaxDiskUsedPercent\\": 0.14,\\n \\"MaxDiskUsedObServer\\": [\\n \\"i-bp1fhj23fs32dfbg4****\\"\\n ],\\n \\"OriginalTotalDiskSize\\": 200,\\n \\"MaxDiskSize\\": 80000\\n },\\n \\"UnitCount\\": 1,\\n \\"LogDiskSize\\": {\\n \\"TotalDiskSize\\": 400,\\n \\"UnitDiskSize\\": 200,\\n \\"LogAssignedSize\\": \\"0.0\\",\\n \\"MaxLogAssignedObServer\\": [\\n \\"[\\\\\\"i-bp1g****\\\\\\",\\\\\\"i-bp11****\\\\\\",\\\\\\"i-bp19****\\\\\\"]\\"\\n ],\\n \\"MaxLogAssignedPercent\\": \\"6.68\\"\\n },\\n \\"CapacityUnit\\": {\\n \\"MaxCapacityUnit\\": 4,\\n \\"MinCapacityUnit\\": 1,\\n \\"UsedCapacityUnit\\": \\"2\\"\\n }\\n },\\n \\"UnitSpec\\": \\"2C4G\\",\\n \\"SharedUnitNumLimit\\": 3,\\n \\"ExclusiveUnitNumLimit\\": 1,\\n \\"EnableReadOnlyReplica\\": true,\\n \\"EnableReadOnlyReplicaManagement\\": false,\\n \\"PrimaryInstance\\": \\"ob3h8ytroxxxxx\\",\\n \\"PrimaryRegion\\": \\"cn-hangzhou\\",\\n \\"SpecType\\": \\"dedicatedspec\\",\\n \\"AllowModifyInternetAddressConnectionLimit\\": false,\\n \\"AllowCreateProxySqlFirewallRule\\": false,\\n \\"Iops\\": 10000,\\n \\"InstanceType\\": \\"\\",\\n \\"MigrationInfo\\": {\\n \\"Migratable\\": true,\\n \\"CheckResult\\": {\\n \\"Level\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"CodeName\\": \\"\\",\\n \\"Module\\": \\"\\",\\n \\"ModuleName\\": \\"\\",\\n \\"SubModule\\": \\"\\",\\n \\"SubModuleName\\": \\"\\"\\n }\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstanceResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <Instance>\\n <InstanceId>ob317v4uif****</InstanceId>\\n <InstanceName>ob4test</InstanceName>\\n <InstanceClass>14C70G</InstanceClass>\\n <Series>NORMAL</Series>\\n <PayType>PREPAY</PayType>\\n <CreateTime>2021-10-19T07:13:41Z</CreateTime>\\n <ExpireTime>2021-10-17T16:00:00Z</ExpireTime>\\n <Version>2.2.77</Version>\\n <DeployType>multiple</DeployType>\\n <DeployMode>1-1-1</DeployMode>\\n <DiskType>cloud_essd_pl1</DiskType>\\n <MaintainTime>19:00Z-20:00Z</MaintainTime>\\n <DataMergeTime>02:00</DataMergeTime>\\n <AutoRenewal>true</AutoRenewal>\\n <Status>ONLINE</Status>\\n <Resource>\\n <Cpu>\\n <TotalCpu>14</TotalCpu>\\n <UsedCpu>10</UsedCpu>\\n <UnitCpu>10</UnitCpu>\\n </Cpu>\\n <Memory>\\n <TotalMemory>70</TotalMemory>\\n <UsedMemory>10</UsedMemory>\\n <UnitMemory>10</UnitMemory>\\n </Memory>\\n <DiskSize>\\n <TotalDiskSize>200</TotalDiskSize>\\n <UsedDiskSize>100</UsedDiskSize>\\n <UnitDiskSize>200</UnitDiskSize>\\n </DiskSize>\\n <UnitCount>1</UnitCount>\\n </Resource>\\n <AutoUpgradeObVersion>true</AutoUpgradeObVersion>\\n <ObRpmVersion>2.2.77-20210526202046</ObRpmVersion>\\n <IsLatestObVersion>true</IsLatestObVersion>\\n <AvailableZones>cn-hangzhou-i</AvailableZones>\\n </Instance>\\n</DescribeInstanceResponse>","errorExample":""}]', + 'title' => 'DescribeInstance', + ], + 'DescribeInstances' => [ + 'summary' => 'You can call this operation to obtain the 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' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组ID信息。如果不填写，返回全部资源。', + 'description' => 'The ID of the resource group. If you do not specify this parameter, all resources are returned.', + 'type' => 'string', + 'required' => false, + 'example' => 'group1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'description' => 'The number of rows to return on each page.'."\n" + .'- Maximum value: 100.'."\n" + .'- Default value: 10.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => 'The number of the page to return.'."\n" + .'- Pages start from page 1.'."\n" + .'- Default value: 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群名称。 长度为1~20个英文或中文字符。如果没有指定该参数，默认值为集群的InstanceId。', + 'description' => 'The name of the OceanBase cluster. It must be 1 to 20 characters in length. If this parameter is not specified, the value is the instance ID of the cluster by default.', + 'type' => 'string', + 'required' => false, + 'example' => 'ob4prod', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询列表的删选关键字。', + 'description' => 'The keyword for fuzzy search, which can be an instance ID, instance name, tenant ID, or tenant name.', + 'type' => 'string', + 'required' => false, + 'example' => 'pay', + ], + ], + [ + 'name' => 'WithOBCloudInstances', + 'in' => 'formData', + 'schema' => [ + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'Instances' => [ + 'title' => 'Oceanbase集群列表。', + 'description' => 'The information of the OceanBase cluster. ', + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the OceanBase cluster. ', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'title' => 'vpcId', + 'description' => 'vpcId', + 'type' => 'string', + 'example' => 'vpc-8vb8qjrixzovjpy******', + ], + 'CommodityCode' => [ + 'title' => 'Oceanbase集群的产品码。 - oceanbase_oceanbasepre_public_cn：国内站云数据库包年包月套餐。 - oceanbase_oceanbasepost_public_cn：国内站云数据库按小时付费套餐。 - oceanbase_obpre_public_intl：国际站云数据库包年包月套餐。', + 'description' => 'The product code of the OceanBase cluster. '."\n" + .'- oceanbase_oceanbasepre_public_cn: indicates an OceanBase cluster that is billed based on the subscription plan and that is deployed in a China site. '."\n" + .'- oceanbase_oceanbasepost_public_cn: indicates an OceanBase cluster that is billed based on the pay-as-you-go plan and that is deployed in a China site. '."\n" + .'- oceanbase_obpre_public_intl: indicates an OceanBase cluster that is billed based on the subscription plan and that is deployed in an international site. ', + 'type' => 'string', + 'example' => 'oceanbase_oceanbasepost_public_cn', + ], + 'ExpireTime' => [ + 'title' => '集群过期时间（UTC格式）。', + 'description' => 'The time in UTC when the cluster expires. '."\n" + .'> This parameter is valid only for subscription instances.', + 'type' => 'string', + 'example' => '2021-10-17T16:00:00Z', + ], + 'State' => [ + 'title' => '集群状态。 - PENDING_CREATE: 创建中 - ONLINE: 运行中 - TENANT_CREATING：租户创建中 - TENANT_SPEC_MODIFYING：租户规格修改中 - EXPANDING: 节点扩容中 - REDUCING: 节点缩容中 - SPEC_UPGRADING:套餐规格扩容中 - DISK_UPGRADING:存储规格扩容中 - WHITE_LIST_MODIFYING: 修改白名单中 - PARAMETER_MODIFYING: 修改参数中 - SSL_MODIFYING: SSL变更中 - PREPAID_EXPIRE_CLOSED: 预付费集群欠费中 - ARREARS_CLOSED: 后付费集群欠费中 - PENDING_DELETE: 删除中。 集群一般为运行中的状态（ONLINE）。', + 'description' => 'The status of the cluster. Valid values: '."\n" + .'- ONLINE: The cluster is running. '."\n" + .'- PENDING_CREATE: The cluster is being created. '."\n" + .'- ARREARS_CLOSED("arrears_closed"): The cluster is suspended due to insufficient balance.'."\n" + .'- PREPAID_EXPIRE_CLOSED("prepaid_expire_closed"): The cluster is suspended because the subscription has expired.'."\n" + .'- WHITE_LIST_MODIFYING("white_list_modifying"): The allowlist of the cluster is being modified.'."\n" + .'- SSL_MODIFYING("ssl_modifying"): The Secure Sockets Layer (SSL) settings of the cluster are being modified.'."\n" + .'- PARAMETER_MODIFYING("parameter_modifying"): Parameters of the cluster are being modified.'."\n" + .'- TENANT_CREATING("tenant_creating"): A tenant is being created in the cluster.'."\n" + .'- TENANT_SPEC_MODIFYING("tenant_spec_modifying"): The specifications of a tenant in the cluster are being modified.'."\n" + .'- EXPANDING("expanding"): Nodes are being added to the cluster.'."\n" + .'- REDUCING("reducing"): Nodes are being removed from the cluster.'."\n" + .'- ZONE_CHANGING("zone_changing"): Zones of the cluster are being modified.'."\n" + .'- SPEC_UPGRADING: The service plan is being upgraded.'."\n" + .'- SPEC_DOWNGRADING("spec_downgrading"): The plan specification is being downgraded.'."\n" + .'- DISK_UPGRADING: The storage space is being expanded.'."\n" + .'- UPGRADING("upgrading"): The version of the cluster is being upgraded.'."\n" + .'- PENDING_DELETE("pending_delete"): The cluster is being deleted.'."\n" + .'- DELETED("deleted"): The cluster has been deleted.'."\n" + .'- ABNORMAL("abnormal"): The cluster is abnormal.'."\n" + .'- OFFLINE("offline"): The cluster is offline.'."\n" + .'- STANDBY_CREATING("standby_creating"): A standby cluster is being created for the cluster.'."\n" + .'- STANDBY_DELETING("standby_deleting"): A standby cluster of the cluster is being deleted.'."\n" + .'- SWITCHOVER_SWITCHING("switchover_switching"): The cluster is undergoing a primary/standby switchover.'."\n" + .'- STANDBY_DISCONNECTING("standby_disconnecting"): The cluster is being decoupled from its standby cluster.'."\n" + .'- LOG_DISK_UPGRADING("log_disk_upgrading"): The log disk of the cluster is being scaled out.'."\n" + .'- ISOLATION_OPTIMIZATION_MODIFYING("isolation_optimization_modifying"): The isolation optimization settings of the cluster are being modified.'."\n" + .'- DISKTYPE_MODIFYING("disktype_modifying"): The data disk type of the cluster is being modified.'."\n" + .'- PROXY_SERVICE_CREATING("proxy_service_creating"): The proxy service is being enabled for the cluster.'."\n" + .'- PROXY_SERVICE_DELETING("proxy_service_deleting"): The proxy service is being disabled for the cluster.'."\n" + .'- PROXY_SERVICE_SPEC_MODIFYING("proxy_service_spec_modifying"): The proxy service specification is being modified for the cluster.'."\n" + .'- READONLY_ADD_NODE("readonly_add_node"): A read-only node is being added to the cluster.'."\n" + .'- READONLY_REDUCE_NODE("readonly_reduce_node"): A read-only node is being removed from the cluster.'."\n" + .'- READONLY_REDUCE_ZONE("readonly_reduce_zone"): A read-only zone is being removed from the cluster.'."\n" + .'- READONLY_ADD_ZONE("readonly_add_zone"): A read-only zone is being added to the cluster.'."\n" + .'- READONLY_UPGRADE_SPEC("readonly_upgrade_spec"): The specification of read-only replicas is being upgraded.'."\n" + .'- READONLY_UPGRADE_DISK("readonly_upgrade_disk"): The disk space of read-only replicas is being scaled out.'."\n" + .'- READONLY_DOWNGRADE_SPEC("readonly_downgrade_spec"): The specification of read-only replicas is being downgraded.'."\n" + .'- READONLY_DOWNGRADE_DISK("readonly_downgrade_disk"): The disk space of read-only replicas is being scaled in.'."\n" + .'- CREATING_TENANT_READONLY_REPLICA("creating_tenant_readonly_replica"): A read-only replica is being created for a tenant in the cluster.'."\n" + .'- DELETING_TENANT_READONLY_REPLICA("deleting_tenant_readonly_replica"): A read-only replica is being deleted for a tenant in the cluster.'."\n" + .'- DISK_DOWNGRADING("disk_downgrading"): The disk space of the cluster is being scaled in.'."\n" + .'- DEPLOY_MODE_MODIFYING("deploy_mode_modifying"): The deployment mode of the cluster is being modified.'."\n" + .'> Generally, the cluster is in the ONLINE state.', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'InstanceClass' => [ + 'title' => '集群规格信息。<br> 当前支持以下套餐：<br> - 4C16GB：4核 16GB <br> - 8C32G：8核 32GB <br>- 14C70G：14核 70GB<br> - 16C32G：16核 32GB<br> - 16C70G：16核 70GB <br> - 20C32G：20核 32GB <br> - 24C120G：24核 120GB <br> - 30C180G：30核 180GB<br> - 32C70G：32核 70GB <br> - 32C160G：32核 160GB <br> - 32C180G：32核 180GB <br> - 40C64G：40核 64GB <br> - 62C400G：62核 400GB<br> - 64C180G：64核 180GB <br> - 64C380G：64核 380GB<br> - 64C400G：64核 400GB 。', + 'description' => 'The specifications of the cluster. You can specify one of the following four plans: '."\n" + .'- 8C32G: indicates 8 CPU cores and 32 GB of memory. '."\n" + .'- 14C70G: indicates 14 CPU cores and 70 GB of memory. '."\n" + .'- 30C180G: indicates 30 CPU cores and 180 GB of memory. '."\n" + .'- 62C400G: indicates 62 CPU cores and 400 GB of memory. ', + 'type' => 'string', + 'example' => '14C70G', + ], + 'CreateTime' => [ + 'title' => '集群的创建时间，UTC时间。', + 'description' => 'The time in UTC when the cluster was created. ', + 'type' => 'string', + 'example' => '2021-10-19T07:13:41Z', + ], + 'DeployMode' => [ + 'title' => '集群的数据副本模式。 单机房为n，双机房为n-n，多机房为n-n-n，其中n为各机房的observer节点数。', + 'description' => 'The data replica distribution mode of the cluster. The value is in the n-n-n format, where n is the number of OBServer nodes in each IDC.', + 'type' => 'string', + 'example' => '1-1-1', + ], + 'CpuArchitecture' => [ + 'title' => '集群的 CPU 架构', + 'description' => 'The CPU architecture of the cluster.', + 'type' => 'string', + 'example' => 'X86_64, AARCH64', + ], + 'MaintainTime' => [ + 'title' => '集群的每天例行维护时间，UTC时间。', + 'description' => 'The time period in UTC for the daily routine maintenance of the cluster. ', + 'type' => 'string', + 'example' => '2021-10-19T07:13:41Z', + ], + 'DeployType' => [ + 'title' => '集群的部署类型。 - multiple：多机房 - single：单机房 - dual：双机房', + 'description' => 'The deployment type of the cluster. Valid values: '."\n" + .'- multiple: multi-IDC deployment '."\n" + .'- single: single-IDC deployment '."\n" + .'- dual: dual-IDC deployment ', + 'type' => 'string', + 'example' => 'multiple', + ], + 'PayType' => [ + 'title' => 'Oceanbase集群的付费类型 - PREPAY：预付费 - POSTPAY：按量付费', + 'description' => 'The billing method for the OceanBase cluster. Valid values: '."\n" + .'- PREPAY: the subscription billing method. '."\n" + .'- POSTPAY: the pay-as-you-go billing method. ', + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'DiskSize' => [ + 'description' => 'The size of the storage space, in GB. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + 'title' => 'The size of the storage space, in GB. ', + ], + 'DiskType' => [ + 'title' => '集群部署的存储类型。默认为cloud_essd_pl1：ESSD云盘。', + 'description' => 'The type of the storage disk where the cluster is deployed. '."\n" + .'The default value is cloud_essd_pl1, which indicates an ESSD cloud disk. ', + 'type' => 'string', + 'example' => 'cloud_essd_pl1', + ], + 'InstanceId' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'ExpireSeconds' => [ + 'title' => '集群已过期时间，单位：秒(s)。', + 'description' => 'The time elapsed since the expiration of the cluster, in seconds. '."\n" + .'> In subscription mode, if the cluster has not expired, this parameter indicates the remaining validity period of the cluster. If the cluster has expired, this parameter indicates the time elapsed since the expiration.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2606682', + ], + 'Mem' => [ + 'title' => '实例的内存大小，单位GB。', + 'description' => 'The memory size of the instance, in GB. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '70', + ], + 'EnableUpgradeNodes' => [ + 'title' => '是否允许新增节点。', + 'description' => 'Indicates whether new nodes can be added. ', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Cpu' => [ + 'title' => '集群的CPU核数。', + 'description' => 'The number of CPU cores of the cluster. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '14', + ], + 'AvailableZones' => [ + 'title' => '集群部署所在的可用区信息。', + 'description' => 'The information about the zone in which the cluster is deployed. ', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the zone in which the cluster is deployed. ', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + ], + 'Version' => [ + 'title' => 'Observer版本信息。', + 'description' => 'The OBServer version. ', + 'type' => 'string', + 'example' => '2.2.77', + ], + 'InstanceName' => [ + 'title' => 'Oceanbase集群名称。', + 'description' => 'The name of the OceanBase cluster. ', + 'type' => 'string', + 'example' => 'ob4test', + ], + 'Series' => [ + 'title' => '实例的系列 - normal（默认）：标准集群版（云盘） - normal_ssd：标准集群版（本地盘） - history：历史库集群版, normal_kv: obkv集群, normal_hg: 信创集群。', + 'description' => 'The series of the OceanBase cluster. Valid values: '."\n" + .'- NORMAL: the high availability edition. '."\n" + .'- BASIC: the basic edition. ', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'UsedDiskSize' => [ + 'title' => '已使用的存储空间，单位GB。', + 'description' => 'The size of used storage space of the cluster, in GB. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'ResourceGroupId' => [ + 'title' => '资源组ID信息。', + 'description' => 'The ID of the resource group. ', + 'type' => 'string', + 'example' => 'group1', + ], + 'Resource' => [ + 'title' => '集群的资源信息', + 'description' => 'The information about cluster resources. ', + 'type' => 'object', + 'properties' => [ + 'Cpu' => [ + 'title' => '集群的CPU资源信息', + 'description' => 'The information about the CPU resources of the cluster. ', + 'type' => 'object', + 'properties' => [ + 'TotalCpu' => [ + 'description' => 'The total number of CPU cores of the cluster. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '14', + 'title' => 'The total number of CPU cores of the cluster.', + ], + 'UsedCpu' => [ + 'description' => 'The number of CPU cores used in the cluster. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '10', + 'title' => 'The number of CPU cores used in the cluster.', + ], + 'UnitCpu' => [ + 'description' => 'The number of CPU cores of each replica node in the cluster. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '10', + 'title' => 'The number of CPU cores of each replica node in the cluster.', + ], + 'OriginalTotalCpu' => [ + 'description' => 'The number of original CPU cores in the cluster.', + 'type' => 'number', + 'format' => 'double', + 'example' => '14', + 'title' => '原始CPU', + ], + ], + ], + 'Memory' => [ + 'title' => '集群的内存资源信息', + 'description' => 'The information about the memory resources of the cluster. ', + 'type' => 'object', + 'properties' => [ + 'TotalMemory' => [ + 'description' => 'The total memory size of the cluster, in GB. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '70', + 'title' => 'The total memory size of the cluster, in GB.', + ], + 'UsedMemory' => [ + 'title' => '集群已使用的内存，单位：GB', + 'description' => 'The size of used memory in the cluster, in GB. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'UnitMemory' => [ + 'title' => '集群中每个副本的内存，单位：GB', + 'description' => 'The memory size of each replica node in the cluster, in GB. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'OriginalTotalMemory' => [ + 'description' => 'The original memory size of the cluster, in GB.', + 'type' => 'number', + 'format' => 'double', + 'example' => '72', + 'title' => '原始内存', + ], + ], + ], + 'DiskSize' => [ + 'title' => '集群的存储资源信息', + 'description' => 'The information about the storage resources of the cluster. ', + 'type' => 'object', + 'properties' => [ + 'TotalDiskSize' => [ + 'description' => 'The total storage space of the cluster, in GB. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '200', + 'title' => 'The total storage space of the cluster, in GB.', + ], + 'UsedDiskSize' => [ + 'title' => '集群已使用的存储空间，单位：GB', + 'description' => 'The size of used storage space of the cluster, in GB. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'UnitDiskSize' => [ + 'description' => 'The storage space of each replica node in the cluster, in GB. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '200', + 'title' => 'The storage space of each replica node in the cluster, in GB.', + ], + 'OriginalTotalDiskSize' => [ + 'description' => 'The original size of the disk.', + 'type' => 'number', + 'format' => 'double', + 'example' => '200', + 'title' => '原始磁盘', + ], + ], + ], + 'UnitCount' => [ + 'title' => '集群的资源Unit数量。', + 'description' => 'The number of resource units in the cluster. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'CapacityUnit' => [ + 'description' => 'The information about capacity units.', + 'type' => 'object', + 'properties' => [ + 'MaxCapacityUnit' => [ + 'description' => 'The maximum number of capacity units.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'MinCapacityUnit' => [ + 'description' => 'The minimum number of capacity units.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'UsedCapacityUnit' => [ + 'description' => 'The number of used capacity units.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'InstanceType' => [ + 'description' => 'The instance type.'."\n" + .'- cluster: indicates a cluster instance.'."\n" + .'- mtenant: indicates a tenant instance in MySQL mode.'."\n" + .'- mtenant_serverless: indicates a serverless instance in MySQL mode.', + 'type' => 'string', + 'example' => 'CLUSTER', + ], + 'InstanceRole' => [ + 'description' => 'The role of the instance.', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'InTempCapacityStatus' => [ + 'description' => 'Specifies whether to indicate the temporary status of the capacity.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'DataDiskAutoScaleConfig' => [ + 'title' => '数据盘自动协调配置', + 'description' => 'Specifies parameters for the automatic scaling of the data disk.', + 'type' => 'object', + 'properties' => [ + 'AutoScale' => [ + 'title' => '是否开启', + 'description' => 'Specifies whether to enable the automatic scaling of the data disk.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Upperbound' => [ + 'description' => 'The maximum space, in GB, to which the data disk can be scaled.', + 'type' => 'number', + 'format' => 'double', + 'example' => '16', + 'title' => '扩容上限', + ], + 'UpperThreshold' => [ + 'description' => 'The maximum usage of the data disk, in percentage, that triggers the scaling of the data disk for daily use.', + 'type' => 'number', + 'format' => 'double', + 'example' => '80', + 'title' => '日常扩容阈值', + ], + 'UpperMergeThreshold' => [ + 'description' => 'The maximum usage of the data disk, in percentage, that triggers the scaling of the data disk for major compactions.', + 'type' => 'number', + 'format' => 'double', + 'example' => '90', + 'title' => '合并扩容阈值', + ], + 'MaxDiskSize' => [ + 'title' => '磁盘最大值', + 'description' => 'The maximum size of the disk, in GB.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '80000', + ], + 'ScaleStepInNormal' => [ + 'description' => 'The size of scaling step during daily use.', + 'type' => 'number', + 'format' => 'double', + 'example' => '50', + 'title' => '日常扩容步长'."\n", + ], + 'ScaleStepInMerge' => [ + 'description' => 'The size of scaling step during a major compaction.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + 'title' => '合并扩容步长', + ], + 'UpperScaleStrategy' => [ + 'title' => '扩容策略（RAW/PERCENTAGE）', + 'description' => 'The scale-out strategy. Valid values: RAW and PERCENTAGE.', + 'type' => 'string', + 'example' => 'RAW', + ], + ], + ], + 'EnableReadOnlyReplicaManagement' => [ + 'description' => 'Indicates whether the cluster supports read-only replicas.', + 'type' => 'boolean', + 'example' => 'yes', + ], + 'SpecType' => [ + 'title' => '规格类型', + 'description' => 'The specification type.', + 'type' => 'string', + 'example' => 'dedicatedspec', + ], + 'ObRpmVersion' => [ + 'title' => '集群的RPM版本信息'."\n" + ."\n", + 'description' => 'The version of the OceanBase Database RedHat Package Managerment (RPM) package.', + 'type' => 'string', + 'example' => '4.2.1.7-107030032024062709', + ], + 'ReplicaMode' => [ + 'title' => '集群的副本模式', + 'type' => 'string', + 'example' => '3F、2F1A', + ], + 'Migratable' => [ + 'type' => 'boolean', + ], + 'MigrationInfo' => [ + 'title' => '切换到云市场信息', + 'type' => 'object', + 'properties' => [ + 'Migratable' => [ + 'title' => '是否可切换', + 'type' => 'boolean', + ], + 'CheckResult' => [ + 'title' => '如果不支持切换，此处有详细原因', + 'type' => 'object', + 'properties' => [ + 'Level' => [ + 'title' => '结果等级', + 'type' => 'string', + ], + 'Code' => [ + 'title' => '检查项代码', + 'type' => 'string', + ], + 'CodeName' => [ + 'title' => '检查项文案', + 'type' => 'string', + ], + 'Module' => [ + 'title' => '模块名', + 'type' => 'string', + ], + 'ModuleName' => [ + 'title' => '模块名文案', + 'type' => 'string', + ], + 'SubModule' => [ + 'title' => '子模块名', + 'type' => 'string', + ], + 'SubModuleName' => [ + 'title' => '子模块文案', + 'type' => 'string', + ], + ], + ], + ], + ], + 'Iops' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + ], + ], + ], + 'TotalCount' => [ + 'title' => '查询到的Oceanbase集群个数。', + 'description' => 'The number of OceanBase clusters queried. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Instances\\": [\\n {\\n \\"VpcId\\": \\"vpc-8vb8qjrixzovjpy******\\",\\n \\"CommodityCode\\": \\"oceanbase_oceanbasepost_public_cn\\",\\n \\"ExpireTime\\": \\"2021-10-17T16:00:00Z\\",\\n \\"State\\": \\"ONLINE\\",\\n \\"InstanceClass\\": \\"14C70G\\",\\n \\"CreateTime\\": \\"2021-10-19T07:13:41Z\\",\\n \\"DeployMode\\": \\"1-1-1\\",\\n \\"CpuArchitecture\\": \\"X86_64、 AARCH64\\",\\n \\"MaintainTime\\": \\"19:00Z-20:00Z\\",\\n \\"DeployType\\": \\"multiple\\",\\n \\"PayType\\": \\"PREPAY\\",\\n \\"DiskSize\\": 200,\\n \\"DiskType\\": \\"cloud_essd_pl1\\",\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"ExpireSeconds\\": 2606682,\\n \\"Mem\\": 70,\\n \\"EnableUpgradeNodes\\": true,\\n \\"Cpu\\": 14,\\n \\"AvailableZones\\": [\\n \\"cn-hangzhou-i\\"\\n ],\\n \\"Version\\": \\"2.2.77\\",\\n \\"InstanceName\\": \\"ob4test\\",\\n \\"Series\\": \\"NORMAL\\",\\n \\"UsedDiskSize\\": 20,\\n \\"ResourceGroupId\\": \\"group1\\",\\n \\"Resource\\": {\\n \\"Cpu\\": {\\n \\"TotalCpu\\": 14,\\n \\"UsedCpu\\": 10,\\n \\"UnitCpu\\": 10,\\n \\"OriginalTotalCpu\\": 14\\n },\\n \\"Memory\\": {\\n \\"TotalMemory\\": 70,\\n \\"UsedMemory\\": 10,\\n \\"UnitMemory\\": 10,\\n \\"OriginalTotalMemory\\": 72\\n },\\n \\"DiskSize\\": {\\n \\"TotalDiskSize\\": 200,\\n \\"UsedDiskSize\\": 100,\\n \\"UnitDiskSize\\": 200,\\n \\"OriginalTotalDiskSize\\": 200\\n },\\n \\"UnitCount\\": 1,\\n \\"CapacityUnit\\": {\\n \\"MaxCapacityUnit\\": 4,\\n \\"MinCapacityUnit\\": 1,\\n \\"UsedCapacityUnit\\": 2\\n }\\n },\\n \\"InstanceType\\": \\"CLUSTER\\",\\n \\"InstanceRole\\": \\"NORMAL\\",\\n \\"InTempCapacityStatus\\": false,\\n \\"DataDiskAutoScaleConfig\\": {\\n \\"AutoScale\\": true,\\n \\"Upperbound\\": 16,\\n \\"UpperThreshold\\": 80,\\n \\"UpperMergeThreshold\\": 90,\\n \\"MaxDiskSize\\": 80000,\\n \\"ScaleStepInNormal\\": 50,\\n \\"ScaleStepInMerge\\": 100,\\n \\"UpperScaleStrategy\\": \\"RAW\\"\\n },\\n \\"EnableReadOnlyReplicaManagement\\": true,\\n \\"SpecType\\": \\"dedicatedspec\\",\\n \\"ObRpmVersion\\": \\"4.2.1.7-107030032024062709\\",\\n \\"ReplicaMode\\": \\"3F、2F1A\\",\\n \\"Migratable\\": true,\\n \\"MigrationInfo\\": {\\n \\"Migratable\\": true,\\n \\"CheckResult\\": {\\n \\"Level\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"CodeName\\": \\"\\",\\n \\"Module\\": \\"\\",\\n \\"ModuleName\\": \\"\\",\\n \\"SubModule\\": \\"\\",\\n \\"SubModuleName\\": \\"\\"\\n }\\n },\\n \\"Iops\\": 10000\\n }\\n ],\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstancesResponse>\\n <Instances>\\n <VpcId>vpc-8vb8qjrixzovjpy******</VpcId>\\n <CommodityCode>oceanbase_oceanbasepost_public_cn</CommodityCode>\\n <ExpireTime>2021-10-17T16:00:00Z</ExpireTime>\\n <State>ONLINE</State>\\n <InstanceClass>14C70G</InstanceClass>\\n <CreateTime>2021-10-19T07:13:41Z</CreateTime>\\n <DeployMode>1-1-1</DeployMode>\\n <MaintainTime>2021-10-19T07:13:41Z</MaintainTime>\\n <DeployType>multiple</DeployType>\\n <PayType>PREPAY</PayType>\\n <DiskSize>200</DiskSize>\\n <DiskType>cloud_essd_pl1</DiskType>\\n <InstanceId>ob317v4uif****</InstanceId>\\n <ExpireSeconds>2606682</ExpireSeconds>\\n <Mem>70</Mem>\\n <EnableUpgradeNodes>true</EnableUpgradeNodes>\\n <Cpu>14</Cpu>\\n <AvailableZones>cn-hangzhou-i</AvailableZones>\\n <Version>2.2.77</Version>\\n <InstanceName>ob4test</InstanceName>\\n <Series>NORMAL</Series>\\n <UsedDiskSize>20</UsedDiskSize>\\n <SecurityIps>-</SecurityIps>\\n <ResourceGroupId>group1</ResourceGroupId>\\n <Resource>\\n <Cpu>\\n <TotalCpu>14</TotalCpu>\\n <UsedCpu>10</UsedCpu>\\n <UnitCpu>10</UnitCpu>\\n </Cpu>\\n <Memory>\\n <TotalMemory>70</TotalMemory>\\n <UsedMemory>10</UsedMemory>\\n <UnitMemory>10</UnitMemory>\\n </Memory>\\n <DiskSize>\\n <TotalDiskSize>200</TotalDiskSize>\\n <UsedDiskSize>100</UsedDiskSize>\\n <UnitDiskSize>200</UnitDiskSize>\\n </DiskSize>\\n <UnitCount>1</UnitCount>\\n </Resource>\\n </Instances>\\n <TotalCount>2</TotalCount>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</DescribeInstancesResponse>","errorExample":""}]', + 'title' => 'DescribeInstances', + ], + 'DescribeInstanceTopology' => [ + 'summary' => 'You can call this operation to query the topology of an OceanBase cluster. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'InstanceTopology' => [ + 'title' => '集群的拓扑信息。', + 'description' => 'The topology of the cluster.', + 'type' => 'object', + 'properties' => [ + 'Tenants' => [ + 'title' => '租户信息。', + 'description' => 'The information about the tenants.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the tenants.', + 'type' => 'object', + 'properties' => [ + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'example' => 't33h8y08k****', + ], + 'TenantName' => [ + 'title' => '租户名称。', + 'description' => 'The name of the tenant.', + 'type' => 'string', + 'example' => 'pay_online', + ], + 'TenantCpu' => [ + 'title' => '租户CPU，单位：核。', + 'description' => 'The number of CPU cores of the tenant.', + 'type' => 'number', + 'format' => 'float', + 'example' => '2', + ], + 'TenantMemory' => [ + 'title' => '租户内存大小，单位：GB。', + 'description' => 'The memory size of the tenant, in GB.', + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'TenantMode' => [ + 'title' => '租户模式。 - Oracle：Oracle模式 - MySQL：MySQL模式。', + 'description' => 'The mode of the tenant. Valid values: '."\n" + .'* Oracle '."\n" + .'* MySQL', + 'type' => 'string', + 'example' => 'Oracle', + ], + 'TenantZones' => [ + 'title' => '租户的可用区信息。', + 'description' => 'The information about the zones.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the zones.', + 'type' => 'object', + 'properties' => [ + 'TenantZoneRole' => [ + 'title' => '可用区的访问角色。 - ReadWrite：可读可写 - ReadOnly：只读。', + 'description' => 'The role to access the zone. Valid values: '."\n" + .'* ReadWrite: a role that has the read and write privileges. '."\n" + .'* ReadOnly: a role that has only the read-only privilege.', + 'type' => 'string', + 'example' => 'ReadWrite', + ], + 'IsPrimaryTenantZone' => [ + 'description' => 'Indicates whether the zone is the primary zone.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TenantZoneId' => [ + 'title' => '可用区ID。', + 'description' => 'The ID of the zone.', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'Units' => [ + 'title' => '资源节点信息列表', + 'description' => 'The information about the resource units.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the resource units.', + 'type' => 'object', + 'properties' => [ + 'UnitId' => [ + 'title' => '资源节点ID', + 'description' => 'The ID of the resource unit.', + 'type' => 'string', + 'example' => '1002', + ], + 'UnitStatus' => [ + 'title' => '资源节点的状态。 ONLINE: 运行中 IMMIGRATING 迁入中 EMIGRATING: 迁出中 CANCEL_EMIGRATING: 取消迁入中 CANCEL_EMIGRATING：取消迁出中 DELETING：删除中', + 'description' => 'The status of the resource unit. Valid values: '."\n" + .'* ONLINE: The resource unit is running. '."\n" + .'* IMMIGRATING: The resource unit is being immigrated. '."\n" + .'* EMIGRATING: The resource unit is being emigrated. '."\n" + .'* CANCEL_EMIGRATING: The immigration of the resource unit is being canceled. '."\n" + .'* CANCEL_EMIGRATING: The emigration of the resource unit is being canceled. '."\n" + .'* DELETING: The resource unit is being deleted.', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'NodeId' => [ + 'title' => '资源节点所在的observer节点ID', + 'description' => 'The ID of the OBServer node in which the resource unit resides.', + 'type' => 'string', + 'example' => 'i-bp16niirq4zdmgvm****', + ], + 'UnitCpu' => [ + 'title' => '资源节点CPU，单位：核。', + 'description' => 'The number of CPU cores of the resource unit.', + 'type' => 'number', + 'format' => 'float', + 'example' => '2', + ], + 'UnitMemory' => [ + 'title' => '资源节点内存大小，单位：GB。', + 'description' => 'The memory size of the resource unit, in GB.', + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'EnableMigrateUnit' => [ + 'title' => '是否可做迁移。', + 'description' => 'Indicates whether the resource unit can be migrated.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ManualMigrate' => [ + 'title' => '是否为手动迁移。', + 'description' => 'Indicates whether the resource unit is manually migrated.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableCancelMigrateUnit' => [ + 'title' => '是否可以取消迁移。该字段只对正在手动迁入中或手动迁出中的unit有效。', + 'description' => 'Indicates whether the migration can be canceled. This parameter is valid only for resource units that are being manually immigrated or emigrated.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'UnitDataSize' => [ + 'title' => 'Unit使用的数据量大小。', + 'description' => 'The data size of the resource unit.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'ReplicaType' => [ + 'description' => 'The type of the replica. Node filtering conditions are configured based on the replica type when you query the monitoring data of the OceanBase cluster. '."\n" + .'* By default, the replica type is not specified when you query the monitoring data of OceanBase clusters or the access proxy. If you do not specify the replica type when you query the monitoring data of an OceanBase cluster, the monitoring data of all nodes is queried. '."\n" + .'* If you set the replica type to FULL when you query the monitoring data of an OceanBase cluster, the monitoring data of only the full-featured replica nodes is queried. '."\n" + .'* If you set the replica type to READONLY when you query the monitoring data of an OceanBase cluster, the monitoring data of only the read-only replica nodes is queried.', + 'type' => 'string', + 'example' => 'FULL', + ], + ], + ], + ], + 'LogicalZone' => [ + 'title' => '副本ID', + 'description' => 'The ID of the replica.', + 'type' => 'string', + 'example' => 'cn-hangzhou-h-z0', + ], + 'ReplicaType' => [ + 'title' => '租户的副本类型', + 'description' => 'The replica type of the tenant.', + 'type' => 'string', + 'example' => 'FULL', + ], + 'ReadOnlyReplicaType' => [ + 'description' => 'The type of the read-only replica.', + 'type' => 'string', + 'example' => 'ROW_STORE', + ], + ], + ], + ], + 'TenantStatus' => [ + 'title' => '租户状态。 - PENDING_CREATE: 创建中 - RESTORE: 恢复中 - ONLINE: 运行中 - SPEC_MODIFYING: 规格修改中 - ALLOCATING_INTERNET_ADDRESS: 公网地址分配中 - PENDING_OFFLINE_INTERNET_ADDRESS: 公网地址关闭中 - PRIMARY_ZONE_MODIFYING: 切主可用区中 - PARAMETER_MODIFYING: 参数修改中 - WHITE_LIST_MODIFING: 白名单修改中', + 'description' => 'The status of the tenant. Valid values: '."\n" + .'* PENDING_CREATE: The tenant is being created. '."\n" + .'* RESTORE: The tenant is being restored. '."\n" + .'* ONLINE: The tenant is running. '."\n" + .'* SPEC_MODIFYING: The specification of the tenant is being modified. '."\n" + .'* ALLOCATING_INTERNET_ADDRESS: A public IP address is being allocated to the tenant. '."\n" + .'* PENDING_OFFLINE_INTERNET_ADDRESS: The public IP address is being disabled. '."\n" + .'* PRIMARY_ZONE_MODIFYING: The tenant is being switched to a new primary zone. '."\n" + .'* PARAMETER_MODIFYING: Parameters are being modified. '."\n" + .'* WHITE_LIST_MODIFYING: The allowlist is being modified.', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'TenantDeployType' => [ + 'title' => '租户的部署类型。 - multiple：多机房 - single：单机房 - dual：双机房。', + 'description' => 'The deployment type of the tenant. Valid values: '."\n" + .'* multiple: multi-IDC deployment. '."\n" + .'* single: single-IDC deployment. '."\n" + .'* dual: dual-IDC deployment.', + 'type' => 'string', + 'example' => 'multiple', + ], + 'TenantUnitNum' => [ + 'title' => '租户的unit个数。', + 'description' => 'The number of resource units in the tenant.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PrimaryZoneDeployType' => [ + 'title' => '主可用区部署模式', + 'description' => 'The deployment mode of the primary zone. Valid values: '."\n" + .'* RANDOM. '."\n" + .'* STATIC.', + 'type' => 'string', + 'enumValueTitles' => [ + 'RANDOM' => 'RANDOM', + 'STATIC' => 'STATIC', + ], + 'example' => 'RANDOM', + ], + 'TenantDiskSize' => [ + 'title' => '租户数据量', + 'description' => 'The disk space of the tenant, in GB.', + 'type' => 'number', + 'format' => 'float', + 'example' => '2', + ], + 'TenantUnitCpu' => [ + 'title' => '租户单节点CPU', + 'description' => 'The number of CPU cores of a single node in the tenant.', + 'type' => 'number', + 'format' => 'float', + 'example' => '4', + ], + 'TenantUnitMemory' => [ + 'title' => '租户单节点内存', + 'description' => 'The memory size of a single node in the tenant, in GB.', + 'type' => 'number', + 'format' => 'float', + 'example' => '16', + ], + ], + ], + ], + 'Zones' => [ + 'title' => '集群的可用区信息。', + 'description' => 'The information about the zones in which the cluster is deployed.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the zones in which the cluster is deployed.', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'title' => '可用区ID。', + 'description' => 'The ID of the zone.', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'Region' => [ + 'title' => '地域ID。', + 'description' => 'The ID of the region.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ZoneDisk' => [ + 'title' => '可用区的存储容量。', + 'description' => 'The storage capacity of the zone.', + 'type' => 'string', + 'example' => '200 GB', + ], + 'Nodes' => [ + 'title' => '节点信息。', + 'description' => 'The information about the nodes.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the nodes.', + 'type' => 'object', + 'properties' => [ + 'NodeId' => [ + 'title' => '节点ID。', + 'description' => 'The ID of the node.', + 'type' => 'string', + 'example' => 'i-bp16niirq4zdmgvm****', + ], + 'NodeCopyId' => [ + 'title' => '节点归属的副本ID。', + 'description' => 'The ID of the replica node.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'NodeStatus' => [ + 'title' => '节点运行状态。', + 'description' => 'The status of the node.', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'NodeResource' => [ + 'title' => '节点资源列表信息', + 'description' => 'The information about node resources.', + 'type' => 'object', + 'properties' => [ + 'Cpu' => [ + 'title' => '节点CPU资源信息。', + 'description' => 'The information about the CPU resources of the node.', + 'type' => 'object', + 'properties' => [ + 'UsedCpu' => [ + 'title' => '节点已使用的CPU，单位：核。', + 'description' => 'The number of CPU cores used by the node.', + 'type' => 'number', + 'format' => 'float', + 'example' => '4', + ], + 'TotalCpu' => [ + 'title' => '节点总的CPU，单位：核。', + 'description' => 'The total number of CPU cores of the node.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '14', + ], + ], + ], + 'Memory' => [ + 'title' => '节点内存资源信息。', + 'description' => 'The information about the memory resources of the node.', + 'type' => 'object', + 'properties' => [ + 'UsedMemory' => [ + 'title' => '节点已使用的内存，单位：GB。', + 'description' => 'The size of memory used by the node, in GB.', + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'TotalMemory' => [ + 'title' => '节点的总内存，单位：GB。', + 'description' => 'The total memory size of the node, in GB.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '70', + ], + ], + ], + 'DiskSize' => [ + 'title' => '节点存储资源信息。', + 'description' => 'The information about the storage resources of the node.', + 'type' => 'object', + 'properties' => [ + 'TotalDiskSize' => [ + 'title' => '节点总存储空间，单位：GB。', + 'description' => 'The total storage space of the node, in GB.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'UsedDiskSize' => [ + 'title' => '节点已使用的存储空间，单位：GB。', + 'description' => 'The size of storage space used by the node, in GB.', + 'type' => 'number', + 'format' => 'double', + 'example' => '50', + ], + ], + ], + ], + ], + 'ReplicaType' => [ + 'description' => 'The type of the replica. Valid values: '."\n" + .'* FULL. '."\n" + .'* READONLY.', + 'type' => 'string', + 'example' => 'FULL', + ], + 'FullCopyId' => [ + 'description' => 'The ID of the full-featured replica.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ReadOnlyCopyId' => [ + 'description' => 'The ID of the read-only replica.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'LogicalZone' => [ + 'title' => '副本ID', + 'description' => 'The ID of the replica.', + 'type' => 'string', + 'example' => 'cn-hangzhou-h-z0', + ], + 'ReadOnlyReplicaType' => [ + 'description' => 'The type of the read-only replica.', + 'type' => 'string', + 'example' => 'ROW_STORE', + ], + ], + ], + ], + 'ZoneResource' => [ + 'title' => 'zone资源信息', + 'description' => 'The information about zones.', + 'type' => 'object', + 'properties' => [ + 'DiskSize' => [ + 'title' => '存储资源信息', + 'description' => 'The information about the storage resources of the node.', + 'type' => 'object', + 'properties' => [ + 'MaxDiskUsedPercent' => [ + 'title' => '最大磁盘使用量百分比', + 'description' => 'The maximum disk usage, in percentage.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.14', + ], + 'MaxDiskUsedObServer' => [ + 'description' => 'The IDs of OBServer nodes that use the maximum disk space.', + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of OBServer nodes that use the maximum disk space.', + 'type' => 'string', + 'example' => 'i-bp1fhj23fs32dfbg4****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Replicas' => [ + 'description' => 'The information about replicas.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LogicalZone' => [ + 'title' => '副本ID', + 'description' => 'The ID of the replica.', + 'type' => 'string', + 'example' => 'cn-hangzhou-h-z0', + ], + 'NodeNum' => [ + 'title' => '副本节点数', + 'description' => 'The number of nodes of the replica.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ZoneLogicalName' => [ + 'title' => '副本地域', + 'description' => 'The region of the replica.', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'ZoneRegionName' => [ + 'title' => '副本可用区', + 'description' => 'The zone of the replica.', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'ReplicaResource' => [ + 'description' => 'The information about the replica resources.', + 'type' => 'object', + 'properties' => [ + 'Memory' => [ + 'description' => 'The information about the memory resources of the replica.', + 'type' => 'object', + 'properties' => [ + 'UsedMemory' => [ + 'title' => '副本已使用内存', + 'description' => 'The size of memory used by the replica, in GB.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16', + ], + 'TotalMemory' => [ + 'title' => '副本总内存', + 'description' => 'The total memory size of the replica, in GB.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + ], + ], + 'DiskSize' => [ + 'description' => 'The information about the data disk of the replica.', + 'type' => 'object', + 'properties' => [ + 'UsedDiskSize' => [ + 'title' => '副本已使用数据量', + 'description' => 'The disk space used by the replica, in GB.', + 'type' => 'number', + 'format' => 'float', + 'example' => '50', + ], + 'TotalDiskSize' => [ + 'title' => '副本总数据量', + 'description' => 'The total disk space of the replica, in GB.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + 'Cpu' => [ + 'description' => 'The information about the CPU resources of the replica.', + 'type' => 'object', + 'properties' => [ + 'TotalCpu' => [ + 'title' => '副本总CPU', + 'description' => 'The total number of CPU cores of the replica.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'UsedCpu' => [ + 'title' => '副本已使用CPU', + 'description' => 'The number of CPU cores used by the replica.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + ], + ], + ], + ], + 'ZoneLogicalId' => [ + 'title' => '副本编号', + 'description' => 'The serial number of the replica.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1'."\n", + ], + 'ReplicaType' => [ + 'title' => '副本类型', + 'description' => 'The type of the replica.', + 'type' => 'string', + 'example' => 'FULL', + ], + 'Status' => [ + 'title' => '副本状态，返回枚举类型（ACTIVE/INACTIVE/UNKNOWN）', + 'description' => 'The status of the replica. Valid values: ACTIVE, INACTIVE, and UNKNOWN.', + 'type' => 'string', + 'example' => 'ACTIVE', + 'enum' => [ + 'ACTIVE', + 'INACTIVE', + 'UNKNOWN', + ], + ], + 'ReadOnlyReplicaType' => [ + 'description' => 'The type of the read-only replica.', + 'type' => 'string', + 'example' => 'ROW_STORE', + 'enum' => [ + 'ROW_STORE', + 'COLUMN_STORE', + 'NOT_READONLY_REPLICA', + ], + ], + 'OnlineNodeNum' => [ + 'title' => '在线节点数', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + 'description' => 'The information about replicas.', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"InstanceTopology\\": {\\n \\"Tenants\\": [\\n {\\n \\"TenantId\\": \\"t33h8y08k****\\",\\n \\"TenantName\\": \\"pay_online\\",\\n \\"TenantCpu\\": 2,\\n \\"TenantMemory\\": 10,\\n \\"TenantMode\\": \\"Oracle\\",\\n \\"TenantZones\\": [\\n {\\n \\"TenantZoneRole\\": \\"ReadWrite\\",\\n \\"IsPrimaryTenantZone\\": true,\\n \\"TenantZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Units\\": [\\n {\\n \\"UnitId\\": \\"1002\\",\\n \\"UnitStatus\\": \\"ONLINE\\",\\n \\"NodeId\\": \\"i-bp16niirq4zdmgvm****\\",\\n \\"UnitCpu\\": 2,\\n \\"UnitMemory\\": 10,\\n \\"EnableMigrateUnit\\": true,\\n \\"ManualMigrate\\": true,\\n \\"EnableCancelMigrateUnit\\": true,\\n \\"UnitDataSize\\": 10,\\n \\"ReplicaType\\": \\"FULL\\"\\n }\\n ],\\n \\"LogicalZone\\": \\"cn-hangzhou-h-z0\\",\\n \\"ReplicaType\\": \\"FULL\\",\\n \\"ReadOnlyReplicaType\\": \\"ROW_STORE\\"\\n }\\n ],\\n \\"TenantStatus\\": \\"ONLINE\\",\\n \\"TenantDeployType\\": \\"multiple\\",\\n \\"TenantUnitNum\\": 1,\\n \\"PrimaryZoneDeployType\\": \\"RANDOM\\",\\n \\"TenantDiskSize\\": 2,\\n \\"TenantUnitCpu\\": 4,\\n \\"TenantUnitMemory\\": 16\\n }\\n ],\\n \\"Zones\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ZoneDisk\\": \\"200 GB\\",\\n \\"Nodes\\": [\\n {\\n \\"NodeId\\": \\"i-bp16niirq4zdmgvm****\\",\\n \\"NodeCopyId\\": 1,\\n \\"NodeStatus\\": \\"ONLINE\\",\\n \\"NodeResource\\": {\\n \\"Cpu\\": {\\n \\"UsedCpu\\": 4,\\n \\"TotalCpu\\": 14\\n },\\n \\"Memory\\": {\\n \\"UsedMemory\\": 10,\\n \\"TotalMemory\\": 70\\n },\\n \\"DiskSize\\": {\\n \\"TotalDiskSize\\": 100,\\n \\"UsedDiskSize\\": 50\\n }\\n },\\n \\"ReplicaType\\": \\"FULL\\",\\n \\"FullCopyId\\": 1,\\n \\"ReadOnlyCopyId\\": 1,\\n \\"LogicalZone\\": \\"cn-hangzhou-h-z0\\",\\n \\"ReadOnlyReplicaType\\": \\"ROW_STORE\\"\\n }\\n ],\\n \\"ZoneResource\\": {\\n \\"DiskSize\\": {\\n \\"MaxDiskUsedPercent\\": 0.14,\\n \\"MaxDiskUsedObServer\\": [\\n \\"i-bp1fhj23fs32dfbg4****\\"\\n ]\\n }\\n }\\n }\\n ],\\n \\"Replicas\\": [\\n {\\n \\"LogicalZone\\": \\"cn-hangzhou-h-z0\\",\\n \\"NodeNum\\": 1,\\n \\"ZoneLogicalName\\": \\"cn-hangzhou-h\\",\\n \\"ZoneRegionName\\": \\"cn-hangzhou-h\\",\\n \\"ReplicaResource\\": {\\n \\"Memory\\": {\\n \\"UsedMemory\\": 16,\\n \\"TotalMemory\\": 32\\n },\\n \\"DiskSize\\": {\\n \\"UsedDiskSize\\": 50,\\n \\"TotalDiskSize\\": 100\\n },\\n \\"Cpu\\": {\\n \\"TotalCpu\\": 16,\\n \\"UsedCpu\\": 8\\n }\\n },\\n \\"ZoneLogicalId\\": 1,\\n \\"ReplicaType\\": \\"FULL\\",\\n \\"Status\\": \\"ACTIVE\\",\\n \\"ReadOnlyReplicaType\\": \\"ROW_STORE\\",\\n \\"OnlineNodeNum\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstanceTopologyResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <InstanceTopology>\\n <Tenants>\\n <TenantId>t33h8y08k****</TenantId>\\n <TenantName>pay_online</TenantName>\\n <TenantCpu>2</TenantCpu>\\n <TenantMemory>10</TenantMemory>\\n <TenantMode>Oracle</TenantMode>\\n <TenantZones>\\n <TenantZoneRole>ReadWrite</TenantZoneRole>\\n <IsPrimaryTenantZone>true</IsPrimaryTenantZone>\\n <TenantZoneId>cn-hangzhou-h</TenantZoneId>\\n <Units>\\n <UnitId>1002</UnitId>\\n <UnitStatus>ONLINE</UnitStatus>\\n <NodeId>i-bp16niirq4zdmgvm****</NodeId>\\n <UnitCpu>2</UnitCpu>\\n <UnitMemory>10</UnitMemory>\\n <EnableMigrateUnit>true</EnableMigrateUnit>\\n <ManualMigrate>true</ManualMigrate>\\n <EnableCancelMigrateUnit>true</EnableCancelMigrateUnit>\\n </Units>\\n </TenantZones>\\n <TenantStatus>ONLINE</TenantStatus>\\n <TenantDeployType>multiple</TenantDeployType>\\n <TenantUnitNum>1</TenantUnitNum>\\n </Tenants>\\n <Zones>\\n <ZoneId>cn-hangzhou-i</ZoneId>\\n <Region>cn-hangzhou</Region>\\n <ZoneDisk>200 GB</ZoneDisk>\\n <Nodes>\\n <NodeId>i-bp16niirq4zdmgvm****</NodeId>\\n <NodeCopyId>1</NodeCopyId>\\n <NodeStatus>ONLINE</NodeStatus>\\n <NodeResource>\\n <Cpu>\\n <UsedCpu>4</UsedCpu>\\n <TotalCpu>14</TotalCpu>\\n </Cpu>\\n <Memory>\\n <UsedMemory>10</UsedMemory>\\n <TotalMemory>70</TotalMemory>\\n </Memory>\\n <DiskSize>\\n <TotalDiskSize>400</TotalDiskSize>\\n <UsedDiskSize>200</UsedDiskSize>\\n </DiskSize>\\n </NodeResource>\\n </Nodes>\\n <ZoneResource>\\n <DiskSize>\\n <MaxDiskUsedPercent>0.14</MaxDiskUsedPercent>\\n <MaxDiskUsedObServer>i-bp1fhj23fs32dfbg4****</MaxDiskUsedObServer>\\n </DiskSize>\\n </ZoneResource>\\n </Zones>\\n </InstanceTopology>\\n</DescribeInstanceTopologyResponse>","errorExample":""}]', + 'title' => 'DescribeInstanceTopology', + ], + 'DescribeAvailableSpec' => [ + 'summary' => 'You can call this operation to query the specifications available for an OceanBase cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群ID', + 'description' => 'The ID of the OceanBase cluster.', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'UpgradeType', + 'in' => 'formData', + 'schema' => [ + 'title' => '变配类型', + 'description' => 'The type of the specification change.'."\n" + .'Valid values:'."\n" + .'- upgradenodenum: Increases the number of nodes.'."\n" + .'- downgradespec: Downgrades the specification plan.'."\n" + .'- upgradespec: Upgrades the specification plan.'."\n" + .'- upgradedisk: Increases the disk size.'."\n" + .'- downgradenodenum: Reduces the number of nodes.', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'downgradedisk' => 'downgradedisk', + 'upgradenodenum' => 'upgradenodenum', + 'downgradespec' => 'downgradespec', + 'upgradespec' => 'upgradespec', + 'upgradedisk' => 'upgradedisk', + 'downgradenodenum' => 'downgradenodenum', + ], + 'example' => 'upgradespec', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点规格', + 'description' => 'The specifications of the node.', + 'type' => 'string', + 'required' => false, + 'example' => 'oceanbase.cluster.cd8.xlarge', + ], + ], + ], + '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 returned data.', + 'type' => 'object', + 'properties' => [ + 'AvailableSpecifications' => [ + 'title' => '返回数据', + 'description' => 'The specifications available for the cluster.', + 'type' => 'array', + 'items' => [ + 'description' => 'The specifications available for the cluster.', + 'type' => 'object', + 'properties' => [ + 'Spec' => [ + 'description' => 'The specifications of the migration instance.', + 'type' => 'string', + 'example' => 'oceanbase.cluster.cd8.xlarge', + ], + 'InstanceClass' => [ + 'description' => 'The specifications of the cluster.', + 'type' => 'string', + 'example' => '4C16GB', + ], + 'NodeNum' => [ + 'title' => '节点个数', + 'description' => 'The number of nodes.', + 'type' => 'array', + 'items' => [ + 'title' => '节点个数', + 'description' => 'The number of nodes.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + 'DiskSizeRange' => [ + 'description' => 'The storage size.', + 'type' => 'object', + 'properties' => [ + 'Step' => [ + 'title' => '最小调整粒度', + 'description' => 'The minimum adjustment step.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Max' => [ + 'title' => '最大值', + 'description' => 'The maximum value of the parameter.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40000', + ], + 'Min' => [ + 'title' => '最小值', + 'description' => 'The minimum value of the parameter.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + 'title' => '', + ], + 'LogDiskSizeRange' => [ + 'description' => 'The size of the log disk.', + 'type' => 'object', + 'properties' => [ + 'Step' => [ + 'title' => '最小调整粒度', + 'description' => 'The minimum adjustment step.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Max' => [ + 'title' => '最大值', + 'description' => 'The maximum value of the parameter.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4000', + ], + 'Min' => [ + 'title' => '最小值', + 'description' => 'The minimum value of the parameter.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + 'title' => '', + ], + 'DiskTypes' => [ + 'title' => '', + 'description' => '存储类型列表信息。', + 'type' => 'array', + 'items' => [ + 'title' => '存储类型', + 'description' => '存储类型。', + 'type' => 'string', + 'example' => 'cloud_essd_pl1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"AvailableSpecifications\\": [\\n {\\n \\"Spec\\": \\"oceanbase.cluster.cd8.xlarge\\",\\n \\"InstanceClass\\": \\"4C16GB\\",\\n \\"NodeNum\\": [\\n 3\\n ],\\n \\"DiskSizeRange\\": {\\n \\"Step\\": 5,\\n \\"Max\\": 40000,\\n \\"Min\\": 1000\\n },\\n \\"LogDiskSizeRange\\": {\\n \\"Step\\": 5,\\n \\"Max\\": 4000,\\n \\"Min\\": 100\\n },\\n \\"DiskTypes\\": [\\n \\"cloud_essd_pl1\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeAvailableSpec', + ], + 'DescribeAvailableZone' => [ + 'summary' => 'You can call this operation to query the configurations available for creating an OceanBase cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceType', + 'in' => 'formData', + 'schema' => [ + 'title' => '实例类型', + 'description' => 'The type of the instance.', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'cluster' => 'cluster', + ], + 'example' => 'cluster', + ], + ], + [ + 'name' => 'Series', + 'in' => 'formData', + 'schema' => [ + 'title' => '系列', + 'description' => 'The series of the OceanBase cluster. Valid values: '."\n" + .'- normal: Standard Cluster Edition (Cloud Disk). This is the default value.'."\n" + .'- normal_ssd: Standard Cluster Edition (Local Disk).'."\n" + .'- history: History Database Cluster Edition.', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'DeployType', + 'in' => 'formData', + 'schema' => [ + 'title' => '部署方案', + 'description' => 'The deployment type of the cluster. Valid values: '."\n" + .'- multiple: multi-IDC deployment '."\n" + .'- single: single-IDC deployment '."\n" + .'- dual: dual-IDC deployment ', + 'type' => 'string', + 'required' => false, + 'example' => 'multiple', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点规划', + 'description' => 'The specification of the node.', + 'type' => 'string', + 'required' => false, + 'example' => 'oceanbase.cluster.cd8.xlarge', + ], + ], + [ + 'name' => 'ObVersion', + 'in' => 'formData', + 'schema' => [ + 'title' => '版本', + 'description' => 'The version of OceanBase Database.', + 'type' => 'string', + 'required' => false, + 'example' => '3.2.4.4', + ], + ], + [ + 'name' => 'CpuArch', + 'in' => 'formData', + 'schema' => [ + 'title' => 'cpu架构', + 'description' => 'cpu架构', + 'type' => 'string', + 'required' => false, + 'example' => 'x86', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'AvailableZones' => [ + 'title' => '返回数据', + 'description' => 'The configurations available for cluster creation.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about configurations available for cluster creation.', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'title' => '地域', + 'description' => 'The region.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Zones' => [ + 'title' => '可用区列表', + 'description' => 'The list of zones.', + 'type' => 'string', + 'example' => 'cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j', + ], + 'Channel' => [ + 'description' => 'The source of the order. '."\n" + .'* PUBLIC '."\n" + .'* FINANCE', + 'type' => 'string', + 'example' => 'PUBLIC', + ], + 'DeployType' => [ + 'title' => '部署方案', + 'description' => 'The deployment type of the cluster. Valid values: '."\n" + .'- multiple: multi-IDC deployment '."\n" + .'- single: single-IDC deployment '."\n" + .'- dual: dual-IDC deployment ', + 'type' => 'string', + 'example' => 'multiple', + ], + 'InstanceType' => [ + 'title' => '实例类型', + 'description' => 'The type of the instance.', + 'type' => 'string', + 'example' => 'cluster', + ], + 'Series' => [ + 'title' => '系列', + 'description' => 'The series of the OceanBase cluster. Valid values: '."\n" + .'- normal: Standard Cluster Edition (Cloud Disk). This is the default value.'."\n" + .'- normal_ssd: Standard Cluster Edition (Local Disk).'."\n" + .'- history: History Database Cluster Edition.', + 'type' => 'string', + 'example' => 'normal', + ], + 'SupportSpecifications' => [ + 'title' => '节点规格', + 'description' => 'The specifications of the node.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about specifications of the node.', + 'type' => 'object', + 'properties' => [ + 'Spec' => [ + 'description' => 'The specification of the node.', + 'type' => 'string', + 'example' => 'oceanbase.cluster.cd8.xlarge', + ], + 'InstanceClass' => [ + 'description' => 'The specification of the cluster.', + 'type' => 'string', + 'example' => '4C16GB', + ], + 'DiskTypes' => [ + 'title' => '存储类型', + 'description' => 'The storage types.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about storage types.', + 'type' => 'string', + 'example' => 'cloud_essd_pl1', + ], + ], + 'DiskSizeRange' => [ + 'title' => '存储大小', + 'description' => 'The storage size.', + 'type' => 'object', + 'properties' => [ + 'Step' => [ + 'title' => '最小调整粒度', + 'description' => 'The minimum adjustment step.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Max' => [ + 'title' => '最大值', + 'description' => 'The maximum value.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40000', + ], + 'Min' => [ + 'title' => '最小值', + 'description' => 'The minimum value.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + ], + 'SupportEngineVersions' => [ + 'title' => '版本', + 'description' => 'The versions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about versions.', + 'type' => 'object', + 'properties' => [ + 'ObVersion' => [ + 'description' => 'The version of OceanBase Database.', + 'type' => 'string', + 'example' => '3.2.4.4', + ], + 'SupportIsolationOptimization' => [ + 'title' => '是否支持隔离', + 'description' => 'Indicates whether isolation is supported.', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'false', + ], + 'SupportReplicaModes' => [ + 'title' => '全功能型副本数', + 'description' => 'The number of full-featured replicas.', + 'type' => 'array', + 'items' => [ + 'title' => '全功能型副本数', + 'description' => 'The number of full-featured replicas.', + 'type' => 'string', + 'example' => '3F', + ], + ], + ], + ], + ], + ], + ], + ], + 'CpuArch' => [ + 'title' => 'cpu架构', + 'description' => 'The CPU architecture.', + 'type' => 'string', + 'example' => 'x86', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"AvailableZones\\": [\\n {\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Zones\\": \\"cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j\\",\\n \\"Channel\\": \\"PUBLIC\\",\\n \\"DeployType\\": \\"multiple\\",\\n \\"InstanceType\\": \\"cluster\\",\\n \\"Series\\": \\"normal\\",\\n \\"SupportSpecifications\\": [\\n {\\n \\"Spec\\": \\"oceanbase.cluster.cd8.xlarge\\",\\n \\"InstanceClass\\": \\"4C16GB\\",\\n \\"DiskTypes\\": [\\n \\"cloud_essd_pl1\\"\\n ],\\n \\"DiskSizeRange\\": {\\n \\"Step\\": 5,\\n \\"Max\\": 40000,\\n \\"Min\\": 1000\\n },\\n \\"SupportEngineVersions\\": [\\n {\\n \\"ObVersion\\": \\"3.2.4.4\\",\\n \\"SupportIsolationOptimization\\": true,\\n \\"SupportReplicaModes\\": [\\n \\"3F\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"CpuArch\\": \\"x86\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeAvailableZone', + ], + 'DescribeInstanceCreatableZone' => [ + 'summary' => 'You can call this operation to query the zones of a cluster that can be set as the primary zone. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the zone. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'The list of zones. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'Indicates whether the cluster is deployed in the zone. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'ZoneList' => [ + 'title' => '可用区列表信息。', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeInstanceCreatableZone**. ', + 'type' => 'array', + 'items' => [ + 'description' => 'Example 1', + 'type' => 'object', + 'properties' => [ + 'IsInCluster' => [ + 'title' => '是否是集群部署的可用区。', + 'description' => ' ', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Zone' => [ + 'title' => '可用区ID。', + 'description' => 'DescribeInstanceCreatableZone', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'FullCopyId' => [ + 'title' => '副本序号', + 'type' => 'string', + ], + 'LogicalZoneName' => [ + 'title' => '逻辑副本', + 'type' => 'string', + ], + 'ReplicateZoneIndex' => [ + 'title' => '副本可用区序号', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'example' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"ZoneList\\": [\\n {\\n \\"IsInCluster\\": true,\\n \\"Zone\\": \\"cn-hangzhou-i\\",\\n \\"FullCopyId\\": \\"1\\",\\n \\"LogicalZoneName\\": \\"cn-shanghai-g-z0,cn-shanghai-g-z1, cn-shanghai-g-z2\\",\\n \\"ReplicateZoneIndex\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstanceCreatableZoneResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <ZoneList>\\n <IsInCluster>true</IsInCluster>\\n <Zone>cn-hangzhou-i</Zone>\\n </ZoneList>\\n</DescribeInstanceCreatableZoneResponse>","errorExample":""}]', + 'title' => 'DescribeInstanceCreatableZone', + ], + 'ModifyInstanceName' => [ + 'summary' => 'You can call this operation to change the name of an OceanBase cluster. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'It is an Alibaba Cloud asset management and configuration tool, with which you can manage multiple Alibaba Cloud products and services by using commands. It is easy to use and a good helper in migration to cloud. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群名称。 长度为1~20个英文或中文字符。如果没有指定该参数，默认值为集群的InstanceId。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob4prod', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The name of the OceanBase cluster. '."\n" + .'It must be 1 to 20 characters in length. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **ModifyInstanceName**. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 9005 => [ + [ + 'errorCode' => 'MissingInstanceId', + 'errorMessage' => 'InstanceId is mandatory for this action.', + ], + ], + [ + [ + 'errorCode' => 'MissingInstanceName', + 'errorMessage' => 'InstanceName is mandatory for this action.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyInstanceNameResponse>\\n <InstanceName>ob4test</InstanceName>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</ModifyInstanceNameResponse>","errorExample":""}]', + 'title' => 'ModifyInstanceName', + ], + 'ModifyInstanceSpec' => [ + 'summary' => 'You can call this operation to modify the cluster specifications and storage space.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群的ID。', + 'description' => 'The ID of the OceanBase cluster.', + 'type' => 'string', + 'required' => true, + 'example' => 'ob3h8ytroxxxxx', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群规格信息。<br> 当前支持以下套餐：<br> - 4C16GB：4核 16GB<br> - 8C32GB：8核 32GB<br>- 14C70GB：14核 70GB<br> - 24C120GB：24核 120GB<br> - 30C180GB：30核 180GB<br> - 62C400GB：62核 400GB<br> - 104C600GB：104核 600GB<br> - 16C70GB：16核 70GB<br> - 32C160GB：32核 160GB<br> - 64C380GB：64核 380GB<br> - 20C32GB：20核 32GB <br> - 40C64GB：40核 64GB<br> - 16C32GB：16核 32GB<br> - 32C70GB：32核 70GB<br> - 64C180GB：64核 180GB<br> - 32C180GB：32核 180GB<br> - 64C400GB：64核 400GB。', + 'description' => 'The specifications of the cluster. You can specify one of the following four plans:'."\n" + .'- 8C32GB: indicates 8 CPU cores and 32 GB of memory.'."\n" + .'- 14C70GB: indicates 14 CPU cores and 70 GB of memory. This is the default value.'."\n" + .'- 30C180GB: indicates 30 CPU cores and 180 GB of memory.'."\n" + .'- 62C400GB: indicates 62 CPU cores and 400 GB of memory.', + 'type' => 'string', + 'required' => false, + 'example' => '14C70GB', + ], + ], + [ + 'name' => 'DiskSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '存储空间大小，单位GB。 存储空间的限制根据集群规格不同而不同，具体如下： - 8C32G：100GB~10TB - 14C70G：200GB~10TB - 30C180G：400GB~10TB - 62C400G：800GB-10TB。 各套餐的存储空间默认值为其最小值。', + 'description' => 'The size of the storage space, in GB. The required storage space varies based on the cluster specifications:'."\n" + .'- 8C32G: 100 GB to 10 TB.'."\n" + .'- 14C70G: 200 GB to 10 TB.'."\n" + .'- 30C180G: 400 GB to 10 TB.'."\n" + .'- 62C400G: 800 GB to 10 TB. The preceding minimum storage space sizes are the default storage space sizes of the corresponding cluster specification plans.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否只预检此次请求, 默认为false。取值范围：'."\n" + .'true：发送检查请求，不会更改实例配置。如果检查通过，则返回DryRunResult=true, 如果检查不通过, 则返回相应错误的错误码。'."\n" + .'false（默认）：发送正常请求，通过检查后直接更改实例配置。', + 'description' => 'Specifies whether to perform only a dry run for the request. Default value: false. Valid values:'."\n" + .'- true: Only a dry-run request is sent and the instance settings are not modified. If the dry run succeeds, DryRunResult=true is returned. If the dry run fails, an error code is returned.'."\n" + .'- false: If the DryRun parameter is set to false, no dry run is performed and the DryRunResult parameter returns false.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'DiskType', + 'in' => 'formData', + 'schema' => [ + 'title' => '存储类型', + 'description' => 'Disk type.', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd_pl1', + ], + ], + [ + 'name' => 'UpgradeSpecNative', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否原地变配', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'title' => '请求返回的数据。', + 'description' => 'The return data of the request.', + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'title' => '订单ID。', + 'description' => 'The ID of the order that you have placed.', + 'type' => 'string', + 'example' => '213290*********', + ], + 'DryRunResult' => [ + 'title' => '预检查请求的结果. 如果DryRun填写为true, 当预检查请求通过, 则DryRunResult返回true, 否则返回相应的错误码信息.', + 'description' => 'The result of the dry-run request.'."\n" + .'- If the DryRun parameter is set to true and the dry run succeeds, the DryRunResult parameter returns true. Otherwise, an error code is returned.'."\n" + .'- If the DryRun parameter is set to false, no dry run is performed and the DryRunResult parameter returns false.', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + 'example' => '1234567890', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Instance.Order.CreateFailed', + 'errorMessage' => 'Instance.Order.CreateFailed', + ], + [ + 'errorCode' => 'InstanceDataSize.Invalid', + 'errorMessage' => 'InstanceDataSize.Invalid', + ], + [ + 'errorCode' => 'InstanceClassSpecification.Invalid', + 'errorMessage' => 'InstanceClassSpecification.Invalid', + ], + [ + 'errorCode' => 'InstanceOrder.NotAvailable', + 'errorMessage' => 'InstanceOrder.NotAvailable', + ], + [ + 'errorCode' => 'InstanceNodeNum.Invalid', + 'errorMessage' => 'InstanceNodeNum.Invalid', + ], + [ + 'errorCode' => 'InstanceLogSize.Invalid', + 'errorMessage' => 'InstanceLogSize.Invalid', + ], + [ + 'errorCode' => 'Instance.ExpandLogDisk.Unsupport', + 'errorMessage' => 'Instance.ExpandLogDisk.Unsupport', + ], + [ + 'errorCode' => 'InstanceStatus.Invalid', + 'errorMessage' => 'InstanceStatus.Invalid', + ], + [ + 'errorCode' => 'InstanceName.ModifyFailed', + 'errorMessage' => 'InstanceName.ModifyFailed', + ], + [ + 'errorCode' => 'InstanceClass.InvalidValue', + 'errorMessage' => 'InstanceClass.InvalidValue', + ], + [ + 'errorCode' => 'InstanceType.Unsupport', + 'errorMessage' => 'InstanceType.Unsupport', + ], + [ + 'errorCode' => 'ZoneList.Unsupport', + 'errorMessage' => 'ZoneList.Unsupport', + ], + [ + 'errorCode' => 'InstanceId.Invalid', + 'errorMessage' => 'InstanceId.Invalid', + ], + [ + 'errorCode' => 'InstanceId.Missing', + 'errorMessage' => 'InstanceId.Missing', + ], + [ + 'errorCode' => 'Instance.Name.Missing', + 'errorMessage' => 'Instance.Name.Missing', + ], + [ + 'errorCode' => 'ListCluster.Fail', + 'errorMessage' => 'ListCluster.Fail', + ], + [ + 'errorCode' => 'GetCluster.Fail', + 'errorMessage' => 'GetCluster.Fail', + ], + [ + 'errorCode' => 'ListClusterGroup.Fail', + 'errorMessage' => 'ListClusterGroup.Fail', + ], + [ + 'errorCode' => 'GetClusterGroup.Fail', + 'errorMessage' => 'GetClusterGroup.Fail', + ], + [ + 'errorCode' => 'ListInstance.Fail', + 'errorMessage' => 'ListInstance.Fail', + ], + [ + 'errorCode' => 'GetInstance.Fail', + 'errorMessage' => 'GetInstance.Fail', + ], + [ + 'errorCode' => 'ListTenant.Fail', + 'errorMessage' => 'ListTenant.Fail', + ], + [ + 'errorCode' => 'GetTenant.Fail', + 'errorMessage' => 'GetTenant.Fail', + ], + [ + 'errorCode' => 'Instance.ListAliyunInstance.Fail', + 'errorMessage' => 'Instance.ListAliyunInstance.Fail', + ], + [ + 'errorCode' => 'Instance.GetAliyunInstance.Fail', + 'errorMessage' => 'Instance.GetAliyunInstance.Fail', + ], + [ + 'errorCode' => 'ListZone.Fail', + 'errorMessage' => 'ListZone.Fail', + ], + [ + 'errorCode' => 'GetObServer.Fail', + 'errorMessage' => 'GetObServer.Fail', + ], + [ + 'errorCode' => 'CreateInstanceParameters.Error', + 'errorMessage' => 'CreateInstanceParameters.Error', + ], + [ + 'errorCode' => 'CreateInstance.Fail', + 'errorMessage' => 'CreateInstance.Fail', + ], + [ + 'errorCode' => 'StandbyInstance.StillOnline', + 'errorMessage' => 'StandbyInstance.StillOnline', + ], + [ + 'errorCode' => 'InstanceServiceName.Missing', + 'errorMessage' => 'InstanceServiceName.Missing', + ], + [ + 'errorCode' => 'PrimaryInstanceStatus.Invalid', + 'errorMessage' => 'PrimaryInstanceStatus.Invalid', + ], + [ + 'errorCode' => 'StandbyInstanceStatus.Invalid', + 'errorMessage' => 'StandbyInstanceStatus.Invalid', + ], + [ + 'errorCode' => 'StandbyInstance.NotSupport', + 'errorMessage' => 'StandbyInstance.NotSupport', + ], + [ + 'errorCode' => 'StandbyInstance.Disconnect.NotAllowed', + 'errorMessage' => 'StandbyInstance.Disconnect.NotAllowed', + ], + [ + 'errorCode' => 'InstanceDiskSize.Invalid', + 'errorMessage' => 'InstanceDiskSize.Invalid', + ], + [ + 'errorCode' => 'CreateInstance.Spec.NotSupport', + 'errorMessage' => 'CreateInstance.Spec.NotSupport', + ], + [ + 'errorCode' => 'MissingParameterDiskSize', + 'errorMessage' => 'MissingParameterDiskSize', + ], + [ + 'errorCode' => 'CreateInstance.ReplicaMode.InvalidValue', + 'errorMessage' => 'CreateInstance.ReplicaMode.InvalidValue', + ], + [ + 'errorCode' => 'CreateInstance.DeployType.InvalidValue', + 'errorMessage' => 'CreateInstance.DeployType.InvalidValue', + ], + [ + 'errorCode' => 'AliyunInstance.NotExists', + 'errorMessage' => 'AliyunInstance.NotExists', + ], + ], + 500 => [ + [ + 'errorCode' => 'Instance.Order.CreateFailed', + 'errorMessage' => 'Instance.Order.CreateFailed', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"OrderId\\": \\"21329031xxxxxxx\\",\\n \\"DryRunResult\\": false\\n }\\n}","type":"json"}]', + 'title' => 'ModifyInstanceSpec', + ], + 'ModifyInstanceNodeNum' => [ + 'summary' => 'You can call this operation to modify the number of nodes in a cluster.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群的ID', + 'description' => 'The ID of the OceanBase cluster.', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'NodeNum', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群节点个数信息。 如果部署模式为n-n-n，则节点个数为n * 3', + 'description' => 'The number of nodes in the cluster. If the cluster is deployed in n-n-n mode, the number of nodes in the cluster equals n × 3.', + 'type' => 'string', + 'required' => true, + 'example' => '6', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否只预检此次请求, 默认为false。取值范围：'."\n" + .'true：发送检查请求，不会更改实例节点数。如果检查通过，则返回DryRunResult=true, 如果检查不通过, 则返回相应错误的错误码。'."\n" + .'false（默认）：发送正常请求，通过检查后直接更改实例节点数。', + 'description' => 'Specifies whether to perform only a dry run for the request. Default value: false. Valid values:'."\n" + .'- true: Only a dry-run request is sent and the number of nodes in the instance is not modified. If the dry run succeeds, DryRunResult=true is returned. If the dry run fails, an error code is returned.'."\n" + .'- false: The actual request is sent and no dry run is performed. The number of nodes is changed if the requirements are met. By default, the DryRunResult parameter returns false if you set DryRun to false.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'title' => '请求返回的信息。', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'title' => '订单号。', + 'description' => 'The ID of the order.', + 'type' => 'string', + 'example' => '2132903*********', + ], + 'DryRunResult' => [ + 'title' => '预检查请求的结果. 如果DryRun填写为true, 当预检查请求通过, 则DryRunResult返回true, 否则返回相应的错误码信息.', + 'description' => 'The result of the dry-run request.'."\n" + .'- If the DryRun parameter is set to true and the dry run succeeds, the DryRunResult parameter returns true. Otherwise, an error code is returned.'."\n" + .'- If the DryRun parameter is set to false, no dry run is performed and the DryRunResult parameter returns false.', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Instance.Order.CreateFailed', + 'errorMessage' => 'Instance.Order.CreateFailed', + ], + [ + 'errorCode' => 'InstanceDataSize.Invalid', + 'errorMessage' => 'InstanceDataSize.Invalid', + ], + [ + 'errorCode' => 'InstanceClassSpecification.Invalid', + 'errorMessage' => 'InstanceClassSpecification.Invalid', + ], + [ + 'errorCode' => 'InstanceLogSize.Invalid', + 'errorMessage' => 'InstanceLogSize.Invalid', + ], + [ + 'errorCode' => 'Instance.ExpandLogDisk.Unsupport', + 'errorMessage' => 'Instance.ExpandLogDisk.Unsupport', + ], + [ + 'errorCode' => 'InstanceOrder.NotAvailable', + 'errorMessage' => 'InstanceOrder.NotAvailable', + ], + [ + 'errorCode' => 'InstanceNodeNum.Invalid', + 'errorMessage' => 'InstanceNodeNum.Invalid', + ], + [ + 'errorCode' => 'InstanceStatus.Invalid', + 'errorMessage' => 'InstanceStatus.Invalid', + ], + [ + 'errorCode' => 'InstanceName.ModifyFailed', + 'errorMessage' => 'InstanceName.ModifyFailed', + ], + [ + 'errorCode' => 'InstanceClass.InvalidValue', + 'errorMessage' => 'InstanceClass.InvalidValue', + ], + [ + 'errorCode' => 'InstanceType.Unsupport', + 'errorMessage' => 'InstanceType.Unsupport', + ], + [ + 'errorCode' => 'InstanceId.Invalid', + 'errorMessage' => 'InstanceId.Invalid', + ], + [ + 'errorCode' => 'InstanceId.Missing', + 'errorMessage' => 'InstanceId.Missing', + ], + [ + 'errorCode' => 'Instance.Name.Missing', + 'errorMessage' => 'Instance.Name.Missing', + ], + [ + 'errorCode' => 'ListCluster.Fail', + 'errorMessage' => 'ListCluster.Fail', + ], + [ + 'errorCode' => 'GetCluster.Fail', + 'errorMessage' => 'GetCluster.Fail', + ], + [ + 'errorCode' => 'ListClusterGroup.Fail', + 'errorMessage' => 'ListClusterGroup.Fail', + ], + [ + 'errorCode' => 'GetClusterGroup.Fail', + 'errorMessage' => 'GetClusterGroup.Fail', + ], + [ + 'errorCode' => 'ListInstance.Fail', + 'errorMessage' => 'ListInstance.Fail', + ], + [ + 'errorCode' => 'GetInstance.Fail', + 'errorMessage' => 'GetInstance.Fail', + ], + [ + 'errorCode' => 'ListTenant.Fail', + 'errorMessage' => 'ListTenant.Fail', + ], + [ + 'errorCode' => 'GetTenant.Fail', + 'errorMessage' => 'GetTenant.Fail', + ], + [ + 'errorCode' => 'Instance.ListAliyunInstance.Fail', + 'errorMessage' => 'Instance.ListAliyunInstance.Fail', + ], + [ + 'errorCode' => 'Instance.GetAliyunInstance.Fail', + 'errorMessage' => 'Instance.GetAliyunInstance.Fail', + ], + [ + 'errorCode' => 'ListZone.Fail', + 'errorMessage' => 'ListZone.Fail', + ], + [ + 'errorCode' => 'GetObServer.Fail', + 'errorMessage' => 'GetObServer.Fail', + ], + [ + 'errorCode' => 'CreateInstanceParameters.Error', + 'errorMessage' => 'CreateInstanceParameters.Error', + ], + [ + 'errorCode' => 'CreateInstance.Fail', + 'errorMessage' => 'CreateInstance.Fail', + ], + [ + 'errorCode' => 'StandbyInstance.StillOnline', + 'errorMessage' => 'StandbyInstance.StillOnline', + ], + [ + 'errorCode' => 'InstanceServiceName.Missing', + 'errorMessage' => 'InstanceServiceName.Missing', + ], + [ + 'errorCode' => 'PrimaryInstanceStatus.Invalid', + 'errorMessage' => 'PrimaryInstanceStatus.Invalid', + ], + [ + 'errorCode' => 'StandbyInstanceStatus.Invalid', + 'errorMessage' => 'StandbyInstanceStatus.Invalid', + ], + [ + 'errorCode' => 'StandbyInstance.NotSupport', + 'errorMessage' => 'StandbyInstance.NotSupport', + ], + [ + 'errorCode' => 'StandbyInstance.Disconnect.NotAllowed', + 'errorMessage' => 'StandbyInstance.Disconnect.NotAllowed', + ], + [ + 'errorCode' => 'InstanceDiskSize.Invalid', + 'errorMessage' => 'InstanceDiskSize.Invalid', + ], + [ + 'errorCode' => 'CreateInstance.Spec.NotSupport', + 'errorMessage' => 'CreateInstance.Spec.NotSupport', + ], + [ + 'errorCode' => 'MissingParameterDiskSize', + 'errorMessage' => 'MissingParameterDiskSize', + ], + [ + 'errorCode' => 'CreateInstance.ReplicaMode.InvalidValue', + 'errorMessage' => 'CreateInstance.ReplicaMode.InvalidValue', + ], + [ + 'errorCode' => 'CreateInstance.DeployType.InvalidValue', + 'errorMessage' => 'CreateInstance.DeployType.InvalidValue', + ], + [ + 'errorCode' => 'AliyunInstance.NotExists', + 'errorMessage' => 'AliyunInstance.NotExists', + ], + ], + 500 => [ + [ + 'errorCode' => 'Instance.Order.CreateFailed', + 'errorMessage' => 'Instance.Order.CreateFailed', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"OrderId\\": \\"21329031xxxxxxxx\\",\\n \\"DryRunResult\\": false\\n }\\n}","type":"json"}]', + 'title' => 'ModifyInstanceNodeNum', + ], + 'ModifyInstanceTemporaryCapacity' => [ + 'summary' => 'You can call this operation to modify the temporary capacity of the OceanBase cluster.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'title' => '规格', + 'description' => 'Specification.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oceanbase.cluster.i2.small', + ], + ], + [ + 'name' => 'DiskSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '磁盘大小，单位G', + 'description' => 'The disk size. Unit: GB.', + 'type' => 'string', + 'required' => false, + 'example' => '400', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => 'ModifyInstanceTemporaryCapacity', + ], + 'SwitchoverInstance' => [ + 'summary' => 'You can call this operation to switch between the primary and standby instances of OceanBase.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '主备实例统一服务名', + 'description' => 'The instance ID of the primary/standby instance. You can set the default value to the instance ID of the instance to be switched to the primary instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TargetInstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '需要切换为主集群实例的实例ID', + 'description' => 'The instance ID of the instance to be switched to the primary instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'ob4bv8o7sp****', + ], + ], + [ + 'name' => 'Forced', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Whether to force the switchover.'."\n" + .'- true: Force the switchover.'."\n" + .'- false: Do not force the switchover.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '473469**-AA6F-4D**-B3DB-A***********', + ], + 'Data' => [ + 'description' => 'The list of data for the switchover.', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message of the switchover.', + 'type' => 'string', + 'example' => 'delete tag-value success', + ], + 'Success' => [ + 'description' => 'Whether the switchover is successful.'."\n" + .'- true: the switchover succeeded.'."\n" + .'- false: the switchover failed.', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469**-AA6F-4D**-B3DB-A***********\\",\\n \\"Data\\": {\\n \\"Message\\": \\"delete tag-value success\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]', + 'title' => 'SwitchoverInstance', + ], + 'RemoveStandbyInstance' => [ + 'summary' => 'You can call this operation to decouple a standby instance from its primary instance.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the primary instance.', + 'type' => 'string', + 'required' => true, + 'example' => 'ob608fgj1q****', + ], + ], + [ + 'name' => 'TargetInstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the standby instance to be decoupled.', + 'type' => 'string', + 'required' => true, + 'example' => 'ob4bv8o7sp****', + ], + ], + [ + 'name' => 'Forced', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether to forcibly decouple the standby instance.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => 'RemoveStandbyInstance', + ], + 'DeleteInstances' => [ + 'summary' => 'You can call this operation to release an OceanBase cluster. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'InstanceIds', + 'in' => 'formData', + 'schema' => [ + 'title' => '要删除的集群ID。格式为son数组的字符串。', + 'description' => 'The ID of the cluster to be deleted. '."\n" + .'The value is a string in the JSON format. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[”ob ob3f6yhv9uxxxx“]', + ], + ], + [ + 'name' => 'BackupRetainMode', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群删除后的备份保留策略。取值如下： - receive_all：保留全部备份集; - delete_all：删除全部备份集； - receive_last：保留最后一个备份集。 默认值为delete_all。', + 'description' => 'The backup retention strategy for cluster deletion. Valid values: '."\n" + .'- receive_all: retains all backup sets. '."\n" + .'- delete_all: deletes all backup sets. '."\n" + .'- receive_last: retains the last backup set. '."\n" + ."\n" + .'> <br>Default value: delete_all. ', + 'type' => 'string', + 'required' => false, + 'example' => 'delete_all', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否只预检此次请求, 默认为false。取值范围：'."\n" + .'true：发送检查请求，不会删除实例。如果检查通过，则返回DryRunResult=true, 如果检查不通过, 则返回相应错误的错误码。'."\n" + .'false（默认）：发送正常请求，通过检查后直接删除实例。', + 'description' => 'Specifies whether to perform only a dry run for the request. Default value: false. Valid values:'."\n" + .'- true: Only a dry-run request is sent and the instance is not deleted. If the dry run succeeds, DryRunResult=true is returned. If the dry run fails, an error code is returned.'."\n" + .'- false: The actual request is sent and no dry run is performed. The instance is deleted if the requirements are met. By default, false is returned for the parameter DryRunResult if you set DryRun to false.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '473469C7-****-****-B3DB-A3DC0DE3C83E', + ], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'DryRunResult' => [ + 'title' => '预检查请求的结果. 如果DryRun填写为true, 当预检查请求通过, 则DryRunResult返回true, 否则返回相应的错误码信息.', + 'description' => 'The result of the dry-run request.'."\n" + .'- If the DryRun parameter is set to true and the dry run succeeds, the DryRunResult parameter returns true. Otherwise, an error code is returned.'."\n" + .'- If the DryRun parameter is set to false, no dry run is performed and the DryRunResult parameter returns false.', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'BadRequest', + ], + ], + 404 => [ + [ + 'errorCode' => 'InstanceStatus.Invalid', + 'errorMessage' => 'InstanceStatus.Invalid', + ], + [ + 'errorCode' => 'StandbyInstance.StillOnline', + 'errorMessage' => 'StandbyInstance.StillOnline', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + [ + 'errorCode' => 'Tenant.StillOnline', + 'errorMessage' => 'Tenant.StillOnline', + ], + [ + 'errorCode' => 'ServiceTemporarilyUnavailable', + 'errorMessage' => 'ServiceTemporarilyUnavailable', + ], + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'NotFound', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'InternalServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"DryRunResult\\": false\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>65BDA532-28AF-4122-AA39-B382721EEE64</RequestId>","errorExample":""}]', + 'title' => 'DeleteInstances', + 'description' => 'Before you call this operation, ensure that the following requirements are met:'."\n" + .'- The cluster is in the Running state.'."\n" + .'- The cluster is a primary cluster and the billing method is pay-as-you-go. ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeInstanceSummary' => [ + 'summary' => 'Obtains the overview information about OceanBase instances.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'description' => 'The number of rows to return on each page.'."\n" + .'- Maximum value: 100.'."\n" + .'- Default value: 10.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => 'The number of the page to return. '."\n" + .'- Start value: 1 '."\n" + .'- Default value: 1 ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'InstanceSummary' => [ + 'description' => 'The overview information about OceanBase instances.', + 'type' => 'object', + 'properties' => [ + 'TotalInstancesCount' => [ + 'description' => 'The total number of instances.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'OverLoadInstancesCount' => [ + 'description' => 'The number of overloaded instances.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ImmediatelyExpiredInstancesCount' => [ + 'description' => 'The total number of expired instances to be released.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RunningInstancesCount' => [ + 'description' => 'The number of running instances.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'InsufficientDiskInstancesCount' => [ + 'description' => 'The total number of clusters with capacity risks.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ExpiredInstancesCount' => [ + 'description' => 'The number of expired instances.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AlarmSummaryCount' => [ + 'description' => 'The total number of alerts during the query period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AnomalySQLCount' => [ + 'description' => 'The total number of abnormal SQL statements.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ClusterInstancesCount' => [ + 'title' => '集群实例数量', + 'description' => 'The number of cluster instances.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TenantInstancesCount' => [ + 'title' => '租户实例数量', + 'description' => 'The number of tenant instances.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalOmsInstancesCount' => [ + 'description' => 'The number of data transmission instances.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RegionalInstanceSummaryList' => [ + 'description' => 'A list of regional instances.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => 'The ID of the region.', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'TotalInstancesCount' => [ + 'description' => 'The total number of instances.', + 'type' => 'integer', + 'example' => '3', + 'format' => 'int64', + ], + 'ImmediatelyExpiredInstancesCount' => [ + 'description' => 'The number of instances about to expire.', + 'type' => 'integer', + 'example' => '1', + 'format' => 'int64', + ], + 'RunningInstancesCount' => [ + 'description' => 'The total number of running instances.', + 'type' => 'integer', + 'example' => '1', + 'format' => 'int64', + ], + 'ExpiredInstancesCount' => [ + 'description' => 'The number of expired instances.', + 'type' => 'integer', + 'example' => '1', + 'format' => 'int64', + ], + 'RecentCreatedInstancesCount' => [ + 'description' => 'The number of recently created instances.', + 'type' => 'integer', + 'example' => '1', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"InstanceSummary\\": {\\n \\"TotalInstancesCount\\": 3,\\n \\"OverLoadInstancesCount\\": 1,\\n \\"ImmediatelyExpiredInstancesCount\\": 1,\\n \\"RunningInstancesCount\\": 1,\\n \\"InsufficientDiskInstancesCount\\": 2,\\n \\"ExpiredInstancesCount\\": 1,\\n \\"AlarmSummaryCount\\": 1,\\n \\"AnomalySQLCount\\": 1,\\n \\"ClusterInstancesCount\\": 1,\\n \\"TenantInstancesCount\\": 1,\\n \\"TotalOmsInstancesCount\\": 1,\\n \\"RegionalInstanceSummaryList\\": [\\n {\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"TotalInstancesCount\\": 3,\\n \\"ImmediatelyExpiredInstancesCount\\": 1,\\n \\"RunningInstancesCount\\": 1,\\n \\"ExpiredInstancesCount\\": 1,\\n \\"RecentCreatedInstancesCount\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeInstanceSummary', + ], + 'DescribeStandbyCreateMode' => [ + 'summary' => 'DescribeStandbyCreateMode', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群ID', + 'description' => 'The ID of the OceanBase cluster.', + 'type' => 'string', + 'required' => true, + 'example' => 'ob4wib********', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'example' => 'txxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"CreateMode\\": \\"BACKUP_RESTORE\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeStandbyCreateMode', + ], + 'DescribeTenantReadableScn' => [ + 'summary' => 'You can call this operation to query the maximum readable timestamp of a tenant.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id', + 'description' => 'The ID of the OceanBase cluster.', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户id', + 'description' => 'The ID of the tenant.', + 'type' => 'string', + 'required' => true, + 'example' => 't33h8y08k****', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8442BB1E-3171-1192-B9DC-F6F4E53B2673\\",\\n \\"Data\\": {\\n \\"ReadableScn\\": 1715329164977\\n }\\n}","type":"json"}]', + 'title' => 'DescribeTenantReadableScn', + ], + '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' => '租户名称。 长度为2~20 个字符，支持英文字母、数字和下划线，区分大小写，必须以字母或下划线开头。 不可设置为 sys。', + 'description' => 'The name of the tenant. '."\n" + .'It must start with a letter or an underscore (_), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (_). It cannot be set to sys. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pay_online', + ], + ], + [ + 'name' => 'Cpu', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户的CPU大小，单位：核数（Cores）', + 'description' => 'The number of CPU cores of the tenant. '."\n" + ."\n" + .'> <br>The CPU specification of a single tenant cannot exceed that of the corresponding cluster. <br>For example, if the specification of the cluster is 14 CPU cores and 70 GB of memory, the CPU specification of the tenant cannot exceed 14 cores. ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'Memory', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户内存大小，单位GB。', + 'description' => 'The memory size of the tenant, in GB. '."\n" + ."\n" + .'> <br>The memory size of a single tenant cannot exceed that of the corresponding cluster. <br>For example, if the specification of the cluster is 14 CPU cores and 70 GB of memory, the memory size of the tenant cannot exceed 70 GB. ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'TimeZone', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户所在时区。 详细参见：DescribeTimeZones。', + 'description' => 'The time zone of the tenant. For more information, see [DescribeTimeZones](https://www.alibabacloud.com/help/en/apsaradb-for-oceanbase/latest/api-oceanbasepro-2019-09-01-describetimezones).', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Asia/Shanghai', + ], + ], + [ + 'name' => 'TenantMode', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户模式。 当前支持Oracle模式（Oracle）、MySQL模式（MySQL） 详细参见：DescribeInstanceTenantModes。', + 'description' => 'The tenant mode. '."\n" + .'Valid values: Oracle and MySQL. '."\n" + .'For more information, see [DescribeInstanceTenantModes](https://www.alibabacloud.com/help/en/apsaradb-for-oceanbase/latest/api-oceanbasepro-2019-09-01-describeinstancetenantmodes).', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Oracle', + ], + ], + [ + 'name' => 'Charset', + 'in' => 'formData', + 'schema' => [ + 'title' => '字符集。 详细参见：DescribeCharset。', + 'description' => 'The character set. '."\n" + .'For more information, see [DescribeCharset](https://www.alibabacloud.com/help/en/apsaradb-for-oceanbase/latest/api-oceanbasepro-2019-09-01-describecharset).', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'utf8mb4', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'UserVpcId', + 'in' => 'formData', + 'schema' => [ + 'title' => '专有网络（VPC） ID。 如果没有合适的 VPC，请根据页面提示创建一个 VPC，详情参见 什么是专有网络', + 'description' => 'The ID of the VPC. '."\n" + .' If no suitable VPC is available, create a VPC as prompted. '."\n" + .'For more information, see "What is a VPC". ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-bp1d2q3mhg9i23ofi****', + ], + ], + [ + 'name' => 'UserVSwitchId', + 'in' => 'formData', + 'schema' => [ + 'title' => '虚拟交换机（VSwitch） ID。 如果没有合适的 VSwitch，请根据页面提示创建一个，详情参见 使用交换机。', + 'description' => 'The ID of the vSwitch. '."\n" + .'If no suitable vSwitch is available, create a vSwitch as prompted. '."\n" + .'For more information, see Use a vSwitch. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vsw-bp11k1aypnzu1l3whi****', + ], + ], + [ + 'name' => 'PrimaryZone', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户的主可用区。 其为集群部署可用区中的一个。', + 'description' => 'The primary zone of the tenant. '."\n" + .'It is one of the zones in which the cluster is deployed. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户描述信息。', + 'description' => 'The description of the database. ', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a test database', + ], + ], + [ + 'name' => 'UnitNum', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户的资源分布节点数。 其与集群的部署模式相耦合，如集群模式为2-2-2，则最后分布节点数最多为2个。', + 'description' => 'The number of resource distribution nodes in the tenant. '."\n" + .'The number is determined by the deployment mode of the cluster. If the cluster is deployed in 2-2-2 mode, the maximum number of resource distribution nodes is 2. ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'default' => '1', + ], + ], + [ + 'name' => 'ReadOnlyZoneList', + 'in' => 'formData', + 'schema' => [ + 'title' => 'ReadOnlyZoneList 即将下线，请勿使用，引导用户使用 ModifyTenantReadonlyReplica', + 'description' => 'Specifies to create a read-only zone. Separate the names of multiple zones with commas (,).'."\n" + .'><notice><br>At present, this parameter is unavailable.></notice>', + '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\\"}', + ], + ], + ], + [ + 'name' => 'UserVpcOwnerId', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户vpc的ownerId', + 'description' => 'The ID of the VPC owner.', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'example' => 't33h8y08k****', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TenantId\\": \\"t33h8y08k****\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => 'CreateTenant', + ], + 'CreateTenantReadOnlyConnection' => [ + 'summary' => 'You can call this operation to create a read-only address for a specified tenant. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'formData', + 'schema' => [ + 'title' => '可用区的ZoneId。 详细参见DescribeInstance中的AvailableZones。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou-i', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => [ + 'title' => '专有网络（VPC） ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'vpc-bp1d2q3mhg9i23ofi****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'formData', + 'schema' => [ + 'title' => '虚拟交换机（VSwitch）ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vsw-bp11k1aypnzu1l3whi****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateTenantReadOnlyConnectionResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</CreateTenantReadOnlyConnectionResponse>","errorExample":""}]', + 'title' => 'CreateTenantReadOnlyConnection', + ], + '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' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'SecurityIpGroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP安全白名单组的组名。 由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', + 'description' => 'The group name of the whitelist group of IP addresses.'."\n" + ."\n" + .'It starts with lowercase letters and ends with lowercase letters or numbers. It can only contain lowercase letters, numbers, and underscores, and should be 2~32 characters in length.', + 'type' => 'string', + 'required' => true, + 'example' => 'paytest', + ], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP安全白名单列表。 其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。最多可设置 40 个。', + 'description' => 'The list of IP addresses in the whitelist group.'."\n" + ."\n" + .'It is a JSON array. Each object in the array is an IP address or a CIDR block. You can have up to 40 whitelists.', + 'type' => 'string', + 'required' => true, + 'example' => '192.***.*.*"', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The returned result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'SecurityIpGroup' => [ + 'title' => '白名单分组信息。', + 'description' => 'The information of the whitelist group. ', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'example' => 't4louaeei****', + ], + 'SecurityIpGroupName' => [ + 'title' => '安全白名单分组名称。', + 'description' => 'The name of the whitelist group. ', + 'type' => 'string', + 'example' => 'paytest', + ], + 'SecurityIps' => [ + 'title' => '白名单列表。其为一个用逗号分隔的字符串，每个对象为一个IP字符串或者IP段。', + 'description' => 'The list of IP addresses in the IP address whitelist group. '."\n" + ."\n" + .'It is a string separated by commas, and each object is an IP address or CIDR block.', + 'type' => 'string', + 'example' => '192.***.*.*', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"SecurityIpGroup\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"TenantId\\": \\"t4louaeei****\\",\\n \\"SecurityIpGroupName\\": \\"paytest\\",\\n \\"SecurityIps\\": \\"[\\\\\\"192.***.*.*\\\\\\"]\\"\\n }\\n}","type":"json"}]', + 'title' => 'CreateTenantSecurityIpGroup', + ], + 'DescribeTenants' => [ + 'summary' => 'You can call this operation to query the tenants in an OceanBase cluster. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantName', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户名称。 长度为2~20 个字符，支持英文字母、数字和下划线，区分大小写，必须以字母或下划线开头。 不可设置为 sys。', + 'description' => 'The name of the tenant. '."\n" + .'It must start with a letter or an underscore (_), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (_). It cannot be set to sys. ', + 'type' => 'string', + 'required' => false, + 'example' => 'pay_online', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'description' => 'The number of rows to return on each page. '."\n" + .'- Maximum value: 100.'."\n" + .'- Default value: 10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => 'The number of the page to return. '."\n" + .'Start value: 1'."\n" + .'- Default value: 1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => false, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询列表的删选关键字。', + 'description' => 'The search keyword. ', + 'type' => 'string', + 'required' => false, + 'example' => 'pay', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '查询到的指定Oceanbase集群的租户总数。', + 'description' => 'The total number of tenants in the specified OceanBase cluster. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Tenants' => [ + 'title' => '租户的列表信息。', + 'description' => 'The information of tenants. ', + 'type' => 'array', + 'items' => [ + 'description' => 'The information of tenants. ', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'title' => '专有网络（VPC） ID。 如果没有合适的 VPC，请根据页面提示创建一个 VPC，详情参见 什么是专有网络', + 'description' => 'The ID of the VPC. <br>If no suitable VPC is available, create a VPC as prompted. For more information, see "What is a VPC". ', + 'type' => 'string', + 'example' => 'vpc-bp1d2q3mhg9i23ofi****', + ], + 'Status' => [ + 'title' => '租户的状态。 PENDING_CREATE: 创建中 RESTORE: 恢复中 ONLINE: 运行中 SPEC_MODIFYING: 规格修改中 ALLOCATING_INTERNET_ADDRESS: 公网地址分配中 PENDING_OFFLINE_INTERNET_ADDRESS: 公网地址关闭中 PRIMARY_ZONE_MODIFYING: 切主可用区中 PARAMETER_MODIFYING: 参数修改中 WHITE_LIST_MODIFING: 白名单修改中', + 'description' => 'The status of the tenant. <br>'."\n" + .'- PENDING_CREATE: The tenant is being created.'."\n" + .'- RESTORE: The tenant is being recovered.'."\n" + .'- ONLINE: The tenant is running.'."\n" + .'- SPEC_MODIFYING: The specification of the tenant is being modified.'."\n" + .'ALLOCATING_INTERNET_ADDRESS: An Internet address is being allocated.'."\n" + .'PENDING_OFFLINE_INTERNET_ADDRESS: The Internet address is being disabled.'."\n" + .'- PRIMARY_ZONE_MODIFYING: The tenant is switching to a new primary zone.'."\n" + .'- PARAMETER_MODIFYING: Parameters are being modified.'."\n" + .'- WHITE_LIST_MODIFYING: The whitelist is being modified.', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'PrimaryZone' => [ + 'title' => '租户的主可用区。', + 'description' => 'The primary zone of the tenant. ', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'DeployType' => [ + 'title' => '租户的部署类型。 multiple：多机房 single：单机房 dual：双机房', + 'description' => 'The deployment type of the tenant. <br>'."\n" + .'- multiple: multi-IDC deployment'."\n" + .'- single: single-IDC deployment'."\n" + .'- dual: dual-IDC deployment', + 'type' => 'string', + 'example' => 'multiple', + ], + 'DeployMode' => [ + 'title' => '租户的数据副本模式。 对于高可用版本：三地域为N-N-N，两可用区和单可用区均为N-N； 对于基础版为N。 其中，N为单可用区内的节点数。', + 'description' => 'The data replica distribution mode of the tenant. '."\n" + ."\n" + .'- For the high availability version, N-N-N indicates the three-zone mode, and N-N indicates the dual-zone or single-zone mode.'."\n" + .'- For the basic version, N indicates the single-zone mode. '."\n" + ."\n" + .'> <br>N represents the number of nodes in a single zone. ', + 'type' => 'string', + 'example' => '1-1-1', + ], + 'CreateTime' => [ + 'title' => '租户的创建时间。', + 'description' => 'The time when the tenant was created. ', + 'type' => 'string', + 'example' => '2021-09-17 15:52:17.0', + ], + 'TenantName' => [ + 'title' => '租户名称。', + 'description' => 'The name of the tenant. ', + 'type' => 'string', + 'example' => 'pay_online', + ], + 'Mem' => [ + 'title' => '租户总的内存大小，单位：GB。', + 'description' => 'The total memory size of the tenant, in GB. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Cpu' => [ + 'title' => '租户总的CPU核数，单位：Core。', + 'description' => 'The total number of CPU cores of the tenant. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Description' => [ + 'title' => '租户描述信息。', + 'description' => 'The description of the tenant. ', + 'type' => 'string', + 'example' => 'PayCore business database', + ], + 'TenantMode' => [ + 'title' => '租户模式。 当前支持： Oracle：Oracle模式 MySQL: MySQL模式', + 'description' => 'The tenant mode. '."\n" + .'Valid values: '."\n" + .'Oracle'."\n" + .'MySQL ', + 'type' => 'string', + 'example' => 'Oracle', + ], + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'example' => 't33h8y08k****', + ], + 'UnitCpu' => [ + 'title' => '租户每个Unit的CPU核数，单位：Core。', + 'description' => 'The number of CPU cores in each resource unit of the tenant. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'UnitMem' => [ + 'title' => '租户每个Unit的内存大小，单位：GB。', + 'description' => 'The memory size of each resource unit of the tenant, in GB. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'UnitNum' => [ + 'title' => '租户的unit个数。', + 'description' => 'The number of resource units in the tenant.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'UsedDiskSize' => [ + 'title' => '租户已使用磁盘量', + 'description' => 'The number of used disks of the tenant. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '10', + ], + 'Charset' => [ + 'title' => '字符集', + 'description' => 'The character set.', + 'type' => 'string', + 'example' => 'utf8mb4', + ], + 'Collation' => [ + 'title' => '字符序', + 'description' => 'The collation.', + 'type' => 'string', + 'example' => 'utf8mb4_general_ci', + ], + 'EnableReadOnlyReplica' => [ + 'type' => 'boolean', + 'description' => 'Indicates whether read-only replicas are supported.', + 'example' => 'true ', + ], + 'ParameterTemplate' => [ + 'title' => '参数模板', + 'description' => 'The parameter template.', + 'type' => 'string', + 'example' => 'express_oltp', + ], + 'Iops' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Tenants\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1d2q3mhg9i23ofi****\\",\\n \\"Status\\": \\"ONLINE\\",\\n \\"PrimaryZone\\": \\"cn-hangzhou-i\\",\\n \\"DeployType\\": \\"multiple\\",\\n \\"DeployMode\\": \\"1-1-1\\",\\n \\"CreateTime\\": \\"2021-09-17 15:52:17.0\\",\\n \\"TenantName\\": \\"pay_online\\",\\n \\"Mem\\": 20,\\n \\"Cpu\\": 10,\\n \\"Description\\": \\"paycore database\\",\\n \\"TenantMode\\": \\"Oracle\\",\\n \\"TenantId\\": \\"t33h8y08k****\\",\\n \\"UnitCpu\\": 5,\\n \\"UnitMem\\": 10,\\n \\"UnitNum\\": 2,\\n \\"UsedDiskSize\\": 10,\\n \\"Charset\\": \\"utf8mb4\\",\\n \\"Collation\\": \\"utf8mb4_general_ci\\",\\n \\"EnableReadOnlyReplica\\": true,\\n \\"ParameterTemplate\\": \\"express_oltp\\",\\n \\"Iops\\": 10000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeTenantsResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <Tenants>\\n <VpcId>vpc-bp1d2q3mhg9i23ofi****</VpcId>\\n <Status>ONLINE</Status>\\n <PrimaryZone>cn-hangzhou-i</PrimaryZone>\\n <DeployType>multiple</DeployType>\\n <DeployMode>1-1-1</DeployMode>\\n <CreateTime>2021-09-17 15:52:17.0</CreateTime>\\n <TenantName>pay_online</TenantName>\\n <Mem>20</Mem>\\n <Cpu>10</Cpu>\\n <Description>paycore业务数据库</Description>\\n <TenantMode>Oracle</TenantMode>\\n <TenantId>t33h8y08k****</TenantId>\\n <UnitCpu>5</UnitCpu>\\n <UnitMem>10</UnitMem>\\n <UnitNum>2</UnitNum>\\n <UsedDiskSize>10</UsedDiskSize>\\n </Tenants>\\n</DescribeTenantsResponse>","errorExample":""}]', + 'title' => 'DescribeTenants', + ], + 'DescribeInstanceTenantModes' => [ + 'summary' => 'You can call this operation to query the modes of tenants. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeInstanceTenantModes**. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'Example 1', + 'type' => 'object', + 'properties' => [ + 'InstanceModes' => [ + 'title' => '租户模式列表。Oracle，Mysql', + 'description' => ' ', + 'type' => 'array', + 'items' => [ + 'description' => 'You can call this operation to query the modes of tenants. ', + 'type' => 'string', + 'enumValueTitles' => [ + 'MySQL' => 'MySQL', + 'Oracle' => 'Oracle', + ], + 'example' => 'Oracle', + ], + 'enumValueTitles' => [], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"InstanceModes\\": [\\n \\"Oracle\\"\\n ],\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstanceTenantModesResponse>\\n <InstanceModes>Oracle</InstanceModes>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</DescribeInstanceTenantModesResponse>","errorExample":""}]', + 'title' => 'DescribeInstanceTenantModes', + ], + 'DescribeTenant' => [ + 'summary' => 'You can call this operation to query the information of a specific tenant in a specific cluster. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => ' The details of the tenant. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Tenant' => [ + 'title' => '租户信息。', + 'description' => 'The information about the tenant.', + 'type' => 'object', + 'properties' => [ + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'example' => 't4louaeei****', + ], + 'TenantName' => [ + 'title' => '租户名称。', + 'description' => 'The name of the tenant. ', + 'type' => 'string', + 'example' => 'forMySQLTenant', + ], + 'TenantMode' => [ + 'title' => '租户模式。 当前支持： Oracle：Oracle模式 MySQL: MySQL模式', + 'description' => 'The mode of the tenant.'."\n" + .'Valid values:'."\n" + .'- Oracle '."\n" + .'- MySQL', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'VpcId' => [ + 'title' => '专有网络（VPC） ID。 如果没有合适的 VPC，请根据页面提示创建一个 VPC，详情参见 什么是专有网络', + 'description' => 'The Virtual Private Cloud (VPC) ID of the tenant. If no suitable VPC is available, create a VPC as prompted. For more information, see "What is a VPC".', + 'type' => 'string', + 'example' => 'vpc-bp1d2q3mhg9i23ofi****', + ], + 'Status' => [ + 'title' => '租户的状态。 PENDING_CREATE: 创建中 RESTORE: 恢复中 ONLINE: 运行中 SPEC_MODIFYING: 规格修改中 ALLOCATING_INTERNET_ADDRESS: 公网地址分配中 PENDING_OFFLINE_INTERNET_ADDRESS: 公网地址关闭中 PRIMARY_ZONE_MODIFYING: 切主可用区中 PARAMETER_MODIFYING: 参数修改中 WHITE_LIST_MODIFING: 白名单修改中', + 'description' => 'The status of the tenant.'."\n" + ."\n" + .'- ONLINE: The tenant is running.'."\n" + ."\n" + .'- PENDING_CREATE: The tenant is being created.'."\n" + ."\n" + .'- WAITING_ALLOCATE_MASTER_ADDRESS: The standby cluster is waiting for the primary address to be created.'."\n" + ."\n" + .'- ALLOCATING_MASTER_ADDRESS: The primary address is being created.'."\n" + ."\n" + .'- DELETING_MASTER_ADDRESS: The primary address is being deleted.'."\n" + ."\n" + .'- ALLOCATING_INTERNET_ADDRESS: The Internet address is being created.'."\n" + ."\n" + .'- PENDING_OFFLINE_INTERNET_ADDRESS: The Internet address is being deleted.'."\n" + ."\n" + .'- ALLOCATING_READONLY_ADDRESS: The read-only address is being created.'."\n" + ."\n" + .'- DELETING_READONLY_ADDRESS: The read-only address is being deleted.'."\n" + ."\n" + .'- ALLOCATING_READWRITE_ADDRESS: The read/write splitting address is being created.'."\n" + ."\n" + .'- DELETING_READWRITE_ADDRESS: The read/write splitting address is being deleted.'."\n" + ."\n" + .'- ALLOCATING_CLOGSERVICE_ADDRESS: The clog address is being created.'."\n" + ."\n" + .'- DELETING_CLOGSERVICE_ADDRESS: The clog address is being deleted.'."\n" + ."\n" + .'- MODIFYING_ADDRESS: The domain name of the address is being modified.'."\n" + ."\n" + .'- MODIFYING_PRIMARY_ZONE: The primary zone is being switched.'."\n" + ."\n" + .'- MODIFYING_READONLY_ADDRESS: The read-only address is being modified.'."\n" + ."\n" + .'- MODIFYING_READWRITE_ADDRESS: The read/write splitting address is being modified.'."\n" + ."\n" + .'- SPEC_MODIFYING: The specifications of the tenant are being modified.'."\n" + ."\n" + .'- WHITE_LIST_MODIFYING: The allowlist is being modified.'."\n" + ."\n" + .'- CREATING_BINLOG: Binlogs are being created.', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'EnableInternetAddressService' => [ + 'title' => '是否可开启租户公网地址。', + 'description' => 'Indicates whether the Internet address can be enabled for the tenant. ', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PrimaryZone' => [ + 'title' => '租户的主可用区。', + 'description' => 'The primary zone of the tenant. ', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'DeployType' => [ + 'title' => '集群的部署类型。 multiple：多机房 single：单机房 dual：双机房', + 'description' => 'The deployment type of the cluster. Valid values: '."\n" + .'- multiple: multi-IDC deployment '."\n" + .'- single: single-IDC deployment '."\n" + .'- dual: dual-IDC deployment ', + 'type' => 'string', + 'example' => 'multiple', + ], + 'DeployMode' => [ + 'title' => '租户的数据副本模式。 对于高可用版本：三地域为N-N-N，两可用区和单可用区均为N-N； 对于基础版为N。 其中，N为单可用区内的节点数。', + 'description' => 'The data replica distribution mode of the tenant. '."\n" + ."\n" + .'- For the high availability version, N-N-N indicates the three-zone mode, and N-N indicates the dual-zone or single-zone mode.'."\n" + .'- For the basic version, N indicates the single-zone mode. '."\n" + ."\n" + .'> <br>N represents the number of nodes in a single zone. ', + 'type' => 'string', + 'example' => '1-1-1', + ], + 'Description' => [ + 'title' => '租户描述信息。', + 'description' => 'The description of the tenant. ', + 'type' => 'string', + 'example' => 'paycore database', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the tenant was created. ', + 'type' => 'string', + 'example' => '2023-04-21 11:15:47.0', + ], + 'TenantResource' => [ + 'title' => '租户的资源信息。', + 'description' => 'The resource information of the tenant. ', + 'type' => 'object', + 'properties' => [ + 'UnitNum' => [ + 'title' => '租户的unit个数。', + 'description' => 'The number of resource units for the tenant.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Cpu' => [ + 'title' => '租户的CPU资源信息。', + 'description' => 'The information about the CPU resources of the tenant.', + 'type' => 'object', + 'properties' => [ + 'UsedCpu' => [ + 'title' => '租户已使用的CPU核数，单位：Core。', + 'description' => 'The number of used CPU cores of the tenant. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '8', + ], + 'TotalCpu' => [ + 'title' => '租户总的CPU核数，单位：Core。', + 'description' => 'The total number of CPU cores of the tenant. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'UnitCpu' => [ + 'title' => '租户每个Unit的CPU核数，单位：Core。', + 'description' => 'The number of CPU cores in each resource unit of the tenant. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '8', + ], + ], + ], + 'Memory' => [ + 'title' => '租户内存资源信息。', + 'description' => 'The information about the memory resources of the tenant. ', + 'type' => 'object', + 'properties' => [ + 'UsedMemory' => [ + 'title' => '租户已使用的内存，单位：GB。', + 'description' => 'The size of used memory of the tenant, in GB. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '30', + ], + 'TotalMemory' => [ + 'title' => '租户总的内存大小，单位：GB。', + 'description' => 'The total memory size of the tenant, in GB. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '64', + ], + 'UnitMemory' => [ + 'title' => '租户每个Unit的内存大小，单位：GB。', + 'description' => 'The memory size of each resource unit of the tenant, in GB. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '32', + ], + ], + ], + 'DiskSize' => [ + 'title' => '租户磁盘资源信息。', + 'description' => 'The information about the disk resources of the tenant. ', + 'type' => 'object', + 'properties' => [ + 'UsedDiskSize' => [ + 'title' => '租户已使用的磁盘大小，单位：GB。', + 'description' => 'The size of used disk space of the tenant, in GB. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '86', + ], + ], + ], + 'CapacityUnit' => [ + 'title' => '容量单元', + 'description' => 'The information about capacity units.', + 'type' => 'object', + 'properties' => [ + 'MaxCapacityUnit' => [ + 'title' => '最大容量单元', + 'description' => 'The maximum number of capacity units.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'MinCapacityUnit' => [ + 'title' => '最小容量单元', + 'description' => 'The minimum number of capacity units.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'UsedCapacit' => [ + 'title' => '已使用容量单元', + 'description' => 'The number of used capacity units.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'LogDiskSize' => [ + 'description' => 'The information about the log disk resources of the tenant.', + 'type' => 'object', + 'properties' => [ + 'TotalLogDisk' => [ + 'description' => 'The total size of log disk of the tenant, in GB.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8.0', + ], + 'UnitLogDisk' => [ + 'description' => 'The log disk size of each resource unit of the tenant, in GB.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8.0', + ], + ], + ], + ], + ], + 'TenantConnections' => [ + 'title' => '租户的连接访问信息。', + 'description' => 'The connection information of the tenant.', + 'type' => 'array', + 'items' => [ + 'description' => 'The connection information of the tenant. ', + 'type' => 'object', + 'properties' => [ + 'IntranetAddress' => [ + 'title' => '访问租户的私网连接地址。', + 'description' => 'The intranet address for accessing the tenant. ', + 'type' => 'string', + 'example' => 't4nunwxr0****.oceanbase.aliyuncs.com', + ], + 'IntranetPort' => [ + 'title' => '访问租户的私网连接端口。', + 'description' => 'The intranet port for accessing the tenant. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2983', + ], + 'InternetAddress' => [ + 'title' => '访问租户的公网连接地址。', + 'description' => 'The Internet address for accessing the tenant. ', + 'type' => 'string', + 'example' => 't32a7ru5u****mo.oceanbase.aliyuncs.com', + ], + 'InternetPort' => [ + 'title' => '访问租户的公网连接端口。', + 'description' => 'The Internet port for accessing the tenant. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3306', + ], + 'VpcId' => [ + 'title' => '专有网络（VPC） ID。', + 'description' => 'The ID of the VPC. ', + 'type' => 'string', + 'example' => 'vpc-bp1qiail1asmfe23t****', + ], + 'VSwitchId' => [ + 'title' => '虚拟交换机（VSwitch） ID。', + 'description' => 'The ID of the vSwitch. ', + 'type' => 'string', + 'example' => 'vsw-bp1i7b94u2et716yl****', + ], + 'IntranetAddressMasterZoneId' => [ + 'title' => '访问租户的连接地址对应的主可用区。', + 'description' => 'The primary zone corresponding to the address for accessing the tenant. ', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'IntranetAddressSlaveZoneId' => [ + 'title' => '访问租户的连接地址对应的备可用区。', + 'description' => 'The standby zone corresponding to the address for accessing the tenant. ', + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + ], + 'IntranetAddressStatus' => [ + 'title' => '访问租户的私网连接地址状态。 ONLINE: 服务中', + 'description' => 'The status of the intranet address for accessing the tenant. '."\n" + .'The value ONLINE indicates that the address is in service. ', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'ConnectionZones' => [ + 'title' => '租户连接对应的访问可用区列表。', + 'description' => 'The list of zones corresponding to the tenant connection. ', + 'type' => 'array', + 'items' => [ + 'description' => 'The zone corresponding to the tenant connection. ', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'example' => '["cn-hangzhou-i", "cn-hangzhou-j"]', + ], + 'InternetAddressStatus' => [ + 'title' => '访问租户的公网连接开通状态。 CLOSED：关闭 ALLOCATING_INTERNET_ADDRESS：申请中 PENDING_OFFLINE_INTERNET_ADDRESS: 公网地址关闭中 ONLINE：服务中', + 'description' => 'The status of the Internet address for accessing the tenant. Valid values: '."\n" + .'- CLOSED: The address is disabled. '."\n" + .'- ALLOCATING_INTERNET_ADDRESS: An address is being applied for. '."\n" + .'- PENDING_OFFLINE_INTERNET_ADDRESS: The address is being disabled. '."\n" + .'- ONLINE: The address is in service.', + 'type' => 'string', + 'example' => 'CLOSED', + ], + 'TransactionSplit' => [ + 'title' => '是否开启事务拆分', + 'description' => 'Specifies whether to enable transaction splitting.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'AddressType' => [ + 'title' => '地址类型', + 'description' => 'The type of the address.'."\n" + ."\n" + .'- MASTER: the primary address, which supports both data read and write.'."\n" + .'- READONLY: a read-only address.'."\n" + .'- READWRITE: a read/write splitting address.'."\n" + .'- CLOGSERVICE: a clog service address.', + 'type' => 'string', + 'enumValueTitles' => [ + 'MASTER' => 'MASTER', + 'READWRITE' => 'READWRITE', + 'CLOGSERVICE' => 'CLOGSERVICE', + 'READONLY' => 'READONLY', + ], + 'example' => 'READONLY', + ], + 'EnableTransactionSplit' => [ + 'title' => '是否开启事务拆分', + 'description' => 'Specifies whether to enable transaction splitting.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ParallelQueryDegree' => [ + 'title' => '并行度', + 'description' => 'The degree of parallelism (DOP).', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'default' => '2', + ], + 'TenantEndpointId' => [ + 'title' => '租户地址id', + 'description' => 'The ID of the tenant endpoint.', + 'type' => 'string', + 'example' => 'obe-4tw51gp7****', + ], + 'MaxConnectionNum' => [ + 'title' => '最大连接数', + 'description' => 'The maximum number of connections.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5000', + ], + 'ConnectionReplicaType' => [ + 'title' => '链接对应的副本类型', + 'description' => 'The type of the replica corresponding to the tenant connection.', + 'type' => 'string', + 'example' => 'FULL', + ], + 'ProxyClusterId' => [ + 'description' => 'The ID of the OceanBase Database Proxy (ODP) cluster.', + 'type' => 'string', + 'example' => 'proxy-xxxxxxx', + ], + 'MaxConnectionLimit' => [ + 'title' => '私网最大连接数的当前值', + 'description' => 'The current value set for the maximum number of private connections.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'InternetMaxConnectionLimit' => [ + 'title' => '公网最大连接数的上限', + 'description' => 'The upper limit of the maximum number of public connections.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4000', + ], + 'IntranetRpcPort' => [ + 'description' => 'The port for direct loads of private connections.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3307'."\n", + ], + 'InternetMaxConnectionNum' => [ + 'title' => '公网最大连接数的当前值', + 'description' => 'The current value set for the maximum number of public connections.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2500', + ], + 'InternetRpcPort' => [ + 'description' => 'The port for direct loads of public connections.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3307', + ], + 'ConnectionLogicalZones' => [ + 'description' => 'The logical zones of the endpoints.', + 'type' => 'array', + 'items' => [ + 'description' => 'The logical zones of the endpoints.', + 'type' => 'string', + 'example' => 'cn-bejing-3-z0,cn-bejing-4-z0', + ], + ], + 'IntranetSqlPort' => [ + 'description' => 'The port of private SQL connections.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3306', + 'title' => "\n", + ], + 'OdpVersion' => [ + 'description' => 'The ODP version.', + 'type' => 'string', + 'example' => '4.3.1-xxxxxxxxx', + ], + 'InternetSqlPort' => [ + 'title' => '公网sql端口', + 'type' => 'integer', + 'format' => 'int32', + ], + 'InternetAddressServiceType' => [ + 'title' => '公网地址地址类型', + 'type' => 'string', + ], + 'IntranetAddressServiceType' => [ + 'title' => '私网地址地址类型', + 'type' => 'string', + ], + ], + ], + ], + 'TenantZones' => [ + 'title' => '租户可用区信息。', + 'description' => 'The information about zones in the tenant.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about zones in the tenant.', + 'type' => 'object', + 'properties' => [ + 'TenantZoneId' => [ + 'title' => '租户可用区ID。', + 'description' => 'The ID of the zone. ', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'Region' => [ + 'title' => '租户可用区所属的地域。', + 'description' => 'The region where the zone of the tenant resides. ', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'TenantZoneRole' => [ + 'title' => '租户可用区的请求类型。 ReadWrite：可读可写 ReadOnly：只读 对于多机房高可用集群，其主可用区为ReadWrite。备可用区为ReadOnly; 对于单机房高可用集群，其所有可用区均为ReadWrite。', + 'description' => 'The role of the zone of the tenant. ', + 'type' => 'string', + 'example' => 'ReadWrite', + ], + 'TenantZoneReplicas' => [ + 'description' => 'The zone replicas of the tenant.', + 'type' => 'array', + 'items' => [ + 'description' => 'The zone replicas of the tenant.', + 'type' => 'object', + 'properties' => [ + 'ZoneReplicaType' => [ + 'description' => 'The type of the zone replica.', + 'type' => 'string', + 'example' => 'FULL', + ], + 'ZoneNodes' => [ + 'description' => 'The number of nodes in the zone.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'LogicZoneName' => [ + 'description' => 'The name of the logical zone.', + 'type' => 'string', + 'example' => 'cn-shanghai-f-z0', + ], + 'ZoneCopyId' => [ + 'description' => 'The ID of the zone replica.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'FullCopyId' => [ + 'description' => 'The ID of the full-featured replica.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ReadOnlyCopyId' => [ + 'description' => 'The ID of the read-only replica.', + 'type' => 'string', + 'example' => '3', + ], + 'ReadOnlyReplicaType' => [ + 'description' => 'The type of the read-only replica.', + 'type' => 'string', + 'example' => 'ROW_STORE', + ], + ], + ], + ], + ], + ], + ], + 'ClogServiceStatus' => [ + 'title' => 'Clog服务开启状态。 CLOSED: 关闭 ONLINE：服务中', + 'description' => 'The enabling status of the clog service. '."\n" + .'- CLOSED: The clog service is disabled. '."\n" + .'- ONLINE: The clog service is running.', + 'type' => 'string', + 'example' => 'CLOSED', + ], + 'EnableClogService' => [ + 'title' => '是否可使用Clog服务，如需开启，请工单联系。', + 'description' => 'Indicates whether the clog service is available. To enable the clog service, submit a ticket.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Charset' => [ + 'title' => '字符集', + 'description' => 'The character set.', + 'type' => 'string', + 'example' => 'utf8mb4', + ], + 'Collation' => [ + 'title' => '字符序', + 'description' => 'The collation.', + 'type' => 'string', + 'example' => 'utf8mb4_general_ci', + ], + 'PrimaryZoneDeployType' => [ + 'title' => '租户主可用区部署模式', + 'description' => 'The deployment type of the primary zone.', + 'type' => 'string', + 'enumValueTitles' => [ + 'RANDOM' => 'RANDOM', + 'STATIC' => 'STATIC', + ], + 'example' => 'RANDOM', + ], + 'MasterIntranetAddressZone' => [ + 'title' => '租户主地址可用区', + 'description' => 'The zone where the primary node is located.', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'PayType' => [ + 'title' => '付费类型', + 'description' => 'The type of the payment.', + 'type' => 'string', + 'example' => 'POSTPAY', + ], + 'InstanceType' => [ + 'title' => '实例类型', + 'description' => 'The type of the instance.', + 'type' => 'string', + 'example' => 'KAFKA_PUBLIC', + ], + 'Series' => [ + 'title' => '实例系列', + 'description' => 'The series of the instance.', + 'type' => 'string', + 'example' => 'normal', + ], + 'DiskType' => [ + 'title' => '磁盘类型', + 'description' => 'The type of the disk.', + 'type' => 'string', + 'example' => 'cloud_essd_pl1', + ], + 'AvailableZones' => [ + 'title' => '可用区', + 'description' => 'The list of zones.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of zones.', + 'type' => 'string', + 'example' => '["cn-hangzhou-i"]', + ], + ], + 'EnableReadWriteSplit' => [ + 'title' => '是否允许开启读写分离地址', + 'description' => 'Indicates whether to enable read/write splitting endpoint.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'EnableParallelQuery' => [ + 'title' => '是否允许开通并行查询', + 'description' => 'Indicates whether parallel query can be enabled.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MaxParallelQueryDegree' => [ + 'title' => '并行度设置上限', + 'description' => 'The maximum value of DOP.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + 'EnableBinlogService' => [ + 'title' => '是否可以申请Binlog服务', + 'description' => 'Indicates whether the binlog service is available for application.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TimeZone' => [ + 'title' => '租户所在时区。 详细参见：DescribeTimeZones。', + 'description' => 'The time zone.', + 'type' => 'string', + 'example' => 'Asia/Shanghai', + ], + 'DataMergeTime' => [ + 'title' => '租户合并时间，仅对4.0以上OB版本有效', + 'description' => 'The major compaction time of the tenant. This parameter is supported only in OceanBase Database V4.0.0 and later.', + 'type' => 'string', + 'example' => '02:36Z', + ], + 'ReadOnlyResource' => [ + 'description' => 'The information about read-only resources.', + 'type' => 'object', + 'properties' => [ + 'UnitNum' => [ + 'title' => '租户的unit个数。', + 'description' => 'The number of resource units in the tenant.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Cpu' => [ + 'description' => 'The number of CPU cores of each replica node in the cluster.', + 'type' => 'object', + 'properties' => [ + 'UsedCpu' => [ + 'description' => 'The number of CPU cores used by the cluster.', + 'type' => 'number', + 'format' => 'float', + 'example' => '8', + ], + 'TotalCpu' => [ + 'title' => '租户总的CPU核数，单位：Core。', + 'description' => 'The total number of CPU cores of the tenant.', + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'UnitCpu' => [ + 'title' => '租户每个Unit的CPU核数，单位：Core。', + 'description' => 'The number of CPU cores in each resource unit of the tenant.', + 'type' => 'number', + 'format' => 'float', + 'example' => '8', + ], + ], + ], + 'Memory' => [ + 'description' => 'The information about the memory resources of the cluster.', + 'type' => 'object', + 'properties' => [ + 'UsedMemory' => [ + 'title' => '租户已使用的内存，单位：GB。', + 'description' => 'The size of memory used by the tenant, in GB.', + 'type' => 'number', + 'format' => 'float', + 'example' => '30', + ], + 'TotalMemory' => [ + 'title' => '租户总的内存大小，单位：GB。', + 'description' => 'The total memory size of the tenant, in GB.', + 'type' => 'number', + 'format' => 'float', + 'example' => '64', + ], + 'UnitMemory' => [ + 'title' => '租户每个Unit的内存大小，单位：GB。', + 'description' => 'The memory size of each resource unit of the tenant, in GB.', + 'type' => 'number', + 'format' => 'float', + 'example' => '32', + ], + ], + ], + 'DiskSize' => [ + 'description' => 'The size of the data disk.', + 'type' => 'object', + 'properties' => [ + 'UsedDiskSize' => [ + 'title' => '租户已使用的磁盘大小，单位：GB。', + 'description' => 'The size of disk space used by the tenant, in GB.', + 'type' => 'number', + 'format' => 'float', + 'example' => '86', + ], + ], + ], + 'CapacityUnit' => [ + 'description' => 'The information about capacity units.', + 'type' => 'object', + 'properties' => [ + 'MaxCapacityUnit' => [ + 'title' => '最大容量单元', + 'description' => 'The maximum number of capacity units.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'MinCapacityUnit' => [ + 'title' => '最小容量单元', + 'description' => 'The minimum number of capacity units.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'UsedCapacit' => [ + 'title' => '已使用容量单元', + 'description' => 'The number of used capacity units.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'LogDiskSize' => [ + 'description' => 'The information about the log disk resources of the tenant.', + 'type' => 'object', + 'properties' => [ + 'TotalLogDisk' => [ + 'description' => 'The total log disk size of the tenant, in GB.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8.0', + ], + 'UnitLogDisk' => [ + 'description' => 'The log disk size of each resource unit of the tenant, in GB.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8.0', + ], + ], + ], + ], + ], + 'EnableReadOnlyReplica' => [ + 'description' => 'Indicates whether read-only replicas are supported.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RecycleBinStatus' => [ + 'title' => '表示租户回收站状态，ON表示开启，OFF表示关闭', + 'description' => 'The status of the recycle bin in the tenant. Valid values: '."\n" + .'* ON: The recycly bin is enabled. '."\n" + .'* OFF: The recycle bin is disabled.', + 'type' => 'string', + 'example' => 'ON', + ], + 'LowerCaseTableNames' => [ + 'description' => 'Indicates whether the table name is case-sensitive. Valid values: '."\n" + .'* **1**: The table name is case-insensitive. '."\n" + .'* **0**: The table name is case-sensitive.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Version' => [ + 'title' => '版本信息', + 'description' => 'The version information.', + 'type' => 'string', + 'example' => '4.2.1', + ], + 'OdpVersion' => [ + 'description' => 'The ODP version.', + 'type' => 'string', + 'example' => '4.3.1-xxxxxxxxx', + ], + 'TenantMaxConnections' => [ + 'title' => '租户允许的最大连接数', + 'description' => 'The maximum number of connections allowed in the tenant.', + 'type' => 'integer', + 'example' => '1600', + 'format' => 'int64', + ], + 'ParameterTemplate' => [ + 'title' => '参数模板', + 'description' => 'The parameter template.', + 'type' => 'string', + 'example' => 'express_oltp', + ], + 'Iops' => [ + 'title' => '租户IOPS', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Tenant\\": {\\n \\"TenantId\\": \\"t4louaeei****\\",\\n \\"TenantName\\": \\"forMySQLTenant\\",\\n \\"TenantMode\\": \\"MySQL\\",\\n \\"VpcId\\": \\"vpc-bp1d2q3mhg9i23ofi****\\",\\n \\"Status\\": \\"ONLINE\\",\\n \\"EnableInternetAddressService\\": true,\\n \\"PrimaryZone\\": \\"cn-hangzhou-h\\",\\n \\"DeployType\\": \\"multiple\\",\\n \\"DeployMode\\": \\"FULL{1}@cn-hangzhou-h,FULL{1}@cn-hangzhou-i,FULL{1}@cn-hangzhou-j\\",\\n \\"Description\\": \\"paycore database\\",\\n \\"CreateTime\\": \\"2023-04-21 11:15:47.0\\",\\n \\"TenantResource\\": {\\n \\"UnitNum\\": 1,\\n \\"Cpu\\": {\\n \\"UsedCpu\\": 8,\\n \\"TotalCpu\\": 10,\\n \\"UnitCpu\\": 8\\n },\\n \\"Memory\\": {\\n \\"UsedMemory\\": 30,\\n \\"TotalMemory\\": 64,\\n \\"UnitMemory\\": 32\\n },\\n \\"DiskSize\\": {\\n \\"UsedDiskSize\\": 86\\n },\\n \\"CapacityUnit\\": {\\n \\"MaxCapacityUnit\\": 16,\\n \\"MinCapacityUnit\\": 1,\\n \\"UsedCapacit\\": 5\\n },\\n \\"LogDiskSize\\": {\\n \\"TotalLogDisk\\": 8,\\n \\"UnitLogDisk\\": 8\\n }\\n },\\n \\"TenantConnections\\": [\\n {\\n \\"IntranetAddress\\": \\"t4nunwxr0****.oceanbase.aliyuncs.com\\",\\n \\"IntranetPort\\": 2983,\\n \\"InternetAddress\\": \\"t4nunwxr0****-mi.oceanbase.aliyuncs.com\\",\\n \\"InternetPort\\": 3306,\\n \\"VpcId\\": \\"vpc-bp1qiail1asmfe23t****\\",\\n \\"VSwitchId\\": \\"vsw-bp1i7b94u2et716yl****\\",\\n \\"IntranetAddressMasterZoneId\\": \\"cn-hangzhou-b\\",\\n \\"IntranetAddressSlaveZoneId\\": \\"cn-hangzhou-g\\",\\n \\"IntranetAddressStatus\\": \\"ONLINE\\",\\n \\"ConnectionZones\\": [\\n \\"cn-hangzhou-b\\"\\n ],\\n \\"InternetAddressStatus\\": \\"CLOSED\\",\\n \\"TransactionSplit\\": false,\\n \\"AddressType\\": \\"READONLY\\",\\n \\"EnableTransactionSplit\\": false,\\n \\"ParallelQueryDegree\\": 1,\\n \\"TenantEndpointId\\": \\"obe-4tw51gp7****\\",\\n \\"MaxConnectionNum\\": 5000,\\n \\"ConnectionReplicaType\\": \\"FULL\\",\\n \\"ProxyClusterId\\": \\"proxy-xxxxxxx\\",\\n \\"MaxConnectionLimit\\": 1000,\\n \\"InternetMaxConnectionLimit\\": 4000,\\n \\"IntranetRpcPort\\": 3307,\\n \\"InternetMaxConnectionNum\\": 2500,\\n \\"InternetRpcPort\\": 3307,\\n \\"ConnectionLogicalZones\\": [\\n \\"cn-bejing-3-z0,cn-bejing-4-z0\\"\\n ],\\n \\"IntranetSqlPort\\": 3306,\\n \\"OdpVersion\\": \\"4.3.1-xxxxxxxxx\\",\\n \\"InternetSqlPort\\": 0,\\n \\"InternetAddressServiceType\\": \\"\\",\\n \\"IntranetAddressServiceType\\": \\"\\"\\n }\\n ],\\n \\"TenantZones\\": [\\n {\\n \\"TenantZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"TenantZoneRole\\": \\"ReadWrite\\",\\n \\"TenantZoneReplicas\\": [\\n {\\n \\"ZoneReplicaType\\": \\"FULL\\",\\n \\"ZoneNodes\\": 1,\\n \\"LogicZoneName\\": \\"cn-shanghai-f-z0\\",\\n \\"ZoneCopyId\\": 2,\\n \\"FullCopyId\\": 3,\\n \\"ReadOnlyCopyId\\": \\"3\\",\\n \\"ReadOnlyReplicaType\\": \\"ROW_STORE\\"\\n }\\n ]\\n }\\n ],\\n \\"ClogServiceStatus\\": \\"ONLINE\\",\\n \\"EnableClogService\\": true,\\n \\"Charset\\": \\"gb18030\\",\\n \\"Collation\\": \\"gb18030_chinese_ci\\",\\n \\"PrimaryZoneDeployType\\": \\"STATIC\\",\\n \\"MasterIntranetAddressZone\\": \\"cn-hangzhou-h\\",\\n \\"PayType\\": \\"POSTPAY\\",\\n \\"InstanceType\\": \\"KAFKA_PUBLIC\\",\\n \\"Series\\": \\"normal\\",\\n \\"DiskType\\": \\"cloud_essd_pl1\\",\\n \\"AvailableZones\\": [\\n \\"[\\\\\\"cn-hangzhou-i\\\\\\"]\\"\\n ],\\n \\"EnableReadWriteSplit\\": true,\\n \\"EnableParallelQuery\\": true,\\n \\"MaxParallelQueryDegree\\": 32,\\n \\"EnableBinlogService\\": true,\\n \\"TimeZone\\": \\"Asia/Shanghai\\",\\n \\"DataMergeTime\\": \\"02:36Z\\",\\n \\"ReadOnlyResource\\": {\\n \\"UnitNum\\": 2,\\n \\"Cpu\\": {\\n \\"UsedCpu\\": 8,\\n \\"TotalCpu\\": 10,\\n \\"UnitCpu\\": 8\\n },\\n \\"Memory\\": {\\n \\"UsedMemory\\": 30,\\n \\"TotalMemory\\": 64,\\n \\"UnitMemory\\": 32\\n },\\n \\"DiskSize\\": {\\n \\"UsedDiskSize\\": 86\\n },\\n \\"CapacityUnit\\": {\\n \\"MaxCapacityUnit\\": 16,\\n \\"MinCapacityUnit\\": 1,\\n \\"UsedCapacit\\": 5\\n },\\n \\"LogDiskSize\\": {\\n \\"TotalLogDisk\\": 8,\\n \\"UnitLogDisk\\": 8\\n }\\n },\\n \\"EnableReadOnlyReplica\\": true,\\n \\"RecycleBinStatus\\": \\"ON\\",\\n \\"LowerCaseTableNames\\": 1,\\n \\"Version\\": \\"4.2.1\\",\\n \\"OdpVersion\\": \\"4.3.1-xxxxxxxxx\\",\\n \\"TenantMaxConnections\\": 1600,\\n \\"ParameterTemplate\\": \\"express_oltp\\",\\n \\"Iops\\": 10000\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeTenantResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <Tenant>\\n <TenantId>t33h8y08k****</TenantId>\\n <TenantName>pay_online</TenantName>\\n <TenantMode>Oracle</TenantMode>\\n <VpcId>vpc-bp1d2q3mhg9i23ofi****</VpcId>\\n <Status>ONLINE</Status>\\n <PrimaryZone>cn-hangzhou-i</PrimaryZone>\\n <DeployType>multiple</DeployType>\\n <DeployMode>1-1-1</DeployMode>\\n <Description>paycore 业务数据库</Description>\\n <CreateTime>2021-09-17 15:52:17</CreateTime>\\n <TenantResource>\\n <UnitNum>1</UnitNum>\\n <Cpu>\\n <UsedCpu>8</UsedCpu>\\n <TotalCpu>10</TotalCpu>\\n <UnitCpu>8</UnitCpu>\\n </Cpu>\\n <Memory>\\n <UsedMemory>30</UsedMemory>\\n <TotalMemory>64</TotalMemory>\\n <UnitMemory>32</UnitMemory>\\n </Memory>\\n <DiskSize>\\n <UsedDiskSize>86</UsedDiskSize>\\n </DiskSize>\\n </TenantResource>\\n <TenantConnections>\\n <ConnectionRole>ReadWrite</ConnectionRole>\\n <IntranetAddress>t32a7ru5u****.oceanbase.aliyuncs.com</IntranetAddress>\\n <IntranetPort>3306</IntranetPort>\\n <InternetAddress>t32a7ru5u****mo.oceanbase.aliyuncs.com</InternetAddress>\\n <InternetPort>3306</InternetPort>\\n <VpcId>vpc-bp1qiail1asmfe23t****</VpcId>\\n <VSwitchId>vsw-bp11k1aypnzu1l3whi****</VSwitchId>\\n <IntranetAddressMasterZoneId>cn-hangzhou-i</IntranetAddressMasterZoneId>\\n <IntranetAddressSlaveZoneId>cn-hangzhou-j</IntranetAddressSlaveZoneId>\\n <IntranetAddressStatus>ONLINE</IntranetAddressStatus>\\n <ConnectionZones>cn-hangzhou-i</ConnectionZones>\\n <InternetAddressStatus>CLOSED</InternetAddressStatus>\\n </TenantConnections>\\n <TenantZones>\\n <TenantZoneId>cn-hangzhou-i</TenantZoneId>\\n <Region>cn-hangzhou</Region>\\n <TenantZoneRole>ReadOnly</TenantZoneRole>\\n </TenantZones>\\n <ClogServiceStatus>CLOSED</ClogServiceStatus>\\n </Tenant>\\n</DescribeTenantResponse>","errorExample":""}]', + 'title' => 'DescribeTenant', + ], + 'DescribeAvailableCpuResource' => [ + 'summary' => 'You can call this operation to query the CPU resources available for a tenant. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The CPU resources available. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeAvailableCpuResource**. ', + 'type' => 'string', + 'required' => false, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户权限修改类型。 可支持以下几种方式： update：全量更新权限，默认值； add：新增权限； delete：删除权限。 默认值：update。', + 'description' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DescribeAvailableCpuResource'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&TenantId=ob2mr3oae0****'."\n" + .'&ModifyType=update'."\n" + .'&Common request parameters'."\n" + .'```', + 'type' => 'string', + 'required' => false, + 'example' => 'update', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'You can call this operation to query the CPU resources available for a tenant. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Data' => [ + 'title' => '可用的CPU资源信息。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'XXXX', + 'type' => 'object', + 'properties' => [ + 'UnitNum' => [ + 'title' => 'unit数量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'MinCpu' => [ + 'title' => '单个unit最小需要申请的CPU核数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'MaxCpu' => [ + 'title' => '单个unit最大可申请的CPU核数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'ReviewCode' => [ + 'title' => 'unitnum变更检查结果', + 'type' => 'string', + 'example' => 'UnitNum.Change.Accept', + 'enum' => [ + 'UnitNum.Change.Accept', + 'UnitNum.Change.Reject', + 'UnitNum.Change.NotRecommend', + ], + ], + 'Comment' => [ + 'title' => '建议', + 'type' => 'string', + 'example' => 'UnitNum.RejectComment.Storage', + 'enum' => [ + 'UnitNum.RejectComment.Storage', + 'UnitNum.NotRecommendComment.Storage', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"UnitNum\\": 2,\\n \\"MinCpu\\": 2,\\n \\"MaxCpu\\": 10,\\n \\"ReviewCode\\": \\"UnitNum.Change.Accept\\",\\n \\"Comment\\": \\"UnitNum.RejectComment.Storage\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeAvailableCpuResourceResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <Data>\\n <UnitNum>2</UnitNum>\\n <MinCpu>2</MinCpu>\\n <MaxCpu>10</MaxCpu>\\n </Data>\\n</DescribeAvailableCpuResourceResponse>","errorExample":""}]', + 'title' => 'DescribeAvailableCpuResource', + ], + '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' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => false, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'UnitNum', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户的资源分布节点数。 其与集群的部署模式相耦合，如集群模式为2-2-2，则最后分布节点数最多为2个。', + 'description' => 'The number of resource distribution nodes in the tenant. '."\n" + .'The number is determined by the deployment mode of the cluster. If the cluster is deployed in 2-2-2 mode, the maximum number of resource distribution nodes is 2. ', + 'type' => 'integer', + 'format' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'title' => '可用的内存资源信息。', + 'description' => 'The available memory size. ', + 'type' => 'object', + 'properties' => [ + 'MinMem' => [ + 'title' => '单个unit最小需要申请的内存大小，单位：GB。', + 'description' => 'The minimum memory size required for each resource unit, in GB. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'MaxMem' => [ + 'title' => '单个unit最大可申请的内存大小，单位：GB。', + 'description' => 'The maximum memory size for each resource unit, in GB. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'UsedMem' => [ + 'title' => '租户的unit个数。', + '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' => '', + ], + ], + ], + ], + ], + '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":"<DescribeAvailableMemResourceResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <Data>\\n <MinMem>5</MinMem>\\n <MaxMem>10</MaxMem>\\n <UsedMem>2</UsedMem>\\n </Data>\\n</DescribeAvailableMemResourceResponse>","errorExample":""}]', + 'title' => 'DescribeAvailableMemResource', + ], + 'DescribeCharset' => [ + 'summary' => 'You can call this operation to query the character set of an OceanBase Database tenant. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TenantMode', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户模式。 当前支持Oracle模式（Oracle）、MySQL模式（MySQL） 详细参见：DescribeInstanceTenantModes。', + 'description' => 'The return result of the request.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Oracle', + 'enum' => [ + 'MySQL', + 'Oracle', + ], + ], + ], + [ + 'name' => 'Series', + 'in' => 'formData', + 'schema' => [ + 'title' => '实例的系列 - normal（默认）：标准集群版（云盘） - normal_ssd：标准集群版（本地盘） - history：历史库集群版。', + 'description' => '实例的系列 - normal（默认）：标准集群版（云盘） - normal_ssd：标准集群版（本地盘） - history：历史库集群版。', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'The character set name.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeCharset**. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Charset' => [ + 'title' => '字符集列表。', + 'description' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DescribeCharset'."\n" + .'&TenantMode=Oracle'."\n" + .'&Common request parameters'."\n" + .'```', + 'type' => 'array', + 'items' => [ + 'description' => ' ', + 'type' => 'object', + 'properties' => [ + 'Charset' => [ + 'title' => '字符集名称。', + 'description' => 'DescribeCharset', + 'type' => 'string', + 'example' => 'utf8', + ], + 'Collations' => [ + 'title' => '字符序集合', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["utf8mb4_general_ci","utf8mb4_bin","binary"]', + ], + ], + ], + ], + 'example' => '', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Charset\\": [\\n {\\n \\"Charset\\": \\"utf8\\",\\n \\"Collations\\": [\\n \\"[\\\\\\"utf8mb4_general_ci\\\\\\",\\\\\\"utf8mb4_bin\\\\\\",\\\\\\"binary\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeCharsetResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <Charset>\\n <Charset>utf8</Charset>\\n </Charset>\\n</DescribeCharsetResponse>","errorExample":""}]', + 'title' => 'DescribeCharset', + ], + 'DescribeInstanceAvailableZones' => [ + 'summary' => 'You can call this operation to query the zones of a cluster that can be set as the primary zone.', + 'methods' => [ + 'post', + ], + '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****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'E3D924FB-52****B253-0C1A7EFB778C', + ], + 'ZoneList' => [ + 'description' => 'The return result of the request.', + 'type' => 'array', + 'items' => [ + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'Zone' => [ + 'description' => 'The name of the physical zone.', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'IsInCluster' => [ + 'description' => 'Indicates whether the cluster is deployed in the zone.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ReplicateZoneIndex' => [ + 'description' => 'The index of the replicated zone.', + 'type' => 'string', + 'example' => '1', + ], + 'LogicalZoneName' => [ + 'description' => 'The name of the logical zone.', + 'type' => 'string', + 'example' => 'cn-shanghai-g-z0,cn-shanghai-g-z1, cn-shanghai-g-z2', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E3D924FB-52****B253-0C1A7EFB778C\\",\\n \\"ZoneList\\": [\\n {\\n \\"Zone\\": \\"cn-hangzhou-i\\",\\n \\"IsInCluster\\": true,\\n \\"ReplicateZoneIndex\\": \\"1\\",\\n \\"LogicalZoneName\\": \\"cn-shanghai-g-z0,cn-shanghai-g-z1, cn-shanghai-g-z2\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeInstanceAvailableZones', + ], + 'DescribeTenantZonesRead' => [ + 'summary' => 'You can call this operation to query the information about read-only zones of a tenant. ', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The zone information of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => 'The return result of the request. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'Indicates whether a read-only connection has been created. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'Indicates whether a read-only connection needs to be created for the zone. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'TenantZones' => [ + 'title' => '租户可用区信息。', + 'description' => 'The request ID. ', + 'type' => 'array', + 'items' => [ + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to DescribeTenantZonesRead. ', + 'type' => 'object', + 'properties' => [ + 'IsElectable' => [ + 'title' => '是否可选为主库。', + 'description' => 'Example 1', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsPrimary' => [ + 'title' => '是否为主可用区。', + 'description' => ' ', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Zone' => [ + 'title' => '可用区ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'IsReadable' => [ + 'title' => '是否可以设置为只读。', + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + 'example' => '', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"TenantZones\\": [\\n {\\n \\"IsElectable\\": true,\\n \\"IsPrimary\\": true,\\n \\"Zone\\": \\"cn-hangzhou-i\\",\\n \\"IsReadable\\": \\"true\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeTenantZonesReadResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <TenantZones>\\n <IsElectable>true</IsElectable>\\n <IsPrimary>true</IsPrimary>\\n <Zone>cn-hangzhou-i</Zone>\\n <IsReadOnlyAddressMaster>true</IsReadOnlyAddressMaster>\\n <IsReadable>true</IsReadable>\\n </TenantZones>\\n</DescribeTenantZonesReadResponse>","errorExample":""}]', + 'title' => 'DescribeTenantZonesRead', + ], + 'DescribeTimeZones' => [ + 'summary' => 'You can call this API to query the time zones supported by an OceanBase Database tenant. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'The default time zone. ', + 'type' => 'object', + 'properties' => [ + 'TimeZones' => [ + 'title' => '租户允许的时区信息。', + 'description' => 'The description of the time zone. ', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'title' => '时区列表信息。', + 'description' => 'The list of time zones. ', + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the time zone. ', + 'type' => 'object', + 'properties' => [ + 'TimeZone' => [ + 'title' => '时区名称。', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeTimeZones**. ', + 'type' => 'string', + 'example' => 'Asia/Shanghai', + ], + 'Description' => [ + 'title' => '时区描述。', + 'description' => 'Example 1', + 'type' => 'string', + 'example' => '(GMT+8:00) Asia/Shanghai', + ], + ], + ], + 'example' => '', + ], + 'Default' => [ + 'title' => '默认时区。', + 'description' => ' ', + 'type' => 'string', + 'example' => 'Asia/Shanghai', + ], + ], + 'example' => '', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'DescribeTimeZones', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TimeZones\\": {\\n \\"List\\": [\\n {\\n \\"TimeZone\\": \\"Asia/Shanghai\\",\\n \\"Description\\": \\"(GMT+8:00) Asia/Shanghai\\"\\n }\\n ],\\n \\"Default\\": \\"Asia/Shanghai\\"\\n },\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeTimeZonesResponse>\\n <TimeZones>\\n <List>\\n <TimeZone>Asia/Shanghai</TimeZone>\\n <Description>(GMT+8:00) Asia/Shanghai</Description>\\n </List>\\n <Default>Asia/Shanghai</Default>\\n </TimeZones>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</DescribeTimeZonesResponse>","errorExample":""}]', + 'title' => 'DescribeTimeZones', + ], + 'DescribeTenantSecurityIpGroups' => [ + 'summary' => 'You can call this operation to view the list of whitelist groups of the tenant.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + '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' => '请求ID。', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => '473469**-AA6F-4D**-B3DB-A***********', + ], + 'TotalCount' => [ + 'title' => '白名单分组个数。', + 'description' => 'The total number of the whitelist groups.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SecurityIpGroups' => [ + 'title' => '白名单分组列表。', + 'description' => 'The list of the whitelist groups.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SecurityIpGroupName' => [ + 'title' => '分组名称', + 'description' => 'The group name.', + 'type' => 'string', + 'example' => 'test1', + ], + 'SecurityIps' => [ + 'title' => '白名单列表。其为一个用逗号分隔的字符串，每个对象为一个IP字符串或者IP段。\'', + 'description' => 'The whitelist of IP addresses. It is a string separated by commas, and each object is an IP string or a CIDR block.', + 'type' => 'string', + 'example' => '192.***.*.*"', + ], + 'SecurityIpGroupType' => [ + 'title' => '白名单分组类型。- instance: 集成自集群的白名单分组；- tenant：本租户的白名单分组', + 'description' => 'The whitelist group type.'."\n" + .'- instance: the whitelist group from the cluster.'."\n" + .'- tenant: the whitelist group of the current tenant.', + 'type' => 'string', + 'example' => 'tenant', + ], + 'TenantId' => [ + 'title' => '租户id', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'example' => 't4louaeei****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error. ', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"TotalCount\\": 2,\\n \\"SecurityIpGroups\\": [\\n {\\n \\"SecurityIpGroupName\\": \\"test1\\",\\n \\"SecurityIps\\": \\"192.***.*.*\\",\\n \\"SecurityIpGroupType\\": \\"tenant\\",\\n \\"TenantId\\": \\"t4louaeei****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeTenantSecurityIpGroups', + ], + 'DescribeZones' => [ + 'summary' => 'You can call this operation to learn of zones where a cluster can be created in an Alibaba Cloud region. ', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Series', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群的系列 - normal（默认）：高可用版本 - basic：基础版本', + 'description' => 'The deployment mode. ', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'NORMAL' => 'NORMAL', + ], + 'example' => 'NORMAL', + 'enum' => [ + 'normal', + 'basic', + ], + ], + ], + [ + 'name' => 'DeployType', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群的部署类型。- multiple：多机房 - single：单机房 - dual：双机房', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeZones**. ', + 'type' => 'string', + 'required' => false, + 'example' => 'single', + 'enum' => [ + 'multiple', + 'single', + 'dual', + ], + ], + ], + [ + 'name' => 'CpuArch', + 'in' => 'formData', + 'schema' => [ + 'title' => 'cpu架构', + 'type' => 'string', + 'example' => 'x86', + ], + ], + ], + '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', + ], + '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' => ' ', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'title' => '可用区ID列表。对于多可用区集群，其可用区名称以逗号连接', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-i,cn-hangzhou-j,cn-hangzhou-h', + ], + 'ZoneName' => [ + 'title' => '可用区名称', + 'description' => '', + 'type' => 'string', + 'example' => 'H/I/J', + ], + 'Series' => [ + 'title' => 'Oceanbase集群的系列 - NORMAL（默认）：高可用版本 - BASIC：基础版本', + 'description' => '', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'DeployType' => [ + 'title' => '部署模式', + 'description' => '', + 'type' => 'string', + 'example' => '1-1-1', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Zones\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-i,cn-hangzhou-j,cn-hangzhou-h\\",\\n \\"ZoneName\\": \\"H/I/J\\",\\n \\"Series\\": \\"NORMAL\\",\\n \\"DeployType\\": \\"1-1-1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeZonesResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n <Zones>\\n <ZoneId>cn-hangzhou-i,cn-hangzhou-j,cn-hangzhou-h</ZoneId>\\n <ZoneName>H/I/J</ZoneName>\\n <Series>Normal</Series>\\n <DeployType>1-1-1</DeployType>\\n </Zones>\\n</DescribeZonesResponse>","errorExample":""}]', + 'title' => 'DescribeZones', + ], + 'ModifyTenantPrimaryZone' => [ + 'summary' => 'You can call this operation to switch the primary zone of the tenant. ', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => 'The return result of the request. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The primary zone of the tenant. '."\n" + .'It is one of the zones in which the cluster is deployed. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'PrimaryZone', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户的主可用区。 其为集群部署可用区中的一个。', + 'description' => 'The ID of the vSwitch. ', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'UserVSwitchId', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户交换机ID', + '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' => [ + 'title' => '租户地址id', + 'type' => 'string', + 'example' => 'obe-4tw51gp7****', + ], + ], + [ + 'name' => 'TenantEndpointDirectId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户直连地址endpoint id', + 'type' => 'string', + ], + ], + [ + 'name' => 'UserDirectVSwitchId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户直连地址vswitch id', + 'type' => 'string', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'UserVpcOwnerId', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户vpc的ownerId', + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'You can call this operation to switch the primary zone of the tenant. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTenantPrimaryZoneResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</ModifyTenantPrimaryZoneResponse>","errorExample":""}]', + 'title' => 'ModifyTenantPrimaryZone', + ], + 'ModifyTenantResource' => [ + 'summary' => 'You can call this operation to modify the specifications of a tenant in an OceanBase cluster. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + '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', + ], + ], + [ + 'name' => 'Memory', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户内存大小，单位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' => 'Oceanbase集群ID。', + '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', + ], + ], + [ + 'name' => 'ReadOnlyZoneList', + 'in' => 'formData', + 'schema' => [ + 'title' => '非必要不使用该参数，推荐使用接口 ModifyTenantReadonlyReplica管理只读副本', + '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, + ], + ], + [ + 'name' => 'Iops', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'example' => 't33h8y08k****', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TenantId\\": \\"t33h8y08k****\\",\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTenantResourceResponse>\\n <TenantId>t33h8y08k****</TenantId>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</ModifyTenantResourceResponse>","errorExample":""}]', + 'title' => 'ModifyTenantResource', + ], + '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' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'SecurityIpGroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP安全白名单组的组名。 由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', + 'description' => 'The group name of the whitelist group of IP addresses.'."\n" + ."\n" + .'It starts with lowercase letters and ends with lowercase letters or numbers. It can only contain lowercase letters, numbers, and underscores, and should be 2~32 characters in length.', + 'type' => 'string', + 'required' => true, + 'example' => 'paytest', + ], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP安全白名单列表。 其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。最多可设置 40 个。', + 'description' => 'The list of IP addresses in the whitelist group.'."\n" + ."\n" + .'It is a JSON array. Each object in the array is an IP address or a CIDR block. You can have up to 40 whitelists.', + 'type' => 'string', + 'required' => true, + 'example' => '192.***.*.*"', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The returned result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'SecurityIpGroup' => [ + 'title' => '白名单分组信息。', + 'description' => 'The information of the IP address whitelist group. ', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'example' => 't4louaeei****', + ], + 'SecurityIpGroupName' => [ + 'title' => '安全白名单分组名称。', + 'description' => 'The name of the whitelist group. ', + 'type' => 'string', + 'example' => 'paytest', + ], + 'SecurityIps' => [ + 'title' => '白名单列表。其为一个用逗号分隔的字符串，每个对象为一个IP字符串或者IP段。', + 'description' => 'The list of IP addresses in the IP address whitelist group.'."\n" + ."\n" + .'It is a string separated by commas, and each object is an IP address or a CIDR block.', + 'type' => 'string', + 'example' => '192.***.*.*', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"SecurityIpGroup\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"TenantId\\": \\"t4louaeei****\\",\\n \\"SecurityIpGroupName\\": \\"paytest\\",\\n \\"SecurityIps\\": \\"[\\\\\\"192.***.*.*\\\\\\"]\\"\\n }\\n}","type":"json"}]', + 'title' => 'ModifyTenantSecurityIpGroup', + ], + 'DeleteTenants' => [ + 'summary' => 'You can call this operation to delete one or more tenants from an OceanBase cluster. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'TenantIds', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户的ID列表。 其为Json格式的数组，数组中每个对象都为租户名称的字符串。', + 'description' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DeleteTenants'."\n" + .'&TenantIds=["ob2mr3oae0****", "ob2mr3oae1****"]'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&Common request parameters'."\n" + .'```', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["ob2mr3oae0****", "ob2mr3oae1****"]', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'You can call this operation to delete one or more tenants from an OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'TenantIds' => [ + 'title' => '租户的ID列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[tjd3da45kc****，tdsjc42cm****]', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"TenantIds\\": [\\n \\"tjd3da45kc****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DeleteTenantsResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <TenantIds>[tjd3da45kc****，tdsjc42cm****]</TenantIds>\\n</DeleteTenantsResponse>","errorExample":""}]', + 'title' => 'DeleteTenants', + ], + 'DeleteTenantSecurityIpGroup' => [ + 'summary' => 'You can call this operation to delete the information on the whitelist group of the tenant.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'SecurityIpGroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => '安全白名单分组的组名。 由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', + 'description' => 'The group name of the whitelist group of IP addresses.'."\n" + ."\n" + .'It starts with lowercase letters and ends with lowercase letters or numbers. It can only contain lowercase letters, numbers, and underscores, and should be 2~32 characters in length.', + 'type' => 'string', + 'required' => true, + 'example' => 'paytest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The returned result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'SecurityIpGroup' => [ + 'title' => '白名单分组信息。', + 'description' => 'The information of the whitelist group. ', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'example' => 't4louaeei****', + ], + 'SecurityIpGroupName' => [ + 'title' => '安全白名单分组名称。', + 'description' => 'The name of the whitelist group. ', + 'type' => 'string', + 'example' => 'paytest', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"SecurityIpGroup\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"TenantId\\": \\"t4louaeei****\\",\\n \\"SecurityIpGroupName\\": \\"paytest\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteTenantSecurityIpGroup', + ], + 'CreateTenantUser' => [ + 'summary' => 'You can call this operation to create an account in a tenant that has access to a database. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库账号名称。 不能使用某些预留关键字，如 SYS、root等。', + 'description' => 'The name of the database account. You cannot use reserved keywords, such as SYS and root. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pay_test', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库账户的类型 Admin：超级账户 Normal：普通账户', + 'description' => 'The type of the database account. Valid values: Admin: the super administrator account. Normal: a general account.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'UserPassword', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库账号访问密码。 必须包含大写英文字符、小写英文字符、数字、特殊字符占三种，长度为 10-32 位； 特殊字符为：!@#$%^&* ()_ +-=', + 'description' => 'The password of the database account. It must be 10 to 32 characters in length and contain three types of the following characters: uppercase letters, lowercase letters, digits, and special characters. The special characters are ! @ # $ % \\ ^ \\ & \\ * ( ) _ + - =', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '!Aliyun4Oceanbase', + ], + ], + [ + 'name' => 'Roles', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户的角色信息。 对于Oracle模式：无需填写。 对于MySQL模式：超级账户默认为ALL PRIVILEGES，无需填写。 普通用户填写账户的信息，其为Json格式的字符串，默认为一个数组，数组内包含schema（Oracle模式）或Database（MySQL模式)信息和角色信息（Role）。 角色包含以下几类： 读写权限（ReadWrite）：ALL PRIVILEGES ； 只读权限（ReadOnly）：SELECT DDL权限（DDL）：CREATE,DROP,ALTER,SHOW VIEW,CREATE VIEW DML权限：SELECT,INSERT,UPDATE,DELETE,SHOW VIEW； DML权限（DML）：SELECT,INSERT,UPDATE,DELETE,SHOW VIEW。', + 'description' => 'The role of the user account. In Oracle mode, this parameter unspecified is left unspecified. In MySQL mode, the super administrator account has ALL PRIVILEGES, and you can leave this parameter unspecified. You need to specify the account information for a general user account. By default, the account information is a JSON array that contains the information of the role and the schema (Oracle mode) or database (MySQL mode). Valid values: ReadWrite: a role that has the read and write privileges, namely ALL PRIVILEGES. ReadOnly: a role that has only the read-only privilege SELECT. DDL: a role that has DDL privileges such as CREATE, DROP, ALTER, SHOW VIEW, and CREATE VIEW. DML: a role that has DML privileges such as SELECT, INSERT, UPDATE, DELETE, and SHOW VIEW. ', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '[{"Database":"oceanbase1","Role":"readwrite"},{"Database":"oceanbase2","Role":"readonly"}]', + ], + ], + [ + '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' => '加密方式。', + 'type' => 'string', + 'required' => false, + 'example' => 'RAS', + ], + ], + [ + 'name' => 'GlobalPermissions', + 'in' => 'formData', + 'schema' => [ + 'title' => '全局权限信息', + 'type' => 'string', + 'example' => 'Encrypt,Decrypt', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'TenantUser' => [ + 'title' => 'The return result of the request. ', + 'description' => 'The list of database accounts in the tenant.', + 'type' => 'object', + 'items' => [ + 'description' => 'The list of database accounts in the tenant. ', + 'type' => 'object', + 'properties' => [ + 'UserType' => [ + 'name' => 'UserType', + 'title' => 'The TenantUser schema. ', + 'description' => 'The type of the database account. Valid values: - Admin: the super administrator account. - Normal: a general account.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Normal', + 'nullToEmpty' => false, + 'backendName' => 'UserType', + 'valueMapping' => [ + 'cases' => [ + [ + 'value' => 'Admin', + 'targetValue' => 'Admin', + ], + [ + 'value' => 'Normal', + 'targetValue' => 'Normal', + ], + ], + ], + ], + 'Roles' => [ + 'name' => 'Roles', + 'title' => 'The type of the database account. Valid values: '."\n" + .' - Admin: the super administrator account. '."\n" + .' - Normal: a general account. ', + 'description' => 'The roles of the accounts.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The roles of the accounts. ', + 'type' => 'object', + 'properties' => [ + 'Database' => [ + 'name' => 'Database', + 'title' => 'The Roles schema. ', + 'description' => 'The name of the database.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'db_pay1', + 'nullToEmpty' => false, + 'backendName' => 'Database', + ], + 'Role' => [ + 'name' => 'Role', + 'title' => 'The name of the database. ', + 'description' => 'The role of the account. In Oracle mode, a role is a schema-level role. Valid values: - ReadWrite: a role that has the read and write privileges, including CREATE TABLE, CREATE VIEW, CREATE PROCEDURE, CREATE SYNONYM, CREATE SEQUENCE, CREATE TRIGGER, CREATE TYPE, CREATE SESSION, EXECUTE ANY PROCEDURE, CREATE ANY OUTLINE, ALTER ANY OUTLINE, DROP ANY OUTLINE, CREATE ANY PROCEDURE, ALTER ANY PROCEDURE, DROP ANY PROCEDURE, CREATE ANY SEQUENCE, ALTER ANY SEQUENCE, DROP ANY SEQUENCE, CREATE ANY TYPE, ALTER ANY TYPE, DROP ANY TYPE, SYSKM, CREATE ANY TRIGGER, ALTER ANY TRIGGER, DROP ANY TRIGGER, CREATE PROFILE, ALTER PROFILE, and DROP PROFILE. - ReadOnly: a role that has only the read-only privilege SELECT.'."\n" + .'In MySQL mode, a role is a database-level role. Valid values: - ReadWrite: a role that has the read and write privileges, namely ALL PRIVILEGES. - ReadOnly: a role that has only the read-only privilege SELECT. - DDL: a role that has the DDL privileges such as CREATE, DROP, ALTER, SHOW VIEW, and CREATE VIEW. - DML: a role that has the DML privileges such as SELECT, INSERT, UPDATE, DELETE, and SHOW VIEW. '."\n" + .'* By default, an Oracle account has the read and write privileges on its own schema, which are not listed here. ', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ReadOnly', + 'nullToEmpty' => false, + 'backendName' => 'Role', + 'valueMapping' => [ + 'cases' => [ + [ + 'value' => 'OnlyRead', + 'targetValue' => 'OnlyRead', + ], + [ + 'value' => 'ReadWrite', + 'targetValue' => 'ReadWrite', + ], + ], + ], + ], + ], + 'extendType' => 'true', + ], + 'example' => '', + 'nullToEmpty' => false, + 'backendName' => 'Roles', + 'itemName' => 'Roles', + ], + 'UserStatus' => [ + 'name' => 'UserStatus', + 'title' => 'The role of the account. '."\n" + .'In Oracle mode, a role is a schema-level role. Valid values: '."\n" + ."\n" + .'- ReadWrite: a role that has the read and write privileges, including CREATE TABLE, CREATE VIEW, CREATE PROCEDURE, CREATE SYNONYM, CREATE SEQUENCE, CREATE TRIGGER, CREATE TYPE, CREATE SESSION, EXECUTE ANY PROCEDURE, CREATE ANY OUTLINE, ALTER ANY OUTLINE, DROP ANY OUTLINE, CREATE ANY PROCEDURE, ALTER ANY PROCEDURE, DROP ANY PROCEDURE, CREATE ANY SEQUENCE, ALTER ANY SEQUENCE, DROP ANY SEQUENCE, CREATE ANY TYPE, ALTER ANY TYPE, DROP ANY TYPE, SYSKM, CREATE ANY TRIGGER, ALTER ANY TRIGGER, DROP ANY TRIGGER, CREATE PROFILE, ALTER PROFILE, and DROP PROFILE. '."\n" + .'- ReadOnly: a role that has only the read-only privilege SELECT. '."\n" + ."\n" + .'In MySQL mode, a role is a database-level role. Valid values: '."\n" + ."\n" + .'- ReadWrite: a role that has the read and write privileges, namely ALL PRIVILEGES. '."\n" + .'- ReadOnly: a role that has only the read-only privilege SELECT. '."\n" + .'- DDL: a role that has the DDL privileges such as CREATE, DROP, ALTER, SHOW VIEW, and CREATE VIEW. '."\n" + .'- DML: a role that has the DML privileges such as SELECT, INSERT, UPDATE, DELETE, and SHOW VIEW. '."\n" + ."\n" + .'> <br>By default, an Oracle account has the read and write privileges on its own schema, which are not listed here. ', + 'description' => 'The status of the database account. Valid values: - Locked: The account is locked. - ONLINE: The account is unlocked. The default status of a new account is ONLINE after it is created.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ONLINE', + 'nullToEmpty' => false, + 'backendName' => 'UserStatus', + 'valueMapping' => [ + 'cases' => [ + [ + 'value' => 'Normal', + 'targetValue' => 'Normal', + ], + [ + 'value' => 'Locked', + 'targetValue' => 'Locked', + ], + ], + ], + ], + 'UserName' => [ + 'name' => 'UserName', + 'title' => 'The status of the database account. Valid values: '."\n" + .'- Locked: The account is locked. '."\n" + .'- ONLINE: The account is unlocked. The default status of a new account is ONLINE after it is created. ', + 'description' => 'The name of the database account. ', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'pay_test', + 'nullToEmpty' => false, + 'backendName' => 'UserName', + ], + ], + 'extendType' => 'true', + ], + 'example' => '', + 'properties' => [ + 'UserType' => [ + 'type' => 'string', + ], + 'Roles' => [ + 'title' => '账户对应的角色权限信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Database' => [ + 'title' => '数据库名称', + 'type' => 'string', + 'example' => 'db_pay1', + ], + 'Role' => [ + 'title' => '拥有的角色。 对于Oracle模式，角色为schema级别，其可分为 - ReadWrite：读写权限，包括CREATE TABLE CREATE VIEW CREATE PROCEDURE CREATE SYNONYM CREATE SEQUENCE CREATE TRIGGER CREATE TYPE CREATE SESSION EXECUTE ANY PROCEDURE CREATE ANY OUTLINE ALTER ANY OUTLINE DROP ANY OUTLINE CREATE ANY PROCEDURE ALTER ANY PROCEDURE DROP ANY PROCEDURE CREATE ANY SEQUENCE ALTER ANY SEQUENCE DROP ANY SEQUENCE CREATE ANY TYPE ALTER ANY TYPE DROP ANY TYPE SYSKM CREATE ANY TRIGGER ALTER ANY TRIGGER DROP ANY TRIGGER CREATE PROFILE ALTER PROFILE DROP PROFILE； - ReadOnly：只读权限，SELECT'."\n" + .'对于MySQL模式，角色为数据库（Database）级别，其有以下几类： - ReadWrite：读写权限，包括ALL PRIVILEGES； - ReadOnly：只读权限，包括SELECT - DDL: DDL权限，包括CREATE,DROP,ALTER,SHOW VIEW,CREATE VIEW - DML: DML权限，包括SELECT,INSERT,UPDATE,DELETE,SHOW VIEW。'."\n" + .'* 另外Oracle账户对自己的schema有默认的读写权限，这里不会列出。', + 'type' => 'string', + 'example' => 'ReadOnly', + ], + ], + ], + 'example' => '', + ], + 'UserStatus' => [ + 'title' => '数据库账号的状态。 - Locked：锁定 - ONLINE：解锁 创建完的账户默认为ONLINE状态', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'UserName' => [ + 'title' => '数据库账号名称。', + 'type' => 'string', + 'example' => 'pay_test', + ], + 'GlobalPermissions' => [ + 'title' => '全局权限', + 'type' => 'string', + 'example' => 'Encrypt,Decrypt', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"TenantUser\\": {\\n \\"UserType\\": \\"Normal\\",\\n \\"Roles\\": [\\n {\\n \\"Database\\": \\"db_pay1\\",\\n \\"Role\\": \\"ReadOnly\\"\\n }\\n ],\\n \\"UserStatus\\": \\"ONLINE\\",\\n \\"UserName\\": \\"pay_test\\",\\n \\"GlobalPermissions\\": \\"Encrypt,Decrypt\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateTenantUserResponse>\\n <TenantUser>\\n <UserType>Normal</UserType>\\n <Roles>\\n <Database>db_pay1</Database>\\n <Role>ReadOnly</Role>\\n </Roles>\\n <UserStatus>ONLINE</UserStatus>\\n <UserName>pay_test</UserName>\\n </TenantUser>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</CreateTenantUserResponse>","errorExample":""}]', + 'title' => 'CreateTenantUser', + 'requestParamsDescription' => 'You can call this operation to create an account in a tenant that has access to a database. ', + ], + 'DescribeTenantUsers' => [ + 'summary' => 'You can call this operation to query all accounts in a tenant that have access to the database. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => ' The return result of the request. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询列表的删选关键字。', + 'description' => 'The return result of the request. ', + 'type' => 'string', + 'required' => false, + 'example' => 'pay', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => 'The database privileges of the account. ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'description' => ' The return result of the request. ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库账号名称。 不能使用某些预留关键字，如 SYS、root等。', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeTenantUsers**. ', + 'type' => 'string', + 'required' => false, + 'example' => 'pay_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The name of the database account. '."\n" + .'You cannot use reserved keywords, such as SYS and root. ', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '租户中的数据库账号总数。', + 'description' => 'The role of the account. '."\n" + .'In Oracle mode, a role is a schema-level role. Valid values: '."\n" + .'- ReadWrite: a role that has the read and write privileges, including: CREATE TABLE, CREATE VIEW, CREATE PROCEDURE, CREATE SYNONYM, CREATE SEQUENCE, CREATE TRIGGER, CREATE TYPE, CREATE SESSION, EXECUTE ANY PROCEDURE, CREATE ANY OUTLINE, ALTER ANY OUTLINE, DROP ANY OUTLINE, CREATE ANY PROCEDURE, ALTER ANY PROCEDURE, DROP ANY PROCEDURE, CREATE ANY SEQUENCE, ALTER ANY SEQUENCE, DROP ANY SEQUENCE, CREATE ANY TYPE, ALTER ANY TYPE, DROP ANY TYPE, SYSKM, CREATE ANY TRIGGER, ALTER ANY TRIGGER, DROP ANY TRIGGER, CREATE PROFILE, ALTER PROFILE, and DROP PROFILE. '."\n" + .'- ReadOnly: a role that has only the read-only privilege SELECT.'."\n" + .'In MySQL mode, a role is a database-level role. Valid values: '."\n" + .'- ReadWrite: a role that has the read and write privileges, namely ALL PRIVILEGES. '."\n" + .'- ReadOnly: a role that has only the read-only privilege SELECT. '."\n" + .'- DDL: a role that has the DDL privileges such as CREATE, DROP, ALTER, SHOW VIEW, and CREATE VIEW. '."\n" + .'- DML: a role that has the DML privileges such as SELECT, INSERT, UPDATE, DELETE, and SHOW VIEW. '."\n" + ."\n" + .'> <br>By default, an Oracle account has the read and write privileges on its own schema, which are not listed here. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The name of the database account. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'TenantUsers' => [ + 'title' => '租户中的数据库账号信息', + 'description' => 'The type of the database account. Valid values: '."\n" + .'- Admin: the super administrator account. '."\n" + .'- NORMAL: a general account. ', + 'type' => 'array', + 'items' => [ + 'description' => 'Example 1', + 'type' => 'object', + 'properties' => [ + 'UserType' => [ + 'title' => '数据库账号类型。 - Admin：超级账户 - Normal：普通账户', + 'description' => ' ', + 'type' => 'string', + 'example' => ' NORMAL', + ], + 'Description' => [ + 'title' => '数据库账号的描述信息。', + 'description' => ' ', + 'type' => 'string', + 'example' => 'use for test', + ], + 'Databases' => [ + 'title' => '账号具备的数据库权限信息。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Database' => [ + 'title' => '数据库(schema)名称', + 'description' => '', + 'type' => 'string', + 'example' => 'db_pay1', + ], + 'Role' => [ + 'title' => '拥有的角色。 对于Oracle模式，角色为schema级别，其可分为 - ReadWrite：读写权限，包括CREATE TABLE CREATE VIEW CREATE PROCEDURE CREATE SYNONYM CREATE SEQUENCE CREATE TRIGGER CREATE TYPE CREATE SESSION EXECUTE ANY PROCEDURE CREATE ANY OUTLINE ALTER ANY OUTLINE DROP ANY OUTLINE CREATE ANY PROCEDURE ALTER ANY PROCEDURE DROP ANY PROCEDURE CREATE ANY SEQUENCE ALTER ANY SEQUENCE DROP ANY SEQUENCE CREATE ANY TYPE ALTER ANY TYPE DROP ANY TYPE SYSKM CREATE ANY TRIGGER ALTER ANY TRIGGER DROP ANY TRIGGER CREATE PROFILE ALTER PROFILE DROP PROFILE； - ReadOnly：只读权限，SELECT'."\n" + .'对于MySQL模式，角色为数据库（Database）级别，其有以下几类： - ReadWrite：读写权限，包括ALL PRIVILEGES； - ReadOnly：只读权限，包括SELECT - DDL: DDL权限，包括CREATE,DROP,ALTER,SHOW VIEW,CREATE VIEW - DML: DML权限，包括SELECT,INSERT,UPDATE,DELETE,SHOW VIEW。'."\n" + .'* 另外Oracle账户对自己的schema有默认的读写权限，这里不会列出。', + 'description' => '', + 'type' => 'string', + 'example' => 'ReadOnly', + ], + 'Table' => [ + 'title' => '表的名称。', + 'description' => '', + 'type' => 'string', + 'example' => 'tbl_pay1', + ], + 'Privileges' => [ + 'type' => 'string', + ], + ], + ], + ], + 'UserStatus' => [ + 'title' => '数据库账号的状态。 - LOCKED：锁定 - ONLINE：解锁', + 'description' => '', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'UserName' => [ + 'title' => '数据库账号名称。', + 'description' => '', + 'type' => 'string', + 'example' => 'pay_test', + ], + 'TenantId' => [ + 'title' => '所属租户Id', + 'description' => '所属租户Id', + 'type' => 'string', + 'example' => 'tshfs3****', + ], + 'InstanceId' => [ + 'title' => '所属集群Id', + 'description' => '所属集群Id', + 'type' => 'string', + 'example' => 'obshc32****', + ], + 'GlobalPermissions' => [ + 'title' => '全局权限信息', + 'type' => 'string', + 'example' => 'Encrypt,Decrypt', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"TenantUsers\\": [\\n {\\n \\"UserType\\": \\"Normal\\",\\n \\"Description\\": \\"use for test\\",\\n \\"Databases\\": [\\n {\\n \\"Database\\": \\"db_pay1\\",\\n \\"Role\\": \\"ReadOnly\\",\\n \\"Table\\": \\"tbl_pay1\\",\\n \\"Privileges\\": \\"select,delete,update\\"\\n }\\n ],\\n \\"UserStatus\\": \\"ONLINE\\",\\n \\"UserName\\": \\"pay_test\\",\\n \\"TenantId\\": \\"t4pnum**** \\",\\n \\"InstanceId\\": \\"obshc32****\\",\\n \\"GlobalPermissions\\": \\"Encrypt,Decrypt\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeTenantUsersResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <TenantUsers>\\n <UserType>Normal</UserType>\\n <Description>use for test</Description>\\n <Databases>\\n <Database>db_pay1</Database>\\n <Role>ReadOnly</Role>\\n <Table>tbl_pay1</Table>\\n </Databases>\\n <UserStatus>Normal</UserStatus>\\n <UserName>pay_test</UserName>\\n </TenantUsers>\\n</DescribeTenantUsersResponse>","errorExample":""}]', + 'title' => 'DescribeTenantUsers', + ], + '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****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'Role' => [ + 'title' => '对于 Oracle 模式，角色为 schema 级别，其可分为'."\n" + .'● ReadWrite：读写权限，包括 CREATE TABLE CREATE VIEW CREATE PROCEDURE CREATE SYNONYM CREATE SEQUENCE CREATE TRIGGER CREATE TYPE CREATE SESSION EXECUTE ANY PROCEDURE CREATE ANY OUTLINE ALTER ANY OUTLINE DROP ANY OUTLINE CREATE ANY PROCEDURE ALTER ANY PROCEDURE DROP ANY PROCEDURE CREATE ANY SEQUENCE ALTER ANY SEQUENCE DROP ANY SEQUENCE CREATE ANY TYPE ALTER ANY TYPE DROP ANY TYPE SYSKM CREATE ANY TRIGGER ALTER ANY TRIGGER DROP ANY TRIGGER CREATE PROFILE ALTER PROFILE DROP PROFILE；'."\n" + .'● ReadOnly：只读权限，SELECT'."\n" + .'对于MySQL模式，角色为数据库（Database）级别，其有以下几类：'."\n" + .'● ReadWrite：读写权限，包括 ALL PRIVILEGES；'."\n" + .'● ReadOnly：只读权限，包括 SELECT；'."\n" + .'● DDL: DDL 权限，包括 CREATE,DROP,ALTER,SHOW VIEW,CREATE VIEW；'."\n" + .'● DML: DML 权限，包括 SELECT,INSERT,UPDATE,DELETE,SHOW VIEW。', + 'description' => 'The list of roles of the user. '."\n" + .'Valid values: '."\n" + ."\n" + .'ReadWrite: a role that has the read and write privileges, namely ALL PRIVILEGES.'."\n" + .'ReadOnly: a role that has only the read-only privilege SELECT.'."\n" + .'DDL: a role that has DDL privileges such as CREATE, DROP, ALTER, SHOW VIEW, and CREATE VIEW.'."\n" + .'DML: a role that has DML privileges such as SELECT, INSERT, UPDATE, DELETE, and SHOW VIEW. ', + 'type' => 'array', + 'items' => [ + 'description' => 'The return result of the request.', + 'type' => 'string', + 'example' => 'DDL', + ], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 1000 => [ + [ + 'errorCode' => 'E001R000', + 'errorMessage' => 'Error found, please try agent later.', + ], + ], + 2014 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Role\\": [\\n \\"DDL\\"\\n ],\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeTenantUserRolesResponse>\\n <Role>DDL</Role>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</DescribeTenantUserRolesResponse>","errorExample":""}]', + 'title' => 'DescribeTenantUserRoles', + ], + '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' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库账号名称。 不能使用某些预留关键字，如 SYS、root等。', + 'description' => 'The description of the database. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pay_test', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库描述信息。', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **ModifyTenantUserDescription**. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'this is a test database', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'Example 1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'You can call this operation to modify the description of a specified account in a tenant. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTenantUserDescriptionResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</ModifyTenantUserDescriptionResponse>","errorExample":""}]', + 'title' => 'ModifyTenantUserDescription', + ], + 'ModifyTenantUserPassword' => [ + 'summary' => 'You can call this operation to change the logon password of a specified account in a tenant. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库账号名称。 不能使用某些预留关键字，如 SYS、root等。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pay_test', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '```'."\n" + .'http(s)://[Endpoint]/?Action=ModifyTenantUserPassword'."\n" + .'&UserName=pay_test'."\n" + .'&TenantId=ob2mr3oae0****'."\n" + .'&UserPassword=!Aliyun4Oceanbase'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&Common request parameters'."\n" + .'```', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'UserPassword', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库账号访问密码。 必须包含大写英文字符、小写英文字符、数字、特殊字符占三种，长度为 10-32 位； 特殊字符为：!@#$%^&* ()_ +-=', + 'description' => 'You can call this operation to change the logon password of a specified account in a tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '!Aliyun4Oceanbase', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'EncryptionType', + 'in' => 'formData', + 'schema' => [ + 'title' => '加密方式。', + 'description' => '加密方式。', + 'type' => 'string', + 'required' => false, + 'example' => 'RSA', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTenantUserPasswordResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</ModifyTenantUserPasswordResponse>","errorExample":""}]', + 'title' => 'ModifyTenantUserPassword', + ], + 'ModifyTenantUserRoles' => [ + 'summary' => 'You can call this operation to modify the database privileges of a specified account in a tenant. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库账号名称。 不能使用某些预留关键字，如 SYS、root等。', + 'description' => 'The role of the database account. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pay_test', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **ModifyTenantUserRoles**. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'UserRole', + 'in' => 'formData', + 'schema' => [ + 'title' => '如果是mysql模式, 则传入所有的数据库和对应的权限, 如果有没传入的数据库, 则视为撤销在该数据库上的权限, 如果取消所有的数据库权限, 则传入为空, 即UserRole:[];'."\n" + .'如果是oracle模式, 则只传入对应需要修改的数据库名, 表名, 以及相应的权限.', + 'description' => 'The type of the account. Valid values: '."\n" + .'- Admin: the super administrator account. '."\n" + .'- Normal: a general account. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"Database":"20210824160559","Role":"readwrite"}]', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The type of the privilege modification operation. '."\n" + .'Valid values: '."\n" + .'update: updates all privileges. This is the default value. '."\n" + .'add: adds a privilege. '."\n" + .'delete: deletes a privilege. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'formData', + 'schema' => [ + 'title' => '如果是mysql模式, 则不传该值;'."\n" + .'如果是oracle模式, 则传入对应的操作: * 添加:ADD'."\n" + .'* 删除: DELETE'."\n" + .'* 更新: UPDATE ', + 'description' => 'The name of the table. ', + 'type' => 'string', + 'required' => false, + 'example' => 'update', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户类型', + 'type' => 'string', + 'example' => 'Normal', + 'enum' => [], + ], + ], + [ + 'name' => 'GlobalPermissions', + 'in' => 'formData', + 'schema' => [ + 'title' => '全局权限', + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'The list of database privileges of the account. ', + 'type' => 'object', + 'properties' => [ + 'TenantUser' => [ + 'title' => '租户中的数据库账号信息。', + 'description' => 'The ID of the tenant. ', + 'type' => 'object', + 'properties' => [ + 'UserRole' => [ + 'title' => '账号类型。 Admin：超级账户 Normal：普通账户', + 'description' => 'The name of the database (MySQL mode) or schema (Oracle mode). ', + 'type' => 'array', + 'items' => [ + 'description' => 'The request ID. ', + 'type' => 'object', + 'properties' => [ + 'Database' => [ + 'title' => '数据库(schema)名称', + 'description' => '```'."\n" + .'http(s)://[Endpoint]/?Action=ModifyTenantUserRoles'."\n" + .'&UserName=pay_test'."\n" + .'&TenantId=ob2mr3oae0****'."\n" + .'&UserRole=[{"Database":"20210824160559","Role":"readwrite"}]'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&ModifyType=update'."\n" + .'&Common request parameters'."\n" + .'```', + 'type' => 'string', + 'example' => 'db_pay1', + ], + 'Role' => [ + 'title' => '拥有的角色。', + 'description' => 'You can call this operation to modify the database privileges of a specified account in a tenant. ', + 'type' => 'string', + 'example' => 'ReadOnly', + ], + 'Table' => [ + 'title' => '表的名称。', + 'description' => '', + 'type' => 'string', + 'example' => 'tbl_pay1', + ], + 'IsSuccess' => [ + 'title' => '是否授权成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'example' => '账号具备的数据库权限信息列表。', + ], + 'UserName' => [ + 'title' => '账号名称。', + 'description' => '', + 'type' => 'string', + 'example' => 'pay_test', + ], + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => '', + 'type' => 'string', + 'example' => 't33h8y08k****', + ], + ], + 'example' => '', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TenantUser\\": {\\n \\"UserRole\\": [\\n {\\n \\"Database\\": \\"db_pay1\\",\\n \\"Role\\": \\"ReadOnly\\",\\n \\"Table\\": \\"tbl_pay1\\",\\n \\"IsSuccess\\": true\\n }\\n ],\\n \\"UserName\\": \\"pay_test\\",\\n \\"TenantId\\": \\"t4pnum****\\"\\n },\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTenantUserRolesResponse>\\n <TenantUser>\\n <UserRole>\\n <Database>db_pay1</Database>\\n <Role>ReadOnly</Role>\\n <Table>tbl_pay1</Table>\\n <IsSuccess>true</IsSuccess>\\n </UserRole>\\n <UserName>pay_test</UserName>\\n <TenantId>t33h8y08k****</TenantId>\\n </TenantUser>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</ModifyTenantUserRolesResponse>","errorExample":""}]', + 'title' => 'ModifyTenantUserRoles', + ], + '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' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'Users', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户名及具备的角色列表。', + 'description' => 'A list of usernames.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["testUser"]', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteTenantUsersResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</DeleteTenantUsersResponse>","errorExample":""}]', + 'title' => 'DeleteTenantUsers', + ], + 'CreateDatabase' => [ + 'summary' => 'You can call this operation to create a database in a tenant. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'DatabaseName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名称。 不能使用某些预留关键字，如 test、mysql。', + 'description' => 'Alibaba Cloud CLI', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sms_pre', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户id, 仅支持mysql模式;', + 'description' => 'The name of the database. '."\n" + .'You cannot use reserved keywords, such as test and mysql. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'Encoding', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库编码方式。目前支持utf8mb4, utf16, gbk, gb18030, binary ', + 'description' => 'The ID of the tenant.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'utf8mb4', + ], + ], + [ + 'name' => 'Collation', + 'in' => 'formData', + 'schema' => [ + 'title' => '字符序. 目前支持的字符序为:'."\n" + .'● Encoding为utf8mb4时, Collation支持utf8mb4_general_ci,utf8mb4_bin,utf8mb4_unicode_ci'."\n" + .'● Encoding为utf16时, Collation支持utf16_general_ci,utf16_unicode_ci,utf16_bin'."\n" + .'● Encoding为gbk时, Collation支持gbk_chinese_ci,gbk_bin'."\n" + .'● Encoding为gb18030时, Collation支持gb18030_chinese_ci,gb18030_bin'."\n" + .'● Encoding为binary时, Collation支持binary', + 'description' => 'The encoding standard of the database.'."\n" + .'For more information, see the Charset field returned by the DescribeCharset operation. ', + 'type' => 'string', + 'required' => false, + 'example' => 'utf8mb4_general_ci', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The collation.', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。', + 'description' => 'The name of the database. ', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库描述信息。', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **CreateDatabase**. ', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a test database', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'Example 1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => ' ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'DatabaseName' => [ + 'title' => '数据库名称。', + 'description' => 'CreateDatabase', + 'type' => 'string', + 'example' => 'sms_pre', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"DatabaseName\\": \\"sms_pre\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDatabaseResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <DatabaseName>sms_pre</DatabaseName>\\n</CreateDatabaseResponse>","errorExample":""}]', + 'title' => 'CreateDatabase', + ], + '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' => '租户ID。', + 'description' => 'The ID of the tenant.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => 'The number of the page returned. '."\n" + .'- Start value: 1 '."\n" + .'- Default value: 1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'description' => 'The number of rows returned on each page. '."\n" + .'- Maximum value: 100. '."\n" + .'- Default value: 10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名称。 不能使用某些预留关键字，如 test、mysql。', + 'description' => 'The name of the database. '."\n" + .'You cannot use reserved keywords, such as test and mysql. ', + 'type' => 'string', + 'required' => false, + 'example' => 'sms_pre', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询列表的删选关键字。', + 'description' => 'The search keyword. ', + 'type' => 'string', + 'required' => false, + 'example' => 'pay', + ], + ], + [ + 'name' => 'WithTables', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否返回数据库中的表信息。'."\n" + .'默认值：false。如果表的数量过大则可能导致接口超时', + 'description' => 'Specifies whether to return the information about tables in the database.'."\n" + .'Default value: false. '."\n" + .'> The operation may time out if the database contains a large number of tables.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id', + 'description' => 'The ID of the cluster.', + 'type' => 'string', + 'required' => false, + 'example' => 'ob****n0abo9uo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '租户中的数据库总数。', + 'description' => 'The total number of databases in the tenant. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Databases' => [ + 'title' => '租户中的数据库列表。', + 'description' => 'The list of databases in the tenant. ', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of databases in the tenant. ', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '数据库的状态。 - ONLINE: 运行中 - DELETING: 删除中', + 'description' => 'The status of the database. Valid values: '."\n" + .'- ONLINE: The database is running. '."\n" + .'- DELETING: The database is being deleted.', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'Description' => [ + 'title' => '数据库的描述信息。', + 'description' => 'The description of the database. ', + 'type' => 'string', + 'example' => 'test db', + ], + 'Encoding' => [ + 'title' => '数据库的编码。目前支持utf8mb4、gbk等编码。', + 'description' => 'The encoding standard of the database. Encoding standards such as utf8mb4 and GBK are supported. ', + 'type' => 'string', + 'example' => 'utf8mb4', + ], + 'DbType' => [ + 'title' => '数据库类型', + 'description' => 'The database type.', + 'type' => 'string', + 'example' => 'mysql', + ], + 'DatabaseName' => [ + 'title' => '数据库名称。', + 'description' => 'The name of the database. ', + 'type' => 'string', + 'example' => 'sms_pre', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the database was created.', + 'type' => 'string', + 'example' => '2022-02-21 15:41:06', + ], + 'Users' => [ + 'title' => '对该数据库赋权的账号信息。', + 'description' => 'The list of accounts that are granted privileges on this database.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of accounts that are granted privileges on this database.', + 'type' => 'object', + 'properties' => [ + 'UserType' => [ + 'title' => '账号类型。 - Admin：超级账户 - Normal：普通账户', + 'description' => 'The type of the account. Valid values: '."\n" + .'- Admin: the super administrator account. '."\n" + .'- Normal: a general account.', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Role' => [ + 'title' => '账号赋予该库的角色权限。 对于MySQL模式，角色为数据库（Database）级别，其有以下几类： - ReadWrite：读写权限，包括ALL PRIVILEGES； - ReadOnly：只读权限，包括SELECT - DDL: DDL权限，包括CREATE,DROP,ALTER,SHOW VIEW,CREATE VIEW - DML: DML权限，包括SELECT,INSERT,UPDATE,DELETE,SHOW VIEW。', + 'description' => 'The role of the account. '."\n" + .'In MySQL mode, a role is a database-level role. Valid values: '."\n" + .'- ReadWrite: a role that has the read and write privileges, namely ALL PRIVILEGES. '."\n" + .'- ReadOnly: a role that has only the read-only privilege SELECT. '."\n" + .'- DDL: a role that has the DDL privileges such as CREATE, DROP, ALTER, SHOW VIEW, and CREATE VIEW. '."\n" + .'- DML: a role that has the DML privileges such as SELECT, INSERT, UPDATE, DELETE, and SHOW VIEW. ', + 'type' => 'string', + 'example' => 'ReadOnly', + ], + 'UserName' => [ + 'title' => '账号名称。', + 'description' => 'The name of the account. ', + 'type' => 'string', + 'example' => 'user_pay_ro', + ], + 'Privileges' => [ + 'description' => 'If you have granted custom privileges on the database, this parameter indicates the custom privileges, separated by commas (,). Otherwise, no data is returned for this parameter.', + 'type' => 'string', + 'example' => 'select,delete,update', + ], + ], + ], + ], + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'example' => 't33h8y08k****', + ], + 'Tables' => [ + 'title' => '数据库表信息', + 'description' => 'The list of database tables.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of database tables.', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'title' => '数据库表名', + 'description' => 'The name of the database table. ', + 'type' => 'string', + 'example' => 'testTables', + ], + ], + ], + ], + 'RequiredSize' => [ + 'title' => '所需容量 单位（GB）', + 'description' => 'The storage space required, in GB.', + 'type' => 'number', + 'format' => 'double', + 'example' => '5.67 GB', + ], + 'DataSize' => [ + 'title' => '实际数据大小单位（GB）', + 'description' => 'The actual data size, in GB. '."\n" + .'><notice>This parameter is no longer used in later versions. RequiredSize is used instead.></notice>', + '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', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + ], + ], + ], + ], + '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":"<DescribeDatabasesResponse>\\n <TotalCount>1</TotalCount>\\n <Databases>\\n <Status>ONLINE</Status>\\n <Description>test db</Description>\\n <Encoding>utf8mb4</Encoding>\\n <DbType>mysql</DbType>\\n <DatabaseName>sms_pre</DatabaseName>\\n <CreateTime>2022-02-21 15:41:06</CreateTime>\\n <Users>\\n <UserType>Normal</UserType>\\n <Role>ReadOnly</Role>\\n <UserName>user_pay_ro</UserName>\\n </Users>\\n <TenantId>t33h8y08k****</TenantId>\\n <Tables>\\n <TableName>testTables</TableName>\\n </Tables>\\n <RequiredSize>0</RequiredSize>\\n <DataSize>5.67</DataSize>\\n </Databases>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</DescribeDatabasesResponse>","errorExample":""}]', + 'title' => 'DescribeDatabases', + ], + 'ModifyDatabaseDescription' => [ + 'summary' => 'You can call this operation to modify the description of an OceanBase database. ', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The description of the database. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **ModifyDatabaseDescription**. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名称。 不能使用某些预留关键字，如 test、mysql。', + 'description' => 'Example 1', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sms_pre', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库描述信息。', + 'description' => ' ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'this is a test database', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDatabaseDescriptionResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</ModifyDatabaseDescriptionResponse>","errorExample":""}]', + 'title' => 'ModifyDatabaseDescription', + ], + 'ModifyTenantUserStatus' => [ + 'summary' => 'You can call this operation to lock or unlock a specified database account. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库账号名称。 不能使用某些预留关键字，如 SYS、root等。', + 'description' => 'The list of database accounts in the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pay_test', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'UserStatus', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库账号的状态。 Locked：锁定 Normal：解锁', + 'description' => 'The status of the database account. Valid values: '."\n" + .'- Locked: The account is locked. '."\n" + .'- Online: The account is unlocked. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'The ID of the tenant. ', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **ModifyTenantUserStatus**. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '$.parameters[5].schema.example', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'Example 1', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'TenantUser' => [ + 'title' => '租户中的数据库账号信息', + 'description' => ' ', + 'type' => 'array', + 'items' => [ + 'description' => 'You can call this operation to lock or unlock a specified database account. ', + 'type' => 'object', + 'properties' => [ + 'UserStatus' => [ + 'title' => '数据库账号的状态。 - LOCKED：锁定 - ONLINE：解锁', + 'description' => '', + 'type' => 'string', + 'example' => 'LOCKED', + ], + 'UserName' => [ + 'title' => '账号名称。', + 'description' => '', + 'type' => 'string', + 'example' => 'pay_test', + ], + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => '', + 'type' => 'string', + 'example' => 't33h8y08k****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"TenantUser\\": [\\n {\\n \\"UserStatus\\": \\"LOCKED\\",\\n \\"UserName\\": \\"pay_test\\",\\n \\"TenantId\\": \\"t33h8y08k****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ModifyTenantUserStatusResponse>\\n <TenantUser>\\n <UserStatus>LOCKED</UserStatus>\\n <UserName>pay_test</UserName>\\n <TenantId>t33h8y08k****</TenantId>\\n </TenantUser>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</ModifyTenantUserStatusResponse>","errorExample":""}]', + 'title' => 'ModifyTenantUserStatus', + ], + 'ModifyDatabaseUserRoles' => [ + 'summary' => 'You can call this operation to modify the privileges of an account on a database. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DatabaseName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名称。 不能使用某些预留关键字，如 test、mysql。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sms_pre', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => 'A list of usernames and their respective roles. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'Users', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户名及具备的角色列表。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"UserName":"omstest","Role":"readwrite"}]', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The account information. ', + 'type' => 'string', + 'required' => false, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'The ID of the tenant. ', + 'type' => 'object', + 'properties' => [ + 'TenantUser' => [ + 'title' => '账号信息。', + 'description' => 'The name of the database. ', + 'type' => 'object', + 'properties' => [ + 'DatabaseName' => [ + 'title' => '数据库名称。', + 'description' => 'Example 1', + 'type' => 'string', + 'example' => 'sms_pre', + ], + 'Users' => [ + 'title' => '对数据库有赋权的账户信息', + 'description' => ' ', + 'type' => 'array', + 'items' => [ + 'description' => 'You can call this operation to modify the privileges of an account on a database. ', + 'type' => 'object', + 'properties' => [ + 'Role' => [ + 'title' => '账号赋予该库的角色权限。 对于MySQL模式，角色为数据库（Database）级别，其有以下几类： - ReadWrite：读写权限，包括ALL PRIVILEGES； - ReadOnly：只读权限，包括SELECT - DDL: DDL权限，包括CREATE,DROP,ALTER,SHOW VIEW,CREATE VIEW - DML: DML权限，包括SELECT,INSERT,UPDATE,DELETE,SHOW VIEW。', + 'description' => '', + 'type' => 'string', + 'example' => 'ReadOnly', + ], + 'UserName' => [ + 'title' => '账号名称。', + 'description' => '', + 'type' => 'string', + 'example' => 'user_pay_ro', + ], + ], + ], + 'example' => '', + ], + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => '', + 'type' => 'string', + 'example' => 't33h8y08k****', + ], + ], + 'example' => '', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TenantUser\\": {\\n \\"DatabaseName\\": \\"sms_pre\\",\\n \\"Users\\": [\\n {\\n \\"Role\\": \\"ReadOnly\\",\\n \\"UserName\\": \\"user_pay_ro\\"\\n }\\n ],\\n \\"TenantId\\": \\"t33h8y08k****\\"\\n },\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDatabaseUserRolesResponse>\\n <TenantUser>\\n <DatabaseName>sms_pre</DatabaseName>\\n <Users>\\n <Role>ReadOnly</Role>\\n <UserName>user_pay_ro</UserName>\\n </Users>\\n <TenantId>t33h8y08k****</TenantId>\\n </TenantUser>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</ModifyDatabaseUserRolesResponse>","errorExample":""}]', + 'title' => 'ModifyDatabaseUserRoles', + ], + 'DeleteDatabases' => [ + 'summary' => 'You can call this operation to delete one or more tenants from an OceanBase cluster. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'DatabaseNames', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名称列表。 其为Json格式的数组，数组中每个对象都为数据库名称的字符串。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["sms_pre", "pay_pre"]', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDatabasesResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</DeleteDatabasesResponse>","errorExample":""}]', + 'title' => 'DeleteDatabases', + ], + 'DescribeParameters' => [ + 'summary' => 'You can call this operation to query the information of cluster or tenant parameters. ', + 'methods' => [ + 'post', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => '498529', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'Dimension', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数类型。 当前支持集群（CLUSTER)和租户（TENANT）', + 'description' => 'It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate executable SDK code samples. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TENANT', + ], + ], + [ + 'name' => 'DimensionValue', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数类型的资源标识。 如果为集群参数可以不填，若为租户的参数，则传入租户的TenantId。', + 'description' => 'Alibaba Cloud CLI', + 'type' => 'string', + 'required' => false, + 'example' => 'ob2mr3oae0****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'The default value of the parameter. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The return result of the request. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Parameters' => [ + 'title' => '参数列表信息', + 'description' => 'Indicates whether a restart is required for changes to the parameter to take effect. Valid values: '."\n" + .'- true: A restart is required. '."\n" + .'- false: A restart is not required. ', + 'type' => 'array', + 'items' => [ + 'description' => 'The resource ID of the parameter type. '."\n" + .'You can leave this parameter unspecified when you call this operation to query cluster parameters. In the case of tenant parameters, pass the tenant ID. ', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => '参数的描述信息。', + 'description' => 'The description of the parameter. ', + 'type' => 'string', + 'example' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeParameters**. ', + ], + 'ValueType' => [ + 'title' => '参数取值的类型。 其支持： - ENUM: 数值枚举 - RANGE: 数值范围 - TIME: 时间 - CAPACITY：存储容量值（K，M，G）', + 'description' => 'The invalid value range of the parameter. '."\n" + .'It is an array with two string elements, which represents a range. The first element represents the minimum value and the second element represents the maximum value. ', + 'type' => 'string', + 'example' => 'CAPACITY', + ], + 'CurrentValue' => [ + 'title' => '参数的当前取值。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'example' => '600', + ], + 'NeedReboot' => [ + 'title' => '修改此参数是否需要重启 - true：需要重启 - false：不需要重启', + 'description' => 'The name of the parameter. ', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Name' => [ + 'title' => '参数名称。', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'connect_timeout', + ], + 'DefaultValue' => [ + 'title' => '参数的默认取值。', + 'description' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DescribeParameters'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&Dimension=TENANT'."\n" + .'&DimensionValue=ob2mr3oae0****'."\n" + .'&Common request parameters'."\n" + .'```', + 'type' => 'string', + 'example' => '600s', + ], + 'RejectedValue' => [ + 'title' => '参数的不允许取值范围。 其格式为具备两个字符串元素的数组类型，表示一个范围值，第一个元素为最小值，第二个元素为最大值。', + 'description' => '{'."\n" + .' "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",'."\n" + .' "Parameters": ['."\n" + .' {'."\n" + .' "Description": "The maximum delay allowed in weak-consistency reads.",'."\n" + .' "ValueType": "CAPACITY",'."\n" + .' "CurrentValue": "600",'."\n" + .' "NeedReboot": false,'."\n" + .' "Name": "connect_timeout",'."\n" + .' "DefaultValue": "600s",'."\n" + .' "RejectedValue": ['."\n" + .' "1s"'."\n" + .' ],'."\n" + .' "AcceptableValue": ['."\n" + .' "1s"'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + 'type' => 'array', + 'items' => [ + 'description' => '<DescribeParametersResponse>'."\n" + .' <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>'."\n" + .' <Parameters>'."\n" + .' <Description>The maximum delay allowed in weak-consistency reads.</Description>'."\n" + .' <ValueType>CAPACITY</ValueType>'."\n" + .' <CurrentValue>600</CurrentValue>'."\n" + .' <NeedReboot>false</NeedReboot>'."\n" + .' <Name>connect_timeout</Name>'."\n" + .' <DefaultValue>600s</DefaultValue>'."\n" + .' <RejectedValue>1s</RejectedValue>'."\n" + .' <AcceptableValue>1s</AcceptableValue>'."\n" + .' </Parameters>'."\n" + .'</DescribeParametersResponse>', + 'type' => 'string', + 'example' => '1s', + ], + ], + 'AcceptableValue' => [ + 'title' => '参数的可接受取值范围。 其格式为具备两个字符串元素的数组类型，表示一个范围值，第一个元素为最小值，第二个元素为最大值。', + 'description' => ' DescribeParameters', + 'type' => 'array', + 'items' => [ + 'title' => 'ob317v4uif****', + 'description' => 'ob317v4uif****', + 'type' => 'string', + 'example' => '1s', + ], + ], + 'Readonly' => [ + 'title' => '参数是否只读', + 'description' => '参数是否只读', + 'type' => 'boolean', + ], + 'Unit' => [ + 'title' => '参数值单位', + 'type' => 'string', + 'example' => 's', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Parameters\\": [\\n {\\n \\"Description\\": \\"弱读允许的最大时间延迟时间\\",\\n \\"ValueType\\": \\"CAPACITY\\",\\n \\"CurrentValue\\": \\"600\\",\\n \\"NeedReboot\\": false,\\n \\"Name\\": \\"connect_timeout\\",\\n \\"DefaultValue\\": \\"600s\\",\\n \\"RejectedValue\\": [\\n \\"1s\\"\\n ],\\n \\"AcceptableValue\\": [\\n \\"2s\\"\\n ],\\n \\"Readonly\\": false,\\n \\"Unit\\": \\"s\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeParametersResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <Parameters>\\n <Description>弱读允许的最大时间延迟时间</Description>\\n <ValueType>CAPACITY</ValueType>\\n <CurrentValue>600</CurrentValue>\\n <NeedReboot>false</NeedReboot>\\n <Name>connect_timeout</Name>\\n <DefaultValue>600s</DefaultValue>\\n <RejectedValue>1s</RejectedValue>\\n <AcceptableValue>1s</AcceptableValue>\\n </Parameters>\\n</DescribeParametersResponse>","errorExample":""}]', + 'title' => ' DescribeParameters', + ], + 'DescribeParametersHistory' => [ + 'summary' => 'You can call this operation to query the modification history of cluster or tenant parameters. ', + 'methods' => [ + 'post', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'Dimension', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数类型。 当前支持集群（CLUSTER)和租户（TENANT）', + 'description' => 'The type of the parameter. '."\n" + .'Valid values: CLUSTER and TENANT. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TENANT', + ], + ], + [ + 'name' => 'DimensionValue', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数类型的资源标识。 如果为集群参数可以不填，若为租户的参数，则传入租户的TenantId。', + 'description' => 'The resource ID of the parameter type. '."\n" + .'You can leave this parameter unspecified when you call this operation to query cluster parameters. In the case of tenant parameters, pass the tenant ID. ', + 'type' => 'string', + 'required' => false, + 'example' => 't4qx8****', + ], + ], + [ + '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' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'description' => 'The number of rows to return on each page. '."\n" + .'- Maximum value: 100.'."\n" + .'- Default value: 10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => 'The number of the page to return. '."\n" + .'- Start value: 1 '."\n" + .'- Default value: 1 ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => 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' => '请求ID。', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Respond' => [ + 'description' => 'The list of parameter modification records.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total count, which takes effect in a pagination query.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PageNumber' => [ + 'description' => 'The number of the page to return. '."\n" + .'- Start value: 1 '."\n" + .'- Default value: 1 ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Parameters' => [ + 'description' => 'The information about parameters.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about parameters.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '修改状态。 - APPLIED：成功 - SCHEDULING：待修改。', + 'description' => 'The modification status of the parameter. Valid values: '."\n" + .'* APPLIED: The parameter was modified.'."\n" + .'* SCHEDULING: The parameter was to be modified.', + 'type' => 'string', + 'example' => 'APPLIED', + ], + 'OldValue' => [ + 'title' => '参数修改前的值。', + 'description' => 'The value of the parameter before the modification.', + 'type' => 'string', + 'example' => '10', + ], + 'UpdateTime' => [ + 'title' => '参数修改的生效时间。', + 'description' => 'The time when the parameter modification took effect.', + 'type' => 'string', + 'example' => '2024-11-26T08:03:34Z', + ], + 'CreateTime' => [ + 'title' => '参数修改的发起时间。', + 'description' => 'The time when the parameter modification was initiated.', + 'type' => 'string', + 'example' => '2024-11-26T08:03:34Z', + ], + 'DimensionValue' => [ + 'title' => '参数类型的资源标识。 如果为集群则为DEFAULT_DIMENSION_VALUE，若为租户的参数，则传入租户的TenantId。', + 'description' => 'The resource ID of the parameter type. When you called this operation to query the modification history of cluster parameters, the value is DEFAULT_DIMENSION_VALUE. When you called this operation to query the modification history of tenant parameters, the value is the tenant ID.', + 'type' => 'string', + 'example' => 't69uo********', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + '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":"<DescribeParametersHistoryResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <Respond>\\n <TotalCount>2</TotalCount>\\n <Parameters>\\n <Status>APPLIED</Status>\\n <OldValue>300</OldValue>\\n <UpdateTime>2021-09-14 10:57:44</UpdateTime>\\n <CreateTime>2021-09-14 10:57:44</CreateTime>\\n <DimensionValue>DEFAULT_DIMENSION_VALUE</DimensionValue>\\n <Name>connect_timeout</Name>\\n <NewValue>200</NewValue>\\n </Parameters>\\n </Respond>\\n</DescribeParametersHistoryResponse>","errorExample":""}]', + 'title' => ' DescribeParametersHistory', + ], + 'ModifyParameters' => [ + 'summary' => 'You can call this operation to modify the parameters of a cluster or tenant. ', + 'methods' => [ + 'post', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'Alibaba Cloud CLI', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'DimensionValue', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数类型的资源标识。 如果为集群参数可以不填，若为租户的参数，则传入租户的TenantId。', + 'description' => 'The cause of the modification failure. ', + 'type' => 'string', + 'required' => false, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'Dimension', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数类型。 当前支持集群（CLUSTER)和租户（TENANT）', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TENANT', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数信息。 其为一个Json格式的数组，数组中每个对象包括两个元素：参数名称（Name）和参数值（Value）。 注意：集群和租户可修改的参数名称和参数值的范围不同，详见DescribeParameters。', + 'description' => 'The resource ID of the parameter type. '."\n" + .'You can leave this parameter unspecified when you call this operation to modify cluster parameters. In the case of tenant parameters, pass the tenant ID. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"Name":"connect_timeout","Value":"20"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'The parameters. '."\n" + .'It is a JSON array. Each object in the array has two elements: Name and Value. '."\n" + ."\n" + .'> <br>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' => '请求ID。', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **ModifyParameters**. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Results' => [ + 'title' => '修改结果信息。', + 'description' => 'Example 1', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否修改成功。 - true：修改成功 - false：修改失败', + 'description' => ' ', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Message' => [ + 'title' => '修改失败信息。', + 'description' => ' ', + 'type' => 'string', + 'example' => 'schedule timeout.', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Results\\": {\\n \\"Success\\": false,\\n \\"Message\\": \\"schedule timeout.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<ModifyParametersResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <Results>\\n <Success>false</Success>\\n <Message>schedule timeout.</Message>\\n </Results>\\n</ModifyParametersResponse>","errorExample":""}]', + 'title' => 'ModifyParameters', + ], + 'DescribeSessionList' => [ + 'summary' => 'You can call this operation to query sessions between the ApsaraDB for OceanBase and the application.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + '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****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'example' => 't4louaeei****', + ], + ], + ], + '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' => '代理服务的sesson Id', + 'description' => 'The session ID of the proxy service.', + 'type' => 'string', + 'example' => 'd2c90ad0-bc54-410f-bb89-2dcf14aa3c6d', + ], + 'Host' => [ + 'title' => '客户端地址，ip:port格式', + 'description' => 'The address of the client, with the format ip:port.', + 'type' => 'string', + 'example' => '192.***.**.100:80'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'example' => 't4louaeei****', + ], + ], + [ + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => 'BatchKillSessionList', + ], + 'BatchKillProcessList' => [ + 'summary' => 'You can call this operation to close sessions in batches. Please note that this operation is executed asynchronously. After calling this operation, you need to verify it by calling DescribeProcessStatsComposition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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****', + ], + ], + [ + '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.***.**.***"}] ', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the tenant.', + 'type' => 'string', + 'required' => true, + 'example' => 't33h8y08k****', + ], + ], + [ + 'name' => 'ByObSessionId', + 'in' => 'formData', + 'schema' => [ + 'title' => '表示是否根据指定的数据库连接ID来进行kill操作。默认为false，根据代理链接ID来进行KILL对应的所有数据库连接；', + 'type' => 'boolean', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"Success\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'BatchKillProcessList', + ], + 'DescribeProcessStatsComposition' => [ + 'summary' => 'You can call this operation to query session information.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'OceanBase 集群 ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + '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' => 't33h8y08k****', + ], + ], + [ + '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.*.*.*', + ], + ], + [ + 'name' => 'ServerIp', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The IP address of the server.', + 'type' => 'string', + 'required' => false, + 'example' => '127.*.*.*', + ], + ], + [ + 'name' => 'Users', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The username of the database.', + 'type' => 'string', + 'required' => false, + 'example' => '["test_user"]', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The status of the session.', + 'type' => 'string', + 'required' => false, + 'example' => 'ACTIVE', + ], + ], + [ + 'name' => 'MergeDynamicSql', + 'in' => 'formData', + 'schema' => [ + 'type' => 'boolean', + ], + ], + ], + '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', + ], + 'Data' => [ + 'description' => 'The return result.', + 'type' => 'object', + 'properties' => [ + 'TotalSessionCount' => [ + 'description' => 'The total number of sessions.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'ActiveSessionCount' => [ + 'description' => 'The number of active sessions.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '60', + ], + 'IdleSessionCount' => [ + 'description' => 'The number of sessions in the SLEEP state.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'AllProcessList' => [ + 'description' => 'The details of all sessions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SqlText' => [ + 'description' => 'The SQL text.', + 'type' => 'string', + 'example' => 'select * from c1 where id = 100;', + ], + 'TenantId' => [ + 'description' => 'The ID of the tenant.', + 'type' => 'string', + 'example' => 'test_mysql', + ], + 'Database' => [ + 'description' => 'The name of the database.', + 'type' => 'string', + 'example' => 'c1', + ], + 'User' => [ + 'description' => 'The user to which the session belongs.', + 'type' => 'string', + 'example' => 'test_user', + ], + 'ExecuteTime' => [ + 'description' => 'The definition of this parameter varies based on whether the SQL statement is executed.'."\n" + .'* When the request is accepted and the result is not returned to the client, this parameter indicates the time interval between the time when the request is accepted and the current time, in seconds.'."\n" + .'* When the request is not accepted, this parameter indicates the duration for which the current status lasts, in seconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'CpuTime' => [ + 'description' => 'The CPU time spent on executing the current SQL statement, in seconds. '."\n" + ."\n" + .'> This parameter is introduced since OceanBase Database V3.2.4 BP5.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ServerIp' => [ + 'description' => 'The IP address of the server.', + 'type' => 'string', + 'example' => 'xx.xx.xx.xx', + ], + 'ClientIp' => [ + 'description' => 'The IP address of the client.', + 'type' => 'string', + 'example' => 'xx.xx.xx.xx', + ], + 'SessionId' => [ + 'description' => 'The ID of the session.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '322441****', + ], + 'ProxySessId' => [ + 'description' => 'The session ID of the client. If an OceanBase Database Proxy (ODP) is used for connection, the session ID of the ODP is returned.', + 'type' => 'string', + 'example' => '7521015416********', + ], + 'Command' => [ + 'description' => 'The type of the SQL statement being executed in the session.', + 'type' => 'string', + 'example' => 'Query', + ], + 'Status' => [ + 'description' => 'The status of the session.', + 'type' => 'string', + 'example' => 'ACTIVE', + ], + 'SqlId' => [ + 'description' => 'The ID of the SQL statement.', + 'type' => 'string', + 'example' => '45CCBDC7DEBDCDAXXXXAFC********', + ], + 'TraceId' => [ + 'description' => 'The ID of the trace.', + 'type' => 'string', + 'example' => 'YB420XXX128-00062XXXX8313XXX1-X-X', + ], + 'PlanId' => [ + 'description' => 'The ID of the execution plan.', + 'type' => 'integer', + 'example' => '1898', + 'format' => 'int64', + ], + 'DynamicSql' => [ + 'type' => 'boolean', + ], + 'ProcessSqlLists' => [ + 'title' => '子 SQL 列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SqlText' => [ + 'type' => 'string', + ], + 'TenantId' => [ + 'type' => 'string', + ], + 'Database' => [ + 'type' => 'string', + ], + 'User' => [ + 'type' => 'string', + ], + 'ExecuteTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CpuTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ServerIp' => [ + 'type' => 'string', + ], + 'ClientIp' => [ + 'type' => 'string', + ], + 'SessionId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ProxySessId' => [ + 'type' => 'string', + ], + 'Command' => [ + 'type' => 'string', + ], + 'Status' => [ + 'type' => 'string', + ], + 'SqlId' => [ + 'type' => 'string', + ], + 'TraceId' => [ + 'type' => 'string', + ], + 'PlanId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DynamicSql' => [ + 'type' => 'boolean', + ], + 'ProcessSqlList' => [ + 'title' => '子 SQL 列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SqlText' => [ + 'type' => 'string', + ], + 'TenantId' => [ + 'type' => 'string', + ], + 'Database' => [ + 'type' => 'string', + ], + 'User' => [ + 'type' => 'string', + ], + 'ExecuteTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CpuTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ServerIp' => [ + 'type' => 'string', + ], + 'ClientIp' => [ + 'type' => 'string', + ], + 'SessionId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ProxySessId' => [ + 'type' => 'string', + ], + 'Command' => [ + 'type' => 'string', + ], + 'Status' => [ + 'type' => 'string', + ], + 'SqlId' => [ + 'type' => 'string', + ], + 'TraceId' => [ + 'type' => 'string', + ], + 'PlanId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DynamicSql' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + ], + 'ServerSn' => [ + 'type' => 'string', + ], + ], + 'description' => 'The details of all sessions.', + ], + ], + 'SessionStatistics' => [ + 'description' => 'The session data in different dimensions.', + 'type' => 'object', + 'properties' => [ + 'UserStatistics' => [ + 'description' => 'The session data in the user dimension.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricValue' => [ + 'description' => 'The username.', + 'type' => 'string', + 'example' => 'test_user', + ], + 'ActiveCount' => [ + 'description' => 'The number of active sessions.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'Type' => [ + 'description' => 'The dimension. This value is fixed to user.', + 'type' => 'string', + 'example' => 'user', + ], + ], + 'description' => 'The session data in the user dimension.', + ], + ], + 'SourceStatistics' => [ + 'description' => 'The session data in the client dimension.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricValue' => [ + 'description' => 'The IP address of the client.', + 'type' => 'string', + 'example' => 'xx.xx.xx.xx', + ], + 'ActiveCount' => [ + 'description' => 'The number of active sessions.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'Type' => [ + 'description' => 'The dimension. This value is fixed to client.', + 'type' => 'string', + 'example' => 'client', + ], + ], + 'description' => 'The session data in the client dimension.', + ], + ], + 'DataBaseStatistics' => [ + 'description' => 'The session data in the database dimension.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricValue' => [ + 'description' => 'The name of the database.', + 'type' => 'string', + 'example' => 'test_database', + ], + 'ActiveCount' => [ + 'description' => 'The number of active sessions.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'Type' => [ + 'description' => 'The dimension. This value is fixed to database.', + 'type' => 'string', + 'example' => 'database', + ], + ], + 'description' => 'The session data in the database dimension.', + ], + ], + ], + ], + 'ObVersion' => [ + 'title' => 'Ob版本号', + 'description' => 'The version of OceanBase Database.', + 'type' => 'string', + 'example' => '3.2.4', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"TotalSessionCount\\": 100,\\n \\"ActiveSessionCount\\": 60,\\n \\"IdleSessionCount\\": 30,\\n \\"AllProcessList\\": [\\n {\\n \\"SqlText\\": \\"select * from c1 where id = 100;\\",\\n \\"TenantId\\": \\"t********\\",\\n \\"Database\\": \\"c1\\",\\n \\"User\\": \\"test_user\\",\\n \\"ExecuteTime\\": 5,\\n \\"CpuTime\\": 1,\\n \\"ServerIp\\": \\"xx.xx.xx.xx\\",\\n \\"ClientIp\\": \\"xx.xx.xx.xx\\",\\n \\"SessionId\\": 0,\\n \\"ProxySessId\\": \\"7521015416********\\",\\n \\"Command\\": \\"Query\\",\\n \\"Status\\": \\"ACTIVE\\",\\n \\"SqlId\\": \\"45CCBDC7DEBDCDAXXXXAFC********\\",\\n \\"TraceId\\": \\"YB420XXX128-00062XXXX8313XXX1-X-X\\",\\n \\"PlanId\\": 1898,\\n \\"DynamicSql\\": false,\\n \\"ProcessSqlLists\\": [\\n {\\n \\"SqlText\\": \\"select * from c1 where id = 100;\\",\\n \\"TenantId\\": \\"t********\\",\\n \\"Database\\": \\"c2\\",\\n \\"User\\": \\"test_user\\",\\n \\"ExecuteTime\\": 5,\\n \\"CpuTime\\": 1,\\n \\"ServerIp\\": \\"xx.xx.xx.xx\\",\\n \\"ClientIp\\": \\"xx.xx.xx.xx\\",\\n \\"SessionId\\": 0,\\n \\"ProxySessId\\": \\"7521015416********\\",\\n \\"Command\\": \\"Query\\",\\n \\"Status\\": \\"ACTIVE\\",\\n \\"SqlId\\": \\"45CCBDC7DEBDCDAXXXXAFC********\\",\\n \\"TraceId\\": \\"YB420XXX128-00062XXXX8313XXX1-X-X\\",\\n \\"PlanId\\": 1898,\\n \\"DynamicSql\\": false,\\n \\"ProcessSqlList\\": [\\n {\\n \\"SqlText\\": \\"select * from c1 where id = 100;\\",\\n \\"TenantId\\": \\"t********\\",\\n \\"Database\\": \\"c3\\",\\n \\"User\\": \\"test_user\\",\\n \\"ExecuteTime\\": 5,\\n \\"CpuTime\\": 1,\\n \\"ServerIp\\": \\"xx.xx.xx.xx\\",\\n \\"ClientIp\\": \\"xx.xx.xx.xx\\",\\n \\"SessionId\\": 0,\\n \\"ProxySessId\\": \\"7521015416********\\",\\n \\"Command\\": \\"Query\\",\\n \\"Status\\": \\"ACTIVE\\",\\n \\"SqlId\\": \\"45CCBDC7DEBDCDAXXXXAFC********\\\\n\\",\\n \\"TraceId\\": \\"YB420XXX128-00062XXXX8313XXX1-X-X\\",\\n \\"PlanId\\": 1898,\\n \\"DynamicSql\\": false\\n }\\n ]\\n }\\n ],\\n \\"ServerSn\\": \\"i-bp1*****sw64dhb*****\\"\\n }\\n ],\\n \\"SessionStatistics\\": {\\n \\"UserStatistics\\": [\\n {\\n \\"MetricValue\\": \\"test_user\\",\\n \\"ActiveCount\\": 25,\\n \\"TotalCount\\": 30,\\n \\"Type\\": \\"user\\"\\n }\\n ],\\n \\"SourceStatistics\\": [\\n {\\n \\"MetricValue\\": \\"xx.xx.xx.xx\\",\\n \\"ActiveCount\\": 25,\\n \\"TotalCount\\": 30,\\n \\"Type\\": \\"client\\"\\n }\\n ],\\n \\"DataBaseStatistics\\": [\\n {\\n \\"MetricValue\\": \\"test_database\\",\\n \\"ActiveCount\\": 25,\\n \\"TotalCount\\": 30,\\n \\"Type\\": \\"database\\"\\n }\\n ]\\n },\\n \\"ObVersion\\": \\"3.2.4\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeProcessStatsComposition', + ], + 'KillProcessList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + '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****', + ], + ], + [ + 'name' => 'SessionList', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The list of the sessions that need to be closed.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"ServerIp":"192.168.13.119","SessionId":"3221614618"}]', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'example' => 't4louaeei****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => 'The data returned.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data returned from the request.', + 'type' => 'object', + 'properties' => [ + 'SessionId' => [ + 'description' => 'The ID of the session.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1123', + ], + 'ServerIp' => [ + 'description' => 'The IP address of the server.', + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'Status' => [ + 'description' => 'The status of the task.', + 'type' => 'string', + 'example' => 'SLEEP', + ], + 'ErrorMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'Instance not found.', + ], + 'ClientIp' => [ + 'description' => 'The client IP address.', + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'TenantId' => [ + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'example' => 't3ogqv07a56n4', + ], + 'User' => [ + 'description' => 'The database username.', + 'type' => 'string', + 'example' => 'oas', + ], + 'Database' => [ + 'description' => 'The name of the database.', + 'type' => 'string', + 'example' => 'test', + ], + 'SqlText' => [ + 'description' => 'The SQL statement.', + 'type' => 'string', + 'example' => ':', + ], + 'Command' => [ + 'description' => 'The start command for the container of the application.', + 'type' => 'string', + 'example' => 'select 1', + ], + 'ExecuteTime' => [ + 'description' => 'Execution time (UTC+8). If it is left empty, it means to execute immediately.', + 'type' => 'string', + 'example' => '142', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"SessionId\\": 1123,\\n \\"ServerIp\\": \\"127.*.*.*\\",\\n \\"Status\\": \\"SLEEP\\",\\n \\"ErrorMessage\\": \\"Instance not found.\\",\\n \\"ClientIp\\": \\"127.*.*.*\\",\\n \\"TenantId\\": \\"t3ogq******n4\\",\\n \\"User\\": \\"oas\\",\\n \\"Database\\": \\"test\\",\\n \\"SqlText\\": \\":\\",\\n \\"Command\\": \\"select 1\\",\\n \\"ExecuteTime\\": \\"142\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'KillProcessList', + 'summary' => 'You can call this operation to close a session.', + ], + 'DescribeOasAnomalySQLList' => [ + 'summary' => 'You can call this API to view the list of SQL statements that are identified as having performance issues by the diagnostic system.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The start time of the monitoring data. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T04:38:38Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The end time of the monitoring data. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T05:38:38Z', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the database. ', + 'type' => 'string', + 'required' => false, + 'example' => 'db_****', + ], + ], + [ + 'name' => 'SearchKeyWord', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The search keyword. ', + 'type' => 'string', + 'required' => false, + 'example' => 'update', + ], + ], + [ + 'name' => 'SearchParam', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The search parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'cputime', + ], + ], + [ + 'name' => 'SearchRule', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The search rule. '."\n" + .'Valid values: "=", ">", ">=", "<", and "<="', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + ], + [ + 'name' => 'SearchValue', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The search value. ', + 'type' => 'string', + 'required' => false, + 'example' => '0.01', + ], + ], + [ + 'name' => 'SqlId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'SQL ID.', + 'type' => 'string', + 'required' => false, + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + ], + [ + 'name' => 'NodeIp', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The node IP.', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp19y05uq6x*********', + ], + ], + [ + 'name' => 'FilterCondition', + 'in' => 'formData', + 'schema' => [ + 'description' => 'All parameters are referenced by the symbol @. For a list of available parameters, refer to the returned parameters in [Query performance indicators of an SQL statement](https://en.oceanbase.com/docs/community-ocp-en-10000000000840290).', + 'type' => 'string', + 'required' => false, + 'example' => '@avgCpuTime > 20 and @executions > 100', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The language of the response. Valid values:'."\n" + .'- zh: Chinese'."\n" + .'- en: English', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + [ + 'name' => 'SqlTextLength', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Max length of the returned SQL text.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '65535', + ], + ], + [ + 'name' => 'Current', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The current page.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Page size.'."\n" + .'- Start value: 1'."\n" + .'- Default value: 1', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否动态SQL', + 'description' => 'Specifies whether the specified SQL statements are dynamic SQL statements.'."\n" + .'> This parameter specifies whether the values of the `SqlId` parameter are the IDs of dynamic SQL statements.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'MergeDynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '返回结果时，是否合并动态 SQL', + 'description' => 'Specifies whether to merge dynamic SQL statements in the return result. '."\n" + ."\n" + .'> This parameter specifies whether to aggregate the results of IN queries.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Returned response.', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '可疑SQL的个数', + 'description' => 'The information about suspicious SQL statements.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about suspicious SQL statements.', + 'type' => 'object', + 'properties' => [ + 'AvgCpuTime' => [ + 'title' => '可疑SQL的平均cpu时间', + 'description' => 'Average CPU time of the suspicious SQL.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.24', + ], + 'AvgElapsedTime' => [ + 'title' => '可疑SQL的平均响应时间', + 'description' => 'Average response time of the suspicious SQL.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.28', + ], + 'AvgGetPlanTime' => [ + 'title' => '可疑SQL的平均获取执行计划的时间', + 'description' => 'Average time to obtain the execution plan of the suspicious SQL.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CpuTime' => [ + 'title' => '可疑SQL的cpu时间', + 'description' => 'CPU time of the suspicious SQL.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.23', + ], + 'DbName' => [ + 'title' => '数据库名', + 'description' => 'The name of the database. ', + 'type' => 'string', + 'example' => 'db_***', + ], + 'DiagTypes' => [ + 'title' => '诊断类型', + 'description' => 'The type of the diagnosis.', + 'type' => 'array', + 'items' => [ + 'description' => 'The type of the diagnosis.', + 'type' => 'string', + 'example' => '['."\n" + .' "TABLE_SCAN_INDEX_NOT_USED"'."\n" + .' ]', + ], + ], + 'Diagnosis' => [ + 'title' => '诊断详情', + 'description' => 'The details of diagnosis.', + 'type' => 'string', + 'example' => '-', + ], + 'Executions' => [ + 'title' => '可疑SQL的总执行次数', + 'description' => 'Total execution count of the suspicious SQL.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'LastExecutedTime' => [ + 'title' => '', + 'description' => 'Last execution time of the suspicious SQL.', + 'type' => 'string', + 'format' => 'double', + 'example' => '2023-04-12T04:38:38Z', + ], + 'RiskLevel' => [ + 'title' => '危险等级', + 'description' => 'Risk level.', + 'type' => 'string', + 'example' => 'high', + ], + 'SqlId' => [ + 'title' => 'sql id ', + 'description' => 'SQL ID.', + 'type' => 'string', + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + 'SqlTextShort' => [ + 'title' => 'sql文本前缀', + 'description' => 'Prefix of the SQL text.', + 'type' => 'string', + 'example' => 'delete /*+ XXX PARALLEL(4) */ from', + ], + 'Suggestion' => [ + 'title' => '可疑SQL的建议', + 'description' => 'Suggestion for the suspicious SQL.', + 'type' => 'string', + 'example' => 'review', + ], + 'SumElapsedTime' => [ + 'title' => '', + 'description' => 'Total response time of the suspicious SQL.', + 'type' => 'number', + 'example' => '11452126.36', + 'format' => 'double', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => 'Username.', + 'type' => 'string', + 'example' => 'test_user', + ], + 'DynamicSql' => [ + 'title' => '是否动态SQL', + 'description' => '是否动态SQL', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SqlList' => [ + 'description' => 'The list of SQL statements.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of SQL statements.', + 'type' => 'object', + 'properties' => [ + 'AvgCpuTime' => [ + 'title' => '可疑SQL的平均cpu时间', + 'description' => 'The average CPU time.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.24', + ], + 'AvgElapsedTime' => [ + 'title' => '可疑SQL的平均响应时间', + 'description' => 'The average response time.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.28', + ], + 'AvgGetPlanTime' => [ + 'title' => '可疑SQL的平均获取执行计划的时间', + 'description' => 'The average plan generation time.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CpuTime' => [ + 'title' => '可疑SQL的cpu时间', + 'description' => 'The total CPU time.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.23', + ], + 'DbName' => [ + 'title' => '数据库名', + 'description' => 'The name of the database.', + 'type' => 'string', + 'example' => 'test_hsp****eway', + ], + 'DiagTypes' => [ + 'title' => '诊断类型', + 'description' => 'The diagnostic types.', + 'type' => 'array', + 'items' => [ + 'description' => 'The diagnostic types.', + 'type' => 'string', + 'example' => '['."\n" + .' "CPU_TIME_PROPORTION_HIGH"'."\n" + .' ]', + ], + ], + 'Diagnosis' => [ + 'title' => '诊断详情', + 'description' => 'The diagnostic details. '."\n" + ."\n" + .'> This parameter is deprecated.', + 'type' => 'string', + 'example' => '-', + ], + 'Executions' => [ + 'title' => '可疑SQL的总执行次数', + 'description' => 'The total number of executions.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'LastExecutedTime' => [ + 'description' => 'The last execution time.', + 'type' => 'string', + 'example' => '2023-04-12T04:38:38Z', + 'title' => '最后一次执行可疑SQL的时间', + ], + 'RiskLevel' => [ + 'title' => '危险等级', + 'description' => 'The risk level.', + 'type' => 'string', + 'example' => 'LOW', + ], + 'SqlId' => [ + 'title' => 'sql id ', + 'description' => 'The ID of the SQL statement.', + 'type' => 'string', + 'example' => '3A645****789F13DE0CF6D084FF9****', + ], + 'SqlTextShort' => [ + 'title' => 'sql文本前缀', + 'description' => 'The prefix of the SQL text.', + 'type' => 'string', + 'example' => 'select * from test', + ], + 'Suggestion' => [ + 'title' => '可疑SQL的建议', + 'description' => 'The suggestion on the suspicious SQL statement.', + 'type' => 'string', + 'example' => '{\'Role\': \'eSG\', \'Result\': \'100\', \'Suggestion\': \'TRACER_OTHER_ERR\'}', + ], + 'SumElapsedTime' => [ + 'title' => '可疑SQL的总响应时间', + 'description' => 'The total response time.', + 'type' => 'number', + 'example' => '11452126.36', + 'format' => 'double', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => 'The username.', + 'type' => 'string', + 'example' => 'test_user', + ], + 'AvgDbTime' => [ + 'title' => '平均数据库时间', + 'description' => 'The average DB time.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SumDbTime' => [ + 'title' => '总数据库时间', + 'description' => 'The total DB time.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'AvgRetryCount' => [ + 'description' => 'The average number of retries.', + 'type' => 'number', + 'format' => 'double', + 'example' => '4', + ], + 'SumRetryCount' => [ + 'description' => 'The total number of retries.', + 'type' => 'number', + 'format' => 'double', + 'example' => '6', + ], + 'AvgLogicalReads' => [ + 'description' => 'The average number of logical reads.', + 'type' => 'number', + 'format' => 'double', + 'example' => '25', + ], + 'FormatSqlId' => [ + 'title' => 'FormatSqlId', + 'type' => 'string', + ], + ], + ], + ], + 'AvgDbTime' => [ + 'description' => 'The average DB time.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SumDbTime' => [ + 'title' => '总数据库时间', + 'description' => 'The total DB time.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'AvgRetryCount' => [ + 'description' => 'The average number of retries.', + 'type' => 'number', + 'format' => 'double', + 'example' => '4', + ], + 'SumRetryCount' => [ + 'description' => 'The total number of retries.', + 'type' => 'number', + 'format' => 'double', + 'example' => '6', + ], + 'AvgLogicalReads' => [ + 'description' => 'The average number of logical reads.', + 'type' => 'number', + 'format' => 'double', + 'example' => '25', + ], + 'FormatSqlId' => [ + 'title' => 'FormatSqlId', + 'type' => 'string', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => '473469**-AA6F-4D**-B3DB-A***********', + ], + 'TotalCount' => [ + 'description' => 'The total count. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AvgCpuTime\\": 100.24,\\n \\"AvgElapsedTime\\": 100.28,\\n \\"AvgGetPlanTime\\": 0,\\n \\"CpuTime\\": 100.23,\\n \\"DbName\\": \\"db_***\\",\\n \\"DiagTypes\\": [\\n \\"[\\\\n \\\\\\"CPU_TIME_PROPORTION_HIGH\\\\\\"\\\\n]\\"\\n ],\\n \\"Diagnosis\\": \\"-\\",\\n \\"Executions\\": 1,\\n \\"LastExecutedTime\\": \\"2023-04-12T04:38:38Z\\",\\n \\"RiskLevel\\": \\"high\\",\\n \\"SqlId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"SqlTextShort\\": \\"delete /*+ XXX PARALLEL(4) */ from\\",\\n \\"Suggestion\\": \\"review\\",\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"UserName\\": \\"test_user\\",\\n \\"DynamicSql\\": false,\\n \\"SqlList\\": [\\n {\\n \\"AvgCpuTime\\": 100.24,\\n \\"AvgElapsedTime\\": 100.28,\\n \\"AvgGetPlanTime\\": 0,\\n \\"CpuTime\\": 100.23,\\n \\"DbName\\": \\"test_hsp****eway\\",\\n \\"DiagTypes\\": [\\n \\"[\\\\n \\\\\\"CPU_TIME_PROPORTION_HIGH\\\\\\"\\\\n ]\\"\\n ],\\n \\"Diagnosis\\": \\"-\\",\\n \\"Executions\\": 100,\\n \\"LastExecutedTime\\": \\"2023-04-12T04:38:38Z\\",\\n \\"RiskLevel\\": \\"LOW\\",\\n \\"SqlId\\": \\"3A645****789F13DE0CF6D084FF9****\\",\\n \\"SqlTextShort\\": \\"select * from test\\",\\n \\"Suggestion\\": \\"{\'Role\': \'eSG\', \'Result\': \'100\', \'Suggestion\': \'TRACER_OTHER_ERR\'}\\",\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"UserName\\": \\"test_user\\",\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"AvgRetryCount\\": 4,\\n \\"SumRetryCount\\": 6,\\n \\"AvgLogicalReads\\": 25,\\n \\"FormatSqlId\\": \\"\\"\\n }\\n ],\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"AvgRetryCount\\": 4,\\n \\"SumRetryCount\\": 6,\\n \\"AvgLogicalReads\\": 25,\\n \\"FormatSqlId\\": \\"\\"\\n }\\n ],\\n \\"RequestId\\": \\"473469**-AA6F-4D**-B3DB-A***********\\",\\n \\"TotalCount\\": 9\\n}","type":"json"}]', + 'title' => 'DescribeOasAnomalySQLList', + ], + 'DescribeSampleSqlRawTexts' => [ + 'summary' => 'You can call this operation to query the original text of a sampled SQL statement.', + 'methods' => [ + 'post', + 'get', + ], + '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****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the tenant.', + 'type' => 'string', + 'required' => false, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the database.', + 'type' => 'string', + 'required' => true, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'SqlId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the SQL statement.', + 'type' => 'string', + 'required' => true, + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of returned rows of the SQL statement.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + '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' => '{ "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C", "Data": { "SqlText": [ "\\"INSERT INTO test (id, k, c, pad) VALUES (36, 87, 11,62582 )\\"" ] } }', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'DescribeOasSQLDetails' => [ + 'summary' => 'You can call this API to query detailed information about the SQL, including the SQL text, related table names, and so on.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + '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****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'SqlId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'SQL ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the database. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_db', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否动态SQL', + 'type' => 'boolean', + ], + ], + [ + 'name' => 'ParseTable', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否解析表结构', + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Returned response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => 'The list of the SQL execution plan.', + 'type' => 'object', + 'properties' => [ + 'Fulltext' => [ + 'title' => 'SQL 文本', + 'description' => 'SQL text.', + 'type' => 'string', + 'example' => 'select a from b', + ], + 'Tables' => [ + 'title' => 'SQL 涉及的表名', + 'description' => 'The table name related to the SQL.', + 'type' => 'array', + 'items' => [ + 'description' => 'The table name.', + 'type' => 'string', + 'example' => '[{"xxxx","xxxx","xxxx"},{...}...]', + ], + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => 'The username.', + 'type' => 'string', + 'example' => 'test_user', + ], + 'Statement' => [ + 'title' => '参数化后的文本', + 'description' => 'Parameterized text.', + 'type' => 'string', + 'example' => 'select a from b', + ], + 'DbName' => [ + 'description' => 'The name of the database. ', + 'type' => 'string', + 'example' => 'test_db', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"Fulltext\\": \\"select * from test where id = ?\\",\\n \\"Tables\\": [\\n \\"[{\\\\\\"xxxx\\\\\\",\\\\\\"xxxx\\\\\\",\\\\\\"xxxx\\\\\\"},{...}...]\\"\\n ],\\n \\"UserName\\": \\"test_user\\",\\n \\"Statement\\": \\"select * from test where id = ?\\",\\n \\"DbName\\": \\"test_db\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeOasSQLDetails', + ], + 'DescribeOasSQLPlans' => [ + 'summary' => 'You can call this API to retrieve information about the SQL execution plan stored in the diagnostic system based on the SQL ID.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The start time of querying the SQL execution plan. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T04:38:38Z', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the database. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'SqlId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'SQL ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Supported language. Valid values:'."\n" + .'- zh-CN: Chinese'."\n" + .'- en-US: English', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否动态SQL', + 'description' => 'Specifies whether the SQL statement is dynamic.', + '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********', + ], + ], + [ + 'name' => 'ReturnBriefInfo', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether to return an overview of the execution plan.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'FormatSqlId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'format sqlId', + 'type' => 'string', + ], + ], + ], + '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 plan.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of SQL execution plan.', + 'type' => 'object', + 'properties' => [ + 'PlanHash' => [ + 'description' => 'The internal identifier of the SQL execution plan in the diagnostic system.', + 'type' => 'string', + 'example' => '1758****24913166****', + ], + 'Plans' => [ + 'title' => '执行计划列表', + 'description' => 'The list of the execution plan.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of the execution plan.', + 'type' => 'object', + 'properties' => [ + 'Uid' => [ + 'title' => 'Plan的唯一标识', + 'description' => 'The unique identifier of the plan.', + 'type' => 'string', + 'example' => 'AAAAAAAAAAI****AAFoT2QAF--7W****', + ], + 'PlanId' => [ + 'description' => 'The ID of the plan.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '590****', + ], + 'FirstLoadTime' => [ + 'title' => 'Plan首次被加载的时间', + 'description' => 'First time to load the plan.', + 'type' => 'string', + 'example' => '2023-04-12T04:46:38Z', + ], + 'PlanType' => [ + 'title' => 'Plan的类型：LOCAL、REMOTE、DIST', + 'description' => 'Plan type, including LOCAL, REMOTE, DIST.', + 'type' => 'string', + 'example' => 'LOCAL', + ], + 'PlanHash' => [ + 'description' => 'The internal identifier of the SQL execution plan in the diagnostic system.', + 'type' => 'string', + 'example' => '-86290582****886880', + ], + 'PlanSize' => [ + 'description' => 'Plan size.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10****', + ], + 'SchemaVersion' => [ + 'description' => 'Schema version.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16838****3550464', + ], + 'MergedVersion' => [ + 'description' => 'Merge version.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '513', + ], + 'ObServerId' => [ + 'description' => 'Server ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ObDbId' => [ + 'description' => 'Database ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11006****828', + ], + 'ServerId' => [ + 'description' => 'The ID of the backend server instance.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'FirstLoadTimeUs' => [ + 'description' => 'First loading time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1684****03289441', + ], + 'HitDiagnosis' => [ + 'description' => 'Whether to hit the diagnosis.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'OutlineData' => [ + 'title' => 'Plan的outline_data字段', + 'description' => 'The outline_data parameter of the SQL execution plan.', + 'type' => 'string', + 'example' => '/*+ BEGIN_OUTLINE_DATA INDEX(@\\"SEL$1\\', + ], + 'OutlineId' => [ + 'description' => 'Outline ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'CollectTimeUs' => [ + 'description' => 'Collection time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1684368****00000', + ], + 'Server' => [ + 'title' => 'server信息', + 'description' => 'The server where the SQL is executed.', + 'type' => 'string', + 'example' => 'i-bp1db1a9us038****jio', + ], + 'HitPercentage' => [ + 'description' => 'Hit rate.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.0', + ], + 'Executions' => [ + 'description' => 'The total number of executions during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExecPs' => [ + 'description' => 'The average execution count per second during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.31', + ], + 'AvgDiskReads' => [ + 'description' => 'The average physical read count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgDiskWrites' => [ + 'description' => 'The average physical write count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgBufferGets' => [ + 'description' => 'Average cache read count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '30137.03', + ], + 'AvgApplicationWaitTime' => [ + 'description' => 'Average Application event waiting time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgConcurrencyWaitTime' => [ + 'description' => 'Average Concurrency event waiting time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgUserIoWaitTime' => [ + 'description' => 'Average UserIo event waiting time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgRowProcessed' => [ + 'description' => 'Average row processing waiting time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.0', + ], + 'AvgElapsedTime' => [ + 'description' => 'Average interval waiting time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1876.78', + ], + 'AvgCpuTime' => [ + 'description' => 'Average CPU time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1875.34', + ], + 'LargeQueryPercentage' => [ + 'description' => 'Percentage of completed long-running queries.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'DelayedLargeQueryPercentage' => [ + 'description' => 'Percentage of delayed long-running queries.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'TimeoutPercentage' => [ + 'description' => 'Percentage of timeouts.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'TableScan' => [ + 'description' => 'Whether a full table scan is performed.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'PlanUnionHash' => [ + 'description' => 'The internal unique identifier of the SQL execution plan in the diagnostic system.', + 'type' => 'string', + 'example' => '"52c7c53****53e61b3f7586b17****ad"', + ], + 'SqlId' => [ + 'description' => 'SQL ID.', + 'type' => 'string', + 'example' => '46939C87ECA****95ED0FF64F44B****', + ], + 'SqlText' => [ + 'type' => 'string', + ], + ], + ], + ], + 'MergedVersion' => [ + 'description' => 'Merge version.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '513', + ], + 'FirstLoadTime' => [ + 'title' => '首次加载时间', + 'description' => 'First loading time.', + 'type' => 'string', + 'example' => '2023-04-12T04:46:38Z', + ], + 'PlanType' => [ + 'title' => '执行计划类型', + 'description' => 'Execution plan type.', + 'type' => 'string', + 'example' => 'LOCAL', + ], + 'HitDiagnosis' => [ + 'description' => 'Whether to hit the diagnosis.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'HitPercentage' => [ + 'description' => 'Hit rate.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.0', + ], + 'AvgCpuTime' => [ + 'description' => 'Average CPU time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1875.34', + ], + 'PlanExplain' => [ + 'title' => '执行计划', + 'description' => 'Execution plan.', + 'type' => 'object', + 'properties' => [ + 'PlanJsonString' => [ + 'description' => 'JSON string of the SQL execution plan.', + 'type' => 'string', + 'example' => '{\\"RootOperations\\":[{\\"Children\\', + ], + ], + ], + 'Executions' => [ + 'description' => 'Execution count.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PlanUnionHash' => [ + 'description' => 'The internal unique identifier of the SQL execution plan in the diagnostic system.', + 'type' => 'string', + 'example' => '"52c7c53****53e61b3f7586b17****ad"', + ], + 'QuerySql' => [ + 'description' => 'The SQL for the query.', + 'type' => 'string', + 'example' => '"select 1 from t"', + ], + 'Bounded' => [ + 'description' => 'Whether to bind the execution plan.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'TableScan' => [ + 'title' => '该计划是否包含全表扫描', + 'description' => 'Indicates whether full table scan is performed.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'OutlineId' => [ + 'title' => '该计划使用的 outline id', + 'description' => 'The ID of the outline used by the execution plan.', + 'type' => 'string', + 'example' => '3********', + ], + 'OutlineStatus' => [ + 'title' => '该计划使用outline时的状态，“已生效” 表示该计划的 outline_data 与 outline的 outlIne_content 能完全匹配上，“未知” 表示，无法判断状态。', + 'description' => 'The outline status of the execution plan. Valid values:'."\n" + .'* **Effective**: indicates that the outline_data and outlIne_content fields exactly match with each other. '."\n" + .'* **Unknown**: indicates that the outline status is unknown.', + 'type' => 'string', + 'example' => 'Effective', + ], + 'ByFormatSqlId' => [ + 'title' => '是否为模糊绑定', + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"PlanHash\\": \\"1758****24913166****\\",\\n \\"Plans\\": [\\n {\\n \\"Uid\\": \\"AAAAAAAAAAI****AAFoT2QAF--7W****\\",\\n \\"PlanId\\": 0,\\n \\"FirstLoadTime\\": \\"2023-04-12T04:46:38Z\\",\\n \\"PlanType\\": \\"LOCAL\\",\\n \\"PlanHash\\": \\"-86290582****886880\\",\\n \\"PlanSize\\": 0,\\n \\"SchemaVersion\\": 0,\\n \\"MergedVersion\\": 513,\\n \\"ObServerId\\": 2,\\n \\"ObDbId\\": 0,\\n \\"ServerId\\": 2,\\n \\"FirstLoadTimeUs\\": 0,\\n \\"HitDiagnosis\\": false,\\n \\"OutlineData\\": \\"/*+ BEGIN_OUTLINE_DATA INDEX(@\\\\\\\\\\\\\\"SEL$1\\\\\\\\\\",\\n \\"OutlineId\\": -1,\\n \\"CollectTimeUs\\": 0,\\n \\"Server\\": \\"i-bp1db1a9us038****jio\\",\\n \\"HitPercentage\\": 100,\\n \\"Executions\\": 1,\\n \\"ExecPs\\": 0.31,\\n \\"AvgDiskReads\\": 0,\\n \\"AvgDiskWrites\\": 0,\\n \\"AvgBufferGets\\": 30137.03,\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"AvgRowProcessed\\": 1,\\n \\"AvgElapsedTime\\": 1876.78,\\n \\"AvgCpuTime\\": 1875.34,\\n \\"LargeQueryPercentage\\": 0,\\n \\"DelayedLargeQueryPercentage\\": 0,\\n \\"TimeoutPercentage\\": 0,\\n \\"TableScan\\": false,\\n \\"PlanUnionHash\\": \\"\\\\\\"52c7c53****53e61b3f7586b17****ad\\\\\\"\\",\\n \\"SqlId\\": \\"46939C87ECA****95ED0FF64F44B****\\",\\n \\"SqlText\\": \\"\\"\\n }\\n ],\\n \\"MergedVersion\\": 513,\\n \\"FirstLoadTime\\": \\"2023-04-12T04:46:38Z\\",\\n \\"PlanType\\": \\"LOCAL\\",\\n \\"HitDiagnosis\\": false,\\n \\"HitPercentage\\": 100,\\n \\"AvgCpuTime\\": 1875.34,\\n \\"PlanExplain\\": {\\n \\"PlanJsonString\\": \\"\\\\\\"PlanJsonString\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"RootOperations\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Children\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Children\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Cost\\\\\\\\\\\\\\":2000,\\\\\\\\\\\\\\"ObjectName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TR\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PHY_TABLE_SCAN\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Property\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"table_rows:8593, physical_range_rows:85, logical_range_rows:85, index_back_rows:0, output_rows:85, est_method:default_stat, avaiable_index_name[ALL_VIRTUAL_AGENT]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Rows\\\\\\\\\\\\\\":86},{\\\\\\\\\\\\\\"Children\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Cost\\\\\\\\\\\\\\":2000,\\\\\\\\\\\\\\"ObjectName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NA\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PHY_TABLE_SCAN\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Property\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"table_rows:1750, physical_range_rows:17, logical_range_rows:17, index_back_rows:0, output_rows:17, est_method:default_stat, avaiable_index_name[ALL_VIRTUAL_AGENT]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Rows\\\\\\\\\\\\\\":18}],\\\\\\\\\\\\\\"Cost\\\\\\\\\\\\\\":2013,\\\\\\\\\\\\\\"ObjectName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NULL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PHY_SORT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Property\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NULL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Rows\\\\\\\\\\\\\\":18}],\\\\\\\\\\\\\\"Cost\\\\\\\\\\\\\\":4024,\\\\\\\\\\\\\\"ObjectName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NULL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PHY_MERGE_JOIN\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Property\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NULL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Rows\\\\\\\\\\\\\\":26}],\\\\\\\\\\\\\\"Cost\\\\\\\\\\\\\\":4025,\\\\\\\\\\\\\\"ObjectName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NULL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PHY_SCALAR_AGGREGATE\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Property\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NULL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Rows\\\\\\\\\\\\\\":1}]}\\\\\\"\\"\\n },\\n \\"Executions\\": 1,\\n \\"PlanUnionHash\\": \\"\\\\\\"52c7c53****53e61b3f7586b17****ad\\\\\\"\\",\\n \\"QuerySql\\": \\"\\\\\\"select 1 from t\\\\\\"\\",\\n \\"Bounded\\": false,\\n \\"TableScan\\": false,\\n \\"OutlineId\\": \\"3********\\",\\n \\"OutlineStatus\\": \\"已生效\\",\\n \\"ByFormatSqlId\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeOasSQLPlans', + ], + 'DescribeSQLSamples' => [ + 'summary' => 'You can call this API to view the sample data of the execution details of the slow queries.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The tenant ID.', + 'type' => 'string', + 'required' => false, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The start time of querying the slow query execution.'."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T04:38:38Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The end time of querying the slow query execution.'."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T05:38:38Z', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The database name.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'SqlId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'SQL ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + ], + [ + 'name' => 'ReturnSqlText', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether to return the SQL text.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Returned response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => 'The list of sample data of slow query execution details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of sample data of slow query execution details.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => 'Request ID.', + 'type' => 'integer', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + 'format' => 'int64', + ], + 'TraceId' => [ + 'title' => 'TraceId', + 'description' => 'Trace ID.', + 'type' => 'string', + 'example' => 'YB42C****-0005E303D1****-0-0', + ], + 'RequestTime' => [ + 'title' => 'SQL的请求时间', + 'description' => 'SQL request time.', + 'type' => 'string', + 'example' => '2023-04-12T04:46:38Z', + ], + 'Server' => [ + 'title' => 'String SQL执行所在的Server（svr_ip:svr_port）', + 'description' => 'The server where the SQL is executed.', + 'type' => 'string', + 'example' => 'i-bp1db1****8uemejio', + ], + 'ClientIp' => [ + 'title' => '客户端Ip', + 'description' => 'Client IP.', + 'type' => 'string', + 'example' => 'i-bp1db****38uemejio', + ], + 'ClientPort' => [ + 'title' => '', + 'description' => 'Client port.', + 'type' => 'integer', + 'example' => '4****', + 'format' => 'int32', + ], + 'DbName' => [ + 'title' => 'SQL访问的数据库', + 'description' => 'Database name.', + 'type' => 'string', + 'example' => 'test_db', + ], + 'UserName' => [ + 'title' => 'SQL的用户', + 'description' => 'Username.', + 'type' => 'string', + 'example' => 'test_user', + ], + 'SqlType' => [ + 'title' => 'SQL的类型', + 'description' => 'SQL type.', + 'type' => 'string', + 'example' => 'select', + ], + 'PlanId' => [ + 'title' => '', + 'description' => 'The execution plan ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '590****', + ], + 'AffectedRows' => [ + 'title' => '', + 'description' => 'Average updated rows during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000.0', + ], + 'ReturnRows' => [ + 'title' => '', + 'description' => 'Average returned rows during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0.0', + ], + 'PartitionCount' => [ + 'title' => '', + 'description' => 'Average number of partition accessed during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1.0', + ], + 'RetCode' => [ + 'title' => '', + 'description' => 'Result code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'WaitEvent' => [ + 'title' => '期间内的最长等待事件', + 'description' => 'Longest wait event during the execution period.', + 'type' => 'string', + 'example' => 'none', + ], + 'WaitTime' => [ + 'title' => '等待时间（毫秒)', + 'description' => 'Wait time (in milliseconds).', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'WaitCount' => [ + 'title' => '', + 'description' => 'Wait count.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0.0', + ], + 'RpcCount' => [ + 'title' => '', + 'description' => 'Number of RPC sent.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8.0', + ], + 'PlanType' => [ + 'title' => '计划类型', + 'description' => 'Plan type.', + 'type' => 'string', + 'example' => 'LOCAL', + ], + 'Inner' => [ + 'title' => '是否内部SQL', + 'description' => 'Whether an internal SQL.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ExecutorRpc' => [ + 'description' => 'Whether to initiate RPC.', + 'type' => 'boolean', + 'example' => '0.0', + 'title' => '', + ], + 'HitPlan' => [ + 'description' => 'Whether to hit the execution plan.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ElapsedTime' => [ + 'title' => '响应时间（毫秒）', + 'description' => 'Response time (in milliseconds).', + 'type' => 'number', + 'format' => 'double', + 'example' => '2182.66', + ], + 'CpuTime' => [ + 'title' => 'CPU时间（毫秒）', + 'description' => 'CPU time (in milliseconds).', + 'type' => 'number', + 'format' => 'double', + 'example' => '3377.57', + ], + 'NetTime' => [ + 'title' => '网络传输时间（毫秒）', + 'description' => 'Network transmission time (in milliseconds).', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'NetWaitTime' => [ + 'title' => '网络入队时间（毫秒）', + 'description' => 'Network enqueue time (in milliseconds).', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'QueueTime' => [ + 'title' => '排队时间（毫秒）', + 'description' => 'Queueing time (in milliseconds).', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.02', + ], + 'DecodeTime' => [ + 'title' => '语法解析时间（毫秒）', + 'description' => 'Syntax parsing time (in milliseconds).', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'GetPlanTime' => [ + 'title' => '计划生成时间（毫秒）', + 'description' => 'Plan generation time (in milliseconds).', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.19', + ], + 'ExecuteTime' => [ + 'title' => '计划执行时间（毫秒）', + 'description' => 'Plan execution time (in milliseconds).', + 'type' => 'number', + 'format' => 'double', + 'example' => '8262.01', + ], + 'ApplicationWaitTime' => [ + 'title' => 'Application事件等待时间（毫秒）', + 'description' => 'Application event waiting time (in milliseconds).', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'ConcurrencyWaitTime' => [ + 'title' => 'Concurrency事件等待时间（毫秒）', + 'description' => 'Concurrency event waiting time (in milliseconds).', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'UserIoWaitTime' => [ + 'title' => 'UserIO事件等待时间（毫秒）', + 'description' => 'UserIO event waiting time (in milliseconds).', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'ScheduleTime' => [ + 'title' => 'Schedule事件等待时间（毫秒）', + 'description' => 'Schedule event waiting time (in milliseconds).', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'RowCacheHit' => [ + 'title' => 'RowCache命中次数', + 'description' => 'RowCache hit count.', + 'type' => 'number', + 'format' => 'double', + 'example' => '498.0', + ], + 'BloomFilterCacheHit' => [ + 'title' => 'BloomFilterCache命中次数', + 'description' => 'BloomFilterCache hit count.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'BlockCacheHit' => [ + 'title' => 'BlockCache命中次数', + 'description' => 'BlockCache hit count', + 'type' => 'number', + 'format' => 'double', + 'example' => '99279.0', + ], + 'BlockIndexCacheHit' => [ + 'title' => 'BlockIndexCache命中次数'."\n" + .'磁盘读次数', + 'description' => 'BlockIndexCache hit count', + 'type' => 'number', + 'format' => 'double', + 'example' => '142514.0', + ], + 'DiskReads' => [ + 'title' => '磁盘读次数', + 'description' => 'Disk read count.', + 'type' => 'number', + 'format' => 'double', + 'example' => '96972.0', + ], + 'RetryCount' => [ + 'title' => '', + 'description' => 'Retry count.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'TableScan' => [ + 'description' => 'Whether to perform full table scan.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'ConsistencyLevel' => [ + 'title' => '一致性级别', + 'description' => 'Consistency level.', + 'type' => 'string', + 'example' => '3', + ], + 'MemstoreReadRows' => [ + 'title' => '', + 'description' => 'Memstore read row count.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ExpectedWorkerCount' => [ + 'title' => '', + 'description' => 'Degree of parallelism.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'UsedWorkerCount' => [ + 'title' => '', + 'description' => 'Actual number of SQL execution threads.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SsstoreReadRows' => [ + 'title' => '', + 'description' => 'Ssstore read row count.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '986190', + ], + 'ObServerId' => [ + 'title' => 'server ID', + 'description' => 'Server ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ObUserId' => [ + 'title' => '', + 'description' => 'User ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100010', + ], + 'ObDbId' => [ + 'title' => '', + 'description' => 'Database ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11006111****4828', + ], + 'Statement' => [ + 'title' => '参数化SQL文本', + 'description' => 'Parameterized SQL text.', + 'type' => 'string', + 'example' => 'select a from b', + ], + 'TransHash' => [ + 'title' => 'transaction hash', + 'description' => 'Transaction hash.', + 'type' => 'string', + 'example' => '1219****927****73791', + ], + 'FullSqlText' => [ + 'description' => 'The full SQL text. '."\n" + ."\n" + .'> This parameter is unavailable.', + 'type' => 'string', + 'example' => 'select * from test where c1 > 1 and c2 > 3;', + ], + 'SqlText' => [ + 'description' => 'The SQL text.', + 'type' => 'string', + 'example' => 'select ** from t', + ], + 'ParamsValue' => [ + 'title' => 'SQL参数值', + 'description' => 'The parameter value of the SQL statement.', + 'type' => 'string', + 'example' => '1****', + ], + 'SqlId' => [ + 'type' => 'string', + ], + 'SqlTextShort' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The start time of querying the execution history of the SQL statement. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T04:38:38Z', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the database. ', + 'type' => 'string', + 'required' => false, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'SqlId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'SQL ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + ], + [ + 'name' => 'NodeIp', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The IP address of the node. ', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp19y05uq6x*********', + ], + ], + [ + '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', + ], + ], + [ + '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' => 'number', + 'format' => 'double', + 'example' => '9978.75', + ], + 'AvgBlockCacheHit' => [ + 'title' => '', + 'description' => 'Average BlockCache hit count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgBlockIndexCacheHit' => [ + 'title' => '', + 'description' => 'Average BlockIndexCache hit count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgBloomFilterCacheHit' => [ + 'title' => '', + 'description' => 'Average BloomFilterCache hit count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'Executions' => [ + 'title' => '期间内的总执行次数', + 'description' => 'Total number of executions during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'FailCount' => [ + 'title' => '期间内的总错误次数', + 'description' => 'The total number of errors during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AvgRpcCount' => [ + 'title' => '', + 'description' => 'Average number of RPC sent during the execution.', + 'type' => 'number', + 'format' => 'double', + 'example' => '8.0', + ], + 'RemotePlans' => [ + 'title' => '远程计划数', + 'description' => 'Remote plan count.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'MissPlans' => [ + 'title' => '未命中计划次数', + 'description' => 'Missed plan count.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AvgReturnRows' => [ + 'title' => '', + 'description' => 'Average number of rows returned during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgLogicalReads' => [ + 'title' => '', + 'description' => 'Average logical reads during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'RetryCount' => [ + 'title' => '期间内的总计重试次数', + 'description' => 'Total number of retries during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AvgRowCacheHit' => [ + 'title' => '', + 'description' => 'Average RowCache hit count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgDiskReads' => [ + 'title' => '', + 'description' => 'Average physical read count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgMemstoreReadRows' => [ + 'title' => '', + 'description' => 'Average Memstore read rows during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgSsstoreReadRows' => [ + 'title' => '', + 'description' => 'Average Ssstore read rows during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgApplicationWaitTime' => [ + 'title' => '客户端等待 期间内的平均Application事件等待时间（毫秒）', + 'description' => 'Average Application event wait time (in milliseconds) during the client waiting period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgElapsedTime' => [ + 'title' => '期间内的平均响应时间（毫秒）', + 'description' => 'Average response time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1876.78', + ], + 'AvgExecuteTime' => [ + 'title' => '期间内的平均计划执行时间（毫秒）', + 'description' => 'Average plan execution time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1895.7', + ], + 'AvgQueueTime' => [ + 'title' => '期间内的平均排队时间（毫秒）', + 'description' => 'Average queueing time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.01', + ], + 'AvgConcurrencyWaitTime' => [ + 'title' => '期间内的平均Concurrency事件等待时间（毫秒）', + 'description' => 'Average Concurrency event wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgCpuTime' => [ + 'title' => '期间内的平均CPU时间（毫秒）', + 'description' => 'Average CPU time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1875.34', + ], + 'AvgDecodeTime' => [ + 'title' => '期间内的平均语法解析时间（毫秒）', + 'description' => 'Average syntax parsing time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgNetWaitTime' => [ + 'title' => '网络等待 期间内的平均网络入队时间（毫秒）', + 'description' => 'Average network enqueue time (in milliseconds) during the network waiting period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgUserIoWaitTime' => [ + 'title' => '期间内的平均UserIO事件等待时间（毫秒）', + 'description' => 'Average UserIO event wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgGetPlanTime' => [ + 'title' => '期间内的平均计划生成时间（毫秒）', + 'description' => 'Average plan generation time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxElapsedTime' => [ + 'title' => '最大响应时间', + 'description' => 'Max response time.', + 'type' => 'number', + 'format' => 'double', + 'example' => '13643.3', + ], + 'SumWaitTime' => [ + 'title' => '内部等待 期间内的总等待时间（毫秒）', + 'description' => 'The total wait time (in milliseconds) during the internal waiting period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '9421.73', + ], + 'AvgScheduleTime' => [ + 'title' => '调度时间 期间内的平均Schedule事件等待时间（毫秒）', + 'description' => 'Average Schedule event wait time (in milliseconds) during the scheduling period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxCpuTime' => [ + 'title' => '最大 CPU 时间', + 'description' => 'Max CPU time.', + 'type' => 'number', + 'format' => 'double', + 'example' => '13641.9', + ], + 'SumElapsedTime' => [ + 'description' => 'Total response time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '11452126.36', + ], + 'Timestamp' => [ + 'title' => '采样时间点', + 'description' => 'Timestamp for the sample.', + 'type' => 'string', + 'example' => '2023-04-12T04:46:38Z', + ], + 'Server' => [ + 'title' => 'SQL执行所在的Server（svr_ip:svr_port, 兼容tars', + 'description' => 'The server where the SQL is executed.', + 'type' => 'string', + 'example' => 'i-bp1db1****8uemejio', + ], + 'UserName' => [ + 'title' => 'userName, 兼容tars', + 'description' => 'Username.', + 'type' => 'string', + 'example' => 'test_user', + ], + 'AvgPartitionCount' => [ + 'title' => '期间内平均访问分区数', + 'description' => 'Average number of partition accessed during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'FailPercentage' => [ + 'title' => '期间内的错误百分比', + 'description' => 'Error percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RetCode4012Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of code 4012 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode4013Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of code 4013 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5001Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of code 5001 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5024Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of code 5024 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5167Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of code 5167 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5217Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of code 5217 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode6002Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of code 6002 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AvgWaitTime' => [ + 'title' => '期间内的平均等待时间（毫秒）', + 'description' => 'Average wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1442.49', + ], + 'AvgWaitCount' => [ + 'title' => '期间内的平均等待次数', + 'description' => 'Average number of waits during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'LocalPlanPercentage' => [ + 'title' => '期间内的本地计划百分比', + 'description' => 'Local plan percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemotePlanPercentage' => [ + 'title' => '期间内的远程计划百分比', + 'description' => 'Remote plan percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DistPlanPercentage' => [ + 'title' => '期间内的分布式计划百分比', + 'description' => 'Distributed plan percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'AvgNetTime' => [ + 'title' => '期间内的平均网络传输时间（毫秒）', + 'description' => 'Average network transmission time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '8', + ], + 'AvgExecutorRpcCount' => [ + 'title' => '期间内的平均执行RPC请求次数', + 'description' => 'Average number of RPC requests executed during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MissPlanPercentage' => [ + 'title' => '期间内的计划命中率', + 'description' => 'Plan hit rage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'TableScanPercentage' => [ + 'title' => '期间内的表扫描百分比', + 'description' => 'Table scan percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'StrongConsistencyPercentage' => [ + 'title' => '期间内的强一致性事务百分比', + 'description' => 'Strong consistent transaction percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'WeakConsistencyPercentage' => [ + 'title' => '期间内的弱一致性事务百分比', + 'description' => 'Eventually consistent transaction percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxAffectedRows' => [ + 'title' => '期间内最大更新行数', + 'description' => 'Max updated rows during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '10000', + ], + 'MaxReturnRows' => [ + 'title' => '期间内最大返回行数', + 'description' => 'Max returned rows during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxWaitTime' => [ + 'title' => '期间内的最大等待时间（毫秒）', + 'description' => 'Max wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '3.4', + ], + 'MaxApplicationWaitTime' => [ + 'title' => '期间内的最大Application事件等待时间（毫秒）', + 'description' => 'Max Application event wait time (in milliseconds) during the execution period', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxConcurrencyWaitTime' => [ + 'title' => '期间内的最大Concurrency事件等待时间（毫秒）', + 'description' => 'Max Concurrency event wait time (in milliseconds) during the execution period', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxUserIoWaitTime' => [ + 'title' => '期间内的最大UserIO事件等待时间（毫秒）', + 'description' => 'Max UserIO event wait time (in milliseconds) during the execution period', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxDiskReads' => [ + 'title' => '期间内的最大物理读次数', + 'description' => 'Max physical read count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgExpectedWorkerCount' => [ + 'title' => '期间内平均并行度', + 'description' => 'Average degree of parallelism during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'AvgUsedWorkerCount' => [ + 'title' => '期间内sql平均使用线程数', + 'description' => 'Average number of threads used of the SQL during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'SumLogicalReads' => [ + 'title' => '总逻辑读', + 'description' => 'Total logical reads.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'ExecPs' => [ + 'description' => 'Average execution count per second during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.31', + ], + 'AvgDbTime' => [ + 'description' => 'The average DB time, in milliseconds.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SumDbTime' => [ + 'description' => 'The total DB time, in milliseconds.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'WaitEvent' => [ + 'description' => 'The wait event.', + 'type' => 'string', + 'example' => 'none', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'DescribeOasTopSQLList' => [ + 'summary' => 'You can call this API to retrieve the list of data on the SQL execution performance collected by the diagnostic system.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The start time of querying the TOPSQL parameter. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T04:38:38Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The end time of querying the TOPSQL parameter.'."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T05:38:38Z', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the database. ', + 'type' => 'string', + 'required' => false, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'SearchKeyWord', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The search keyword. ', + 'type' => 'string', + 'required' => false, + 'example' => 'update', + ], + ], + [ + 'name' => 'SearchParam', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The search parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'cputime', + ], + ], + [ + 'name' => 'SearchRule', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The search rule. ', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + ], + [ + 'name' => 'SearchValue', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The search value. ', + 'type' => 'string', + 'required' => false, + 'example' => '0.01', + ], + ], + [ + 'name' => 'SqlId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'SQL ID.'."\n" + .'> When the SQL ID is provided, the system collects all the request data for the target SQL ID. When the SQL ID is empty, the system collects all the request data for the entire database instance.', + 'type' => 'string', + 'required' => false, + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + ], + [ + 'name' => 'NodeIp', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The node IP.', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp18l4****str4uk03', + ], + ], + [ + 'name' => 'FilterCondition', + 'in' => 'formData', + 'schema' => [ + 'description' => 'All parameters are referenced by the symbol @. For a list of available parameters, refer to the returned parameters in [Query performance indicators of an SQL statement](https://en.oceanbase.com/docs/community-ocp-en-10000000000840290).', + 'type' => 'string', + 'required' => false, + 'example' => '@avgCpuTime > 20 and @executions > 100', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- zh: Chinese'."\n" + .'- en: English', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + [ + 'name' => 'SqlTextLength', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Max length of the returned SQL text.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '65535', + ], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否动态SQL', + 'type' => 'boolean', + ], + ], + [ + 'name' => 'MergeDynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '返回结果时，是否合并动态 SQL', + 'type' => 'boolean', + ], + ], + [ + 'name' => 'CustomColumns', + 'in' => 'formData', + 'schema' => [ + 'title' => '自定义字段规则', + 'type' => 'string', + ], + ], + ], + '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 Top SQL.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Executions' => [ + 'title' => '', + 'description' => 'Total number of executions during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RpcCount' => [ + 'title' => '期间的RPC次数', + 'description' => 'RPC count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'RemotePlans' => [ + 'title' => '', + 'description' => 'Remote execution count during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'MissPlans' => [ + 'title' => '', + 'description' => 'Missed hit count of the execution plan during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'MaxElapsedTime' => [ + 'title' => '期间最大响应时间', + 'description' => 'Max response time during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '13643.3', + ], + 'TotalWaitTime' => [ + 'title' => '期间总等待时间', + 'description' => 'Total wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '10.966', + ], + 'ExecPs' => [ + 'title' => '期间的平均每秒执行次数', + 'description' => 'Average execution count per second during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.31', + ], + 'MaxCpuTime' => [ + 'title' => '最大CPU时间', + 'description' => 'Max CPU time (in milliseconds).', + 'type' => 'number', + 'format' => 'double', + 'example' => '13641.9', + ], + 'CpuPercentage' => [ + 'title' => 'CPU占比', + 'description' => 'CPU percentage.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.0', + ], + 'ClientIp' => [ + 'title' => '客户端 IP。', + 'description' => 'Client IP.', + 'type' => 'string', + 'example' => 'i-bp1db****38uemejio', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => 'Username.', + 'type' => 'string', + 'example' => 'test_user', + ], + 'DbName' => [ + 'title' => '数据库名', + 'description' => 'The name of the database. ', + 'type' => 'string', + 'example' => 'test_db', + ], + 'RetCode4012Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of the code 4012 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode4013Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of the code 4013 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5001Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of the code 5001 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5024Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of the code 5024 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5167Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of the code 5167 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5217Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of the code 5217 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode6002Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of the code 6002 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'FailPercentage' => [ + 'title' => '期间内的错误百分比', + 'description' => 'Error percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'SumWaitTime' => [ + 'title' => '期间内的总等待时间（毫秒）', + 'description' => 'Total wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '9421.73', + ], + 'AvgWaitCount' => [ + 'title' => '期间内的平均等待次数', + 'description' => 'Average wait count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgRpcCount' => [ + 'title' => '期间内的平均发送RPC次数', + 'description' => 'Average count of RPC sent during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '8.0', + ], + 'LocalPlanPercentage' => [ + 'title' => '期间内的本地计划百分比', + 'description' => 'Local plan percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'RemotePlanPercentage' => [ + 'title' => '期间内的远程计划百分比', + 'description' => 'Remote plan percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'DistPlanPercentage' => [ + 'title' => '期间内的分布式计划百分比', + 'description' => 'Distributed plan percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.0', + ], + 'SumElapsedTime' => [ + 'title' => '期间内的总响应时间（毫秒）', + 'description' => 'Total response time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '11452126.36', + ], + 'AvgNetTime' => [ + 'title' => '期间内的平均网络传输时间（毫秒）', + 'description' => 'Average network transmission time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgExecutorRpcCount' => [ + 'title' => '期间内的平均执行RPC请求次数', + 'description' => 'Average number of RPC requests executed during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MissPlanPercentage' => [ + 'title' => '期间内的计划命中率', + 'description' => 'Plan hit rage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'TableScanPercentage' => [ + 'title' => '期间内的表扫描百分比', + 'description' => 'Table scan percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'StrongConsistencyPercentage' => [ + 'title' => '期间内的强一致性事务百分比', + 'description' => 'Strong consistent transaction percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.0', + ], + 'WeakConsistencyPercentage' => [ + 'title' => '期间内的弱一致性事务百分比', + 'description' => 'Eventually consistent transaction percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxAffectedRows' => [ + 'title' => '期间内的最大影响行数', + 'description' => 'Max affected rows during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '10000.0', + ], + 'MaxReturnRows' => [ + 'title' => '期间内的最大返回行数', + 'description' => 'Max returned rows during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxWaitTime' => [ + 'title' => '期间内的最大等待时间（毫秒', + 'description' => 'Max wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '3.4', + ], + 'MaxApplicationWaitTime' => [ + 'title' => '期间内的最大Application事件等待时间（毫秒）', + 'description' => 'Max Application event wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxConcurrencyWaitTime' => [ + 'title' => '期间内的最大Concurrency事件等待时间（毫秒）', + 'description' => 'Max Concurrency event wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxUserIoWaitTime' => [ + 'title' => '期间内的最大UserIO事件等待时间（毫秒）', + 'description' => 'Max UserIO event wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxDiskReads' => [ + 'title' => '期间内的最大物理读次数', + 'description' => 'Max physical read count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgExpectedWorkerCount' => [ + 'title' => '期间内平均并行度', + 'description' => 'Average degree of parallelism during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'AvgUsedWorkerCount' => [ + 'title' => '期间内sql平均使用线程数', + 'description' => 'Average number of threads used of the SQL during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'SumLogicalReads' => [ + 'title' => '期间内 sql 总逻辑读', + 'description' => 'Total logical reads.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'Server' => [ + 'title' => 'SQL执行所在的Server', + 'description' => 'The server where the SQL is executed.', + 'type' => 'string', + 'example' => 'i-bp1db1****8uemejio', + ], + 'ServerIp' => [ + 'title' => 'SQL执行所在的Server的IP', + 'description' => 'The server IP where the SQL is executed.', + 'type' => 'string', + 'example' => 'i-bp1db1****8uemejio', + ], + 'ServerPort' => [ + 'title' => 'SQL执行所在的Server的Port', + 'description' => 'The server port where the SQL is executed.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '389', + ], + 'SqlTextShort' => [ + 'title' => 'SQL的文本（前100字符）', + 'description' => 'SQL text (the first 100 characters).', + 'type' => 'string', + 'example' => 'delete /*+ XXX PARALLEL(4) */ fro', + ], + 'SqlType' => [ + 'title' => 'SQL类型', + 'description' => 'SQL type.', + 'type' => 'string', + 'example' => 'select ', + ], + 'SqlId' => [ + 'title' => 'SQL id', + 'description' => 'SQL ID.', + 'type' => 'string', + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + 'Inner' => [ + 'title' => '是否是内部SQL', + 'description' => 'Whether a internal SQL.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'WaitEvent' => [ + 'title' => '期间内的最长等待事件', + 'description' => 'Longest wait event during the execution period.', + 'type' => 'string', + 'example' => 'none', + ], + 'AvgAffectedRows' => [ + 'title' => '期间内平均更新行数', + 'description' => 'Average updated rows during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '9978.75', + ], + 'AvgReturnRows' => [ + 'title' => '期间内平均返回行数', + 'description' => 'Average returned rows during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgPartitionCount' => [ + 'title' => '期间内平均访问分区数', + 'description' => 'Average number of partition accessed during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.0', + ], + 'FailCount' => [ + 'title' => '', + 'description' => 'Average number of partition accessed during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AvgWaitTime' => [ + 'title' => '期间内的平均等待时间（毫秒）', + 'description' => 'Average wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1442.49', + ], + 'AvgElapsedTime' => [ + 'title' => '期间内的平均响应时间（毫秒）', + 'description' => 'Average response time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '903.29', + ], + 'AvgCpuTime' => [ + 'title' => '期间内的平均CPU时间（毫秒）', + 'description' => 'Average CPU time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1875.34', + ], + 'AvgNetWaitTime' => [ + 'title' => '期间内的平均网络入队时间（毫秒）', + 'description' => 'Average network enqueue time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgQueueTime' => [ + 'title' => '期间内的平均排队时间（毫秒）', + 'description' => 'Average queueing time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.01', + ], + 'AvgDecodeTime' => [ + 'title' => '期间内的平均语法解析时间（毫秒）', + 'description' => 'Average syntax parsing time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgGetPlanTime' => [ + 'title' => '期间内的平均计划生成时间（毫秒）', + 'description' => 'Average plan generation time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgExecuteTime' => [ + 'title' => '期间内的平均计划执行时间（毫秒）', + 'description' => 'Average plan execution time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1895.7', + ], + 'AvgApplicationWaitTime' => [ + 'title' => '期间内的平均Application事件等待时间（毫秒）', + 'description' => 'Average Application event wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgConcurrencyWaitTime' => [ + 'title' => '期间内的平均Concurrency事件等待时间（毫秒）', + 'description' => 'Average Concurrency event wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgUserIoWaitTime' => [ + 'title' => '期间内的平均UserIO事件等待时间（毫秒）', + 'description' => 'Average UserIO event wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgScheduleTime' => [ + 'title' => '期间内的平均Schedule事件等待时间（毫秒）', + 'description' => 'Average Schedule event wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgRowCacheHit' => [ + 'title' => '期间内的平均RowCache命中次数', + 'description' => 'Average RowCache hit count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgBloomFilterCacheHit' => [ + 'title' => '期间内的平均BloomFilterCache命中次数', + 'description' => 'Average BloomFilterCache hit count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgBlockCacheHit' => [ + 'title' => '期间内的平均BlockCache命中次数', + 'description' => 'Average BlockCache hit count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgBlockIndexCacheHit' => [ + 'title' => '期间内的平均BlockIndexCache命中次数', + 'description' => 'Average BlockIndexCache hit count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgDiskReads' => [ + 'title' => '期间内的平均物理读次数', + 'description' => 'Average physical read count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'RetryCount' => [ + 'title' => '', + 'description' => 'Total retry count during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AvgMemstoreReadRows' => [ + 'title' => '期间内的强一致性事务百分比', + 'description' => 'Strong consistent transaction percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgSsstoreReadRows' => [ + 'title' => '期间内的弱一致性事务百分比', + 'description' => 'Eventually consistent transaction percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgLogicalReads' => [ + 'title' => '期间内 sql 平均逻辑读', + 'description' => 'Average logical reads of the SQL during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'DynamicSql' => [ + 'title' => '是否动态SQL', + 'type' => 'boolean', + ], + 'SqlList' => [ + 'title' => 'SQL列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Executions' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'RpcCount' => [ + 'title' => '期间的RPC次数', + 'type' => 'number', + 'format' => 'double', + ], + 'RemotePlans' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'MissPlans' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'MaxElapsedTime' => [ + 'title' => '期间最大响应时间', + 'type' => 'number', + 'format' => 'double', + ], + 'TotalWaitTime' => [ + 'title' => '期间总等待时间', + 'type' => 'number', + 'format' => 'double', + ], + 'ExecPs' => [ + 'title' => '期间的平均每秒执行次数', + 'type' => 'number', + 'format' => 'double', + ], + 'MaxCpuTime' => [ + 'title' => '最大CPU时间', + 'type' => 'number', + 'format' => 'double', + ], + 'CpuPercentage' => [ + 'title' => 'CPU占比', + 'type' => 'number', + 'format' => 'double', + ], + 'ClientIp' => [ + 'title' => '客户端 IP。', + 'type' => 'string', + ], + 'UserName' => [ + 'title' => '用户名', + 'type' => 'string', + ], + 'DbName' => [ + 'title' => '数据库名', + 'type' => 'string', + ], + 'RetCode4012Count' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'RetCode4013Count' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'RetCode5001Count' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'RetCode5024Count' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'RetCode5167Count' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'RetCode5217Count' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'RetCode6002Count' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'FailPercentage' => [ + 'title' => '期间内的错误百分比', + 'type' => 'number', + 'format' => 'double', + ], + 'SumWaitTime' => [ + 'title' => '期间内的总等待时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgWaitCount' => [ + 'title' => '期间内的平均等待次数', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgRpcCount' => [ + 'title' => '期间内的平均发送RPC次数', + 'type' => 'number', + 'format' => 'double', + ], + 'LocalPlanPercentage' => [ + 'title' => '期间内的本地计划百分比', + 'type' => 'number', + 'format' => 'double', + ], + 'RemotePlanPercentage' => [ + 'title' => '期间内的远程计划百分比', + 'type' => 'number', + 'format' => 'double', + ], + 'DistPlanPercentage' => [ + 'title' => '期间内的分布式计划百分比', + 'type' => 'number', + 'format' => 'double', + ], + 'SumElapsedTime' => [ + 'title' => '期间内的总响应时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgNetTime' => [ + 'title' => '期间内的平均网络传输时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgExecutorRpcCount' => [ + 'title' => '期间内的平均执行RPC请求次数', + 'type' => 'number', + 'format' => 'double', + ], + 'MissPlanPercentage' => [ + 'title' => '期间内的计划命中率', + 'type' => 'number', + 'format' => 'double', + ], + 'TableScanPercentage' => [ + 'title' => '期间内的表扫描百分比', + 'type' => 'number', + 'format' => 'double', + ], + 'StrongConsistencyPercentage' => [ + 'title' => '期间内的强一致性事务百分比', + 'type' => 'number', + 'format' => 'double', + ], + 'WeakConsistencyPercentage' => [ + 'title' => '期间内的弱一致性事务百分比', + 'type' => 'number', + 'format' => 'double', + ], + 'MaxAffectedRows' => [ + 'title' => '期间内的最大影响行数', + 'type' => 'number', + 'format' => 'double', + ], + 'MaxReturnRows' => [ + 'title' => '期间内的最大返回行数', + 'type' => 'number', + 'format' => 'double', + ], + 'MaxWaitTime' => [ + 'title' => '期间内的最大等待时间（毫秒', + 'type' => 'number', + 'format' => 'double', + ], + 'MaxApplicationWaitTime' => [ + 'title' => '期间内的最大Application事件等待时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'MaxConcurrencyWaitTime' => [ + 'title' => '期间内的最大Concurrency事件等待时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'MaxUserIoWaitTime' => [ + 'title' => '期间内的最大UserIO事件等待时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'MaxDiskReads' => [ + 'title' => '期间内的最大物理读次数', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgExpectedWorkerCount' => [ + 'title' => '期间内平均并行度', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgUsedWorkerCount' => [ + 'title' => '期间内sql平均使用线程数', + 'type' => 'number', + 'format' => 'double', + ], + 'SumLogicalReads' => [ + 'title' => '期间内 sql 总逻辑读', + 'type' => 'number', + 'format' => 'double', + ], + 'Server' => [ + 'title' => 'SQL执行所在的Server', + 'type' => 'string', + ], + 'ServerIp' => [ + 'title' => 'SQL执行所在的Server的IP', + 'type' => 'string', + ], + 'ServerPort' => [ + 'title' => 'SQL执行所在的Server的Port', + 'type' => 'integer', + 'format' => 'int64', + ], + 'SqlTextShort' => [ + 'title' => 'SQL的文本（前100字符）', + 'type' => 'string', + ], + 'SqlType' => [ + 'title' => 'SQL类型', + 'type' => 'string', + ], + 'SqlId' => [ + 'title' => 'SQL id', + 'type' => 'string', + ], + 'Inner' => [ + 'title' => '是否是内部SQL', + 'type' => 'boolean', + ], + 'WaitEvent' => [ + 'title' => '期间内的最长等待事件', + 'type' => 'string', + ], + 'AvgAffectedRows' => [ + 'title' => '期间内平均更新行数', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgReturnRows' => [ + 'title' => '期间内平均返回行数', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgPartitionCount' => [ + 'title' => '期间内平均访问分区数', + 'type' => 'number', + 'format' => 'double', + ], + 'FailCount' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'AvgWaitTime' => [ + 'title' => '期间内的平均等待时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgElapsedTime' => [ + 'title' => '期间内的平均响应时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgCpuTime' => [ + 'title' => '期间内的平均CPU时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgNetWaitTime' => [ + 'title' => '期间内的平均网络入队时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgQueueTime' => [ + 'title' => '期间内的平均排队时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgDecodeTime' => [ + 'title' => '期间内的平均语法解析时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgGetPlanTime' => [ + 'title' => '期间内的平均计划生成时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgExecuteTime' => [ + 'title' => '期间内的平均计划执行时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgApplicationWaitTime' => [ + 'title' => '期间内的平均Application事件等待时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgConcurrencyWaitTime' => [ + 'title' => '期间内的平均Concurrency事件等待时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgUserIoWaitTime' => [ + 'title' => '期间内的平均UserIO事件等待时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgScheduleTime' => [ + 'title' => '期间内的平均Schedule事件等待时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgRowCacheHit' => [ + 'title' => '期间内的平均RowCache命中次数', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgBloomFilterCacheHit' => [ + 'title' => '期间内的平均BloomFilterCache命中次数', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgBlockCacheHit' => [ + 'title' => '期间内的平均BlockCache命中次数', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgBlockIndexCacheHit' => [ + 'title' => '期间内的平均BlockIndexCache命中次数', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgDiskReads' => [ + 'title' => '期间内的平均物理读次数', + 'type' => 'number', + 'format' => 'double', + ], + 'RetryCount' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'AvgMemstoreReadRows' => [ + 'title' => '期间内的强一致性事务百分比', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgSsstoreReadRows' => [ + 'title' => '期间内的弱一致性事务百分比', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgLogicalReads' => [ + 'title' => '期间内 sql 平均逻辑读', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgDbTime' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'SumDbTime' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'FormatSqlId' => [ + 'title' => 'FormatSqlId', + 'type' => 'string', + ], + ], + ], + ], + 'LastFailCode' => [ + 'title' => '期间最后一次执行出错的错误码', + 'type' => 'integer', + 'format' => 'int64', + ], + 'AvgDbTime' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'SumDbTime' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'CustomColumns' => [ + 'title' => '自定义列', + 'type' => 'object', + 'properties' => [ + 'Expression' => [ + 'title' => '自定义列的表达式', + 'type' => 'string', + ], + 'Value' => [ + 'title' => '根据表达式计算的值', + 'type' => 'string', + ], + ], + ], + 'ObDbId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'FormatSqlId' => [ + 'title' => 'FormatSqlId', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"Executions\\": 100,\\n \\"RpcCount\\": 100,\\n \\"RemotePlans\\": 100,\\n \\"MissPlans\\": 100,\\n \\"MaxElapsedTime\\": 10000,\\n \\"TotalWaitTime\\": 100000,\\n \\"ExecPs\\": 0.31,\\n \\"MaxCpuTime\\": 13641.9,\\n \\"CpuPercentage\\": 100,\\n \\"ClientIp\\": \\"i-bp1db****38uemejio\\",\\n \\"UserName\\": \\"test_user\\",\\n \\"DbName\\": \\"test_db\\",\\n \\"RetCode4012Count\\": 0,\\n \\"RetCode4013Count\\": 0,\\n \\"RetCode5001Count\\": 0,\\n \\"RetCode5024Count\\": 0,\\n \\"RetCode5167Count\\": 0,\\n \\"RetCode5217Count\\": 0,\\n \\"RetCode6002Count\\": 0,\\n \\"FailPercentage\\": 0,\\n \\"SumWaitTime\\": 9421.73,\\n \\"AvgWaitCount\\": 0,\\n \\"AvgRpcCount\\": 8,\\n \\"LocalPlanPercentage\\": 0,\\n \\"RemotePlanPercentage\\": 0,\\n \\"DistPlanPercentage\\": 100,\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"AvgNetTime\\": 0,\\n \\"AvgExecutorRpcCount\\": 0,\\n \\"MissPlanPercentage\\": 0,\\n \\"TableScanPercentage\\": 0,\\n \\"StrongConsistencyPercentage\\": 100,\\n \\"WeakConsistencyPercentage\\": 0,\\n \\"MaxAffectedRows\\": 10000,\\n \\"MaxReturnRows\\": 0,\\n \\"MaxWaitTime\\": 3.4,\\n \\"MaxApplicationWaitTime\\": 0,\\n \\"MaxConcurrencyWaitTime\\": 0,\\n \\"MaxUserIoWaitTime\\": 0,\\n \\"MaxDiskReads\\": 0,\\n \\"AvgExpectedWorkerCount\\": 3,\\n \\"AvgUsedWorkerCount\\": 3,\\n \\"SumLogicalReads\\": 0,\\n \\"Server\\": \\"i-bp1db1****8uemejio\\",\\n \\"ServerIp\\": \\"i-bp1db1****8uemejio\\",\\n \\"ServerPort\\": 389,\\n \\"SqlTextShort\\": \\"delete /*+ XXX PARALLEL(4) */ fro\\",\\n \\"SqlType\\": \\"select \\",\\n \\"SqlId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"Inner\\": false,\\n \\"WaitEvent\\": \\"none\\",\\n \\"AvgAffectedRows\\": 9978.75,\\n \\"AvgReturnRows\\": 0,\\n \\"AvgPartitionCount\\": 1,\\n \\"FailCount\\": 0,\\n \\"AvgWaitTime\\": 1442.49,\\n \\"AvgElapsedTime\\": 903.29,\\n \\"AvgCpuTime\\": 1875.34,\\n \\"AvgNetWaitTime\\": 0,\\n \\"AvgQueueTime\\": 0.01,\\n \\"AvgDecodeTime\\": 0,\\n \\"AvgGetPlanTime\\": 0,\\n \\"AvgExecuteTime\\": 1895.7,\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"AvgScheduleTime\\": 0,\\n \\"AvgRowCacheHit\\": 0,\\n \\"AvgBloomFilterCacheHit\\": 0,\\n \\"AvgBlockCacheHit\\": 0,\\n \\"AvgBlockIndexCacheHit\\": 0,\\n \\"AvgDiskReads\\": 0,\\n \\"RetryCount\\": 0,\\n \\"AvgMemstoreReadRows\\": 0,\\n \\"AvgSsstoreReadRows\\": 0,\\n \\"AvgLogicalReads\\": 0,\\n \\"DynamicSql\\": false,\\n \\"SqlList\\": [\\n {\\n \\"Executions\\": 100,\\n \\"RpcCount\\": 100,\\n \\"RemotePlans\\": 100,\\n \\"MissPlans\\": 100,\\n \\"MaxElapsedTime\\": 10000,\\n \\"TotalWaitTime\\": 100000,\\n \\"ExecPs\\": 0.31,\\n \\"MaxCpuTime\\": 13641.9,\\n \\"CpuPercentage\\": 100,\\n \\"ClientIp\\": \\"127.*.*.*\\",\\n \\"UserName\\": \\"test_user\\",\\n \\"DbName\\": \\"test\\",\\n \\"RetCode4012Count\\": 0,\\n \\"RetCode4013Count\\": 0,\\n \\"RetCode5001Count\\": 0,\\n \\"RetCode5024Count\\": 0,\\n \\"RetCode5167Count\\": 0,\\n \\"RetCode5217Count\\": 0,\\n \\"RetCode6002Count\\": 0,\\n \\"FailPercentage\\": 0,\\n \\"SumWaitTime\\": 9421.73,\\n \\"AvgWaitCount\\": 0,\\n \\"AvgRpcCount\\": 8,\\n \\"LocalPlanPercentage\\": 0,\\n \\"RemotePlanPercentage\\": 0,\\n \\"DistPlanPercentage\\": 100,\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"AvgNetTime\\": 0,\\n \\"AvgExecutorRpcCount\\": 0,\\n \\"MissPlanPercentage\\": 0,\\n \\"TableScanPercentage\\": 0,\\n \\"StrongConsistencyPercentage\\": 100,\\n \\"WeakConsistencyPercentage\\": 0,\\n \\"MaxAffectedRows\\": 10000,\\n \\"MaxReturnRows\\": 0,\\n \\"MaxWaitTime\\": 3.4,\\n \\"MaxApplicationWaitTime\\": 0,\\n \\"MaxConcurrencyWaitTime\\": 0,\\n \\"MaxUserIoWaitTime\\": 0,\\n \\"MaxDiskReads\\": 0,\\n \\"AvgExpectedWorkerCount\\": 3,\\n \\"AvgUsedWorkerCount\\": 3,\\n \\"SumLogicalReads\\": 0,\\n \\"Server\\": \\"i-bp1db1****8uemejio\\",\\n \\"ServerIp\\": \\"i-bp1db1****8uemejio\\",\\n \\"ServerPort\\": 389,\\n \\"SqlTextShort\\": \\"delete /*+ XXX PARALLEL(4) */ fro\\",\\n \\"SqlType\\": \\"select\\",\\n \\"SqlId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"Inner\\": false,\\n \\"WaitEvent\\": \\"none\\",\\n \\"AvgAffectedRows\\": 9978.75,\\n \\"AvgReturnRows\\": 0,\\n \\"AvgPartitionCount\\": 1,\\n \\"FailCount\\": 0,\\n \\"AvgWaitTime\\": 1442.49,\\n \\"AvgElapsedTime\\": 903.29,\\n \\"AvgCpuTime\\": 1875.34,\\n \\"AvgNetWaitTime\\": 0,\\n \\"AvgQueueTime\\": 0.01,\\n \\"AvgDecodeTime\\": 0,\\n \\"AvgGetPlanTime\\": 0,\\n \\"AvgExecuteTime\\": 1895.7,\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"AvgScheduleTime\\": 0,\\n \\"AvgRowCacheHit\\": 0,\\n \\"AvgBloomFilterCacheHit\\": 0,\\n \\"AvgBlockCacheHit\\": 0,\\n \\"AvgBlockIndexCacheHit\\": 0,\\n \\"AvgDiskReads\\": 0,\\n \\"RetryCount\\": 2,\\n \\"AvgMemstoreReadRows\\": 0,\\n \\"AvgSsstoreReadRows\\": 0,\\n \\"AvgLogicalReads\\": 0,\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"FormatSqlId\\": \\"\\"\\n }\\n ],\\n \\"LastFailCode\\": -4012,\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"CustomColumns\\": {\\n \\"Expression\\": \\"@failCount/@executions\\",\\n \\"Value\\": \\"0.0\\"\\n },\\n \\"ObDbId\\": 0,\\n \\"FormatSqlId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeOasTopSQLList', + ], + 'DescribeOasSlowSQLList' => [ + 'summary' => 'You can call this API to view a list of slow queries.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The start time of querying slow SQL historical parameters. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T04:38:38Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The end time of querying slow SQL historical parameters. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T05:38:38Z', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the database. ', + 'type' => 'string', + 'required' => false, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'SearchKeyWord', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The search keyword. ', + 'type' => 'string', + 'required' => false, + 'example' => 'update', + ], + ], + [ + 'name' => 'SearchParam', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The search parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'cputime', + ], + ], + [ + 'name' => 'SearchRule', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The search rule. ', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + ], + [ + 'name' => 'SearchValue', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The search value. ', + 'type' => 'string', + 'required' => false, + 'example' => '0.01', + ], + ], + [ + 'name' => 'SqlId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'SQL ID, the unique identifier of the SQL.', + 'type' => 'string', + 'required' => false, + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + ], + [ + 'name' => 'NodeIp', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The IP of the database node.', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp18qljorblo8es*****', + ], + ], + [ + 'name' => 'FilterCondition', + 'in' => 'formData', + 'schema' => [ + 'description' => 'All parameters are referenced by the symbol @. For a list of available parameters, refer to the returned parameters in [Query performance indicators of an SQL statement](https://en.oceanbase.com/docs/community-ocp-en-10000000000840290).', + 'type' => 'string', + 'required' => false, + 'example' => '@avgCpuTime > 20 and @executions > 100', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The language of the response.', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + [ + 'name' => 'SqlTextLength', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Max length of the returned SQL text.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '65535', + ], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否动态SQL', + 'type' => 'boolean', + ], + ], + [ + 'name' => 'MergeDynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '返回结果时，是否合并动态 SQL', + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Returned response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => 'The list of slow queries.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Executions' => [ + 'title' => '', + 'description' => 'Total number of executions during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RpcCount' => [ + 'title' => '期间的RPC次数', + 'description' => 'RPC count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemotePlans' => [ + 'title' => '', + 'description' => 'Remote execution count during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'MissPlans' => [ + 'title' => '', + 'description' => 'Missed hit count of the execution plan during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'MaxElapsedTime' => [ + 'title' => '期间最大响应时间', + 'description' => 'Max response time during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '260.044', + ], + 'TotalWaitTime' => [ + 'title' => '期间总等待时间', + 'description' => 'Total wait time during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '10.966', + ], + 'ExecPs' => [ + 'title' => '期间的平均每秒执行次数', + 'description' => 'Average execution count per second during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.31', + ], + 'MaxCpuTime' => [ + 'title' => '最大CPU时间', + 'description' => 'Max CPU time.', + 'type' => 'number', + 'format' => 'double', + 'example' => '257.967', + ], + 'ClientIp' => [ + 'title' => '客户端 IP。', + 'description' => 'Client IP.', + 'type' => 'string', + 'example' => '1*2.***.1*3.***', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => 'Username.', + 'type' => 'string', + 'example' => 'test_user', + ], + 'DbName' => [ + 'title' => '数据库名', + 'description' => 'The name of the database. ', + 'type' => 'string', + 'example' => 'test_db', + ], + 'RetCode4012Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of code 4012 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode4013Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of code 4013 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5001Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of code 5001 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5024Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of code 5024 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5167Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of code 5167 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5217Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of code 5217 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode6002Count' => [ + 'title' => '', + 'description' => 'Number of occurrences of code 6002 during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'FailPercentage' => [ + 'title' => '期间内的错误百分比', + 'description' => 'Error percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'SumWaitTime' => [ + 'title' => '期间内的总等待时间（毫秒）', + 'description' => 'The total wait time (in milliseconds) during the internal waiting period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '9421.73', + ], + 'AvgWaitCount' => [ + 'title' => '期间内的平均等待次数', + 'description' => 'Average number of waits during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgRpcCount' => [ + 'title' => '期间内的平均发送RPC次数', + 'description' => 'Average number of RPC sent during the execution.', + 'type' => 'number', + 'format' => 'double', + 'example' => '8.0', + ], + 'LocalPlanPercentage' => [ + 'title' => '期间内的本地计划百分比', + 'description' => 'Local plan percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'RemotePlanPercentage' => [ + 'title' => '期间内的远程计划百分比', + 'description' => 'Remote plan percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'DistPlanPercentage' => [ + 'title' => '期间内的分布式计划百分比', + 'description' => 'Distributed plan percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.0', + ], + 'SumElapsedTime' => [ + 'title' => '期间内的总响应时间（毫秒）', + 'description' => 'Total response time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '11452126.36', + ], + 'AvgNetTime' => [ + 'title' => '期间内的平均网络传输时间（毫秒）', + 'description' => 'Average network transmission time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgExecutorRpcCount' => [ + 'title' => '期间内的平均执行RPC请求次数', + 'description' => 'Average number of RPC requests executed during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MissPlanPercentage' => [ + 'title' => '期间内的计划命中率', + 'description' => 'Plan hit rage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'TableScanPercentage' => [ + 'title' => '期间内的表扫描百分比', + 'description' => 'Table scan percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'StrongConsistencyPercentage' => [ + 'title' => '期间内的强一致性事务百分比', + 'description' => 'Strong consistent transaction percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.0', + ], + 'WeakConsistencyPercentage' => [ + 'title' => '期间内的弱一致性事务百分比', + 'description' => 'Eventually consistent transaction percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxAffectedRows' => [ + 'title' => '期间内的最大影响行数', + 'description' => 'Max affected rows during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '10000.0', + ], + 'MaxReturnRows' => [ + 'title' => '期间内的最大返回行数', + 'description' => 'Max returned rows during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxWaitTime' => [ + 'title' => '期间内的最大等待时间（毫秒', + 'description' => 'Max wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '3.4', + ], + 'MaxApplicationWaitTime' => [ + 'title' => '期间内的最大Application事件等待时间（毫秒）', + 'description' => 'Max Application event wait time (in milliseconds) during the execution period', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxConcurrencyWaitTime' => [ + 'title' => '期间内的最大Concurrency事件等待时间（毫秒）', + 'description' => 'Max Concurrency event wait time (in milliseconds) during the execution period', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxUserIoWaitTime' => [ + 'title' => '期间内的最大UserIO事件等待时间（毫秒）', + 'description' => 'Max UserIO event wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxDiskReads' => [ + 'title' => '期间内的最大物理读次数', + 'description' => 'Max physical read count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgExpectedWorkerCount' => [ + 'title' => '期间内平均并行度', + 'description' => 'Average degree of parallelism during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'AvgUsedWorkerCount' => [ + 'title' => '期间内sql平均使用线程数', + 'description' => 'Average number of threads used of the SQL during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'SumLogicalReads' => [ + 'title' => '期间内 sql 总逻辑读', + 'description' => 'Total logical reads of the SQL during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'Server' => [ + 'title' => 'SQL执行所在的Server', + 'description' => 'The server where the SQL is executed.', + 'type' => 'string', + 'example' => 'i-bp1db1a**s038**mej**', + ], + 'ServerIp' => [ + 'title' => 'SQL执行所在的Server的IP', + 'description' => 'The IP address of the server.', + 'type' => 'string', + 'example' => 'i-bp1db1a**s038**mej**', + ], + 'ServerPort' => [ + 'title' => 'SQL执行所在的Server的Port', + 'description' => 'The server port where the SQL is executed.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10110', + ], + 'SqlTextShort' => [ + 'title' => 'SQL的文本（前100字符）', + 'description' => 'SQL text (the first 100 characters).', + 'type' => 'string', + 'example' => 'select a from b where', + ], + 'SqlType' => [ + 'title' => 'SQL类型', + 'description' => 'SQL type.', + 'type' => 'string', + 'example' => 'select ', + ], + 'SqlId' => [ + 'title' => 'SQL id', + 'description' => 'SQL ID.', + 'type' => 'string', + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + 'Inner' => [ + 'title' => '是否是内部SQL', + 'description' => 'Whether an internal SQL.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'WaitEvent' => [ + 'title' => '期间内的最长等待事件', + 'description' => 'Longest wait event during the execution period.', + 'type' => 'string', + 'example' => 'none', + ], + 'AvgAffectedRows' => [ + 'title' => '期间内平均更新行数', + 'description' => 'Average updated rows during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '9978.75', + ], + 'AvgReturnRows' => [ + 'title' => '期间内平均返回行数', + 'description' => 'Average number of rows returned during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgPartitionCount' => [ + 'title' => '期间内平均访问分区数', + 'description' => 'Average number of partition accessed during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.0', + ], + 'FailCount' => [ + 'title' => '', + 'description' => 'Average number of partition accessed during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AvgWaitTime' => [ + 'title' => '期间内的平均等待时间（毫秒）', + 'description' => 'Average wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.42', + ], + 'AvgElapsedTime' => [ + 'title' => '期间内的平均响应时间（毫秒）', + 'description' => 'Average response time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1876.78', + ], + 'AvgCpuTime' => [ + 'title' => '期间内的平均CPU时间（毫秒）', + 'description' => 'Average CPU time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1875.34', + ], + 'AvgNetWaitTime' => [ + 'title' => '期间内的平均网络入队时间（毫秒）', + 'description' => 'Average network enqueue time (in milliseconds) during the network waiting period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgQueueTime' => [ + 'title' => '期间内的平均排队时间（毫秒）', + 'description' => 'Average queueing time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.01', + ], + 'AvgDecodeTime' => [ + 'title' => '期间内的平均语法解析时间（毫秒）', + 'description' => 'Average syntax parsing time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgGetPlanTime' => [ + 'title' => '期间内的平均计划生成时间（毫秒）', + 'description' => 'Average plan generation time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgExecuteTime' => [ + 'title' => '期间内的平均计划执行时间（毫秒）', + 'description' => 'Average plan execution time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1895.7', + ], + 'AvgApplicationWaitTime' => [ + 'title' => '期间内的平均Application事件等待时间（毫秒）', + 'description' => 'Average Application event wait time (in milliseconds) during the client waiting period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgConcurrencyWaitTime' => [ + 'title' => '期间内的平均Concurrency事件等待时间（毫秒）', + 'description' => 'Average Concurrency event wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgUserIoWaitTime' => [ + 'title' => '期间内的平均UserIO事件等待时间（毫秒）', + 'description' => 'Average UserIO event wait time (in milliseconds) during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgScheduleTime' => [ + 'title' => '期间内的平均Schedule事件等待时间（毫秒）', + 'description' => 'Average Schedule event wait time (in milliseconds) during the scheduling period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgRowCacheHit' => [ + 'title' => '期间内的平均RowCache命中次数', + 'description' => 'Average RowCache hit count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgBloomFilterCacheHit' => [ + 'title' => '期间内的平均BloomFilterCache命中次数', + 'description' => 'Average BloomFilterCache hit count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgBlockCacheHit' => [ + 'title' => '期间内的平均BlockCache命中次数', + 'description' => 'Average BlockCache hit count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgBlockIndexCacheHit' => [ + 'title' => '期间内的平均BlockIndexCache命中次数', + 'description' => 'Average BlockIndexCache hit count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgDiskReads' => [ + 'title' => '期间内的平均物理读次数', + 'description' => 'Average physical read count during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'RetryCount' => [ + 'title' => '', + 'description' => 'Total number of retries during the execution period.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'AvgMemstoreReadRows' => [ + 'title' => '期间内的强一致性事务百分比', + 'description' => 'Strong consistent transaction percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgSsstoreReadRows' => [ + 'title' => '期间内的弱一致性事务百分比', + 'description' => 'Eventually consistent transaction percentage during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgLogicalReads' => [ + 'title' => '期间内 sql 平均逻辑读', + 'description' => 'Average logical reads of the SQL during the execution period.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'DynamicSql' => [ + 'title' => '是否动态SQL', + 'type' => 'boolean', + ], + 'SqlList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Executions' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'RpcCount' => [ + 'title' => '期间的RPC次数', + 'type' => 'number', + 'format' => 'double', + ], + 'RemotePlans' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'MissPlans' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'MaxElapsedTime' => [ + 'title' => '期间最大响应时间', + 'type' => 'number', + 'format' => 'double', + ], + 'TotalWaitTime' => [ + 'title' => '期间总等待时间', + 'type' => 'number', + 'format' => 'double', + ], + 'ExecPs' => [ + 'title' => '期间的平均每秒执行次数', + 'type' => 'number', + 'format' => 'double', + ], + 'MaxCpuTime' => [ + 'title' => '最大CPU时间', + 'type' => 'number', + 'format' => 'double', + ], + 'ClientIp' => [ + 'title' => '客户端 IP。', + 'type' => 'string', + ], + 'UserName' => [ + 'title' => '用户名', + 'type' => 'string', + ], + 'DbName' => [ + 'title' => '数据库名', + 'type' => 'string', + ], + 'RetCode4012Count' => [ + 'title' => '期间内结果码4012的发生次数', + 'type' => 'integer', + 'format' => 'int64', + ], + 'RetCode4013Count' => [ + 'title' => '期间内结果码4013的发生次数', + 'type' => 'integer', + 'format' => 'int64', + ], + 'RetCode5001Count' => [ + 'title' => '期间内结果码5001的发生次数', + 'type' => 'integer', + 'format' => 'int64', + ], + 'RetCode5024Count' => [ + 'title' => '期间内结果码5024的发生次数', + 'type' => 'integer', + 'format' => 'int64', + ], + 'RetCode5167Count' => [ + 'title' => '期间内结果码5167的发生次数', + 'type' => 'integer', + 'format' => 'int64', + ], + 'RetCode5217Count' => [ + 'title' => '期间内结果码5217的发生次数', + 'type' => 'integer', + 'format' => 'int64', + ], + 'RetCode6002Count' => [ + 'title' => '期间内结果码6002的发生次数', + 'type' => 'integer', + 'format' => 'int64', + ], + 'FailPercentage' => [ + 'title' => '期间内的错误百分比', + 'type' => 'number', + 'format' => 'double', + ], + 'SumWaitTime' => [ + 'title' => '期间内的总等待时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgWaitCount' => [ + 'title' => '期间内的平均等待次数', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgRpcCount' => [ + 'title' => '期间内的平均发送RPC次数', + 'type' => 'number', + 'format' => 'double', + ], + 'LocalPlanPercentage' => [ + 'title' => '期间内的本地计划百分比', + 'type' => 'number', + 'format' => 'double', + ], + 'RemotePlanPercentage' => [ + 'title' => '期间内的远程计划百分比', + 'type' => 'number', + 'format' => 'double', + ], + 'DistPlanPercentage' => [ + 'title' => '期间内的分布式计划百分比', + 'type' => 'number', + 'format' => 'double', + ], + 'SumElapsedTime' => [ + 'title' => '期间内的总响应时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgNetTime' => [ + 'title' => '期间内的平均网络传输时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgExecutorRpcCount' => [ + 'title' => '期间内的平均执行RPC请求次数', + 'type' => 'number', + 'format' => 'double', + ], + 'MissPlanPercentage' => [ + 'title' => '期间内的计划命中率', + 'type' => 'number', + 'format' => 'double', + ], + 'TableScanPercentage' => [ + 'title' => '期间内的表扫描百分比', + 'type' => 'number', + 'format' => 'double', + ], + 'StrongConsistencyPercentage' => [ + 'title' => '期间内的强一致性事务百分比', + 'type' => 'number', + 'format' => 'double', + ], + 'WeakConsistencyPercentage' => [ + 'title' => '期间内的弱一致性事务百分比', + 'type' => 'number', + 'format' => 'double', + ], + 'MaxAffectedRows' => [ + 'title' => '期间内的最大影响行数', + 'type' => 'number', + 'format' => 'double', + ], + 'MaxReturnRows' => [ + 'title' => '期间内的最大返回行数', + 'type' => 'number', + 'format' => 'double', + ], + 'MaxWaitTime' => [ + 'title' => '期间内的最大等待时间（毫秒', + 'type' => 'number', + 'format' => 'double', + ], + 'MaxApplicationWaitTime' => [ + 'title' => '期间内的最大Application事件等待时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'MaxConcurrencyWaitTime' => [ + 'title' => '期间内的最大Concurrency事件等待时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'MaxUserIoWaitTime' => [ + 'title' => '期间内的最大UserIO事件等待时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'MaxDiskReads' => [ + 'title' => '期间内的最大物理读次数', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgExpectedWorkerCount' => [ + 'title' => '期间内平均并行度', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgUsedWorkerCount' => [ + 'title' => '期间内sql平均使用线程数', + 'type' => 'number', + 'format' => 'double', + ], + 'SumLogicalReads' => [ + 'title' => '期间内 sql 总逻辑读', + 'type' => 'number', + 'format' => 'double', + ], + 'Server' => [ + 'title' => 'SQL执行所在的Server', + 'type' => 'string', + ], + 'ServerIp' => [ + 'title' => 'SQL执行所在的Server的IP', + 'type' => 'string', + ], + 'ServerPort' => [ + 'title' => 'SQL执行所在的Server的Port', + 'type' => 'integer', + 'format' => 'int64', + ], + 'SqlTextShort' => [ + 'title' => 'SQL的文本（前100字符）', + 'type' => 'string', + ], + 'SqlType' => [ + 'title' => 'SQL类型', + 'type' => 'string', + ], + 'SqlId' => [ + 'title' => 'SQL id', + 'type' => 'string', + ], + 'Inner' => [ + 'title' => '是否是内部SQL', + 'type' => 'boolean', + ], + 'WaitEvent' => [ + 'title' => '期间内的最长等待事件', + 'type' => 'string', + ], + 'AvgAffectedRows' => [ + 'title' => '期间内平均更新行数', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgReturnRows' => [ + 'title' => '期间内平均返回行数', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgPartitionCount' => [ + 'title' => '期间内平均访问分区数', + 'type' => 'number', + 'format' => 'double', + ], + 'FailCount' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'AvgWaitTime' => [ + 'title' => '期间内的平均等待时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgElapsedTime' => [ + 'title' => '期间内的平均响应时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgCpuTime' => [ + 'title' => '期间内的平均CPU时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgNetWaitTime' => [ + 'title' => '期间内的平均网络入队时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgQueueTime' => [ + 'title' => '期间内的平均排队时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgDecodeTime' => [ + 'title' => '期间内的平均语法解析时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgGetPlanTime' => [ + 'title' => '期间内的平均计划生成时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgExecuteTime' => [ + 'title' => '期间内的平均计划执行时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgApplicationWaitTime' => [ + 'title' => '期间内的平均Application事件等待时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgConcurrencyWaitTime' => [ + 'title' => '期间内的平均Concurrency事件等待时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgUserIoWaitTime' => [ + 'title' => '期间内的平均UserIO事件等待时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgScheduleTime' => [ + 'title' => '期间内的平均Schedule事件等待时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgRowCacheHit' => [ + 'title' => '期间内的平均RowCache命中次数', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgBloomFilterCacheHit' => [ + 'title' => '期间内的平均BloomFilterCache命中次数', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgBlockCacheHit' => [ + 'title' => '期间内的平均BlockCache命中次数', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgBlockIndexCacheHit' => [ + 'title' => '期间内的平均BlockIndexCache命中次数', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgDiskReads' => [ + 'title' => '期间内的平均物理读次数', + 'type' => 'number', + 'format' => 'double', + ], + 'RetryCount' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'AvgMemstoreReadRows' => [ + 'title' => '期间内的强一致性事务百分比', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgSsstoreReadRows' => [ + 'title' => '期间内的弱一致性事务百分比', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgLogicalReads' => [ + 'title' => '期间内 sql 平均逻辑读', + 'type' => 'number', + 'format' => 'double', + ], + 'AvgDbTime' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'SumDbTime' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'FormatSqlId' => [ + 'title' => 'FormatSqlId', + 'type' => 'string', + ], + ], + ], + ], + 'AvgDbTime' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'SumDbTime' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'FormatSqlId' => [ + 'title' => 'FormatSqlId', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"Executions\\": 100,\\n \\"RpcCount\\": 0,\\n \\"RemotePlans\\": 0,\\n \\"MissPlans\\": 0,\\n \\"MaxElapsedTime\\": 260.044,\\n \\"TotalWaitTime\\": 10.966,\\n \\"ExecPs\\": 0.31,\\n \\"MaxCpuTime\\": 257.967,\\n \\"ClientIp\\": \\"1*2.***.1*3.***\\",\\n \\"UserName\\": \\"test_user\\",\\n \\"DbName\\": \\"test_db\\",\\n \\"RetCode4012Count\\": 0,\\n \\"RetCode4013Count\\": 0,\\n \\"RetCode5001Count\\": 0,\\n \\"RetCode5024Count\\": 0,\\n \\"RetCode5167Count\\": 0,\\n \\"RetCode5217Count\\": 0,\\n \\"RetCode6002Count\\": 0,\\n \\"FailPercentage\\": 0,\\n \\"SumWaitTime\\": 9421.73,\\n \\"AvgWaitCount\\": 0,\\n \\"AvgRpcCount\\": 8,\\n \\"LocalPlanPercentage\\": 0,\\n \\"RemotePlanPercentage\\": 0,\\n \\"DistPlanPercentage\\": 100,\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"AvgNetTime\\": 0,\\n \\"AvgExecutorRpcCount\\": 0,\\n \\"MissPlanPercentage\\": 0,\\n \\"TableScanPercentage\\": 0,\\n \\"StrongConsistencyPercentage\\": 100,\\n \\"WeakConsistencyPercentage\\": 0,\\n \\"MaxAffectedRows\\": 10000,\\n \\"MaxReturnRows\\": 0,\\n \\"MaxWaitTime\\": 3.4,\\n \\"MaxApplicationWaitTime\\": 0,\\n \\"MaxConcurrencyWaitTime\\": 0,\\n \\"MaxUserIoWaitTime\\": 0,\\n \\"MaxDiskReads\\": 0,\\n \\"AvgExpectedWorkerCount\\": 3,\\n \\"AvgUsedWorkerCount\\": 3,\\n \\"SumLogicalReads\\": 0,\\n \\"Server\\": \\"i-bp1db1a**s038**mej**\\",\\n \\"ServerIp\\": \\"i-bp1db1a**s038**mej**\\",\\n \\"ServerPort\\": 10110,\\n \\"SqlTextShort\\": \\"select a from b where\\",\\n \\"SqlType\\": \\"select \\",\\n \\"SqlId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"Inner\\": false,\\n \\"WaitEvent\\": \\"none\\",\\n \\"AvgAffectedRows\\": 9978.75,\\n \\"AvgReturnRows\\": 0,\\n \\"AvgPartitionCount\\": 1,\\n \\"FailCount\\": 0,\\n \\"AvgWaitTime\\": 1.42,\\n \\"AvgElapsedTime\\": 1876.78,\\n \\"AvgCpuTime\\": 1875.34,\\n \\"AvgNetWaitTime\\": 0,\\n \\"AvgQueueTime\\": 0.01,\\n \\"AvgDecodeTime\\": 0,\\n \\"AvgGetPlanTime\\": 0,\\n \\"AvgExecuteTime\\": 1895.7,\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"AvgScheduleTime\\": 0,\\n \\"AvgRowCacheHit\\": 0,\\n \\"AvgBloomFilterCacheHit\\": 0,\\n \\"AvgBlockCacheHit\\": 0,\\n \\"AvgBlockIndexCacheHit\\": 0,\\n \\"AvgDiskReads\\": 0,\\n \\"RetryCount\\": 5,\\n \\"AvgMemstoreReadRows\\": 0,\\n \\"AvgSsstoreReadRows\\": 0,\\n \\"AvgLogicalReads\\": 0,\\n \\"DynamicSql\\": false,\\n \\"SqlList\\": [\\n {\\n \\"Executions\\": 100,\\n \\"RpcCount\\": 100,\\n \\"RemotePlans\\": 100,\\n \\"MissPlans\\": 100,\\n \\"MaxElapsedTime\\": 10000,\\n \\"TotalWaitTime\\": 100000,\\n \\"ExecPs\\": 0.31,\\n \\"MaxCpuTime\\": 257.967,\\n \\"ClientIp\\": \\"127.0.0.1\\",\\n \\"UserName\\": \\"admin\\",\\n \\"DbName\\": \\"test\\",\\n \\"RetCode4012Count\\": 0,\\n \\"RetCode4013Count\\": 0,\\n \\"RetCode5001Count\\": 0,\\n \\"RetCode5024Count\\": 0,\\n \\"RetCode5167Count\\": 0,\\n \\"RetCode5217Count\\": 0,\\n \\"RetCode6002Count\\": 0,\\n \\"FailPercentage\\": 0,\\n \\"SumWaitTime\\": 9421.73,\\n \\"AvgWaitCount\\": 0,\\n \\"AvgRpcCount\\": 0,\\n \\"LocalPlanPercentage\\": 0,\\n \\"RemotePlanPercentage\\": 0,\\n \\"DistPlanPercentage\\": 100,\\n \\"SumElapsedTime\\": 11452126.36,\\n \\"AvgNetTime\\": 0,\\n \\"AvgExecutorRpcCount\\": 0,\\n \\"MissPlanPercentage\\": 0,\\n \\"TableScanPercentage\\": 0,\\n \\"StrongConsistencyPercentage\\": 100,\\n \\"WeakConsistencyPercentage\\": 0,\\n \\"MaxAffectedRows\\": 10000,\\n \\"MaxReturnRows\\": 0,\\n \\"MaxWaitTime\\": 3.4,\\n \\"MaxApplicationWaitTime\\": 0,\\n \\"MaxConcurrencyWaitTime\\": 0,\\n \\"MaxUserIoWaitTime\\": 0,\\n \\"MaxDiskReads\\": 0,\\n \\"AvgExpectedWorkerCount\\": 3,\\n \\"AvgUsedWorkerCount\\": 3,\\n \\"SumLogicalReads\\": 0,\\n \\"Server\\": \\"10.**.**.6\\",\\n \\"ServerIp\\": \\"11.***.**.69\\",\\n \\"ServerPort\\": 389,\\n \\"SqlTextShort\\": \\"select * from test\\",\\n \\"SqlType\\": \\"SELECT\\",\\n \\"SqlId\\": \\"4CE89****8536A03374DD2****E76DE5\\",\\n \\"Inner\\": false,\\n \\"WaitEvent\\": \\"none\\",\\n \\"AvgAffectedRows\\": 9978.75,\\n \\"AvgReturnRows\\": 0,\\n \\"AvgPartitionCount\\": 1,\\n \\"FailCount\\": 22,\\n \\"AvgWaitTime\\": 1.42,\\n \\"AvgElapsedTime\\": 1876.78,\\n \\"AvgCpuTime\\": 0,\\n \\"AvgNetWaitTime\\": 0,\\n \\"AvgQueueTime\\": 0.01,\\n \\"AvgDecodeTime\\": 0,\\n \\"AvgGetPlanTime\\": 0,\\n \\"AvgExecuteTime\\": 1895.7,\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"AvgScheduleTime\\": 0,\\n \\"AvgRowCacheHit\\": 0,\\n \\"AvgBloomFilterCacheHit\\": 0,\\n \\"AvgBlockCacheHit\\": 0,\\n \\"AvgBlockIndexCacheHit\\": 0,\\n \\"AvgDiskReads\\": 0,\\n \\"RetryCount\\": 2,\\n \\"AvgMemstoreReadRows\\": 0,\\n \\"AvgSsstoreReadRows\\": 0,\\n \\"AvgLogicalReads\\": 0,\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"FormatSqlId\\": \\"\\"\\n }\\n ],\\n \\"AvgDbTime\\": 100,\\n \\"SumDbTime\\": 100,\\n \\"FormatSqlId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeOasSlowSQLList', + ], + 'DescribeOutlineBinding' => [ + 'summary' => 'You can call this operation to query the outline binding information or throttling information of an SQL statement in the database based on an SQLID. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't2mr3oae0****', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => [ + 'title' => '表名称。', + 'description' => 'The name of the tenant. '."\n" + .'It must start with a letter or an underscore (_), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (_). It cannot be set to SYS. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pay_online', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名称', + 'description' => 'The name of the database. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testdb', + ], + ], + [ + 'name' => 'SQLId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'SQLID', + 'description' => 'SQLID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + ], + [ + 'name' => 'IsConcurrentLimit', + 'in' => 'formData', + 'schema' => [ + 'title' => '当值为True时，查询SQLID在数据库中的限流信息', + 'description' => '- When the value is set to True, the throttling information in the database is queried based on the SQL ID. '."\n" + .'- When the value is set to False, the bound index or execution plan in the database is queried based on the SQL ID. ', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => false, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否模版sql', + 'type' => 'boolean', + ], + ], + [ + 'name' => 'FormatSqlId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'format sqlId', + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'OutlineBinding' => [ + 'title' => '绑定信息', + 'description' => 'The binding information. ', + 'type' => 'object', + 'properties' => [ + 'BindPlan' => [ + 'title' => '绑定计划', + 'description' => 'The bound plan. ', + 'type' => 'string', + 'example' => 'PHY_TABLE_SCAN | bmsql_order_line | 40 ******', + ], + 'OutlineId' => [ + 'title' => 'OutlineID', + 'description' => 'OutlineID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'BindIndex' => [ + 'title' => '绑定索引', + 'description' => 'The bound index. ', + 'type' => 'string', + 'example' => 'PRIMARY', + ], + 'MaxConcurrent' => [ + 'title' => '最大并发', + 'description' => 'The maximum number of concurrent tasks. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TableName' => [ + 'title' => '表名称', + 'description' => 'The name of the tenant. The tenant name must start with a letter or an underscore (_), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (_). It cannot be set to sys.', + 'type' => 'string', + 'example' => 'cluster_info', + ], + 'SqlText' => [ + 'title' => '限流的文本', + 'type' => 'string', + ], + 'SqlTextConcurrentNum' => [ + 'title' => '限流的数值', + 'type' => 'integer', + 'format' => 'int64', + ], + 'ByFormatSqlId' => [ + 'title' => '是否为模糊绑定', + 'type' => 'boolean', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"OutlineBinding\\": {\\n \\"BindPlan\\": \\"PHY_TABLE_SCAN | bmsql_order_line | 40 ******\\",\\n \\"OutlineId\\": -1,\\n \\"BindIndex\\": \\"PRIMARY\\",\\n \\"MaxConcurrent\\": 2,\\n \\"TableName\\": \\"cluster_info\\",\\n \\"SqlText\\": \\"\\",\\n \\"SqlTextConcurrentNum\\": 0,\\n \\"ByFormatSqlId\\": true\\n },\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeOutlineBindingResponse>\\n <OutlineBinding>\\n <BindPlan>PHY_TABLE_SCAN | bmsql_order_line | 40 ******</BindPlan>\\n <OutlineId>-1</OutlineId>\\n <BindIndex>PRIMARY</BindIndex>\\n <MaxConcurrent>2</MaxConcurrent>\\n </OutlineBinding>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</DescribeOutlineBindingResponse>","errorExample":""}]', + 'title' => 'DescribeOutlineBinding', + ], + 'DescribeRecommendIndex' => [ + 'summary' => 'You can call this operation to query the index recommended by the diagnostic system based on an SQL ID. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID', + 'description' => 'The index recommended for the SQL statement after calculation by the diagnostic system. '."\n" + .'- If the recommended index is the primary key, PRIMARY is returned. '."\n" + .'- If an index created by the user is recommended, the index name is returned. '."\n" + .'The system recommends only one index for an SQL statement. You can call the DescribeIndexes operation to view the indexes of a table. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't2mr3oae0****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The return result of the request. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'SQLId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'SQLID', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'You can obtain the SQL ID from the return value of the DescribeSlowSQLList or DescribeTopSQLList operation. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The tenant mode. Valid values: '."\n" + .'Oracle '."\n" + .'MySQL ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'RecommendIndex' => [ + 'title' => '推荐索引信息', + 'description' => 'The information about the recommended index. ', + 'type' => 'object', + 'properties' => [ + 'SuggestIndex' => [ + 'title' => '建议索引，如果是主键，就是 PRIMARY，如果不是主键，以用户取名为准', + 'description' => 'Example 1', + 'type' => 'string', + 'example' => 'PRIMARY', + ], + 'TenantMode' => [ + 'title' => '租户模式', + 'description' => ' ', + 'type' => 'string', + 'example' => 'mysql', + ], + 'TableList' => [ + 'title' => '表信息', + 'description' => ' ', + 'type' => 'string', + 'example' => 'testtable', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"RecommendIndex\\": {\\n \\"SuggestIndex\\": \\"PRIMARY\\",\\n \\"TenantMode\\": \\"mysql\\",\\n \\"TableList\\": \\"testtable\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeRecommendIndexResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <RecommendIndex>\\n <SuggestIndex>PRIMARY</SuggestIndex>\\n <TenantMode>mysql</TenantMode>\\n <TableList>testtable</TableList>\\n </RecommendIndex>\\n</DescribeRecommendIndexResponse>","errorExample":""}]', + 'title' => 'DescribeRecommendIndex', + ], + 'DescribeSQLTuningAdvices' => [ + 'summary' => 'You can call this operation to query SQL optimization suggestions for two purposes: creating indexes and binding execution plans.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'obsdf43****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'tsdc2s2****', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名称', + 'description' => 'The name of the database. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testdb', + ], + ], + [ + 'name' => 'SqlId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'SqlId', + 'description' => 'The ID of the SQL statement.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '开始时间', + 'description' => 'The start time.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T04:38:38Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '结束时间', + 'description' => 'The end time.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T05:38:38Z', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The supported language. Valid values: '."\n" + .'* zh-CN '."\n" + .'* en-US', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the execution plans of the SQL statement.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The optimization type.', + 'type' => 'string', + 'example' => 'PLAN_BINDING/INDEX_CREATION', + ], + 'ColumnNames' => [ + 'description' => 'The sequence of index columns.', + 'type' => 'string', + 'example' => 'c1;c2;c3', + ], + 'LocalityType' => [ + 'title' => '索引类型', + 'description' => 'The type of the index.', + 'type' => 'string', + 'example' => 'Local/Global', + ], + 'Columns' => [ + 'title' => '索引列', + 'description' => 'The list of index columns.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about index columns.', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'title' => '列名', + 'description' => 'The name of the column.', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'Ndv' => [ + 'title' => 'NDV', + 'description' => 'The NDV of the column.', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'MinValue' => [ + 'title' => '最小值', + 'description' => 'The minimum value of the column.', + 'type' => 'string', + 'example' => '1', + ], + 'MaxValue' => [ + 'title' => '最大值', + 'description' => 'The maximum value of the column.', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + 'DbName' => [ + 'title' => '数据库名称', + 'description' => 'The name of the database. ', + 'type' => 'string', + 'example' => 'test_db', + ], + 'Table' => [ + 'title' => '表名', + 'description' => 'The name of the table.', + 'type' => 'string', + 'example' => 'test_table', + ], + 'Plan' => [ + 'description' => 'The execution plan.', + 'type' => 'object', + 'properties' => [ + 'Executions' => [ + 'description' => 'The total number of executions within the specified period of time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2062', + ], + 'AvgCpuTime' => [ + 'description' => 'The average CPU time within the specified period of time, in milliseconds.', + 'type' => 'number', + 'format' => 'float', + 'example' => '100.36', + ], + 'PlanHash' => [ + 'description' => 'The unique identifier of the execution plan in the diagnostic system.', + 'type' => 'string', + 'example' => '-86290582****886880', + ], + 'TimeoutPercentage' => [ + 'description' => 'The percentage of executions with a timeout error.', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'AvgConcurrencyWaitTime' => [ + 'description' => 'The average amount of time spent on a Concurrency wait event within the specified period of time, in milliseconds.', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'FirstLoadTimeUs' => [ + 'description' => 'The time when the execution plan was loaded for the first time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1672367130576163', + ], + 'AvgDiskWrites' => [ + 'description' => 'The average number of physical writes within the specified period of time.', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'AvgUserIoWaitTime' => [ + 'description' => 'The average amount of time spent on a UserIo wait event within the specified period of time, in milliseconds.', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'PlanSize' => [ + 'description' => 'The size of the execution plan.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '49216', + ], + 'ServerSn' => [ + 'description' => 'The ID of the node.', + 'type' => 'string', + 'example' => 'i-bp1*****sw64dhb*****', + ], + 'OutlineData' => [ + 'description' => 'The outline_data field of the execution plan.', + 'type' => 'string', + 'example' => 'xxxxx', + ], + 'PlanType' => [ + 'description' => 'The type of the execution plan. Valid values: LOCAL, REMOTE, and DIST.', + 'type' => 'string', + 'example' => 'LOCAL', + ], + 'ObDbId' => [ + 'description' => 'The ID of the database.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1108307720799259', + ], + 'HitPercentage' => [ + 'description' => 'The hit rate.', + 'type' => 'number', + 'format' => 'float', + 'example' => '66.8', + ], + 'AvgBufferGets' => [ + 'description' => 'The average number of cache reads within the specified period of time.', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ExecPs' => [ + 'description' => 'The average number of executions per second within the specified period of time.', + 'type' => 'number', + 'format' => 'float', + 'example' => '1.45', + ], + 'DelayedLargeQueryPercentage' => [ + 'description' => 'The percentage of delayed long-running queries.', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'TableScan' => [ + 'description' => 'Indicates whether full table scan is performed.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'LargeQueryPercentage' => [ + 'description' => 'The percentage of completed long-running queries.', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'SchemaVersion' => [ + 'description' => 'The version of the schema.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1672367130529680', + ], + 'PlanId' => [ + 'description' => 'The ID of the execution plan.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '818', + ], + 'FirstLoadTime' => [ + 'description' => 'The time when the execution plan was loaded for the first time.', + 'type' => 'string', + 'example' => '2022-12-30T02:25:30.576Z', + ], + 'AvgRowProcessed' => [ + 'description' => 'The average wait time of row processing within the specified period of time, in milliseconds.', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'MergedVersion' => [ + 'description' => 'The version of the major compaction.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'HitDiagnosis' => [ + 'description' => 'Indicates whether the diagnosis is hit.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Uid' => [ + 'description' => 'The unique identifier of the execution plan.', + 'type' => 'string', + 'example' => 'AAAAAAAAAAEAAAAAAAADMgAF8QJQwIUj', + ], + 'AvgApplicationWaitTime' => [ + 'description' => 'The average amount of time spent on an Application wait event within the specified period of time, in milliseconds.', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'CollectTimeUs' => [ + 'description' => 'The period of time during which data is collected.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1672358400000000', + ], + 'AvgElapsedTime' => [ + 'description' => 'The average interval wait time within the specified period of time, in milliseconds.', + 'type' => 'number', + 'format' => 'float', + 'example' => '713.62', + ], + 'ObServerId' => [ + 'description' => 'The ID of the server.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'OutlineId' => [ + 'description' => 'The ID of the outline.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AvgDiskReads' => [ + 'description' => 'The average number of physical reads within the specified period of time.', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Data\\": [\\n {\\n \\"Type\\": \\"PLAN_BINDING/INDEX_CREATION\\",\\n \\"ColumnNames\\": \\"c1;c2;c3\\",\\n \\"LocalityType\\": \\"Local/Global\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"xxxx\\",\\n \\"Ndv\\": 100,\\n \\"MinValue\\": \\"1\\",\\n \\"MaxValue\\": \\"100\\"\\n }\\n ],\\n \\"DbName\\": \\"test_db\\",\\n \\"Table\\": \\"test_table\\",\\n \\"Plan\\": {\\n \\"Executions\\": 2062,\\n \\"AvgCpuTime\\": 100.36,\\n \\"PlanHash\\": \\"-86290582****886880\\",\\n \\"TimeoutPercentage\\": 0,\\n \\"AvgConcurrencyWaitTime\\": 0,\\n \\"FirstLoadTimeUs\\": 1672367130576163,\\n \\"AvgDiskWrites\\": 0,\\n \\"AvgUserIoWaitTime\\": 0,\\n \\"PlanSize\\": 49216,\\n \\"ServerSn\\": \\"i-bp1*****sw64dhb*****\\",\\n \\"OutlineData\\": \\"xxxxx\\",\\n \\"PlanType\\": \\"LOCAL\\",\\n \\"ObDbId\\": 1108307720799259,\\n \\"HitPercentage\\": 66.8,\\n \\"AvgBufferGets\\": 0,\\n \\"ExecPs\\": 1.45,\\n \\"DelayedLargeQueryPercentage\\": 0,\\n \\"TableScan\\": false,\\n \\"LargeQueryPercentage\\": 0,\\n \\"SchemaVersion\\": 1672367130529680,\\n \\"PlanId\\": 818,\\n \\"FirstLoadTime\\": \\"2022-12-30T02:25:30.576Z\\",\\n \\"AvgRowProcessed\\": 1,\\n \\"MergedVersion\\": 3,\\n \\"HitDiagnosis\\": false,\\n \\"Uid\\": \\"AAAAAAAAAAEAAAAAAAADMgAF8QJQwIUj\\",\\n \\"AvgApplicationWaitTime\\": 0,\\n \\"CollectTimeUs\\": 1672358400000000,\\n \\"AvgElapsedTime\\": 713.62,\\n \\"ObServerId\\": 1,\\n \\"OutlineId\\": 1,\\n \\"AvgDiskReads\\": 0\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeSQLTuningAdvices', + ], + 'DescribeSqlAuditStat' => [ + 'summary' => 'You can call this operation to collect the execution statistics of an SQL statement by client IP address, user, and SQL statement ID.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群实例Id', + 'description' => 'The ID of the OceanBase cluster.', + 'type' => 'string', + 'required' => false, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户Id', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => false, + 'example' => 't33h8y08k****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '开始时间 yyyy-MM-dd\'T\'HH:mm:ss\'Z\'', + 'description' => 'The start time, in the format of yyyy-MM-dd\'T\'HH:mm:ss\'Z\'.', + 'type' => 'string', + 'required' => false, + 'example' => '2025-01-14T02:34:49Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '结束时间yyyy-MM-dd\'T\'HH:mm:ss\'Z\' (时间跨度过大会导致数据不精准，6小时内最佳，跟单位时间内的数据量有关)', + 'description' => 'The end time, in the format of yyyy-MM-dd\'T\'HH:mm:ss\'Z\' . The time range cannot exceed 6 hours.', + 'type' => 'string', + 'required' => false, + 'example' => '2025-01-14T03:34:49Z', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页大小', + 'description' => 'The number of rows to return on each page.'."\n" + .'- Maximum value: 100.'."\n" + .'- Default value: 10.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页页码', + 'description' => 'The number of the page to return.'."\n" + .'- Pages start from page 1.'."\n" + .'- Default value: 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'OperatorType', + 'in' => 'formData', + 'schema' => [ + 'title' => '操作类型', + 'description' => 'The type of the operation.', + 'type' => 'string', + 'required' => false, + 'example' => 'INSERT', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => ' '."\n" + .'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C'."\n", + ], + 'Data' => [ + 'title' => '数据集合', + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => '集群实例Id', + 'description' => 'The ID of the cluster instance.', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'TenantId' => [ + 'title' => '租户Id', + 'description' => 'The ID of the tenant.', + 'type' => 'string', + 'example' => 't33h8y08k****', + ], + 'UserClientIp' => [ + 'title' => '客户端IP', + 'description' => 'The IP address of the client.', + 'type' => 'string', + 'example' => 'xx.xx.xx.xx'."\n", + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => 'The username.', + 'type' => 'string', + 'example' => 'test_mysql ', + ], + 'DatabaseName' => [ + 'title' => '数据库名', + 'description' => 'The name of the database', + 'type' => 'string', + 'example' => 'test_database_1', + ], + 'SqlId' => [ + 'title' => 'SqlID', + 'description' => 'The ID of the SQL statement.', + 'type' => 'string', + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + 'TotalSucceed' => [ + 'title' => '总成功条数', + 'description' => 'The total number of successful executions.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalFailed' => [ + 'title' => '总失败条数', + 'description' => 'The total number of failed executions.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'TotalAffectRows' => [ + 'title' => '总影响行数', + 'description' => 'The total number of affected rows.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalScanRows' => [ + 'title' => '总扫描行数', + 'description' => 'The total number of scanned rows.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalReturnRows' => [ + 'title' => '总返回行数', + 'description' => 'The total number of returned rows.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AffectRows' => [ + 'title' => '平均影响行数（0的数据不计算在内）四舍五入', + 'description' => 'The average number of affected rows. SQL executions that affect 0 rows are excluded from the calculation. The value is rounded off.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'ScanRows' => [ + 'title' => '平均扫描行数0的数据不计算在内）四舍五入', + 'description' => 'The average number of scanned rows. SQL executions that affect 0 rows are excluded from the calculation. The value is rounded off.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'ReturnRows' => [ + 'title' => '平均返回行数（0的数据不计算在内）四舍五入', + 'description' => 'The average number of returned rows. SQL executions that affect 0 rows are excluded from the calculation. The value is rounded off.', + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'ExecuteTime' => [ + 'title' => '平均执行耗时 单位ms', + 'description' => 'The average execution time, in ms.', + 'type' => 'number', + 'format' => 'double', + 'example' => '142', + ], + 'SqlStatement' => [ + 'title' => 'SQL模板', + 'description' => 'The SQL template.', + 'type' => 'string', + 'example' => 'UPDATE `oceanbase_test_table` SET `name` = ? WHERE `key` = ?', + ], + 'OperatorType' => [ + 'title' => '操作类型', + 'description' => 'The type of the operation.', + 'type' => 'string', + 'example' => 'UPDATE', + ], + ], + ], + ], + 'TotalCount' => [ + 'title' => '总数', + 'description' => 'The total count.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\\\t\\\\nEE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\\\n\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"TenantId\\": \\"t33h8y08k****\\",\\n \\"UserClientIp\\": \\"xx.xx.xx.xx\\\\n\\",\\n \\"UserName\\": \\"test_mysql \\",\\n \\"DatabaseName\\": \\"test_database_1\\",\\n \\"SqlId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"TotalSucceed\\": 1,\\n \\"TotalFailed\\": 0,\\n \\"TotalAffectRows\\": 1,\\n \\"TotalScanRows\\": 10,\\n \\"TotalReturnRows\\": 1,\\n \\"AffectRows\\": 1,\\n \\"ScanRows\\": 1,\\n \\"ReturnRows\\": 1,\\n \\"ExecuteTime\\": 142,\\n \\"SqlStatement\\": \\"UPDATE `oceanbase_test_table` SET `name` = ? WHERE `key` = ?\\",\\n \\"OperatorType\\": \\"UPDATE\\"\\n }\\n ],\\n \\"TotalCount\\": 9\\n}","type":"json"}]', + 'title' => 'DescribeSqlAuditStat', + ], + 'CreateOasOutlineTask' => [ + 'summary' => 'You can call this operation to initiate outline binding tasks.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '实例Id', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'SqlText', + 'in' => 'formData', + 'schema' => [ + 'title' => 'sql文本', + 'description' => 'The SQL text.', + 'type' => 'string', + 'required' => true, + 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名', + 'description' => 'The name of the database. ', + 'type' => 'string', + 'required' => true, + 'example' => 'test_data', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => [ + 'title' => '表名', + 'description' => 'The name of the table.', + 'type' => 'string', + 'required' => false, + 'example' => 'test_1', + ], + ], + [ + 'name' => 'SqlId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'sqlId', + 'description' => 'The ID of the SQL statement.', + 'type' => 'string', + 'required' => false, + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + ], + [ + 'name' => 'IsConcurrentLimit', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否为限流', + 'description' => '- When the value is set to True, the throttling information in the database is queried based on the SQL ID. '."\n" + .'- When the value is set to False, the bound index or execution plan in the database is queried based on the SQL ID. ', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否为动态SQL', + 'description' => 'Specifies whether the specified SQL statements are dynamic SQL statements.'."\n" + .'> This parameter specifies whether the values of the `SqlId` parameter are the IDs of dynamic SQL statements.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'UId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The user identifier (UID) of the OceanBase database.', + 'type' => 'string', + 'required' => false, + 'example' => '139*************', + ], + ], + [ + 'name' => 'PlanData', + 'in' => 'formData', + 'schema' => [ + 'title' => '执行计划', + 'description' => 'The execution plan.', + 'type' => 'string', + 'required' => false, + 'example' => '********', + ], + ], + [ + 'name' => 'IndexName', + 'in' => 'formData', + 'schema' => [ + 'title' => '索引名', + 'description' => 'The name of the index.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'idx_a', + ], + ], + [ + 'name' => 'MaxConcurrent', + 'in' => 'formData', + 'schema' => [ + 'title' => '限流数值', + 'description' => 'The maximum number of outline binding tasks that can be initiated at a time.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '开始时间', + 'description' => 'The start time of querying the TOPSQL parameter. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', + 'type' => 'string', + 'required' => false, + 'example' => '2025-05-13T15:40:43Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '结束时间', + 'description' => 'The end time of querying the SQL execution plan. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', + 'type' => 'string', + 'required' => false, + 'example' => '2025-05-13T16:40:43Z', + ], + ], + [ + 'name' => 'StatementId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'sql模版id'."\n", + 'description' => 'The ID of the SQL template.', + 'type' => 'string', + 'required' => false, + 'example' => '********', + ], + ], + [ + 'name' => 'BySqlId', + 'in' => 'formData', + 'schema' => [ + 'title' => '用来判断是通过sqlId/sqlText绑定，默认为true', + 'description' => 'Specifies whether to bind by SQLID/SQLText. Default value: true.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Success' => [ + 'title' => '提交成功/失败', + 'description' => 'Indicates whether the call is successful. ', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '信息', + 'description' => 'The error description.', + 'type' => 'string', + 'example' => 'successful', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => 'CreateOasOutlineTask', + ], + 'ModifyInstanceSSL' => [ + 'summary' => 'You can call this operation to modify the Secure Sockets Layer (SSL) setting for an OceanBase cluster instance.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'EnableSSL', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'The operation to modify the SSL status. Valid values:'."\n" + ."\n" + .'- open: Enable SSL encryption.'."\n" + ."\n" + .'- update: Update the CA certificate.'."\n" + ."\n" + .'- close: Disable SSL encryption.', + 'type' => 'string', + 'required' => true, + 'example' => 'open', + 'enum' => [], + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The return result.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'InstanceSSL' => [ + 'title' => 'job', + 'description' => 'The SSL setting of the OceanBase cluster instance.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'EnableSSL' => [ + 'description' => 'The operation to modify the SSL status. Valid values:'."\n" + ."\n" + .'- open: Enable SSL encryption.'."\n" + ."\n" + .'- update: Update the CA certificate.'."\n" + ."\n" + .'- close: Disable SSL encryption.', + 'type' => 'string', + 'example' => 'open', + ], + 'TenantId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"InstanceSSL\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"EnableSSL\\": \\"open\\",\\n \\"TenantId\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => 'ModifyInstanceSSL', + 'description' => 'There is currently no authorization information disclosed in the API.', + ], + 'DescribeInstanceSSL' => [ + 'summary' => '查询集群SSL配置', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster.', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'OceanBase租户ID', + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C', + ], + 'InstanceSSL' => [ + 'description' => 'The SSL setting of the OceanBase cluster instance.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'EnableSSL' => [ + 'description' => 'The operation to modify the SSL status. Valid values:'."\n" + ."\n" + .'- open: Enable SSL encryption.'."\n" + ."\n" + .'- update: Update the CA certificate.'."\n" + ."\n" + .'- close: Disable SSL encryption.', + 'type' => 'string', + 'example' => 'OPEN', + ], + 'ValidPeriod' => [ + 'description' => 'The validity period of the SSL certificate.', + 'type' => 'string', + 'example' => '2024-09-20 07:55:03.0', + ], + 'CaUrl' => [ + 'description' => 'The URL of the certificate authority (CA) node.', + 'type' => 'string', + 'example' => 'https://xxxx', + ], + 'Status' => [ + 'description' => 'The SSL status of the cluster.', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'ForceSSLSupport' => [ + 'title' => '是否支持强制开启SSL', + 'description' => 'Indicates whether SSL can be forcibly enabled.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ForceSSL' => [ + 'title' => '强制开启状态', + 'description' => 'The forced enabling status of SSL.', + 'type' => 'string', + 'example' => 'CLOSE', + 'enum' => [ + 'CLOSE', + 'OPEN', + ], + ], + 'AutoUpdate' => [ + 'description' => 'The status of automatic update of SSL certificates. Valid values: '."\n" + .'* CLOSE: The automatic update of SSL certificates is disabled. '."\n" + .'* OPEN: The automatic update of SSL certificates is enabled.', + 'type' => 'string', + 'enumValueTitles' => [ + 'CLOSE' => 'CLOSE', + 'OPEN' => 'OPEN', + ], + 'example' => 'OPEN', + ], + 'TenantId' => [ + 'type' => 'string', + ], + 'CertValid' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C\\",\\n \\"InstanceSSL\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"EnableSSL\\": \\"OPEN\\",\\n \\"ValidPeriod\\": \\"2024-09-20 07:55:03.0\\",\\n \\"CaUrl\\": \\"https://xxxx\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ForceSSLSupport\\": false,\\n \\"ForceSSL\\": \\"CLOSE\\",\\n \\"AutoUpdate\\": \\"OPEN\\",\\n \\"TenantId\\": \\"\\",\\n \\"CertValid\\": true\\n }\\n}","type":"json"}]', + 'title' => 'DescribeInstanceSSL', + ], + 'CreateSecurityIpGroup' => [ + 'summary' => 'You can call this operation to create an IP address whitelist group. ', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP安全白名单列表。 其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。最多可设置 40 个。', + 'description' => 'The return result of the request. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"192.168.1.1","192.168.0.0.1/8"}', + ], + ], + [ + 'name' => 'SecurityIpGroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP安全白名单组的组名。 由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', + 'description' => 'The name of the whitelist group. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pay_online', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'The ID of the region. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The IP addresses or CIDR blocks in the IP address whitelist group. '."\n" + .'The return values of SecurityIps are strings that are separated with commas (,). ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'SecurityIpGroup' => [ + 'title' => '白名单分组信息。', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **CreateSecurityIpGroup**. ', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => '```'."\n" + .'http(s)://[Endpoint]/?Action=CreateSecurityIpGroup'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&SecurityIps=192.168.1.1,192.168.0.0.1/8'."\n" + .'&SecurityIpGroupName=pay_online'."\n" + .'&Common request parameters'."\n" + .'```', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'SecurityIpGroupName' => [ + 'title' => '白名单分组名称。', + 'description' => 'You can call this operation to create an IP address whitelist group. ', + 'type' => 'string', + 'example' => 'pay_online', + ], + 'SecurityIps' => [ + 'title' => 'IP白名单分组中的IP地址或地址段。其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。', + 'description' => '', + 'type' => 'string', + 'example' => '192.168.1.1,192.168.0.0.1/8', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"SecurityIpGroup\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"SecurityIpGroupName\\": \\"pay_online\\",\\n \\"SecurityIps\\": \\"[\\\\\\"192.***.1.1\\\\\\"]\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateSecurityIpGroupResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <SecurityIpGroup>\\n <InstanceId>ob317v4uif****</InstanceId>\\n <SecurityIpGroupName>pay_online</SecurityIpGroupName>\\n <SecurityIps>192.168.1.1,192.168.0.0.1/8</SecurityIps>\\n </SecurityIpGroup>\\n</CreateSecurityIpGroupResponse>","errorExample":""}]', + 'title' => 'CreateSecurityIpGroup', + ], + 'DescribeSecurityIpGroups' => [ + 'summary' => 'You can call this operation to view the list of IP address whitelist groups. ', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'i-bp67acfmxazb4p****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'The list of IP addresses and CIDR blocks in the whitelist. '."\n" + .'It is a JSON array. Each object in the array is an IP address or CIDR block. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'TotalCount' => [ + 'title' => '查询到的白名单分组个数。', + 'description' => 'Example 1', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SecurityIpGroups' => [ + 'title' => 'IP白名单分组信息。', + 'description' => ' ', + 'type' => 'array', + 'items' => [ + 'description' => 'You can call this operation to view the list of IP address whitelist groups. ', + 'type' => 'object', + 'properties' => [ + 'SecurityIps' => [ + 'title' => 'IP安全白名单列表。其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。', + 'description' => '', + 'type' => 'string', + 'example' => '121.41.106.33,100.104.7.0/26', + ], + 'SecurityIpGroupName' => [ + 'title' => '安全组名称。', + 'description' => '', + 'type' => 'string', + 'example' => 'online_paycore', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"TotalCount\\": 2,\\n \\"SecurityIpGroups\\": [\\n {\\n \\"SecurityIps\\": \\"127.*.*.1\\",\\n \\"SecurityIpGroupName\\": \\"default\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeSecurityIpGroupsResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <TotalCount>2</TotalCount>\\n <SecurityIpGroups>\\n <SecurityIps>121.41.106.33,100.104.7.0/26</SecurityIps>\\n <SecurityIpGroupName>online_paycore</SecurityIpGroupName>\\n </SecurityIpGroups>\\n</DescribeSecurityIpGroupsResponse>","errorExample":""}]', + 'title' => 'DescribeSecurityIpGroups', + ], + 'DescribeTenantSecurityConfigs' => [ + 'summary' => 'You can call this operation to query security check items of an OceanBase Database tenant.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID', + 'description' => 'The ID of the OceanBase cluster.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户Id', + 'description' => 'The ID of the tenant.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'CheckId', + 'in' => 'formData', + 'schema' => [ + 'title' => '安全检测的唯一标识', + 'description' => 'The unique identifier of the security check.', + 'type' => 'string', + 'required' => false, + 'example' => '****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '523E7183-****-590D-****-12DFD316614B', + ], + 'Configs' => [ + 'description' => 'The list of parameters.', + 'type' => 'object', + 'properties' => [ + 'TotalCheckCount' => [ + 'title' => '安全配置总体检测项目', + 'description' => 'The total number of security check items.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'TotalRiskCount' => [ + 'title' => '检测出来的总体风险项目', + 'description' => 'The total number of detected security risks.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TenantSecurityConfigs' => [ + 'title' => '检测结果', + 'description' => 'The check result.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the tenant.', + 'type' => 'object', + 'properties' => [ + 'TenantId' => [ + 'title' => '租户Id', + 'description' => 'The ID of the tenant.', + 'type' => 'string', + 'example' => 'xxx', + ], + 'TenantName' => [ + 'title' => '租户名称', + 'description' => 'The name of the tenant.', + 'type' => 'string', + 'example' => 'xxx', + ], + 'RiskCount' => [ + 'title' => '租户的风险条目', + 'description' => 'The number of detected tenant security risks.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SecurityConfigs' => [ + 'title' => '风险列表', + 'description' => 'The list of risks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of risks.', + 'type' => 'object', + 'properties' => [ + 'ConfigGroup' => [ + 'title' => '风险分组', + 'description' => 'The group of the risk.', + 'type' => 'string', + 'example' => 'WHITELIST', + ], + 'ConfigName' => [ + 'title' => '风险项目名称', + 'description' => 'The name of the risk.', + 'type' => 'string', + 'example' => 'WHITELIST_RANGE_LARGE', + ], + 'Risk' => [ + 'title' => '是否有风险', + 'description' => 'Indicates whether the risk causes security issues.', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'false', + ], + 'RiskDescription' => [ + 'title' => '风险描述', + 'description' => 'The description of the risk.', + 'type' => 'string', + 'example' => 'The scope of the allowlist is too big.', + ], + 'ConfigDescription' => [ + 'title' => '检测项名称', + 'description' => 'The name of the check item.', + 'type' => 'string', + 'example' => 'Check whether the scope of the cluster allowlist is too big', + ], + ], + ], + ], + ], + ], + ], + 'CheckId' => [ + 'title' => '检测的唯一标识', + 'description' => 'The unique identifier of the check.', + 'type' => 'string', + 'example' => ' xxx', + ], + 'InstanceId' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster.', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'CheckTime' => [ + 'title' => '检测时间', + 'description' => 'The time when the check was performed.', + 'type' => 'string', + 'example' => '2023-08-07 15:30:00', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"523E7183-1490-590D-BA03-12DFD316614B\\",\\n \\"Configs\\": {\\n \\"TotalCheckCount\\": 4,\\n \\"TotalRiskCount\\": 0,\\n \\"TenantSecurityConfigs\\": [\\n {\\n \\"TenantId\\": \\"xxx\\",\\n \\"TenantName\\": \\"xxx\\",\\n \\"RiskCount\\": 0,\\n \\"SecurityConfigs\\": [\\n {\\n \\"ConfigGroup\\": \\"WHITELIST\\",\\n \\"ConfigName\\": \\"WHITELIST_RANGE_LARGE\\",\\n \\"Risk\\": true,\\n \\"RiskDescription\\": \\"白名单开放过大，建议按需设置\\",\\n \\"ConfigDescription\\": \\"校验集群白名单范围是否过大\\"\\n }\\n ]\\n }\\n ],\\n \\"CheckId\\": \\" xxx\\",\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"CheckTime\\": \\"2023-08-07 15:30:00\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeTenantSecurityConfigs', + ], + 'DescribeTenantEncryption' => [ + 'summary' => 'You can call this operation to query the encryption information of a tenant.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the OceanBase cluster.', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => false, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'TenantName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the tenant. '."\n" + .'It must start with a letter or an underscore (_), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (_). It cannot be set to sys. ', + 'type' => 'string', + 'required' => false, + 'example' => 'forMySQLTenant', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n" + .'- Pages start from page 1.'."\n" + .'- Default value: 1.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of rows to return on each page. '."\n" + .'- Maximum value: 100.'."\n" + .'- Default value: 10', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned. This parameter takes effect in a pagination query.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'TenantEncryptions' => [ + 'description' => 'The scenarios supporting encryption.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about scenarios supporting encryption.', + 'type' => 'object', + 'properties' => [ + 'TenantId' => [ + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'example' => 't4louaeei****', + ], + 'TenantMode' => [ + 'description' => 'The compatible mode of the tenant. Valid values: '."\n" + .'* Oracle '."\n" + .'* MySQL', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'TenantName' => [ + 'description' => 'The name of the tenant.', + 'type' => 'string', + 'example' => 'forMySQLTenant', + ], + 'EnableEncryption' => [ + 'description' => 'Indicates whether encryption is enabled. Valid values: '."\n" + .'* true '."\n" + .'* false', + 'type' => 'boolean', + 'example' => 'false', + ], + 'TenantStatus' => [ + 'description' => 'The status of the tenant.', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'Status' => [ + 'description' => 'The status of tenant encryption enablement.', + 'type' => 'string', + 'example' => 'OPEN', + ], + 'EncryptionType' => [ + 'title' => '加密的类型', + 'description' => 'The encryption type.', + 'type' => 'string', + 'example' => 'INTERNAL', + ], + 'EncryptionKeyId' => [ + 'title' => 'xxx', + 'description' => 'The ID of the encryption key created by Key Management Service (KMS).', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"TotalCount\\": 8,\\n \\"TenantEncryptions\\": [\\n {\\n \\"TenantId\\": \\"t4louaeei****\\",\\n \\"TenantMode\\": \\"MySQL\\",\\n \\"TenantName\\": \\"forMySQLTenant\\",\\n \\"EnableEncryption\\": false,\\n \\"TenantStatus\\": \\"ONLINE\\",\\n \\"Status\\": \\"OPEN\\",\\n \\"EncryptionType\\": \\"INTERNAL\\",\\n \\"EncryptionKeyId\\": \\"xxx\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeTenantEncryption', + ], + 'DescribeInstanceSecurityConfigs' => [ + 'summary' => 'You can call this operation to query security check items of an OceanBase cluster.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'CheckId', + 'in' => 'formData', + 'schema' => [ + 'title' => '检测的唯一标识', + 'description' => 'The unique identifier of the check.', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'InstanceSecurityConfigs' => [ + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'TotalCheckCount' => [ + 'title' => '集群安全项检测总数', + 'description' => 'The total number of security check items for the cluster.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TotalRiskCount' => [ + 'title' => '集群安全项风险总数', + 'description' => 'The total number of detected cluster security risks.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SecurityConfigs' => [ + 'title' => '检测项目列表', + 'description' => 'The list of check items.', + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the specific check item.', + 'type' => 'object', + 'properties' => [ + 'ConfigName' => [ + 'title' => '具体检测项名称', + 'description' => 'The name of the specific check item.', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Risk' => [ + 'title' => '是否存在风险', + 'description' => 'Specifies whether a risk is detected.', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'RiskDescription' => [ + 'title' => '安全建议', + 'description' => 'Security recommendations.', + 'type' => 'string', + 'example' => 'xxx', + ], + 'ConfigGroup' => [ + 'title' => '检测分组', + 'description' => 'The group of the check.', + 'type' => 'string', + 'example' => 'WHITELIST', + ], + 'ConfigDescription' => [ + 'title' => '检测项名称', + 'description' => 'The name of the check item.', + 'type' => 'string', + 'example' => 'Check whether the scope of the cluster allowlist is too big', + ], + ], + ], + ], + 'CheckTime' => [ + 'title' => '2023-08-07 15:30:00', + 'description' => 'The time when the check was performed.', + 'type' => 'string', + 'example' => '2023-08-07 15:30:00', + ], + 'InstanceId' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster.', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'CheckId' => [ + 'title' => '检测的唯一标识', + 'description' => 'The unique identifier of the check.', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"InstanceSecurityConfigs\\": {\\n \\"TotalCheckCount\\": 5,\\n \\"TotalRiskCount\\": 0,\\n \\"SecurityConfigs\\": [\\n {\\n \\"ConfigName\\": \\"xxx\\",\\n \\"Risk\\": true,\\n \\"RiskDescription\\": \\"xxx\\",\\n \\"ConfigGroup\\": \\"WHITELIST\\",\\n \\"ConfigDescription\\": \\"校验集群白名单范围是否过大\\"\\n }\\n ],\\n \\"CheckTime\\": \\"2023-08-07 15:30:00\\",\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"CheckId\\": \\"xxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeInstanceSecurityConfigs', + ], + 'ModifySecurityIps' => [ + 'summary' => 'You can call this operation to modify the IP address list in a group. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP安全白名单列表。 其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。最多可设置 40 个。', + 'description' => 'The list of IP addresses and CIDR blocks in the whitelist. '."\n" + .'It is a JSON array. Each object in the array is an IP address or CIDR block. You can specify at most 40 IP addresses or CIDR blocks. ', + 'type' => 'string', + 'required' => false, + 'example' => '["192.168.0.0/20","192.169.1.1"]', + ], + ], + [ + 'name' => 'SecurityIpGroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP安全白名单组的组名。 由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', + 'description' => 'The information of the IP address whitelist group. ', + 'type' => 'string', + 'required' => false, + 'example' => 'paytest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'The name of the security group. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'SecurityIpGroup' => [ + 'title' => 'IP白名单分组信息。', + 'description' => 'Example 1', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => ' ', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'SecurityIpGroupName' => [ + 'title' => '安全组名称。', + 'description' => ' ', + 'type' => 'string', + 'example' => 'online_paycore', + ], + 'SecurityIps' => [ + 'title' => 'IP安全白名单列表。其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。', + 'description' => '', + 'type' => 'string', + 'example' => '121.41.106.33,100.104.7.0/26', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"SecurityIpGroup\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"SecurityIpGroupName\\": \\"online_paycore\\",\\n \\"SecurityIps\\": \\"[\\\\\\"192.***.1.2\\\\\\",\\\\\\"192.***.1.1\\\\\\"]\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<ModifySecurityIpsResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <SecurityIpGroup>\\n <InstanceId>ob317v4uif****</InstanceId>\\n <SecurityIpGroupName>online_paycore</SecurityIpGroupName>\\n <SecurityIps>121.41.106.33,100.104.7.0/26</SecurityIps>\\n </SecurityIpGroup>\\n</ModifySecurityIpsResponse>","errorExample":""}]', + 'title' => 'ModifySecurityIps', + ], + 'ModifyTenantEncryption' => [ + 'summary' => 'You can call this operation to enable transparent encryption for a tenant.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the OceanBase cluster.', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'EncryptionType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The encryption type. Valid values: '."\n" + .'* INTERNAL: a service key (automatically generated by the cloud service) '."\n" + .'* USER_KMS: a custom key (Alibaba Cloud KMS) '."\n" + .'> After transparent encryption is enabled for cloud disks, it cannot be disabled.', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'INTERNAL' => 'INTERNAL', + 'USER_KMS' => 'USER_KMS', + ], + 'example' => 'INTERNAL', + ], + ], + [ + 'name' => 'EncryptionKeyId', + 'in' => 'formData', + 'schema' => [ + 'title' => '加密使用的key', + 'description' => 'The ID of the key.', + 'type' => 'string', + 'required' => false, + 'example' => 'key-shh322****470h8v0-g2ll85****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'TenantEncryption' => [ + 'title' => 'job', + 'description' => 'job', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'TenantId' => [ + 'description' => 'The ID of the tenant.', + 'type' => 'string', + 'example' => 'ob2mr3oae0****', + ], + 'EncryptionType' => [ + 'description' => 'The encryption type. Valid values: '."\n" + .'* INTERNAL: a service key (automatically generated by the cloud service) '."\n" + .'* USER_KMS: a custom key (Alibaba Cloud KMS) '."\n" + .'> After transparent encryption is enabled for cloud disks, it cannot be disabled.', + 'type' => 'string', + 'enumValueTitles' => [ + 'INTERNAL' => 'INTERNAL', + 'USER_KMS' => 'USER_KMS', + ], + 'example' => 'INTERNAL', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"TenantEncryption\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"TenantId\\": \\"ob2mr3oae0****\\",\\n \\"EncryptionType\\": \\"INTERNAL\\"\\n }\\n}","type":"json"}]', + 'title' => 'ModifyTenantEncryption', + ], + 'DeleteSecurityIpGroup' => [ + 'summary' => 'You can call this operation to delete an IP address whitelist group of an OceanBase cluster. ', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The name of the IP address whitelist group. '."\n" + .'It must be 2 to 32 characters in length, start with a lowercase letter, end with a lowercase letter or digit, and contain only lowercase letters, digits, and underscores (_). ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'SecurityIpGroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP安全白名单组的组名。 由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', + 'description' => 'The information of the deleted IP whitelist group. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'paytest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => 'The request ID. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'Example 1', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'SecurityIpGroup' => [ + 'title' => '删除的IP白名单分组信息。', + 'description' => ' ', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'SecurityIpGroupName' => [ + 'title' => '删除的IP安全白名单组的组名。', + 'description' => '', + 'type' => 'string', + 'example' => 'paytest', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"SecurityIpGroup\\": {\\n \\"InstanceId\\": \\"ob317v4uif****\\",\\n \\"SecurityIpGroupName\\": \\"paytest\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteSecurityIpGroupResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <SecurityIpGroup>\\n <InstanceId>ob317v4uif****</InstanceId>\\n <SecurityIpGroupName>paytest</SecurityIpGroupName>\\n </SecurityIpGroup>\\n</DeleteSecurityIpGroupResponse>","errorExample":""}]', + 'title' => ' DeleteSecurityIpGroup', + ], + 'DescribeBackupEncryptedString' => [ + 'summary' => 'DescribeBackupEncryptedString', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id', + 'description' => 'The ID of the OceanBase cluster.', + 'type' => 'string', + 'required' => true, + 'example' => 'ob4wib********', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户id', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'example' => 'txxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => 'The return data of the request.', + 'type' => 'object', + 'properties' => [ + 'BackupInfoJson' => [ + 'description' => 'Information about the overall encrypted backup data.', + 'type' => 'string', + 'example' => 'xxxxxxxx (encrypted string)', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"BackupInfoJson\\": \\"xxxxxxxx（加密串）\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeBackupEncryptedString', + ], + 'DescribeMetricsDataV2' => [ + 'summary' => 'You can call this operation to return metric data.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群实例Id', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'Metrics', + 'in' => 'formData', + 'schema' => [ + 'title' => '监控指标名称', + 'description' => 'The metrics. Separate multiple metrics with commas (,). Example: "sql_all_count,sql_all_rt...".', + 'type' => 'string', + 'required' => true, + 'example' => 'sql_all_rt', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '开始时间 YYYY-MM-DDThh:mm:ssZ', + 'description' => 'The start time, in the format of YYYY-MM-DDThh:mm:ssZ.', + 'type' => 'string', + 'required' => true, + 'example' => '2023-04-12T04:38:38Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '结束时间 YYYY-MM-DDThh:mm:ssZ', + 'description' => 'The end time, in the format of YYYY-MM-DDThh:mm:ssZ.', + 'type' => 'string', + 'required' => true, + 'example' => '2023-04-12T05:38:38Z', + ], + ], + [ + 'name' => 'Labels', + 'in' => 'formData', + 'schema' => [ + 'title' => '监控数据查询条件标签', + 'description' => 'A string of key-value pairs separated with commas (,). Each key and its value are separated with a colon (\\:). Multiple values of a key are separated with semicolons (\\;). Example: "clusterId:ob\\*\\*\\*\\*\\*,tenantId:t\\*\\*\\*\\*\\*\\*;t\\*\\*\\*\\*\\*\\*\\*,serverId:\\*\\*\\*\\*\\*,zoneId:cn-hangzhou-j". The string can contain only the following fixed keys: '."\n" + .'* clusterId: the ID of the OceanBase cluster. '."\n" + .'* tenantId: the ID of the OceanBase Database tenant. '."\n" + .'* zoneId: the ID of the zone.'."\n" + .' * serverId: the ID of the OBServer node.', + 'type' => 'string', + 'required' => true, + 'example' => 'clusterId:ob***', + ], + ], + [ + 'name' => 'GroupByLabels', + 'in' => 'formData', + 'schema' => [ + 'title' => '监控数据分组标签', + 'description' => 'The one or more keys used for grouping. Separate multiple keys with commas (,). Example: "clusterId,tenantId".', + 'type' => 'string', + 'required' => true, + 'example' => 'clusterId', + ], + ], + [ + 'name' => 'SortMetricKey', + 'in' => 'formData', + 'schema' => [ + 'title' => 'SortMetricKey', + 'description' => 'The sort column.', + 'type' => 'string', + 'required' => false, + 'example' => 'tps', + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序顺序', + 'description' => 'The sorting rule. Valid values: '."\n" + .'* ASC: in ascending order '."\n" + .'* DESC: in descending order', + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序后返回的 Data 数组长度', + 'description' => 'The length of the data array returned after sorting.', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ReplicaType', + 'in' => 'formData', + 'schema' => [ + 'title' => '副本类型', + 'description' => 'The type of the replica. Node filtering conditions are configured based on the replica type when you query the monitoring data of the OceanBase cluster. '."\n" + .'* By default, the replica type is not specified when you query the monitoring data of OceanBase clusters or the access proxy. If you do not specify the replica type when you query the monitoring data of an OceanBase cluster, the monitoring data of all nodes is queried. '."\n" + .'* If you set the replica type to FULL when you query the monitoring data of an OceanBase cluster, the monitoring data of only the full-featured replica nodes is queried.'."\n" + .'* If you set the replica type to READONLY when you query the monitoring data of an OceanBase cluster, the monitoring data of only the read-only replica nodes is queried.', + 'type' => 'string', + 'required' => false, + 'example' => 'FULL', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'title' => '数据集合', + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'Labels' => [ + 'title' => '数据标签', + 'description' => 'The data label.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'clusterId:ob********', + 'description' => 'The details of the label.', + ], + ], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'MetricValue' => [ + 'title' => '监控指标数据', + 'description' => 'The metric data.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '\'load1\': 1.29', + 'description' => 'The metric data.', + ], + ], + 'Timestamp' => [ + 'title' => '时间戳', + 'description' => 'The timestamp.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1702434300', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"Labels\\": {\\n \\"key\\": \\"clusterId:ob********\\"\\n },\\n \\"Data\\": [\\n {\\n \\"MetricValue\\": {\\n \\"key\\": \\"\'load1\': 1.29\\"\\n },\\n \\"Timestamp\\": 1702434300\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeMetricsDataV2', + ], + 'DescribeMetricsData' => [ + 'summary' => 'You can call this operation to query single-dimensional or multi-dimensional metric data of an OceanBase cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '集群 id', + 'description' => 'The ID of the OceanBase cluster.', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询监控指标数据的起始时间。 该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'description' => 'The start time for querying metric data. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', + 'type' => 'string', + 'required' => true, + 'example' => '2021-06-13T15:40:43Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询监控指标数据的结束时间。 该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'description' => 'The end time for querying metric data. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.', + 'type' => 'string', + 'required' => true, + 'example' => '2021-06-13T15:40:43Z', + ], + ], + [ + 'name' => 'Metrics', + 'in' => 'query', + 'schema' => [ + 'title' => '监控指标', + 'description' => 'The metrics. Separate multiple metrics with commas (,). Example: "sql_all_count,sql_all_rt...".', + 'type' => 'string', + 'required' => true, + 'example' => 'tps', + ], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => [ + 'description' => 'A string of key-value pairs separated with commas (,). Each key and its value are separated with a colon (\\:). Example: "app:OB,clusterId:ob\\*\\*\\*\\*\\*,tenantId:t\\*\\*\\*\\*\\*\\*,serverId:\\*\\*\\*\\*\\*,zoneId:cn-hangzhou-j". The string can contain only the following fixed keys: * app: the application type. At present, only OceanBase Database is supported. * clusterId: the ID of the OceanBase cluster. * tenantId: the ID of the OceanBase Database tenant. * zoneId: the ID of the zone. * serverId: the ID of the OBServer node. | app:OB,clusterId:ob\\*\\*\\*', + 'type' => 'string', + 'required' => true, + 'example' => 'app:OB,clusterId:ob***', + ], + ], + [ + 'name' => 'GroupByLabels', + 'in' => 'query', + 'schema' => [ + 'description' => 'The one or more keys used for grouping. Separate multiple keys with commas (,). Example: "app,clusterId,tenantId".', + 'type' => 'string', + 'required' => true, + 'example' => 'app,clusterId', + ], + ], + [ + 'name' => 'SortMetricKey', + 'in' => 'query', + 'schema' => [ + 'title' => '排序列', + 'description' => 'The sort column.', + 'type' => 'string', + 'required' => false, + 'example' => 'tps', + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'query', + 'schema' => [ + 'title' => '排序规则', + 'description' => 'The sorting rule. Valid values: '."\n" + .'* ASC: in ascending order '."\n" + .'* DESC: in descending order', + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'title' => '排序后返回的Data 数组长度', + 'description' => 'The length of the data array returned after sorting.', + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'ReplicaType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of the replica. Node filtering conditions are configured based on the replica type when you query the monitoring data of the OceanBase cluster. '."\n" + .'* By default, the replica type is not specified when you query the monitoring data of OceanBase clusters or the access proxy. If you do not specify the replica type when you query the monitoring data of an OceanBase cluster, the monitoring data of all nodes is queried. '."\n" + .'* If you set the replica type to FULL when you query the monitoring data of an OceanBase cluster, the monitoring data of only the full-featured replica nodes is queried. '."\n" + .'* If you set the replica type to READONLY when you query the monitoring data of an OceanBase cluster, the monitoring data of only the read-only replica nodes is queried.', + 'type' => 'string', + 'required' => false, + 'example' => 'FULL', + 'enum' => [ + 'FULL', + 'READONLY', + ], + ], + ], + [ + 'name' => 'MetricScope', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The dimensions of the performance metric.', + 'example' => 'cluster', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[{\'clusterId\': \'ob5b8*********\', \'Data\': [{\'timestamp\': 1702434300, \'sql_all_rt\': 0.64}, {\'timestamp\': 1702434240, \'sql_all_rt\': 0.0}], \'tenantId\': \'t5b8*********\'}]', + ], + 'example' => '['."\n" + .' {'."\n" + .' "sql_select_count":75.****15****1515,'."\n" + .' "timestamp":165079****'."\n" + .' },'."\n" + .' ......'."\n" + .' ]', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n \\"[{\'clusterId\': \'ob5b8*********\', \'Data\': [{\'timestamp\': 1702434300, \'sql_all_rt\': 0.64}, {\'timestamp\': 1702434240, \'sql_all_rt\': 0.0}], \'tenantId\': \'t5b8*********\'}]\\"\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeMetricsData', + ], + 'DescribeNodeMetrics' => [ + 'summary' => 'You can call this operation to query the detailed metrics information of an OceanBase Database node. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'The list of nodes. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'description' => 'The ID of the tenant. ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => '$.parameters[6].schema.description', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '$.parameters[6].schema.enumValueTitles', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'tfafd34fs****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '监控数据的起始时间。该时间只支持UTC时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'description' => '$.parameters[9].schema.example', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-06-13T15:40:43Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '监控数据的结束时间。该时间只支持UTC时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'description' => '$.parameters[7].schema.description', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-09-13T15:40:43Z', + ], + ], + [ + 'name' => 'Metrics', + 'in' => 'formData', + 'schema' => [ + 'title' => '监控指标项。当前可支持的指标及说明可参考：https://help.aliyun.com/document_detail/212099.html。', + 'description' => '$.parameters[7].schema.enumValueTitles', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'tps', + ], + ], + [ + 'name' => 'NodeName', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点名称', + 'description' => '$.parameters[8].schema.example', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp16niirq4zdmgvm****', + ], + ], + [ + 'name' => 'NodeIdList', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点列表', + 'description' => '$.parameters[10].schema.description', + 'type' => 'string', + 'required' => false, + 'example' => '[i-bp16niirq4zdmgvm****,i-bp16n56hq4z4fgvm****]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '$.parameters[10].schema.enumValueTitles', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数量', + 'description' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DescribeNodeMetrics'."\n" + .'&InstanceId=ob317v4uif****'."\n" + .'&PageSize=10'."\n" + .'&PageNumber=1'."\n" + .'&TenantId=ob2mr3oae0****'."\n" + .'&StartTime=2021-06-13 15:40:43'."\n" + .'&EndTime=2021-09-13 15:40:43'."\n" + .'&Metrics=tps'."\n" + .'&NodeName=i-bp16niirq4zdmgvm****'."\n" + .'&NodeIdList=["i-bp19y05uq6xpacyqnlrc","i-bp1blcr3htr3g3u2vqvu","i-bp1392ikhayhr3hi4fli"]'."\n" + .'&Common request parameters'."\n" + .'```', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'You can call this operation to query the detailed metrics information of an OceanBase Database node. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'NodeMetrics' => [ + 'title' => '节点指标信息', + 'description' => '', + 'type' => 'string', + 'example' => '-', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 9,\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"NodeMetrics\\": \\"-\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeNodeMetricsResponse>\\n <TotalCount>0</TotalCount>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <NodeMetrics>-</NodeMetrics>\\n</DescribeNodeMetricsResponse>","errorExample":""}]', + 'title' => 'DescribeNodeMetrics', + ], + 'DescribeTenantMetrics' => [ + 'summary' => 'You can call this operation to query the metrics of a specified OceanBase Database tenant. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => '2021-06-13T15:40:43Z', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'description' => 'tfafd34fs****', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TenantName', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户名称。 长度为2~20 个字符，支持英文字母、数字和下划线，区分大小写，必须以字母或下划线开头。 不可设置为 sys。TenantName、TenantId、TenantList至少填一项', + 'description' => '2021-06-13T15:45:43Z', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'pay_online', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '监控数据的起始时间。该时间只支持UTC时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'description' => 'Example 1', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-06-13T15:40:43Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '监控数据的结束时间。该时间只支持UTC时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'description' => ' ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-06-13T15:45:43Z', + ], + ], + [ + 'name' => 'Metrics', + 'in' => 'formData', + 'schema' => [ + 'title' => '监控指标。当前可支持的指标及说明参考：https://help.aliyun.com/document_detail/212125.html', + 'description' => '{"name":"DescribeTenantMetrics","product":"OceanBasePro","version":"2019-09-01","path":"/","deprecated":0,"method":"POST|GET","protocol":"HTTP|HTTPS","hidden":0,"timeout":10000,"parameter_type":"Single","params":"[{\\"name\\":\\"Action\\",\\"position\\":\\"Query\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"description\\":\\"\\",\\"example\\":\\"DescribeTenantMetrics\\"},{\\"name\\":\\"InstanceId\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"ob317v4uif****\\"},{\\"name\\":\\"PageSize\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"Integer\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"10\\"},{\\"name\\":\\"PageNumber\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"Integer\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"1\\"},{\\"name\\":\\"TenantName\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":true,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"pay_online\\"},{\\"name\\":\\"StartTime\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"2021-06-13T15:40:43Z\\"},{\\"name\\":\\"EndTime\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"2021-06-13T15:45:43Z\\"},{\\"name\\":\\"Metrics\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"tps\\"},{\\"name\\":\\"TenantId\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":true,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"tfafd34fs****\\"},{\\"name\\":\\"TenantIdList\\",\\"position\\":\\"Body\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"[tdak3nac****,tdakc42df****]\\"}]","response_headers":"[]","response":"{\\"type\\":\\"Object\\",\\"children\\":[{\\"name\\":\\"TotalCount\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"Integer\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"9\\"},{\\"name\\":\\"RequestId\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"},{\\"name\\":\\"TenantMetrics\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"\\\\\\"Metrics\\\\\\":[ {\\\\\\"request_queue_rt\\\\\\":0.0,\\\\\\"TimeStamp\\\\\\":\\\\\\"2022-02-23T01:58:00Z\\\\\\"}]\\"}],\\"title\\":\\"\\",\\"description\\":\\"\\"}","errors":"{}"}', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'tps', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。TenantName、TenantId、TenantList至少填一项', + 'description' => '', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'tfafd34fs****', + ], + ], + [ + 'name' => 'TenantIdList', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户 ID 列表，入参为JSONArray格式，需要使用双引号和方括号。'."\n" + .'TenantName、TenantId、TenantList至少填一项，', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[tdak3nac****,tdakc42df****]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'TenantMetrics' => [ + 'title' => '租户指标信息。', + 'description' => '', + 'type' => 'string', + 'example' => '"Metrics":[ {"request_queue_rt":0.0,"TimeStamp":"2022-02-23T01:58:00Z"}]', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 9,\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"TenantMetrics\\": \\"\\\\\\"Metrics\\\\\\":[ {\\\\\\"request_queue_rt\\\\\\":0.0,\\\\\\"TimeStamp\\\\\\":\\\\\\"2022-02-23T01:58:00Z\\\\\\"}]\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeTenantMetricsResponse>\\n <TotalCount>0</TotalCount>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <TenantMetrics>-</TenantMetrics>\\n</DescribeTenantMetricsResponse>","errorExample":""}]', + 'title' => 'DescribeTenantMetrics', + ], + 'CreateProject' => [ + 'summary' => '创建项目', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'UseOss', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否使用OSS方式创建', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'OssKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '通过 GetUploadOssUrl 获取的 Osskey', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'open_api_create_project/oacp_xxx', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目 ID', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '任务名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'title' => '任务类型（MIGRATION 迁移任务、SYNC 同步任务）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'MIGRATION', + 'enum' => [ + 'MIGRATION', + 'SYNC', + ], + ], + ], + [ + 'name' => 'LabelIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '标签ID。最多支持5个', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'I_dfe****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'WorkerGradeId', + 'in' => 'formData', + 'schema' => [ + 'title' => '传输实例ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'g_abcdefj***', + ], + ], + [ + 'name' => 'SourceEndpointId', + 'in' => 'formData', + 'schema' => [ + 'title' => '源端数据源ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e_4j0c12z****', + ], + ], + [ + 'name' => 'SinkEndpointId', + 'in' => 'formData', + 'schema' => [ + 'title' => '目标端数据源ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e_4j0cz****', + ], + ], + [ + 'name' => 'TransferMapping', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '传输对象映射信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Mode' => [ + 'title' => '传输对象映射模式（SPECIFIC 指定对象、WILDCARD 匹配规则）', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SPCEIFIC', + 'enum' => [ + 'SPECIFIC', + 'WILDCARD', + ], + ], + 'Databases' => [ + 'title' => '数据库信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '库ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'gez3***', + ], + 'Name' => [ + 'title' => '数据库名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'db_name', + ], + 'MappedName' => [ + 'title' => '数据库映射名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mapped_db', + ], + 'ClusterName' => [ + 'title' => '映射对象集群（已废弃）', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cluster_name', + ], + 'TenantName' => [ + 'title' => '映射对象租户（已废弃）', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'tenant_name', + ], + 'Tables' => [ + 'title' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'table_name', + ], + 'MappedName' => [ + 'title' => '表映射名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mapped_table', + ], + 'Id' => [ + 'title' => '表ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'e_4l085bu7***', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'id > 1', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pk_col', + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PARTITION BY VALUE(\'id\')', + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + 'required' => false, + ], + 'ObkvPartitionConfig' => [ + 'title' => 'Hbase 模式分区配置，仅迁移到OBKV场景下使用', + 'type' => 'object', + 'properties' => [ + 'PartitionType' => [ + 'type' => 'string', + 'enum' => [ + 'KEY', + 'RANGE', + 'NONE', + ], + ], + 'VirtualColumn' => [ + 'type' => 'string', + ], + 'PartitionSize' => [ + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '1024', + 'minimum' => '1', + ], + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Views' => [ + 'title' => '当前库下的传输视图对象配置', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '视图名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'view_name', + ], + 'MappedName' => [ + 'title' => '视图映射名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mapped_view', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'e_4himpq4z***', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'id>1', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pk_col', + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PARTITION BY VALUE(\'id\')', + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'SpecificTables' => [ + 'title' => '具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'table_name', + ], + 'MappedName' => [ + 'title' => '表映射名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mapped_table', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'e_4azdil4lu7***', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'id<5', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pk_col', + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PARTITION BY VALUE(\'id\')', + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'SpecificViews' => [ + 'title' => '具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '视图名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'view_name', + ], + 'MappedName' => [ + 'title' => '视图映射名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mapped_view', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'e_3wsmjv49a***', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'id<5', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pk_col', + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PARTITION BY VALUE(\'id\')', + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'DatabasesBlack' => [ + 'title' => '匹配规则模式：数据库对象黑名单', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'e_3y6v5v1x94f4', + ], + 'Name' => [ + 'title' => '库名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'db_name', + ], + 'MappedName' => [ + 'title' => '映射库名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mapped_db', + ], + 'ClusterName' => [ + 'title' => '映射对象集群（已废弃）', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cluster_name', + ], + 'TenantName' => [ + 'title' => '映射对象租户（已废弃）', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'tenant_name', + ], + 'Tables' => [ + 'title' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'table_name', + ], + 'MappedName' => [ + 'title' => '表映射名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mapped_table', + ], + 'Id' => [ + 'title' => '表ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'e_474hmh5iqo***', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'id<1', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PARTITION BY VALUE(\'id\')'."\n", + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Views' => [ + 'title' => '当前库下的传输视图对象配置', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '视图名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'view_name', + ], + 'MappedName' => [ + 'title' => '视图映射名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mapped_view', + ], + 'Id' => [ + 'title' => '视图ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'e_4azdil4lu7mo', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'id<5', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pk_col', + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PARTITION BY VALUE(\'id\')'."\n", + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'SpecificTables' => [ + 'title' => '具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'table_name', + ], + 'Id' => [ + 'title' => '表ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'e_4himpq4zf***', + ], + 'MappedName' => [ + 'title' => '表映射名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mapped_table', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'id<1', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PARTITION BY VALUE(\'id\')', + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'SpecificViews' => [ + 'title' => '具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'table_name', + ], + 'MappedName' => [ + 'title' => '表映射名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mapped_table', + ], + 'Id' => [ + 'title' => '视图ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'e_474hmh5iqo***', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'id<1', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PARTITION BY VALUE(\'id\')'."\n", + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'TableAndViewWhiteList' => [ + 'title' => '匹配规则模式：表、视图的通配白名单', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + 'required' => false, + ], + 'TableAndViewBlackList' => [ + 'title' => '匹配规则模式：表、视图的通配黑名单', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'CommonTransferConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '通用传输配置', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TableCategory' => [ + 'title' => '支持的表类型（ALL 所有表、WITH_UNIQUE_ROW_ID 有唯一行标识的表、WITHOUT_UNIQUE_ROW_ID 没有唯一行标识的表），默认 ALL', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL', + 'default' => 'ALL', + 'enum' => [ + 'ALL', + 'WITHOUT_UNIQUE_ROW_ID', + 'WITH_UNIQUE_ROW_ID', + ], + ], + 'ActiveActive' => [ + 'title' => '是否双活容灾场景', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'MqSerializerType' => [ + 'title' => '投递到消息队列时，数据 json 序列化类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT', + ], + 'MqPartitionMode' => [ + 'title' => '投递到消息队列时，分区路由方式', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ONE', + ], + 'MqPartition' => [ + 'title' => '当 partitionMode 为 ONE 时，此参数表示投递分区的在当前 topic 下的位置', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'DatahubTopicType' => [ + 'title' => '投递到消息队列（DATAHUB）时，指定 topic 的类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'BLOB' => 'BLOB', + 'TUPLE' => 'TUPLE', + ], + 'example' => 'TUPLE', + ], + 'RocketMqProducerGroup' => [ + 'title' => '指定生产组名(目标端为 ROCKETMQ 时生效),默认 OMS', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'OMS', + ], + 'RocketMqMsgTags' => [ + 'title' => '设置消息 tag(目标端为 ROCKETMQ 时生效)，默认 default -> default_tag', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'default_tag', + ], + 'RocketMqEnableMsgTrace' => [ + 'title' => '是否开启消息追踪(目标端为 ROCKETMQ 时生效)', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'RocketMqSendMsgTimeout' => [ + 'title' => '设置消息投递超时时间(目标端为 ROCKETMQ 时生效)', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => 'null', + ], + 'DataWorksBusinessName' => [ + 'title' => '业务系统标识', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + 'SyncSchema' => [ + 'title' => '是否同步源端数据所在的 schema 到目标端（预期目标端表上会创建一个附加字段，用来接收 schema 名称，该字段见 syncSchemaColumnName 参数）', + 'type' => 'boolean', + ], + 'SyncSchemaColumnName' => [ + 'title' => '若开启同步 schema 到目标端的功能，可以指定同步到目标端的字段名', + 'type' => 'string', + ], + 'CustomColumns' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'title' => '列名称', + 'type' => 'string', + ], + 'Expression' => [ + 'title' => '列值表达式', + 'type' => 'string', + ], + ], + ], + ], + 'SinkStoreFormat' => [ + 'title' => '若开启同步 schema 到目标端的功能，可以指定同步到目标端的字段名', + 'type' => 'string', + ], + 'SourceStoreFormat' => [ + 'title' => '若开启同步 schema 到目标端的功能，可以指定同步到目标端的字段名', + 'type' => 'string', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'EnableStructTransfer', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否允许结构传输', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'StructTransferConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '结构传输配置', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ByteCharConvertStrategy' => [ + 'title' => 'byte/char 转换方案，默认 DO_NOTHING_IF_BYTE_USED', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DO_NOTHING_IF_BYTE_USED', + 'default' => 'DO_NOTHING_IF_BYTE_USED', + 'enum' => [ + 'IGNORE_BYTE_IF_BYTE_USED', + 'FORCE_CHAR_IF_BYTE_USED', + 'EXPAND_LEN_IF_BYTE_USED', + 'DO_NOTHING_IF_BYTE_USED', + ], + ], + 'DeferIndexCreation' => [ + 'title' => '是否允许索引后置', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'EnableFullTransfer', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否允许全量传输', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'EnableFullVerify', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否允许全量校验', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'FullTransferConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '全量传输配置', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NonePkUkTruncateDstTable' => [ + 'title' => '在处理源端无唯一索引表德的全量迁移时，是否 truncate 目标表（清空目标表数据）,组件层面默认为 true。'."\n" + .'目前场景：PolarDB-X 1.0 多链路无主键表汇聚到同一目标端表，避免前若干条链路前有部分数据后，另一链路刚启动就清空了历史的迁移数据', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'AllowDestTableNotEmpty' => [ + 'title' => '允许目标端表非空，在源端多个分表向目标端一张表聚合迁移时，需要打开。'."\n" + .'注意：只有在没有选中"全量校验"的情况下，才允许打开此开关。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'FullTransferSpeedMode' => [ + 'title' => '全量传输速度', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'NORMAL', + 'default' => 'NORMAL', + 'enum' => [ + 'STEADY', + 'NORMAL', + 'FAST', + ], + ], + 'FullVerifySpeedMode' => [ + 'title' => '全量校验速度', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'NORMAL', + 'default' => 'NORMAL', + 'enum' => [ + 'STEADY', + 'NORMAL', + 'FAST', + ], + ], + 'WriteWorkerNum' => [ + 'title' => '写入并发数 null 未配置', + 'type' => 'integer', + 'format' => 'int32', + ], + 'ReadWorkerNum' => [ + 'title' => '读取并发数 null 未配置', + 'type' => 'integer', + 'format' => 'int32', + ], + 'ThrottleRps' => [ + 'title' => '限制RPS null 不限速', + 'type' => 'integer', + 'format' => 'int32', + ], + 'ThrottleIOPS' => [ + 'title' => '限制流量，单位字节 null 不限速', + 'type' => 'integer', + 'format' => 'int32', + ], + 'HbaseObjCheckMode' => [ + 'title' => 'hbase 对象校验模式: NEWEST, ALL', + 'type' => 'string', + 'enum' => [ + 'ALL', + 'NEWEST', + ], + ], + 'HbaseObjMigMode' => [ + 'title' => 'hbase 对象迁移模式: NEWEST, ALL', + 'type' => 'string', + 'enum' => [ + 'ALL', + 'NEWEST', + ], + ], + 'IndexDDLConcurrencyLimit' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MaxConcurrentIndexDDLs' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'EnableIncrTransfer', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否允许增量传输', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'EnableReverseIncrTransfer', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否允许反向增量', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'IncrTransferConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '增量传输配置', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'StartTimestamp' => [ + 'title' => '增量同步位点', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1689201369', + ], + 'RecordTypeWhiteList' => [ + 'title' => '有增量同步阶段时，同步的增量数据类型', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'INSERT', + 'enum' => [ + 'HEARTBEAT', + 'INSERT', + 'UPDATE', + 'DELETE', + 'BEGIN', + 'COMMIT', + 'ROLLBACK', + 'DDL', + 'ROW', + ], + ], + 'required' => false, + ], + 'StoreLogKeptHour' => [ + 'title' => '有增量同步阶段，且增量日志拉取组件为 Store 时，日志保存时间, 单位小时，默认7天，最长365天', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '24', + ], + 'EnableSequencingWithinTxn' => [ + 'title' => '有增量同步阶段时，且增量日志拉取组件为 Store 时，是否开启事务内序号编排', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'IncrSyncConcurrency' => [ + 'title' => '增量同步线程数，默认64', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1024', + 'minimum' => '1', + 'example' => '64', + 'default' => '64', + ], + 'EnableIncrSyncStatistics' => [ + 'title' => '是否开启增量记录(dml、ddl)统计', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'ThrottleRps' => [ + 'title' => '限制RPS null 不限速', + 'type' => 'integer', + 'format' => 'int32', + ], + 'ThrottleIOPS' => [ + 'title' => '限制流量，单位字节 null 不限速', + 'type' => 'integer', + 'format' => 'int32', + ], + 'SupportDDLTypes' => [ + 'title' => '支持DDL类型', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => 'CREATE_TABLE', + 'enum' => [ + 'CREATE_TABLE', + 'ALTER_TABLE', + 'DROP_TABLE', + 'RENAME_TABLE', + 'TRUNCATE_TABLE', + 'CREATE_INDEX', + 'DROP_INDEX', + ], + ], + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ReverseIncrTransferConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '反向增量传输配置', + 'type' => 'object', + 'properties' => [ + 'StartTimestamp' => [ + 'title' => '反向增量同步位点', + 'type' => 'string', + ], + 'RecordTypeWhiteList' => [ + 'title' => '有反向增量同步阶段时，同步的增量数据类型', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => 'INSERT', + 'enum' => [ + 'HEARTBEAT', + 'INSERT', + 'UPDATE', + 'DELETE', + 'BEGIN', + 'COMMIT', + 'ROLLBACK', + 'DDL', + 'ROW', + 'PUT', + ], + ], + ], + 'StoreLogKeptHour' => [ + 'title' => '有反向增量同步阶段，且增量日志拉取组件为 Store 时，日志保存时间, 单位小时，默认7天，最长365天', + 'type' => 'integer', + 'format' => 'int32', + ], + 'EnableSequencingWithinTxn' => [ + 'title' => '有反向增量同步阶段时，且增量日志拉取组件为 Store 时，是否开启事务内序号编排', + 'type' => 'boolean', + ], + 'IncrSyncConcurrency' => [ + 'title' => '反向增量同步线程数，默认64', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '1024', + 'minimum' => '1', + 'default' => '64', + ], + 'EnableIncrSyncStatistics' => [ + 'title' => '是否开启反向增量记录(dml、ddl)统计', + 'type' => 'boolean', + ], + 'ThrottleRps' => [ + 'title' => '限制RPS null 不限速', + 'type' => 'integer', + 'format' => 'int32', + ], + 'ThrottleIOPS' => [ + 'title' => '限制流量，单位字节 null 不限速', + 'type' => 'integer', + 'format' => 'int32', + ], + 'SupportDDLTypes' => [ + 'title' => '支持DDL类型', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => 'CREATE_TABLE', + 'enum' => [ + 'CREATE_TABLE', + 'ALTER_TABLE', + 'DROP_TABLE', + 'RENAME_TABLE', + 'TRUNCATE_TABLE', + 'CREATE_INDEX', + 'DROP_INDEX', + ], + ], + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator.', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'XCVSADG****DSGDS', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '27', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'string', + 'example' => 'np_****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"XCVSADG****DSGDS\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"27\\",\\n \\"Data\\": \\"np_****\\"\\n}","type":"json"}]', + ], + 'StartProject' => [ + 'summary' => '启动项目', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'np_4w3a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator.', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'XCVSADG****DSGDS'."\n", + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100'."\n", + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"XCVSADG****DSGDS\\\\n\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + ], + 'StopProject' => [ + 'summary' => '暂停项目', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'np_4w3a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => '473469**-AA6F-4D**-B3DB-A***********', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '27 ms', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"473469**-AA6F-4D**-B3DB-A***********\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"27 ms\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + ], + 'ResumeProject' => [ + 'summary' => '恢复项目', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'np_4w3a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111'."\n", + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator.', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator.', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Data' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator.\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 50,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + ], + 'ReleaseProject' => [ + 'summary' => '释放项目', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'np_4w3a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111'."\n", + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator.'."\n", + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Data' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\\\n\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 50,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + ], + 'DeleteProject' => [ + 'summary' => '删除项目', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'np_4w3a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111'."\n", + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator.', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => '473469C7-XXXX-XXX-B3DB-A3DC0DE', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Data' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"473469C7-XXXX-XXX-B3DB-A3DC0DE\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 24,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + ], + 'ListProjects' => [ + 'summary' => '查询项目列表', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'SearchKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目名称或项目ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'np_4w****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目类型（MIGRATION,SYNC）', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'MIGRATION', + 'enum' => [ + 'MIGRATION', + 'SYNC', + ], + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '项目状态（INIT,RUNNING,SUSPEND,FAILED,FINISHED,RELEASING,RELEASED,DELETED,RUNNING_MODIFYING,RUNNING_MERGING,RUNNING_ALARMING,UNCONFIGURED）', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'RUNNING', + 'enum' => [ + 'INIT', + 'RUNNING', + 'SUSPEND', + 'FAILED', + 'FINISHED', + 'RELEASING', + 'RELEASED', + 'DELETED', + 'RUNNING_MODIFYING', + 'RUNNING_MERGING', + 'RUNNING_ALARMING', + ], + ], + 'required' => false, + 'enumValueTitles' => [], + ], + ], + [ + 'name' => 'LabelIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '标签ID集合', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'l_dfe****'."\n", + ], + 'required' => false, + ], + ], + [ + 'name' => 'SourceEndpointTypes', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '源端数据源类型（MYSQL,MARIADB,OB_MYSQL,OB_MYSQL_CE,OB_ORACLE,ORACLE,DB2_LUW,KAFKA,ROCKETMQ,DATAHUB,ADB,DBP_OP_ROUTE,DMS,IDB,TIDB,POSTGRESQL,POLARDB_X_1,POLARDB_X_2）', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'POLARDB_X_1' => 'POLARDB_X_1', + 'MYSQL' => 'MYSQL', + 'TIDB' => 'TIDB', + 'OB_ORACLE' => 'OB_ORACLE', + 'OB_MYSQL' => 'OB_MYSQL', + 'ORACLE' => 'ORACLE', + 'POLARDB_X_2' => 'POLARDB_X_2', + ], + 'example' => 'MYSQL', + 'enum' => [ + 'MYSQL', + 'MARIADB', + 'OB_MYSQL', + 'OB_MYSQL_CE', + 'OB_ORACLE', + 'ORACLE', + 'DB2_LUW', + 'KAFKA', + 'ROCKETMQ', + 'DATAHUB', + 'ADB', + 'DBP_OP_ROUTE', + 'DMS', + 'IDB', + 'TIDB', + 'POSTGRESQL', + 'POLARDB_X_1', + 'POLARDB_X_2', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'SinkEndpointTypes', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '目标端数据源类型（MYSQL,MARIADB,OB_MYSQL,OB_MYSQL_CE,OB_ORACLE,ORACLE,DB2_LUW,KAFKA,ROCKETMQ,DATAHUB,ADB,DBP_OP_ROUTE,DMS,IDB,TIDB,POSTGRESQL,POLARDB_X_1,POLARDB_X_2）', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'MYSQL' => 'MYSQL', + 'OB_ORACLE' => 'OB_ORACLE', + 'KAFKA' => 'KAFKA', + 'ROCKETMQ' => 'ROCKETMQ', + 'DATAHUB' => 'DATAHUB', + 'OB_MYSQL' => 'OB_MYSQL', + 'ORACLE' => 'ORACLE', + 'ADB' => 'ADB', + ], + 'example' => 'MYSQL', + 'enum' => [ + 'MYSQL', + 'MARIADB', + 'OB_MYSQL', + 'OB_MYSQL_CE', + 'OB_ORACLE', + 'ORACLE', + 'DB2_LUW', + 'KAFKA', + 'ROCKETMQ', + 'DATAHUB', + 'ADB', + 'DBP_OP_ROUTE', + 'DMS', + 'IDB', + 'TIDB', + 'POSTGRESQL', + 'POLARDB_X_1', + 'POLARDB_X_2', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'VisibleSubProject', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否展示子项目，默认不展示 ', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'SortField', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序字段（gmtCreate、gmtModified）,默认 gmtCreate', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'gmtCreate', + ], + ], + [ + 'name' => 'Order', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序顺序（asc：升序 descend:降序），默认降序', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'descend', + 'default' => 'descend', + 'enum' => [ + 'asc', + 'descend', + ], + ], + ], + [ + 'name' => 'NeedRelatedInfo', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否需要查询项目关联信息，默认true（数据源连接信息、传输实例信息、项目步骤信息等）', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页参数，当前页', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '每页个数,默认10，最大150', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '150', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111'."\n", + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'WorkerGradeId' => [ + 'title' => '实例规格 ID', + 'description' => '', + 'type' => 'string', + 'example' => 'g_i4wa7XXX', + ], + 'WorkerGradeInfo' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'ID', + 'type' => 'string', + ], + 'Name' => [ + 'title' => '别名', + 'type' => 'string', + ], + 'Grade' => [ + 'title' => '规格', + 'type' => 'string', + ], + 'Spec' => [ + 'title' => '规格大小', + 'type' => 'string', + ], + 'SpecName' => [ + 'title' => '规格大小名称', + 'type' => 'string', + ], + 'SourceType' => [ + 'title' => '源端数据源类型', + 'type' => 'string', + ], + 'SourceRegion' => [ + 'title' => '源端数据源地域', + 'type' => 'string', + ], + 'DestType' => [ + 'title' => '目标端数据源类型', + 'type' => 'string', + ], + 'DestRegion' => [ + 'title' => '目标端数据源地域', + 'type' => 'string', + ], + 'ChargeType' => [ + 'title' => '计费类型', + 'type' => 'string', + ], + 'AutoRenewal' => [ + 'type' => 'boolean', + ], + 'Expired' => [ + 'type' => 'boolean', + ], + 'EndTime' => [ + 'title' => '到期时间，UTC时间', + 'type' => 'string', + ], + 'GmtCreate' => [ + 'title' => '创建时间，UTC时间', + 'type' => 'string', + ], + ], + ], + 'Id' => [ + 'title' => '项目 id', + 'description' => '', + 'type' => 'string', + 'example' => 'np_4w****'."\n", + ], + 'Type' => [ + 'title' => '类型 (MIGRATION: 数据迁移任务, SYNC: 数据同步任务)', + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'MIGRATION' => 'MIGRATION', + 'SYNC' => 'SYNC', + ], + 'example' => 'MIGRATION', + ], + 'Name' => [ + 'title' => '项目名称', + 'description' => '', + 'type' => 'string', + 'example' => 'project_name', + ], + 'Labels' => [ + 'title' => '标签id集合', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '标签id', + 'description' => '', + 'type' => 'string', + 'example' => 'l_dfe****'."\n", + ], + 'Name' => [ + 'title' => '标签名称', + 'description' => '', + 'type' => 'string', + 'example' => 'label_name', + ], + 'Creator' => [ + 'title' => '创建人(只有在管理员视角下才进行返回)', + 'description' => '', + 'type' => 'string', + 'example' => 'admin', + ], + 'Type' => [ + 'title' => '1 用户标签，0 运维标签', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Count' => [ + 'title' => '使用此标签的项目数量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + 'Owner' => [ + 'title' => '项目owner', + 'description' => '', + 'type' => 'string', + 'example' => 'admin', + ], + 'Importance' => [ + 'title' => '项目告警等级 (HIGH: 高保护状态, MEDIUM: 中保护状态, LOW: 低保护状态, IGNORE: 无保护状态)', + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'HIGH' => 'HIGH', + 'MEDIUM' => 'MEDIUM', + 'LOW' => 'LOW', + 'IGNORE' => 'IGNORE', + ], + 'example' => 'MEDIUM', + ], + 'Status' => [ + 'title' => '项目状态 (INIT: 未启动, RUNNING: 运行中, SUSPEND: 暂停中, FAILED: 已失败, FINISHED: 已完成, RELEASING: 释放中, RELEASED: 已释放, DELETED: 已删除, RUNNING_MODIFYING: 修改中, RUNNING_MERGING: 合并中)', + 'description' => '', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'GmtCreate' => [ + 'title' => '项目创建时间 UTC时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T06:26:15', + ], + 'GmtModified' => [ + 'title' => '项目更新时间 UTC时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T07:01:27', + ], + 'GmtStart' => [ + 'title' => '项目开始时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T07:02:27', + ], + 'GmtFinish' => [ + 'title' => '项目结束时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T08:01:27', + ], + 'DestConnId' => [ + 'title' => '目的连接信息ID', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'IsMerging' => [ + 'title' => '是否处于合并中', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IsModifying' => [ + 'title' => '是否处于修改中', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IsSubProject' => [ + 'title' => '是否子项目', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SourceEndpointType' => [ + 'title' => '源端数据源类型 (MYSQL, MARIADB, OB_MYSQL, OB_MYSQL_CE, OB_ORACLE, ORACLE, DB2_LUW, KAFKA, ROCKETMQ, DATAHUB, SYBASE, LOGPROXY, ADB, DBP_OP_ROUTE, DMS, IDB, TIDB, POSTGRESQL, POLARDB_X_1)', + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'POLARDB_X_1' => 'POLARDB_X_1', + 'MYSQL' => 'MYSQL', + 'TIDB' => 'TIDB', + 'OB_ORACLE' => 'OB_ORACLE', + 'OB_MYSQL' => 'OB_MYSQL', + 'ORACLE' => 'ORACLE', + 'POLARDB_X_2' => 'POLARDB_X_2', + ], + 'example' => 'MYSQL', + ], + 'SinkEndpointType' => [ + 'title' => '目的端数据源 id (MYSQL, MARIADB, OB_MYSQL, OB_MYSQL_CE, OB_ORACLE, ORACLE, DB2_LUW, KAFKA, ROCKETMQ, DATAHUB, SYBASE, LOGPROXY, ADB, DBP_OP_ROUTE, DMS, IDB, TIDB, POSTGRESQL, POLARDB_X_1)', + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'MYSQL' => 'MYSQL', + 'OB_ORACLE' => 'OB_ORACLE', + 'KAFKA' => 'KAFKA', + 'ROCKETMQ' => 'ROCKETMQ', + 'DATAHUB' => 'DATAHUB', + 'OB_MYSQL' => 'OB_MYSQL', + 'ORACLE' => 'ORACLE', + 'ADB' => 'ADB', + ], + 'example' => 'OB_MYSQL', + ], + 'TransferMapping' => [ + 'title' => '传输对象和映射关系', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Mode' => [ + 'title' => '传输对象映射模式 (SPECIFIC, WILDCARD)', + 'description' => '', + 'type' => 'string', + 'example' => 'SPECIFIC', + ], + ], + ], + 'CommonTransferConfig' => [ + 'title' => '公共传输配置（所有步骤）', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TableCategory' => [ + 'title' => '传输的表类型', + 'description' => '', + 'type' => 'string', + 'example' => 'ALL', + ], + 'ActiveActive' => [ + 'title' => '是否双活场景', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MqSerializerType' => [ + 'title' => '投递到消息队列时，数据 json 序列化类型', + 'description' => '', + 'type' => 'string', + 'example' => 'DEFAULT', + ], + 'MqPartitionMode' => [ + 'title' => '投递到消息队列时，分区路由方式', + 'description' => '', + 'type' => 'string', + 'example' => 'ONE', + ], + 'MqPartition' => [ + 'title' => '当 partitionMode 为 ONE 时，此参数表示投递分区的在当前 topic 下的位置', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DatahubTopicType' => [ + 'title' => '投递到消息队列时，指定 topic 的类型', + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'BLOB' => 'BLOB', + 'TUPLE' => 'TUPLE', + ], + 'example' => 'TUPLE', + ], + 'RocketMqProducerGroup' => [ + 'title' => '指定生产组名(目标端为 ROCKETMQ 时生效),默认 OMS', + 'description' => '', + 'type' => 'string', + 'example' => 'OMS', + ], + 'RocketMqMsgTags' => [ + 'title' => '设置消息 tag(目标端为 ROCKETMQ 时生效)，默认 default -> default_tag', + 'description' => '', + 'type' => 'string', + 'example' => 'default_tag', + ], + 'RocketMqEnableMsgTrace' => [ + 'title' => '是否开启消息追踪(目标端为 ROCKETMQ 时生效)', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'RocketMqSendMsgTimeout' => [ + 'title' => '设置消息投递超时时间(目标端为 ROCKETMQ 时生效)', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'null', + ], + 'DataWorksBusinessName' => [ + 'title' => '业务系统标识(可选)', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + 'EnableStructTransfer' => [ + 'title' => '是否启用结构传输', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'StructTransferConfig' => [ + 'title' => '结构传输配置', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ByteCharConvertStrategy' => [ + 'title' => 'byte/char 转换方案', + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'IGNORE_BYTE_IF_BYTE_USED' => 'IGNORE_BYTE_IF_BYTE_USED', + 'FORCE_CHAR_IF_BYTE_USED' => 'FORCE_CHAR_IF_BYTE_USED', + 'DO_NOTHING_IF_BYTE_USED' => 'DO_NOTHING_IF_BYTE_USED', + 'EXPAND_LEN_IF_BYTE_USED' => 'EXPAND_LEN_IF_BYTE_USED', + ], + 'example' => 'DO_NOTHING_IF_BYTE_USED', + ], + 'DeferIndexCreation' => [ + 'title' => '是否允许索引后置（默认不允许）', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'EnableFullTransfer' => [ + 'title' => '是否启用全量传输', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableFullVerify' => [ + 'title' => '是否启用全量校验', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'FullTransferConfig' => [ + 'title' => '全量传输配置', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NonePkUkTruncateDstTable' => [ + 'title' => '在处理源端无唯一索引表德的全量迁移时，是否 truncate 目标表（清空目标表数据）,组件层面默认为 true', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'AllowDestTableNotEmpty' => [ + 'title' => '允许目标端表非空，在源端多个分表向目标端一张表聚合迁移时，需要打开', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'FullTransferSpeedMode' => [ + 'title' => '全量迁移 配置(STEADY：平稳，NORMAL：正常，FAST：快速)。', + 'description' => '', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'FullVerifySpeedMode' => [ + 'title' => '全量校验 配置(STEADY：平稳，NORMAL：正常，FAST：快速)。', + 'description' => '', + 'type' => 'string', + 'example' => 'NORMAL', + ], + ], + ], + 'EnableIncrTransfer' => [ + 'title' => '是否启用增量传输', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableIncrVerify' => [ + 'title' => '是否启用增量校验', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableReverseIncrTransfer' => [ + 'title' => '是否启用反向增量传输', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IncrTransferConfig' => [ + 'title' => '增量配置', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'StartTimestamp' => [ + 'title' => '勾选了增量且没勾选全量时，允许设置增量起始位点，秒级时间戳', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1681004708', + ], + 'RecordTypeWhiteList' => [ + 'title' => '有增量同步阶段时，同步的增量数据类型', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'DELETE' => 'DELETE', + 'COMMIT' => 'COMMIT', + 'INSERT' => 'INSERT', + 'UPDATE' => 'UPDATE', + 'BEGIN' => 'BEGIN', + 'ROW' => 'ROW', + 'HEARTBEAT' => 'HEARTBEAT', + 'DDL' => 'DDL', + 'ROLLBACK' => 'ROLLBACK', + ], + 'example' => 'INSERT', + ], + ], + 'StoreLogKeptHour' => [ + 'title' => '有增量同步阶段，且增量日志拉取组件为 Store 时，日志保存时间, 单位小时，默认7天，最长365天', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '24', + ], + 'EnableSequencingWithinTxn' => [ + 'title' => '有增量同步阶段时，且增量日志拉取组件为 Store 时，是否开启事务内序号编排', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IncrSyncConcurrency' => [ + 'title' => '增量同步线程数，默认64', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '64', + ], + 'EnableIncrSyncStatistics' => [ + 'title' => '是否开启增量记录(dml\\ddl)统计', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'SourceConnectInfo' => [ + 'title' => '源端节点连接信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '连接信息ID', + 'description' => '', + 'type' => 'string', + 'example' => 'c_4w3aq****', + ], + 'EndpointName' => [ + 'title' => '终端节点名', + 'description' => '', + 'type' => 'string', + 'example' => 'ration12****0obmysql4116892***', + ], + 'EndpointId' => [ + 'title' => '终端节点id', + 'description' => '', + 'type' => 'string', + 'example' => 'e_4w3al***', + ], + 'EndpointSide' => [ + 'title' => '终端节点类型（source 源端，dest 目的端） （后续set进去，库中不存储） (SOURCE, DEST)', + 'description' => '', + 'type' => 'string', + 'example' => 'source', + ], + 'DbEngine' => [ + 'title' => '终端节点数据库引擎 (MYSQL_PUBLIC, MYSQL_VPC, MYSQL_DG, OB_MYSQL_CE_PUBLIC, OB_MYSQL: 公有云服务 OB 集群, OB_ORACLE, OB_MYSQL_TENANT: 公有云服务 OB 集群租户模式, OB_ORACLE_TENANT, POSTGRESQL_PUBLIC, OB_MYSQL_VPC: 用户VPC内自建OB集群，非公有云自有OB, OB_ORACLE_VPC, OB_MYSQL_PUBLIC: 公网 OB 集群, OB_ORACLE_PUBLIC, ORACLE_PUBLIC, ORACLE_VPC, ORACLE_DG, RDS_MYSQL, POLAR_MYSQL, ADB_MYSQL, TIDB_PUBLIC, TIDB_VPC, KAFKA_ALIYUN, KAFKA_VPC, KAFKA_PUBLIC, ROCKETMQ_PUBLIC, ROCKETMQ_ALIYUN, ROCKETMQ_VPC, DB2_LUW_PUBLIC, SYBASE_PUBLIC, DATAHUB_PUBLIC, DATAHUB_ALIYUN, DATAHUB_VPC, DBP_OP_ROUTE, DMS, IDB, POLARDB_X_1_ALIYUN, AURORA_MYSQL_PRIVATE_LINK, AURORA_MYSQL_PUBLIC, AURORA_MYSQL_PEERING)', + 'description' => '', + 'type' => 'string', + 'example' => 'OB_MYSQL_PUBLIC', + ], + 'ConnectionInfo' => [ + 'title' => '终端节点连接信息', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'Username' => [ + 'title' => '连接用户名', + 'description' => '', + 'type' => 'string', + 'example' => 'oms931mys**', + ], + 'Version' => [ + 'title' => '数据库版本', + 'description' => '', + 'type' => 'string', + 'example' => '5.7.27', + ], + 'Timezone' => [ + 'title' => '数据库时区', + 'description' => '', + 'type' => 'string', + 'example' => 'UTC', + ], + 'Charset' => [ + 'title' => '编码', + 'description' => '', + 'type' => 'string', + 'example' => 'utf8mb4', + ], + 'NlsLengthSemantics' => [ + 'title' => 'nls_length_semantics 属性，只针对 oracle、ob-oracle。', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'OperatingSystem' => [ + 'title' => '操作系统(OB 没有)。', + 'description' => '', + 'type' => 'string', + 'example' => 'Linux', + ], + 'Region' => [ + 'title' => '地域属性', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'OcpName' => [ + 'title' => 'ocp name 属性，记录 ocp。', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ConnExtraAttributes' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + 'Owner' => [ + 'title' => 'owner', + 'description' => 'Owner。', + 'type' => 'string', + 'example' => 'admin', + ], + 'ResourceOwner' => [ + 'title' => '资源所有者uid', + 'description' => '', + 'type' => 'string', + 'example' => '1325847***', + ], + 'Host' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1'."\n", + ], + 'Port' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2883', + ], + ], + ], + 'SinkConnectInfo' => [ + 'title' => '目的端节点连接信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '连接信息ID', + 'description' => '', + 'type' => 'string', + 'example' => 'c_4w3akx***', + ], + 'EndpointName' => [ + 'title' => '终端节点名', + 'description' => '', + 'type' => 'string', + 'example' => 'ation129***9apimysql5616****', + ], + 'EndpointId' => [ + 'title' => '终端节点id', + 'description' => '', + 'type' => 'string', + 'example' => 'e_4w3aic***', + ], + 'EndpointSide' => [ + 'title' => '终端节点类型（source 源端，dest 目的端） （后续set进去，库中不存储） (SOURCE, DEST)', + 'description' => '', + 'type' => 'string', + 'example' => 'sink', + ], + 'DbEngine' => [ + 'title' => '终端节点数据库引擎 (MYSQL_PUBLIC, MYSQL_VPC, MYSQL_DG, OB_MYSQL_CE_PUBLIC, OB_MYSQL: 公有云服务 OB 集群, OB_ORACLE, OB_MYSQL_TENANT: 公有云服务 OB 集群租户模式, OB_ORACLE_TENANT, POSTGRESQL_PUBLIC, OB_MYSQL_VPC: 用户VPC内自建OB集群，非公有云自有OB, OB_ORACLE_VPC, OB_MYSQL_PUBLIC: 公网 OB 集群, OB_ORACLE_PUBLIC, ORACLE_PUBLIC, ORACLE_VPC, ORACLE_DG, RDS_MYSQL, POLAR_MYSQL, ADB_MYSQL, TIDB_PUBLIC, TIDB_VPC, KAFKA_ALIYUN, KAFKA_VPC, KAFKA_PUBLIC, ROCKETMQ_PUBLIC, ROCKETMQ_ALIYUN, ROCKETMQ_VPC, DB2_LUW_PUBLIC, SYBASE_PUBLIC, DATAHUB_PUBLIC, DATAHUB_ALIYUN, DATAHUB_VPC, DBP_OP_ROUTE, DMS, IDB, POLARDB_X_1_ALIYUN, AURORA_MYSQL_PRIVATE_LINK, AURORA_MYSQL_PUBLIC, AURORA_MYSQL_PEERING)', + 'description' => '', + 'type' => 'string', + 'example' => 'MYSQL_PUBLIC', + ], + 'ConnectionInfo' => [ + 'title' => '终端节点连接信息', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'Username' => [ + 'title' => '连接用户名', + 'description' => '', + 'type' => 'string', + 'example' => 'oms**obmys**', + ], + 'Version' => [ + 'title' => '数据库版本', + 'description' => '', + 'type' => 'string', + 'example' => '2.2.77', + ], + 'Timezone' => [ + 'title' => '数据库时区', + 'description' => '', + 'type' => 'string', + 'example' => '+08:00', + ], + 'Charset' => [ + 'title' => '编码', + 'description' => '', + 'type' => 'string', + 'example' => 'utf8mb4', + ], + 'NlsLengthSemantics' => [ + 'title' => 'nls_length_semantics 属性，只针对 oracle、ob-oracle。', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'OperatingSystem' => [ + 'title' => '操作系统(OB 没有)。', + 'description' => '', + 'type' => 'string', + 'example' => 'Linux', + ], + 'Region' => [ + 'title' => '地域属性', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'OcpName' => [ + 'title' => 'ocp name 属性，记录 ocp。', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ConnExtraAttributes' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + 'Owner' => [ + 'title' => 'owner', + 'description' => 'Owner。', + 'type' => 'string', + 'example' => 'admin', + ], + 'ResourceOwner' => [ + 'title' => '资源所有者uid', + 'description' => '', + 'type' => 'string', + 'example' => '1325847***', + ], + 'Host' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1', + ], + 'Port' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2883', + ], + ], + ], + 'Steps' => [ + 'title' => '步骤列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Order' => [ + 'title' => '步骤顺序', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Name' => [ + 'title' => '步骤名 (PRE_CHECK, TRANSFER_PRECHECK, PREPARE, STRUCT_TRANSFER, STRUCT_MIGRATION, INDEX_MIGRATION, INDEX_TRANSFER, STRUCT_SYNC, FULL_MIGRATION, FULL_TRANSFER, APP_SWITCH, TRANSFER_APP_SWITCH, REVERSE_INCR_SYNC, REVERSE_INCR_TRANSFER, FULL_VALIDATION, FULL_VERIFIER, INCR_LOG_PULL, TRANSFER_INCR_LOG_PULL, INCR_SYNC, INCR_TRANSFER, INCR_VERIFIER, SYNC_PREPARE, TRANSFER_PREPARE, SYNC_INCR_LOG_PULL, CONNECTOR_FULL_SYNC, CONNECTOR_INCR_SYNC)', + 'description' => '', + 'type' => 'string', + 'example' => 'TRANSFER_PRECHECK', + ], + 'Description' => [ + 'title' => '步骤描述（预检查/结构迁移/结构同步/全量迁移/全量同步/全量校验/索引迁移/增量日志拉取/增量同步/增量校验/正向切换）', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Status' => [ + 'title' => '步骤状态 (INIT: 初始化, RUNNING: 运行中, FAILED: 失败, FINISHED: 已完成, SUSPEND: 暂停中, MONITORING: 持续监控状态，用于增量同步和增量校验的持续监控态)', + 'description' => '', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'ExtraInfo' => [ + 'title' => '补充信息（json）', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ErrorDetails' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111'."\n", + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + 'ErrorCode' => [ + 'title' => '错误码 (AUTHENTICATION_ERROR, PARAM_ERROR, PARAM_ERROR_MESSAGE, NOT_IMPLEMENTED_ERROR, SHARD_COLUMNS_CONFLICT_MESSAGE, FAILED_PARSE_TOKEN_MESSAGE, CONNECT_CHECK_ERROR, NOT_SUPPORT_ERROR, CE_NOT_SUPPORT_ERROR, NOT_FOUND_ERROR, SHARDING_COLUMN_NOT_INCLUDED_ERROR, INNER_ERROR, OMS_META_DB_ACCESS_FAILED, DB_QUERY_ERROR, DATAHUB_QUERY_ERROR, USER_LACK_SYS_PRIV_ERROR, USER_LACK_TABLE_PRIV_ERROR, RM_API_ERROR, RM_TASK_ERROR, CM_API_ERROR, CM_API_NOT_SUCCESS, BAGUALU_API_ERROR, IDB_API_ERROR, SUPERVISOR_API_ERROR, OCP_API_ERROR, OCP_SERVICE_ERROR, OCP_QUERY_VERSION_FAILED, OCP_VERSION_INCORRECT_ERROR, OCP_VERSION_NOT_SUPPORTED_ERROR, OCP_API_USER_PASSWORD_INCORRECT_ERROR, OBSCHEMA_ERROR, EXECUTOR_THREAD_POOL_BUSY, NO_TABLE_SELECTED, NO_VIEW_SELECTED, SOURCE_CRAWLER_START_FAILED, SOURCE_CRAWLER_START_FAILED_DATA_EXPIRED, SOURCE_CRAWLER_START_TIMEOUT, DEST_WRITER_START_FAILED, WRITER_UNKNOWN_STATUS, DRC_TOPIC_EXISTS_ERROR, TOPIC_EMPTY_ERROR, REACH_WRITER_LIMIT_ERROR, FOUND_NO_FEASIBLE_STORE_ERROR, TOO_MANY_STORES_FOR_SUBTOPIC, TIMEOUT_EXCEPTION, KIPP_API_ERROR: KIPP 相关错误信息, KIPP_API_RESOURCE_NOT_FOUND, KIPP_API_INVALID_PARAM, KIPP_API_UNKNOWN_ERROR, KIPP_API_INTERNAL_ERROR, KIPP_API_SERVICE_UNAVAILABLE, OMS_AGENT_API_ERROR, KMS_API_ERROR, OMS_ENCRYPT_API_ERROR, OMS_DECRYPT_API_ERROR, ALIYUN_SDK_ERROR, YAOCHI_API_ERROR, AWS_SDK_ERROR, AWS_PRIVATE_LINK_SERVICE_INITIALIZING_ERROR, AWS_PRIVATE_LINK_SERVICE_UNAVAILABLE_ERROR, AWS_PRIVATE_LINK_SERVICE_NEED_ACCEPTANCE_ERROR, UNSUPPORTED_AWS_SERVICE_ERROR, RESOURCE_WITHOUT_STOCK_ERROR, RESOURCE_NO_AVAILABLE_ZONE, CM_SDK_ERROR, MIGRATION_PROJECT_STEP_PRECHECK_FAILED, PRE_CHECK_ERROR, FAILURES_CORRECT_ERROR, EXECUTE_DDL_FAILURE, EXECUTE_DDL_UNSUPPORTED_OR_FAILURE, STRUCT_RECORD_DDL_NOT_FOUND, STRUCT_RECORD_INDEX_NOT_FOUND, STRUCT_RECORD_NOT_FOUND, STRUCT_RECORD_NOT_FOUND_IN_DBCAT, STRUCT_RECORD_NOT_FOUND_IN_DBCAT_PUBLIC, SCHEMA_OBJECT_TYPE_NOT_SUPPORT_ERROR, POLAR_MYSQL_NETWORK_TYPE_NOT_SUPPORT_ERROR, RDS_NETWORK_TYPE_NOT_SUPPORT_ERROR, RDS_VPC_NETWORK_NOT_SUPPORT_ERROR, DB_TYPE_NOT_SUPPORT_ERROR, SYNC_TYPE_NOT_SUPPORT_ERROR, SLAVE_OPERATION_STEP_NOT_SUPPORT_ERROR, BYTE_USED_TYPE_NOT_SUPPORT_ERROR, MANY_TO_ONE_SCHEMA_TABLE_REVERSE_INCR_NOT_SUPPORT_ERROR, MANY_TO_ONE_SCHEMA_REVERSE_INCR_NOT_SUPPORT_ERROR, DUPLICATE_SCHEMA_TABLE_ERROR, OMS_STEP_NOT_SUPPORT_ERROR, ORACLE_DATABASE_ROLE_NOT_SUPPORT_ERROR, OLD_PRE_CHECK_NOT_SUPPORT_ERROR, SCHEMA_ONE_TO_MANY_NOT_SUPPORT_ERROR, PROJECT_NOT_FOUND_ERROR, SYNC_PROJECT_NOT_FOUND_ERROR, ENDPOINT_NOT_FOUND_ERROR, ENDPOINT_NAME_ALREADY_EXIST_ERROR, ENDPOINT_QUERY_ERROR, ENDPOINT_SQL_QUERY_ERROR, PROJECT_NAME_ALREADY_EXIST_ERROR, CHECKER_NOT_FOUND_ERROR, CHECKER_FAILED_ERROR, CHECKER_STATUS_UNEXPECTED_ERROR, CHECKER_NO_TASK_TYPE_ERROR, WORKER_INSTANCE_NOT_FOUND_ERROR, WORKER_INSTANCE_ALLOCATING_ERROR, LOG_SERVICE_TOPIC_NOT_FOUND_ERROR, CLUSTER_NOT_FOUND_ERROR, TENANT_NOT_FOUND_ERROR, DATABASE_NOT_FOUND_ERROR, TABLE_NOT_FOUND_ERROR, COLUMN_NOT_FOUND_ERROR, TABLE_META_NOT_FOUND_ERROR, SYBASE_CHARSET_NOT_FOUND_ERROR, OCP_NOT_FOUND_ERROR, REGION_NOT_FOUND_ERROR, OCP_ALREADY_EXIST_ERROR, ALARM_CHANNEL_NAME_ALREADY_EXIST_ERROR, SEND_MARKDOWN_TEXT_TO_WEBHOOK_FAILED_EXCEPTION_RESPONSE, SEND_MARKDOWN_TEXT_TO_WEBHOOK_FAILED_EXCEPTION_STATUS, LABEL_ALREADY_EXIST_ERROR, LABEL_NOT_EXIST_ERROR, OCP_ALREADY_USED_ERROR, REGION_INFO_INCONSISTENT_ERROR, OCP_NAME_EMPTY_ERROR, MASTER_SLAVE_ENDPOINT_NAME_INCONSISTENT_ERROR, LOG_FILE_NOT_FOUND_ERROR, CHECKER_METRICS_LOG_FILE_NOT_FOUND_ERROR, OPERATION_NOT_ALLOWED_ERROR, PROJECT_OPERATION_NOT_ALLOWED_ERROR, PROJECT_RELEASE_FAILED, STRUCT_MIGRATION_RETRY_NOT_ALLOWED_ERROR, WORKER_INSTANCE_OPERATION_NOT_ALLOWED_ERROR, USER_OPERATION_NOT_ALLOWED_ERROR, OCP_NAME_OR_REGION_NOT_ALLOWED_UPDATE, UPDATE_CONFIG_WITH_NEWLINE_NOT_ALLOWED, EXIST_UNRELEASED_PROJECT_ERROR, EXIST_UNRELEASED_TOPIC_ERROR, LABEL_CREATE_NOT_ALLOWED_ERROR, LABEL_UPDATE_NOT_ALLOWED_ERROR, LABEL_DELETE_NOT_ALLOWED_ERROR, TOPIC_NAME_INVALID_ERROR, MAPPING_INVALID_ERROR, INVALID_STATUS_ERROR, INVALID_CSV_HEAD_ERROR, INVALID_CSV_BODY_ERROR, DUPLICATE_SCHEMA_TABLE_SETTING_ERROR, MULTIPLE_TABLES_NOT_ALLOWED_ERROR, PROJECT_INVALID_STATUS_ERROR, PROJECT_INVALID_CONNECTOR_COUNT_ERROR, WORKER_INSTANCE_INVALID_STATUS_ERROR, LOG_SERVICE_INVALID_STATUS_ERROR, STEP_INVALID_STATUS_ERROR, UPDATE_ALLOW_DEST_TABLE_NOT_EMPTY_NOT_ALLOWED_ERROR, EXIST_INCONSISTENCY_ERROR, OMS_SWITCH_SUBSTEP_FAILED_ERROR, ENDPOINT_ID_INVALID_ERROR, DB_QUERY_VERSION_EMPTY_ERROR, ENDPOINT_NAME_INVALID_ERROR, CLOUD_ENDPOINT_NAME_INVALID_ERROR, ENDPOINT_SCHEMA_NOT_ALLOWED_ERROR, ENDPOINT_USERNAME_NOT_ALLOWED_ERROR, ENDPOINT_SCHEMA_CHAR_NOT_ALLOWED_ERROR, NAME_HAS_SPACE_EXCEPTION, CONFIG_CONVERT_VALUE_ERROR, CONFIG_VALUE_EXCEEDS_LIMIT_ERROR, CONFIG_KEY_NOT_FOUND_KEY_ERROR, CONFIG_VALUE_NOT_EMPTY_ERROR, SCHEMA_HAS_CONVERT_INFO, TIME_SERIES_QUERY_SERVICE_ERROR, ETL_VERIFY_ERROR, ETL_SYNTAX_UNSUPPORTED, ETL_FIELD_NOTFOUND, ETL_FAILED_PARSE_SQL, ETL_VAL_TYPE_ERROR, NOT_SUPPORT_GENERATE_COLUMNS, NOT_SUPPORT_UPDATE_ETL, LOCK_FAILED, OMS_USER_EXIST_ERROR, OMS_USER_NOT_FOUND_ERROR, OMS_USER_NAME_LENGTH_CONSTRAINT, OMS_USER_EMAIL_LENGTH_CONSTRAINT: 用户名, OMS_USER_PASSWORD_ERROR, LOGIN_EXPIRE, USER_NAME_OR_PASSWORD_ERROR, USER_NAME_OR_PASSWORD_LOGIN_FAILURE_TIMES_ERROR: 用户名或密码错误: 您的用户将在, OMS_USER_PASSWORD_HAS_EXPIRED_ERROR, OMS_USER_ROOT_PASSWORD_HAS_EXPIRED_ERROR, OMS_USER_PASSWORD_LOCKED_ERROR, OMS_USER_ROOT_PASSWORD_LOCKED_ERROR, OMS_USER_PASSWORD_VALIDATION_ERROR, OMS_USER_PASSWORD_DEFAULT_ERROR, CAPTCHA_EXPIRE_KEY, CAPTCHA_ERROR_KEY, OMS_USER_PERMISSION_DENIED_ERROR, OMS_USER_NOT_ACTIVE, OMS_USER_EDIT_ADMIN_ROLE_INFO_PERMISSION_DENIED_ERROR, OMS_USER_ILLEGAL_DELETED_ERROR, OMS_USER_FORBID_DELETED_ERROR, OMS_DEPARTMENT_ALREADY_EXIST_ERROR, OMS_DEPARTMENT_MAXIMUM_LIMIT, OMS_DEPARTMENT_USER_NOT_EMPTY, CONNECTOR_TASK_DELETE_ERROR, METRIC_SERVICE_ERROR, SYNC_PROJECT_TYPE_INVALID_ERROR, SYNC_SHARDING_COLUMNS_INVALID_ERROR, SYNC_PROJECT_PRODUCER_GROUP_INVALID_ERROR, SYNC_PROJECT_PRODUCER_GROUP_LIMIT_EXCEEDS_ERROR, SYNC_PROJECT_COMPLEMENT_CONFIG_ERROR, META_SCHEMA_CREATE_FAILED, RESUME_STEP_FAILED, SCHEMA_INCONSISTENCY, SCHEMA_CASCADE_MAPPING_NOT_SUPPORT_ERROR, SCHEMA_NOT_EXISTED, SCHEMA_EXISTED, SCHEMA_NOT_EXIST, BLACK_LIST_MATCH_ALL, BLACK_LIST_CONTAIN_NON_WHITE_SCHEMA, OPERATOR_ERROR, OPERATOR_DIMENSION_NOT_SUPPORT, OPERATOR_PULL_LOG_ERROR, OPERATOR_UPDATE_CONFIG_NOT_SUPPORT, UPDATE_CONFIG_NOT_SUPPORT_BLANK_CHAR, UPDATE_CONFIG_INVALID_NOT_NUMBER, UPDATE_CHECKER_CONCURRENCY_CONFIG_NOT_SATISFY, KAFKA_CREATE_TOPIC_ERROR, KAFKA_QUERY_TOPIC_ERROR, KAFKA_BUILD_PROPERTIES_ERROR, KAFKA_CHECK_SASL_USER_ERROR, ROCKETMQ_CREATE_TOPIC_ERROR, ROCKETMQ_QUERY_TOPIC_ERROR, SYNC_OBJECT_EMPTY_ERROR, WRITER_NUMBER_NOT_UNIQUE, WRITER_NOT_ACTIVE, PROJECT_NAME_DUPLICATE_ERROR, EMPTY_FAILED_STRUCT_MIGRATION_TABLES_ERROR, LOGIC_TABLE_NOT_SUPPORT_UPDATE_OBJECT_ERROR, LOGIC_REQUEST_ERROR, LOGIC_DTO_BUILD_ERROR, UNEXPECTED_REMOTE_API_RESULT, OCEANBASE_USER_UNEXPECTED, STORE_CREATE_FAILED_ERROR, STORE_START_FAILED, STORE_NOT_PULL_LOG_ERROR, ALL_HOSTS_STATUS_ERROR, ALARM_CHANNEL_NAME_LIST_DUPLICATE, ALARM_CHANNEL_NAME_LIST_CONFLICT, CUSTOMER_NOT_FOUND_ERROR, WORKER_ECS_NOT_FOUND_ERROR, WORKER_ECS_NOT_FOUND_FOR_USER_ERROR, WORKER_POD_NOT_FOUND_ERROR, WORKER_POD_NOT_FOUND_FOR_USER_ERROR, WORKER_INSTANCE_NOT_FOUND_ERROR_V2, WORKER_INSTANCE_NOT_FOUND_FOR_USER_ERROR, RELEASE_PLAN_CREATED_CONFLICT, INCR_SYNC_START_TIMESTAMP_INVALID, OMS_RESOURCE_OPERATION_BROKEN_ACCESS)', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'ErrorMsg' => [ + 'title' => '错误消息', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ErrorParam' => [ + 'title' => '错误相关参数', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'FailedTime' => [ + 'title' => '错误时间', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + 'StartTime' => [ + 'title' => '开始时间，UTC 格式："2020-05-22T17:04:18"', + 'description' => '', + 'type' => 'string', + 'example' => '2020-05-22T17:04:18', + ], + 'FinishTime' => [ + 'title' => '结束时间，UTC 格式："2020-05-22T17:04:18"', + 'description' => '', + 'type' => 'string', + 'example' => '2020-05-22T17:05:18', + ], + 'Progress' => [ + 'title' => '步骤进度', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'StepInfo' => [ + 'title' => '步骤详情,全量传输/增量传输/正向切换', + 'description' => '', + 'type' => 'object', + 'example' => 'null', + ], + ], + ], + ], + 'ExtraInfo' => [ + 'title' => '错误信息等补充信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RunningStep' => [ + 'title' => '正在处于 running step (PRE_CHECK, TRANSFER_PRECHECK, PREPARE, STRUCT_TRANSFER, STRUCT_MIGRATION, INDEX_MIGRATION, INDEX_TRANSFER, STRUCT_SYNC, FULL_MIGRATION, FULL_TRANSFER, APP_SWITCH, TRANSFER_APP_SWITCH, REVERSE_INCR_SYNC, REVERSE_INCR_TRANSFER, FULL_VALIDATION, FULL_VERIFIER, INCR_LOG_PULL, TRANSFER_INCR_LOG_PULL, INCR_SYNC, INCR_TRANSFER, INCR_VERIFIER, SYNC_PREPARE, TRANSFER_PREPARE, SYNC_INCR_LOG_PULL, CONNECTOR_FULL_SYNC, CONNECTOR_INCR_SYNC)', + 'description' => '', + 'type' => 'string', + 'example' => 'TRANSFER_PRECHECK', + ], + 'RunningProgress' => [ + 'title' => 'running step 进度', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'MonitoringIncr' => [ + 'title' => '是否开始监控增量', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Subtopics' => [ + 'title' => '任务关联 store 的 subtopics', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + ], + 'ReverseSubtopics' => [ + 'title' => '任务关联反向 store 的 subtopics', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + ], + 'LogServiceStartCheckpoint' => [ + 'title' => '起始位点，对于', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1689214358', + ], + 'SourceStoreKeptHour' => [ + 'title' => '日志保存时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '24', + ], + 'SyncDelay' => [ + 'title' => '增量同步延时', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'null', + ], + 'SyncDelaySampleTimestamp' => [ + 'title' => '同步延迟的采集时间戳，秒级别', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1689214358', + ], + 'AccessObSource' => [ + 'title' => '是否能够直连OB源端，不能的话Store Source会变为LogProxy Source', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OverwriteConfig' => [ + 'title' => '是否允许完全覆盖更新配置', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IgnoreUnsupportDdl' => [ + 'title' => '对于connector，是否忽略不支持的ddl', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SubDbs' => [ + 'title' => '记录不同下游消费方的表配置，用于同步任务复用时的配置合并', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ClusterName' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'cluster_name', + ], + 'TenantName' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'tenant_name', + ], + 'DatabaseId' => [ + 'title' => '目前只有逻辑库才会具有 id，可能存在在一个 Endpoint 中库名相同，但是 id 不同，表示的是不同的 id 情况', + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + 'DatabaseName' => [ + 'title' => '数据库名称', + 'type' => 'string', + 'description' => '', + 'example' => 'db_name', + ], + 'MappingDatabaseName' => [ + 'title' => '数据库映射名', + 'type' => 'string', + 'example' => 'mapped_db', + 'description' => '', + ], + 'SourceClientId' => [ + 'title' => '用于标识是哪个 source client 来处理该 databaseName', + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + 'Tables' => [ + 'title' => '表名称', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableId' => [ + 'title' => '目前只有逻辑表才会存在 tableId，在逻辑表中可能存库表名完全相同，但是只能根据 id 才能区分的场景', + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + 'Database' => [ + 'title' => '库名称', + 'type' => 'string', + 'description' => '', + 'example' => 'db_name', + ], + 'TableName' => [ + 'title' => '表名', + 'type' => 'string', + 'description' => '', + 'example' => 'table_name', + ], + 'MappingTableName' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'mapped_name', + ], + 'Instance' => [ + 'title' => '逻辑表返回的 instance，只有逻辑表会存在, @link PhysicalTableDTO#url', + 'type' => 'string', + 'description' => '', + 'example' => 'g_i4kat***', + ], + 'Columns' => [ + 'title' => '表列信息，如果是逻辑表可能放在外层', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'title' => '列名', + 'type' => 'string', + 'example' => 'column_name', + 'description' => '', + ], + 'Position' => [ + 'title' => '字段位置', + 'type' => 'integer', + 'format' => 'int32', + 'description' => '', + 'example' => 'null', + ], + 'ColumnType' => [ + 'title' => '列类型', + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + 'RecordFieldType' => [ + 'title' => '列类型引申 (INT8, INT16, INT24, INT32, INT64, BIGINT, BOOLEAN, FLOAT, DOUBLE, DECIMAL, NUMBER, MONEY, DEC_FLOAT, REAL, UCHAR_STRING, GRAPHIC_STRING, CHAR_STRING, NCHAR_STRING, VAR_GRAPHIC_STRING, VAR_UCHAR_STRING, VAR_STRING, VAR_CHAR_STRING, VAR_NCHAR_STRING, ROW_ID, UROWID, TEXT, UTEXT, TINY_TEXT, MEDIUM_TEXT, LONG_TEXT, BINARY_BYTES, VAR_BINARY_BYTES, RAW, LONG_RAW, BIT, VAR_BIT, BLOB, TINY_BLOB, MEDIUM_BLOB, LONG_BLOB, BFILE, IMAGE, JSONB, UUID, ENUM, SET, INTERVAL_DAY_TO_SECOND, INTERVAL_YEAR_TO_MONTH, INTERVAL_DATE_TIME, CLOB, NCLOB, XML, JSON, LONG_VAR_CHAR, LONG_VAR_GRAPHIC, GEOGRAPHY, GEOMETRY, POINT, LSEG, BOX, PATH, CIRCLE, LINESTRING, POLYGON, MULTIPOINT, MULTILINESTRING, MULTIPOLYGON, GEOMETRYCOLLECTION, CIDR, INET, MACADDR, MACADDR8, TSVERCTOR, TSQUERY, YEAR, DATE, MYSQL_NEW_DATE, TIME, TIME_WITH_NANOS, TIME_WITH_TIMEZONE, DATETIME, DATETIME_WITH_NONAS, TIMESTAMP_IN_LONG, TIMESTAMP_IN_LONG_WITH_NANOS, TIMESTAMP, TIMESTAMP_WITH_NANOS, TIMESTAMP_WITH_TIMEZONE, TIMESTAMP_WITH_LOCAL_TIMEZONE, ZONED_DATETIME, OID, REGCLASS, REGCOLLATION, REGCONFIG, REGDICTIONARY, REGNAMESPACE, REGOPER, REGOPERATOR, REGROLE, REGTYPE, INT4RANGE, INT8RANGE, NUMRANGE, TSRANGE, TSTZRANGE, DATERANGE, STRUCT, LIST, NULL, CUSTOM_TYPE, UNSUPPORTED_TYPE)', + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + 'RawColumnType' => [ + 'title' => '数据库记录的列类型原始字符串', + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + 'ColumnKey' => [ + 'title' => '索引类型 (PRI, UNI, MUL)', + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + 'Nullable' => [ + 'title' => '是否可为空', + 'type' => 'boolean', + 'description' => '', + 'example' => 'false', + ], + 'DefaultValue' => [ + 'title' => '默认值', + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + 'DataLength' => [ + 'title' => '字段长度', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'null', + 'description' => '', + ], + 'DataPrecision' => [ + 'title' => '精度', + 'type' => 'integer', + 'format' => 'int32', + 'description' => '', + 'example' => '64', + ], + 'DataScale' => [ + 'title' => '小数点', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + 'description' => '', + ], + 'Encoding' => [ + 'title' => '字符编码', + 'type' => 'string', + 'description' => '', + 'example' => 'utf8', + ], + 'ColumnComment' => [ + 'title' => '字段注释', + 'type' => 'string', + 'example' => 'comments', + 'description' => '', + ], + 'IsGenerateField' => [ + 'title' => '是否是隐藏列', + 'type' => 'boolean', + 'example' => 'false', + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'SubConds' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TenantName' => [ + 'title' => '源端租户名称', + 'type' => 'string', + 'example' => 'tenant_name', + 'description' => '', + ], + 'Database' => [ + 'title' => '源端数据库名', + 'type' => 'string', + 'example' => 'db_name', + 'description' => '', + ], + 'DestDatabase' => [ + 'title' => '目标数据库名', + 'type' => 'string', + 'example' => 'dest_db', + 'description' => '', + ], + 'TableName' => [ + 'title' => '源端表名', + 'type' => 'string', + 'description' => '', + 'example' => 'table_name', + ], + 'DestName' => [ + 'title' => '目标端表名/Topic名', + 'type' => 'string', + 'example' => 'dest_name', + 'description' => '', + ], + 'WhereClause' => [ + 'title' => 'sql 语法', + 'type' => 'string', + 'example' => 'id>1', + 'description' => '', + ], + 'FilterColumns' => [ + 'title' => '过滤列，如果该集合空表示都需要，如果该集合有值表示保留值', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'col', + ], + 'description' => '', + ], + 'ShardColumns' => [ + 'title' => '分片键列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'col', + ], + 'description' => '', + ], + 'LogicTableId' => [ + 'title' => '针对逻辑表下，逻辑表 tableId', + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + 'SourceEndpointId' => [ + 'title' => '针对物理表下传递 endpointId', + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + 'SourceClientId' => [ + 'title' => 'connector client id', + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'SubIds' => [ + 'title' => '取代', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'MaxConnectorCount' => [ + 'title' => 'connector 最大数量，-1 表示不限制', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'StoreIncr' => [ + 'title' => '是否保存增量', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IncrSyncTimestamp' => [ + 'title' => '增量当前位点 秒级时间戳', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1689244596', + ], + ], + ], + 'AlarmStats' => [ + 'title' => '告警统计信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Target' => [ + 'title' => '被告警目标（项目、host）', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'Alarming' => [ + 'title' => '是否正在告警', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'RecentlyTriggerCount' => [ + 'title' => '最近告警消息总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RuleToRecentlyTriggerCount' => [ + 'title' => '分规则最近告警消息数', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'description' => '', + ], + ], + 'AlarmContent' => [ + 'title' => '最近告警内容', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'OpenMonitor' => [ + 'title' => '公有云下，是否开启监控告警开关', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 4,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": [\\n {\\n \\"WorkerGradeId\\": \\"g_i4wa7***\\",\\n \\"WorkerGradeInfo\\": {\\n \\"Id\\": \\"g_i4wa7***\\",\\n \\"Name\\": \\"i5fu***\\",\\n \\"Grade\\": \\"OMS_G2_MIGRATION_LARGE\\",\\n \\"Spec\\": \\"LARGE\\",\\n \\"SpecName\\": \\"LARGE\\",\\n \\"SourceType\\": \\"OB_MYSQL\\",\\n \\"SourceRegion\\": \\"ap-southeast-1\\",\\n \\"DestType\\": \\"OB_MYSQL\\",\\n \\"DestRegion\\": \\"ap-southeast-1\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"AutoRenewal\\": false,\\n \\"Expired\\": false,\\n \\"EndTime\\": \\"2024-01-28T15:07:44\\",\\n \\"GmtCreate\\": \\"2024-01-28T14:07:44\\"\\n },\\n \\"Id\\": \\"np_4w****\\\\n\\",\\n \\"Type\\": \\"MIGRATION\\",\\n \\"Name\\": \\"project_name\\",\\n \\"Labels\\": [\\n {\\n \\"Id\\": \\"l_dfe****\\\\n\\",\\n \\"Name\\": \\"label_name\\",\\n \\"Creator\\": \\"admin\\",\\n \\"Type\\": 1,\\n \\"Count\\": 2\\n }\\n ],\\n \\"Owner\\": \\"admin\\",\\n \\"Importance\\": \\"MEDIUM\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"GmtCreate\\": \\"2023-07-13T06:26:15\\",\\n \\"GmtModified\\": \\"2023-07-13T07:01:27\\",\\n \\"GmtStart\\": \\"2023-07-13T07:02:27\\",\\n \\"GmtFinish\\": \\"2023-07-13T08:01:27\\",\\n \\"DestConnId\\": \\"null\\",\\n \\"IsMerging\\": false,\\n \\"IsModifying\\": false,\\n \\"IsSubProject\\": false,\\n \\"SourceEndpointType\\": \\"MYSQL\\",\\n \\"SinkEndpointType\\": \\"OB_MYSQL\\",\\n \\"TransferMapping\\": {\\n \\"Mode\\": \\"SPECIFIC\\"\\n },\\n \\"CommonTransferConfig\\": {\\n \\"TableCategory\\": \\"ALL\\",\\n \\"ActiveActive\\": false,\\n \\"MqSerializerType\\": \\"DEFAULT\\",\\n \\"MqPartitionMode\\": \\"ONE\\",\\n \\"MqPartition\\": 0,\\n \\"DatahubTopicType\\": \\"TUPLE\\",\\n \\"RocketMqProducerGroup\\": \\"OMS\\",\\n \\"RocketMqMsgTags\\": \\"default_tag\\",\\n \\"RocketMqEnableMsgTrace\\": false,\\n \\"RocketMqSendMsgTimeout\\": 0,\\n \\"DataWorksBusinessName\\": \\"null\\"\\n },\\n \\"EnableStructTransfer\\": true,\\n \\"StructTransferConfig\\": {\\n \\"ByteCharConvertStrategy\\": \\"DO_NOTHING_IF_BYTE_USED\\",\\n \\"DeferIndexCreation\\": false\\n },\\n \\"EnableFullTransfer\\": true,\\n \\"EnableFullVerify\\": true,\\n \\"FullTransferConfig\\": {\\n \\"NonePkUkTruncateDstTable\\": false,\\n \\"AllowDestTableNotEmpty\\": false,\\n \\"FullTransferSpeedMode\\": \\"NORMAL\\",\\n \\"FullVerifySpeedMode\\": \\"NORMAL\\"\\n },\\n \\"EnableIncrTransfer\\": true,\\n \\"EnableIncrVerify\\": true,\\n \\"EnableReverseIncrTransfer\\": true,\\n \\"IncrTransferConfig\\": {\\n \\"StartTimestamp\\": 1681004708,\\n \\"RecordTypeWhiteList\\": [\\n \\"INSERT\\"\\n ],\\n \\"StoreLogKeptHour\\": 24,\\n \\"EnableSequencingWithinTxn\\": true,\\n \\"IncrSyncConcurrency\\": 64,\\n \\"EnableIncrSyncStatistics\\": true\\n },\\n \\"SourceConnectInfo\\": {\\n \\"Id\\": \\"c_4w3aq****\\",\\n \\"EndpointName\\": \\"ration12****0obmysql4116892***\\",\\n \\"EndpointId\\": \\"e_4w3al***\\",\\n \\"EndpointSide\\": \\"source\\",\\n \\"DbEngine\\": \\"OB_MYSQL_PUBLIC\\",\\n \\"ConnectionInfo\\": \\"null\\",\\n \\"Username\\": \\"oms931mys**\\",\\n \\"Version\\": \\"5.7.27\\",\\n \\"Timezone\\": \\"UTC\\",\\n \\"Charset\\": \\"utf8mb4\\",\\n \\"NlsLengthSemantics\\": \\"null\\",\\n \\"OperatingSystem\\": \\"Linux\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"OcpName\\": \\"null\\",\\n \\"ConnExtraAttributes\\": \\"null\\",\\n \\"Owner\\": \\"admin\\",\\n \\"ResourceOwner\\": \\"1325847***\\",\\n \\"Host\\": \\"xxx.xxx.xxx.1\\\\n\\",\\n \\"Port\\": 2883\\n },\\n \\"SinkConnectInfo\\": {\\n \\"Id\\": \\"c_4w3akx***\\",\\n \\"EndpointName\\": \\"ation129***9apimysql5616****\\",\\n \\"EndpointId\\": \\"e_4w3aic***\\",\\n \\"EndpointSide\\": \\"sink\\",\\n \\"DbEngine\\": \\"MYSQL_PUBLIC\\",\\n \\"ConnectionInfo\\": \\"null\\",\\n \\"Username\\": \\"oms**obmys**\\",\\n \\"Version\\": \\"2.2.77\\",\\n \\"Timezone\\": \\"+08:00\\",\\n \\"Charset\\": \\"utf8mb4\\",\\n \\"NlsLengthSemantics\\": \\"null\\",\\n \\"OperatingSystem\\": \\"Linux\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"OcpName\\": \\"null\\",\\n \\"ConnExtraAttributes\\": \\"null\\",\\n \\"Owner\\": \\"admin\\",\\n \\"ResourceOwner\\": \\"1325847***\\",\\n \\"Host\\": \\"xxx.xxx.xxx.1\\",\\n \\"Port\\": 2883\\n },\\n \\"Steps\\": [\\n {\\n \\"Order\\": 1,\\n \\"Name\\": \\"TRANSFER_PRECHECK\\",\\n \\"Description\\": \\"预检查\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ExtraInfo\\": {\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"INNER_ERROR\\",\\n \\"ErrorMsg\\": \\"A system error occurred.\\\\n\\",\\n \\"ErrorParam\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"FailedTime\\": \\"null\\"\\n },\\n \\"StartTime\\": \\"2020-05-22T17:04:18\\",\\n \\"FinishTime\\": \\"2020-05-22T17:05:18\\",\\n \\"Progress\\": 100,\\n \\"StepInfo\\": null\\n }\\n ],\\n \\"ExtraInfo\\": {\\n \\"RunningStep\\": \\"TRANSFER_PRECHECK\\",\\n \\"RunningProgress\\": 90,\\n \\"MonitoringIncr\\": true,\\n \\"Subtopics\\": [\\n \\"null\\"\\n ],\\n \\"ReverseSubtopics\\": [\\n \\"null\\"\\n ],\\n \\"LogServiceStartCheckpoint\\": 1689214358,\\n \\"SourceStoreKeptHour\\": 24,\\n \\"SyncDelay\\": 0,\\n \\"SyncDelaySampleTimestamp\\": 1689214358,\\n \\"AccessObSource\\": true,\\n \\"OverwriteConfig\\": true,\\n \\"IgnoreUnsupportDdl\\": true,\\n \\"SubDbs\\": {\\n \\"key\\": [\\n {\\n \\"ClusterName\\": \\"cluster_name\\",\\n \\"TenantName\\": \\"tenant_name\\",\\n \\"DatabaseId\\": \\"null\\",\\n \\"DatabaseName\\": \\"db_name\\",\\n \\"MappingDatabaseName\\": \\"mapped_db\\",\\n \\"SourceClientId\\": \\"null\\",\\n \\"Tables\\": [\\n {\\n \\"TableId\\": \\"null\\",\\n \\"Database\\": \\"db_name\\",\\n \\"TableName\\": \\"table_name\\",\\n \\"MappingTableName\\": \\"mapped_name\\",\\n \\"Instance\\": \\"g_i4kat***\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"column_name\\",\\n \\"Position\\": 0,\\n \\"ColumnType\\": \\"null\\",\\n \\"RecordFieldType\\": \\"null\\",\\n \\"RawColumnType\\": \\"null\\",\\n \\"ColumnKey\\": \\"null\\",\\n \\"Nullable\\": false,\\n \\"DefaultValue\\": \\"null\\",\\n \\"DataLength\\": 0,\\n \\"DataPrecision\\": 64,\\n \\"DataScale\\": 0,\\n \\"Encoding\\": \\"utf8\\",\\n \\"ColumnComment\\": \\"comments\\",\\n \\"IsGenerateField\\": false\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"SubConds\\": {\\n \\"key\\": [\\n {\\n \\"TenantName\\": \\"tenant_name\\",\\n \\"Database\\": \\"db_name\\",\\n \\"DestDatabase\\": \\"dest_db\\",\\n \\"TableName\\": \\"table_name\\",\\n \\"DestName\\": \\"dest_name\\",\\n \\"WhereClause\\": \\"id>1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"LogicTableId\\": \\"null\\",\\n \\"SourceEndpointId\\": \\"null\\",\\n \\"SourceClientId\\": \\"null\\"\\n }\\n ]\\n },\\n \\"SubIds\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MaxConnectorCount\\": -1,\\n \\"StoreIncr\\": true,\\n \\"IncrSyncTimestamp\\": 1689244596\\n },\\n \\"AlarmStats\\": {\\n \\"Target\\": \\"null\\",\\n \\"Alarming\\": false,\\n \\"RecentlyTriggerCount\\": 0,\\n \\"RuleToRecentlyTriggerCount\\": {\\n \\"key\\": 0\\n },\\n \\"AlarmContent\\": \\"null\\",\\n \\"OpenMonitor\\": true\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeProject' => [ + 'summary' => '查询项目详情', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'np_fe****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111'."\n", + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => '473469C7-XXXX-XXXX-B3DB-A3DC0DE3C83E', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'WorkerGradeId' => [ + 'title' => '实例规格 ID', + 'description' => '', + 'type' => 'string', + 'example' => 'g_i4wa7XXX'."\n", + ], + 'WorkerGradeInfo' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'ID', + 'type' => 'string', + ], + 'Name' => [ + 'title' => '别名', + 'type' => 'string', + ], + 'Grade' => [ + 'title' => '规格', + 'type' => 'string', + ], + 'Spec' => [ + 'title' => '规格大小', + 'type' => 'string', + ], + 'SpecName' => [ + 'title' => '规格大小名称', + 'type' => 'string', + ], + 'SourceType' => [ + 'title' => '源端数据源类型', + 'type' => 'string', + ], + 'SourceRegion' => [ + 'title' => '源端数据源地域', + 'type' => 'string', + ], + 'DestType' => [ + 'title' => '目标端数据源类型', + 'type' => 'string', + ], + 'DestRegion' => [ + 'title' => '目标端数据源地域', + 'type' => 'string', + ], + 'ChargeType' => [ + 'title' => '计费方式', + 'type' => 'string', + ], + 'AutoRenewal' => [ + 'type' => 'boolean', + ], + 'Expired' => [ + 'type' => 'boolean', + ], + 'EndTime' => [ + 'title' => '到期时间，UTC时间', + 'type' => 'string', + ], + 'GmtCreate' => [ + 'title' => '创建时间，UTC时间', + 'type' => 'string', + ], + ], + ], + 'Id' => [ + 'title' => '项目 id', + 'description' => '', + 'type' => 'string', + 'example' => 'np_fe****', + ], + 'Type' => [ + 'title' => '类型 (MIGRATION: 数据迁移任务, SYNC: 数据同步任务)', + 'description' => '', + 'type' => 'string', + 'example' => 'SYNC', + ], + 'Name' => [ + 'title' => '项目名称', + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'Labels' => [ + 'title' => '标签id集合', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '标签id', + 'description' => '', + 'type' => 'string', + 'example' => 'l_dr****', + ], + 'Name' => [ + 'title' => '标签名称', + 'description' => '', + 'type' => 'string', + 'example' => 'test_tag', + ], + ], + ], + ], + 'Owner' => [ + 'title' => '项目owner', + 'description' => '', + 'type' => 'string', + 'example' => 'omsefry***', + ], + 'Importance' => [ + 'title' => '项目告警等级 (HIGH: 高保护状态, MEDIUM: 中保护状态, LOW: 低保护状态, IGNORE: 无保护状态)', + 'description' => '', + 'type' => 'string', + 'example' => 'HIGH', + ], + 'Status' => [ + 'title' => '项目状态 (INIT: 未启动, RUNNING: 运行中, SUSPEND: 暂停中, FAILED: 已失败, FINISHED: 已完成, RELEASING: 释放中, RELEASED: 已释放, DELETED: 已删除, RUNNING_MODIFYING: 修改中, RUNNING_MERGING: 合并中)', + 'description' => '', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'GmtCreate' => [ + 'title' => '项目创建时间 UTC时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T06:26:15', + ], + 'GmtModified' => [ + 'title' => '项目更新时间 UTC时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T06:26:15'."\n", + ], + 'GmtStart' => [ + 'title' => '项目开始时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T07:02:27', + ], + 'GmtFinish' => [ + 'title' => '项目结束时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T07:02:27', + ], + 'DestConnId' => [ + 'title' => '目的连接信息ID', + 'description' => '', + 'type' => 'string', + 'example' => 'c_deg***', + ], + 'IsMerging' => [ + 'title' => '是否处于合并中', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false ', + ], + 'IsModifying' => [ + 'title' => '是否处于修改中', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false ', + ], + 'IsSubProject' => [ + 'title' => '是否子项目', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SourceEndpointType' => [ + 'title' => '源端数据源类型 (MYSQL, MARIADB, OB_MYSQL, OB_MYSQL_CE, OB_ORACLE, ORACLE, DB2_LUW, KAFKA, ROCKETMQ, DATAHUB, SYBASE, LOGPROXY, ADB, DBP_OP_ROUTE, DMS, IDB, TIDB, POSTGRESQL, POLARDB_X_1)', + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'POLARDB_X_1' => 'POLARDB_X_1', + 'MYSQL' => 'MYSQL', + 'TIDB' => 'TIDB', + 'OB_ORACLE' => 'OB_ORACLE', + 'OB_MYSQL' => 'OB_MYSQL', + 'ORACLE' => 'ORACLE', + 'POLARDB_X_2' => 'POLARDB_X_2', + ], + 'example' => 'OB_MYSQL', + ], + 'SinkEndpointType' => [ + 'title' => '目的端数据源 id (MYSQL, MARIADB, OB_MYSQL, OB_MYSQL_CE, OB_ORACLE, ORACLE, DB2_LUW, KAFKA, ROCKETMQ, DATAHUB, SYBASE, LOGPROXY, ADB, DBP_OP_ROUTE, DMS, IDB, TIDB, POSTGRESQL, POLARDB_X_1)', + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'MYSQL' => 'MYSQL', + 'OB_ORACLE' => 'OB_ORACLE', + 'KAFKA' => 'KAFKA', + 'ROCKETMQ' => 'ROCKETMQ', + 'DATAHUB' => 'DATAHUB', + 'OB_MYSQL' => 'OB_MYSQL', + 'ORACLE' => 'ORACLE', + 'ADB' => 'ADB', + ], + 'example' => 'MYSQL', + ], + 'TransferMapping' => [ + 'title' => '传输对象和映射关系', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Mode' => [ + 'title' => '传输对象映射模式 (SPECIFIC, WILDCARD)', + 'description' => '', + 'type' => 'string', + 'example' => 'SPECIFIC', + ], + 'Databases' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MYSQL', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'db_id', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'db_name', + ], + 'MappedName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_db', + ], + 'TenantName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tenant_name', + ], + 'Tables' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'table_name', + ], + 'MappedName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_table', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'id > 1', + ], + 'FilterColumns' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'ShardColumns' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col1', + ], + ], + 'AdbTableSchema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pk', + ], + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col2', + ], + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PARTITION BY VALUE(\'id\')', + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + ], + ], + ], + ], + ], + 'Views' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'view_name', + ], + 'MappedName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_view', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'fexdg***', + ], + 'WhereClause' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'id < 1', + ], + 'FilterColumns' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'ShardColumns' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col1', + ], + ], + 'AdbTableSchema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pk', + ], + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col2', + ], + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PARTITION BY VALUE(\'id\')'."\n", + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + ], + ], + ], + ], + ], + 'SpecificTables' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'table_name', + ], + 'MappedName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_table', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'id>1', + ], + 'FilterColumns' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'ShardColumns' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'AdbTableSchema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PARTITION BY VALUE(\'id\')'."\n", + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + ], + ], + ], + ], + ], + 'SpecificViews' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'view_name', + ], + 'MappedName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_name', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'view_id', + ], + 'WhereClause' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'id<3', + ], + 'FilterColumns' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'ShardColumns' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'AdbTableSchema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pk', + ], + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PARTITION BY VALUE(\'id\')'."\n", + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'DatabasesBlack' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DATABASE', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'db_id', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'db_name', + ], + 'MappedName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_db', + ], + 'TenantName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_tenant', + ], + 'Tables' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'table_name', + ], + 'MappedName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_table', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'id>1', + ], + 'FilterColumns' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'ShardColumns' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'AdbTableSchema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pk', + ], + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PARTITION BY VALUE(\'id\')'."\n", + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + ], + ], + ], + ], + ], + 'Views' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'view_name', + ], + 'MappedName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_name', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'view_id', + ], + 'WhereClause' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'id>2', + ], + 'FilterColumns' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'ShardColumns' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'AdbTableSchema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pk', + ], + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PARTITION BY VALUE(\'id\')'."\n", + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + ], + ], + ], + ], + ], + 'SpecificTables' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'table_name', + ], + 'MappedName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_table', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'id<3', + ], + 'FilterColumns' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'ShardColumns' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'AdbTableSchema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pk', + ], + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PARTITION BY VALUE(\'id\')'."\n", + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + ], + ], + ], + ], + ], + 'SpecificViews' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'view_name', + ], + 'MappedName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_view', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'view_id', + ], + 'WhereClause' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'id>2', + ], + 'FilterColumns' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'ShardColumns' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'AdbTableSchema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pk', + ], + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PARTITION BY VALUE(\'id\')'."\n", + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'TableAndViewWhiteList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + ], + 'TableAndViewBlackList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + 'CommonTransferConfig' => [ + 'title' => '公共传输配置（所有步骤）', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TableCategory' => [ + 'title' => '传输的表类型', + 'description' => '', + 'type' => 'string', + 'example' => 'ALL', + ], + 'ActiveActive' => [ + 'title' => '是否双活场景', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MqSerializerType' => [ + 'title' => '投递到消息队列时，数据 json 序列化类型', + 'description' => '', + 'type' => 'string', + 'example' => 'DEFAULT', + ], + 'MqPartitionMode' => [ + 'title' => '投递到消息队列时，分区路由方式', + 'description' => '', + 'type' => 'string', + 'example' => 'ONE', + ], + 'MqPartition' => [ + 'title' => '当 partitionMode 为 ONE 时，此参数表示投递分区的在当前 topic 下的位置', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DatahubTopicType' => [ + 'title' => '投递到消息队列时，指定 topic 的类型', + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'BLOB' => 'BLOB', + 'TUPLE' => 'TUPLE', + ], + 'example' => 'TUPLE', + ], + 'RocketMqProducerGroup' => [ + 'title' => '指定生产组名(目标端为 ROCKETMQ 时生效),默认 OMS', + 'description' => '', + 'type' => 'string', + 'example' => 'OMS', + ], + 'RocketMqMsgTags' => [ + 'title' => '设置消息 tag(目标端为 ROCKETMQ 时生效)，默认 default -> default_tag', + 'description' => '', + 'type' => 'string', + 'example' => 'default_tag', + ], + 'RocketMqEnableMsgTrace' => [ + 'title' => '是否开启消息追踪(目标端为 ROCKETMQ 时生效)', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RocketMqSendMsgTimeout' => [ + 'title' => '设置消息投递超时时间(目标端为 ROCKETMQ 时生效)', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'null', + ], + 'DataWorksBusinessName' => [ + 'title' => '业务系统标识(可选)', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'SinkStoreFormat' => [ + 'title' => '业务系统标识(可选)', + 'type' => 'string', + ], + 'SourceStoreFormat' => [ + 'title' => '业务系统标识(可选)', + 'type' => 'string', + ], + ], + ], + 'EnableStructTransfer' => [ + 'title' => '是否启用结构传输', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'StructTransferConfig' => [ + 'title' => '结构传输配置', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ByteCharConvertStrategy' => [ + 'title' => 'byte/char 转换方案', + 'description' => '', + 'type' => 'string', + 'example' => 'DO_NOTHING_IF_BYTE_USED', + ], + 'DeferIndexCreation' => [ + 'title' => '是否允许索引后置（默认不允许）', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'EnableFullTransfer' => [ + 'title' => '是否启用全量传输', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableFullVerify' => [ + 'title' => '是否启用全量校验', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'FullTransferConfig' => [ + 'title' => '全量传输配置', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NonePkUkTruncateDstTable' => [ + 'title' => '在处理源端无唯一索引表德的全量迁移时，是否 truncate 目标表（清空目标表数据）,组件层面默认为 true', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'AllowDestTableNotEmpty' => [ + 'title' => '允许目标端表非空，在源端多个分表向目标端一张表聚合迁移时，需要打开', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'FullTransferSpeedMode' => [ + 'title' => '全量迁移 配置(STEADY：平稳，NORMAL：正常，FAST：快速)。', + 'description' => '', + 'type' => 'string', + 'example' => 'FAST', + ], + 'FullVerifySpeedMode' => [ + 'title' => '全量校验 配置(STEADY：平稳，NORMAL：正常，FAST：快速)。', + 'description' => '', + 'type' => 'string', + 'example' => 'FAST', + ], + 'WriteWorkerNum' => [ + 'title' => '写入并发数', + 'type' => 'integer', + 'format' => 'int32', + ], + 'ReadWorkerNum' => [ + 'title' => '读取并发数', + 'type' => 'integer', + 'format' => 'int32', + ], + 'ThrottleRps' => [ + 'title' => '限制RPS', + 'type' => 'integer', + 'format' => 'int32', + ], + 'ThrottleIOPS' => [ + 'title' => '限制流量，单位字节', + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'EnableIncrTransfer' => [ + 'title' => '是否启用增量传输', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableIncrVerify' => [ + 'title' => '是否启用增量校验', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableReverseIncrTransfer' => [ + 'title' => '是否启用反向增量传输', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IncrTransferConfig' => [ + 'title' => '增量配置', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'StartTimestamp' => [ + 'title' => '勾选了增量且没勾选全量时，允许设置增量起始位点，秒级时间戳', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1667286900', + ], + 'RecordTypeWhiteList' => [ + 'title' => '有增量同步阶段时，同步的增量数据类型', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'DELETE' => 'DELETE', + 'COMMIT' => 'COMMIT', + 'INSERT' => 'INSERT', + 'UPDATE' => 'UPDATE', + 'BEGIN' => 'BEGIN', + 'ROW' => 'ROW', + 'HEARTBEAT' => 'HEARTBEAT', + 'DDL' => 'DDL', + 'ROLLBACK' => 'ROLLBACK', + ], + 'example' => 'INSERT', + ], + ], + 'StoreLogKeptHour' => [ + 'title' => '有增量同步阶段，且增量日志拉取组件为 Store 时，日志保存时间, 单位小时，默认7天，最长365天', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '24', + ], + 'EnableSequencingWithinTxn' => [ + 'title' => '有增量同步阶段时，且增量日志拉取组件为 Store 时，是否开启事务内序号编排', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IncrSyncConcurrency' => [ + 'title' => '增量同步线程数，默认64', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '64', + ], + 'EnableIncrSyncStatistics' => [ + 'title' => '是否开启增量记录(dml\\ddl)统计', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ThrottleRps' => [ + 'title' => '限制RPS', + 'type' => 'integer', + 'format' => 'int32', + ], + 'ThrottleIOPS' => [ + 'title' => '限制流量，单位字节', + 'type' => 'integer', + 'format' => 'int32', + ], + 'SupportDDLTypes' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'ReverseIncrTransferConfig' => [ + 'title' => '反向增量配置', + 'type' => 'object', + 'properties' => [ + 'StartTimestamp' => [ + 'title' => '勾选了增量且没勾选全量时，允许设置增量起始位点，秒级时间戳', + 'type' => 'integer', + 'format' => 'int64', + ], + 'RecordTypeWhiteList' => [ + 'title' => '有增量同步阶段时，同步的增量数据类型', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'StoreLogKeptHour' => [ + 'title' => '有增量同步阶段，且增量日志拉取组件为 Store 时，日志保存时间, 单位小时，默认7天，最长365天', + 'type' => 'integer', + 'format' => 'int32', + ], + 'EnableSequencingWithinTxn' => [ + 'title' => '有增量同步阶段时，且增量日志拉取组件为 Store 时，是否开启事务内序号编排', + 'type' => 'boolean', + ], + 'IncrSyncConcurrency' => [ + 'title' => '增量同步线程数，默认64', + 'type' => 'integer', + 'format' => 'int32', + ], + 'EnableIncrSyncStatistics' => [ + 'title' => '是否开启增量记录(dml\\ddl)统计', + 'type' => 'boolean', + ], + 'ThrottleRps' => [ + 'title' => '限制RPS', + 'type' => 'integer', + 'format' => 'int32', + ], + 'ThrottleIOPS' => [ + 'title' => '限制流量，单位字节', + 'type' => 'integer', + 'format' => 'int32', + ], + 'SupportDDLTypes' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'SourceConnectInfo' => [ + 'title' => '源端节点连接信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '连接信息ID', + 'description' => '', + 'type' => 'string', + 'example' => 'c_feg****', + ], + 'EndpointName' => [ + 'title' => '终端节点名', + 'description' => '', + 'type' => 'string', + 'example' => 'migon****', + ], + 'EndpointId' => [ + 'title' => '终端节点id', + 'description' => '', + 'type' => 'string', + 'example' => 'e_3kx5i***1s', + ], + 'EndpointSide' => [ + 'title' => '终端节点类型（source 源端，dest 目的端） （后续set进去，库中不存储） (SOURCE, DEST)', + 'description' => '', + 'type' => 'string', + 'example' => 'source', + ], + 'DbEngine' => [ + 'title' => '终端节点数据库引擎 (MYSQL_PUBLIC, MYSQL_VPC, MYSQL_DG, OB_MYSQL_CE_PUBLIC, OB_MYSQL: 公有云服务 OB 集群, OB_ORACLE, OB_MYSQL_TENANT: 公有云服务 OB 集群租户模式, OB_ORACLE_TENANT, POSTGRESQL_PUBLIC, OB_MYSQL_VPC: 用户VPC内自建OB集群，非公有云自有OB, OB_ORACLE_VPC, OB_MYSQL_PUBLIC: 公网 OB 集群, OB_ORACLE_PUBLIC, ORACLE_PUBLIC, ORACLE_VPC, ORACLE_DG, RDS_MYSQL, POLAR_MYSQL, ADB_MYSQL, TIDB_PUBLIC, TIDB_VPC, KAFKA_ALIYUN, KAFKA_VPC, KAFKA_PUBLIC, ROCKETMQ_PUBLIC, ROCKETMQ_ALIYUN, ROCKETMQ_VPC, DB2_LUW_PUBLIC, SYBASE_PUBLIC, DATAHUB_PUBLIC, DATAHUB_ALIYUN, DATAHUB_VPC, DBP_OP_ROUTE, DMS, IDB, POLARDB_X_1_ALIYUN, AURORA_MYSQL_PRIVATE_LINK, AURORA_MYSQL_PUBLIC, AURORA_MYSQL_PEERING)', + 'description' => '', + 'type' => 'string', + 'example' => 'OB_MYSQL_PUBLIC', + ], + 'ConnectionInfo' => [ + 'title' => '终端节点连接信息', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'Username' => [ + 'title' => '连接用户名', + 'description' => '', + 'type' => 'string', + 'example' => 'oms2027obmysql@oms_***', + ], + 'Version' => [ + 'title' => '数据库版本', + 'description' => '', + 'type' => 'string', + 'example' => '2.2.77', + ], + 'Timezone' => [ + 'title' => '数据库时区', + 'description' => '', + 'type' => 'string', + 'example' => '+08:00', + ], + 'Charset' => [ + 'title' => '编码', + 'description' => '', + 'type' => 'string', + 'example' => 'utf8mb4', + ], + 'NlsLengthSemantics' => [ + 'title' => 'nls_length_semantics 属性，只针对 oracle、ob-oracle。', + 'description' => '', + 'type' => 'string', + 'example' => 'null'."\n", + ], + 'OperatingSystem' => [ + 'title' => '操作系统(OB 没有)。', + 'description' => '', + 'type' => 'string', + 'example' => 'Linux', + ], + 'Region' => [ + 'title' => '地域属性', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'OcpName' => [ + 'title' => 'ocp name 属性，记录 ocp。', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ConnExtraAttributes' => [ + 'title' => '', + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + 'Owner' => [ + 'title' => 'owner', + 'description' => 'Owner。', + 'type' => 'string', + 'example' => 'oms_test', + ], + 'ResourceOwner' => [ + 'title' => '资源所有者uid', + 'description' => '', + 'type' => 'string', + 'example' => '1325847***'."\n", + ], + 'Host' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1', + ], + 'Port' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2883', + ], + ], + ], + 'SinkConnectInfo' => [ + 'title' => '目的端节点连接信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '连接信息ID', + 'description' => '', + 'type' => 'string', + 'example' => 'e_4lgzuzi9znr4', + ], + 'EndpointName' => [ + 'title' => '终端节点名', + 'description' => '', + 'type' => 'string', + 'example' => 'RATION12948*****', + ], + 'EndpointId' => [ + 'title' => '终端节点id', + 'description' => '', + 'type' => 'string', + 'example' => 'e_4w1q****', + ], + 'EndpointSide' => [ + 'title' => '终端节点类型（source 源端，dest 目的端） （后续set进去，库中不存储） (SOURCE, DEST)', + 'description' => '', + 'type' => 'string', + 'example' => 'sink', + ], + 'DbEngine' => [ + 'title' => '终端节点数据库引擎 (MYSQL_PUBLIC, MYSQL_VPC, MYSQL_DG, OB_MYSQL_CE_PUBLIC, OB_MYSQL: 公有云服务 OB 集群, OB_ORACLE, OB_MYSQL_TENANT: 公有云服务 OB 集群租户模式, OB_ORACLE_TENANT, POSTGRESQL_PUBLIC, OB_MYSQL_VPC: 用户VPC内自建OB集群，非公有云自有OB, OB_ORACLE_VPC, OB_MYSQL_PUBLIC: 公网 OB 集群, OB_ORACLE_PUBLIC, ORACLE_PUBLIC, ORACLE_VPC, ORACLE_DG, RDS_MYSQL, POLAR_MYSQL, ADB_MYSQL, TIDB_PUBLIC, TIDB_VPC, KAFKA_ALIYUN, KAFKA_VPC, KAFKA_PUBLIC, ROCKETMQ_PUBLIC, ROCKETMQ_ALIYUN, ROCKETMQ_VPC, DB2_LUW_PUBLIC, SYBASE_PUBLIC, DATAHUB_PUBLIC, DATAHUB_ALIYUN, DATAHUB_VPC, DBP_OP_ROUTE, DMS, IDB, POLARDB_X_1_ALIYUN, AURORA_MYSQL_PRIVATE_LINK, AURORA_MYSQL_PUBLIC, AURORA_MYSQL_PEERING)', + 'description' => '', + 'type' => 'string', + 'example' => 'MYSQL_PUBLIC', + ], + 'ConnectionInfo' => [ + 'title' => '终端节点连接信息', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'Username' => [ + 'title' => '连接用户名', + 'description' => '', + 'type' => 'string', + 'example' => 'oms2027obmysql@oms_***'."\n", + ], + 'Version' => [ + 'title' => '数据库版本', + 'description' => '', + 'type' => 'string', + 'example' => '2.2.77', + ], + 'Timezone' => [ + 'title' => '数据库时区', + 'description' => '', + 'type' => 'string', + 'example' => '+08:00', + ], + 'Charset' => [ + 'title' => '编码', + 'description' => '', + 'type' => 'string', + 'example' => 'utf8mb4', + ], + 'NlsLengthSemantics' => [ + 'title' => 'nls_length_semantics 属性，只针对 oracle、ob-oracle。', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'OperatingSystem' => [ + 'title' => '操作系统(OB 没有)。', + 'description' => '', + 'type' => 'string', + 'example' => 'Linux', + ], + 'Region' => [ + 'title' => '地域属性', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'OcpName' => [ + 'title' => 'ocp name 属性，记录 ocp。', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ConnExtraAttributes' => [ + 'title' => '', + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + 'Owner' => [ + 'title' => 'owner', + 'description' => 'Owner。', + 'type' => 'string', + 'example' => 'oms_test', + ], + 'ResourceOwner' => [ + 'title' => '资源所有者uid', + 'description' => '', + 'type' => 'string', + 'example' => '1325847***'."\n", + ], + 'Host' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1'."\n", + ], + 'Port' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2883', + ], + ], + ], + 'Steps' => [ + 'title' => '步骤列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Order' => [ + 'title' => '步骤顺序', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Name' => [ + 'title' => '步骤名 (PRE_CHECK, TRANSFER_PRECHECK, PREPARE, STRUCT_TRANSFER, STRUCT_MIGRATION, INDEX_MIGRATION, INDEX_TRANSFER, STRUCT_SYNC, FULL_MIGRATION, FULL_TRANSFER, APP_SWITCH, TRANSFER_APP_SWITCH, REVERSE_INCR_SYNC, REVERSE_INCR_TRANSFER, FULL_VALIDATION, FULL_VERIFIER, INCR_LOG_PULL, TRANSFER_INCR_LOG_PULL, INCR_SYNC, INCR_TRANSFER, INCR_VERIFIER, SYNC_PREPARE, TRANSFER_PREPARE, SYNC_INCR_LOG_PULL, CONNECTOR_FULL_SYNC, CONNECTOR_INCR_SYNC)', + 'description' => '', + 'type' => 'string', + 'example' => 'PRE_CHECK', + ], + 'Description' => [ + 'title' => '步骤描述（预检查/结构迁移/结构同步/全量迁移/全量同步/全量校验/索引迁移/增量日志拉取/增量同步/增量校验/正向切换）', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Status' => [ + 'title' => '步骤状态 (INIT: 初始化, RUNNING: 运行中, FAILED: 失败, FINISHED: 已完成, SUSPEND: 暂停中, MONITORING: 持续监控状态，用于增量同步和增量校验的持续监控态)', + 'description' => '', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'ExtraInfo' => [ + 'title' => '补充信息（json）', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ErrorDetails' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => ' '."\n" + .'CM-RESOAT1111'."\n", + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => 'FATAL, ERROR, WARNING, CRITICAL', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + 'example' => 'null', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. '."\n" + ."\n", + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + 'ErrorCode' => [ + 'title' => '错误码 (AUTHENTICATION_ERROR, PARAM_ERROR, PARAM_ERROR_MESSAGE, NOT_IMPLEMENTED_ERROR, SHARD_COLUMNS_CONFLICT_MESSAGE, FAILED_PARSE_TOKEN_MESSAGE, CONNECT_CHECK_ERROR, NOT_SUPPORT_ERROR, CE_NOT_SUPPORT_ERROR, NOT_FOUND_ERROR, SHARDING_COLUMN_NOT_INCLUDED_ERROR, INNER_ERROR, OMS_META_DB_ACCESS_FAILED, DB_QUERY_ERROR, DATAHUB_QUERY_ERROR, USER_LACK_SYS_PRIV_ERROR, USER_LACK_TABLE_PRIV_ERROR, RM_API_ERROR, RM_TASK_ERROR, CM_API_ERROR, CM_API_NOT_SUCCESS, BAGUALU_API_ERROR, IDB_API_ERROR, SUPERVISOR_API_ERROR, OCP_API_ERROR, OCP_SERVICE_ERROR, OCP_QUERY_VERSION_FAILED, OCP_VERSION_INCORRECT_ERROR, OCP_VERSION_NOT_SUPPORTED_ERROR, OCP_API_USER_PASSWORD_INCORRECT_ERROR, OBSCHEMA_ERROR, EXECUTOR_THREAD_POOL_BUSY, NO_TABLE_SELECTED, NO_VIEW_SELECTED, SOURCE_CRAWLER_START_FAILED, SOURCE_CRAWLER_START_FAILED_DATA_EXPIRED, SOURCE_CRAWLER_START_TIMEOUT, DEST_WRITER_START_FAILED, WRITER_UNKNOWN_STATUS, DRC_TOPIC_EXISTS_ERROR, TOPIC_EMPTY_ERROR, REACH_WRITER_LIMIT_ERROR, FOUND_NO_FEASIBLE_STORE_ERROR, TOO_MANY_STORES_FOR_SUBTOPIC, TIMEOUT_EXCEPTION, KIPP_API_ERROR: KIPP 相关错误信息, KIPP_API_RESOURCE_NOT_FOUND, KIPP_API_INVALID_PARAM, KIPP_API_UNKNOWN_ERROR, KIPP_API_INTERNAL_ERROR, KIPP_API_SERVICE_UNAVAILABLE, OMS_AGENT_API_ERROR, KMS_API_ERROR, OMS_ENCRYPT_API_ERROR, OMS_DECRYPT_API_ERROR, ALIYUN_SDK_ERROR, YAOCHI_API_ERROR, AWS_SDK_ERROR, AWS_PRIVATE_LINK_SERVICE_INITIALIZING_ERROR, AWS_PRIVATE_LINK_SERVICE_UNAVAILABLE_ERROR, AWS_PRIVATE_LINK_SERVICE_NEED_ACCEPTANCE_ERROR, UNSUPPORTED_AWS_SERVICE_ERROR, RESOURCE_WITHOUT_STOCK_ERROR, RESOURCE_NO_AVAILABLE_ZONE, CM_SDK_ERROR, MIGRATION_PROJECT_STEP_PRECHECK_FAILED, PRE_CHECK_ERROR, FAILURES_CORRECT_ERROR, EXECUTE_DDL_FAILURE, EXECUTE_DDL_UNSUPPORTED_OR_FAILURE, STRUCT_RECORD_DDL_NOT_FOUND, STRUCT_RECORD_INDEX_NOT_FOUND, STRUCT_RECORD_NOT_FOUND, STRUCT_RECORD_NOT_FOUND_IN_DBCAT, STRUCT_RECORD_NOT_FOUND_IN_DBCAT_PUBLIC, SCHEMA_OBJECT_TYPE_NOT_SUPPORT_ERROR, POLAR_MYSQL_NETWORK_TYPE_NOT_SUPPORT_ERROR, RDS_NETWORK_TYPE_NOT_SUPPORT_ERROR, RDS_VPC_NETWORK_NOT_SUPPORT_ERROR, DB_TYPE_NOT_SUPPORT_ERROR, SYNC_TYPE_NOT_SUPPORT_ERROR, SLAVE_OPERATION_STEP_NOT_SUPPORT_ERROR, BYTE_USED_TYPE_NOT_SUPPORT_ERROR, MANY_TO_ONE_SCHEMA_TABLE_REVERSE_INCR_NOT_SUPPORT_ERROR, MANY_TO_ONE_SCHEMA_REVERSE_INCR_NOT_SUPPORT_ERROR, DUPLICATE_SCHEMA_TABLE_ERROR, OMS_STEP_NOT_SUPPORT_ERROR, ORACLE_DATABASE_ROLE_NOT_SUPPORT_ERROR, OLD_PRE_CHECK_NOT_SUPPORT_ERROR, SCHEMA_ONE_TO_MANY_NOT_SUPPORT_ERROR, PROJECT_NOT_FOUND_ERROR, SYNC_PROJECT_NOT_FOUND_ERROR, ENDPOINT_NOT_FOUND_ERROR, ENDPOINT_NAME_ALREADY_EXIST_ERROR, ENDPOINT_QUERY_ERROR, ENDPOINT_SQL_QUERY_ERROR, PROJECT_NAME_ALREADY_EXIST_ERROR, CHECKER_NOT_FOUND_ERROR, CHECKER_FAILED_ERROR, CHECKER_STATUS_UNEXPECTED_ERROR, CHECKER_NO_TASK_TYPE_ERROR, WORKER_INSTANCE_NOT_FOUND_ERROR, WORKER_INSTANCE_ALLOCATING_ERROR, LOG_SERVICE_TOPIC_NOT_FOUND_ERROR, CLUSTER_NOT_FOUND_ERROR, TENANT_NOT_FOUND_ERROR, DATABASE_NOT_FOUND_ERROR, TABLE_NOT_FOUND_ERROR, COLUMN_NOT_FOUND_ERROR, TABLE_META_NOT_FOUND_ERROR, SYBASE_CHARSET_NOT_FOUND_ERROR, OCP_NOT_FOUND_ERROR, REGION_NOT_FOUND_ERROR, OCP_ALREADY_EXIST_ERROR, ALARM_CHANNEL_NAME_ALREADY_EXIST_ERROR, SEND_MARKDOWN_TEXT_TO_WEBHOOK_FAILED_EXCEPTION_RESPONSE, SEND_MARKDOWN_TEXT_TO_WEBHOOK_FAILED_EXCEPTION_STATUS, LABEL_ALREADY_EXIST_ERROR, LABEL_NOT_EXIST_ERROR, OCP_ALREADY_USED_ERROR, REGION_INFO_INCONSISTENT_ERROR, OCP_NAME_EMPTY_ERROR, MASTER_SLAVE_ENDPOINT_NAME_INCONSISTENT_ERROR, LOG_FILE_NOT_FOUND_ERROR, CHECKER_METRICS_LOG_FILE_NOT_FOUND_ERROR, OPERATION_NOT_ALLOWED_ERROR, PROJECT_OPERATION_NOT_ALLOWED_ERROR, PROJECT_RELEASE_FAILED, STRUCT_MIGRATION_RETRY_NOT_ALLOWED_ERROR, WORKER_INSTANCE_OPERATION_NOT_ALLOWED_ERROR, USER_OPERATION_NOT_ALLOWED_ERROR, OCP_NAME_OR_REGION_NOT_ALLOWED_UPDATE, UPDATE_CONFIG_WITH_NEWLINE_NOT_ALLOWED, EXIST_UNRELEASED_PROJECT_ERROR, EXIST_UNRELEASED_TOPIC_ERROR, LABEL_CREATE_NOT_ALLOWED_ERROR, LABEL_UPDATE_NOT_ALLOWED_ERROR, LABEL_DELETE_NOT_ALLOWED_ERROR, TOPIC_NAME_INVALID_ERROR, MAPPING_INVALID_ERROR, INVALID_STATUS_ERROR, INVALID_CSV_HEAD_ERROR, INVALID_CSV_BODY_ERROR, DUPLICATE_SCHEMA_TABLE_SETTING_ERROR, MULTIPLE_TABLES_NOT_ALLOWED_ERROR, PROJECT_INVALID_STATUS_ERROR, PROJECT_INVALID_CONNECTOR_COUNT_ERROR, WORKER_INSTANCE_INVALID_STATUS_ERROR, LOG_SERVICE_INVALID_STATUS_ERROR, STEP_INVALID_STATUS_ERROR, UPDATE_ALLOW_DEST_TABLE_NOT_EMPTY_NOT_ALLOWED_ERROR, EXIST_INCONSISTENCY_ERROR, OMS_SWITCH_SUBSTEP_FAILED_ERROR, ENDPOINT_ID_INVALID_ERROR, DB_QUERY_VERSION_EMPTY_ERROR, ENDPOINT_NAME_INVALID_ERROR, CLOUD_ENDPOINT_NAME_INVALID_ERROR, ENDPOINT_SCHEMA_NOT_ALLOWED_ERROR, ENDPOINT_USERNAME_NOT_ALLOWED_ERROR, ENDPOINT_SCHEMA_CHAR_NOT_ALLOWED_ERROR, NAME_HAS_SPACE_EXCEPTION, CONFIG_CONVERT_VALUE_ERROR, CONFIG_VALUE_EXCEEDS_LIMIT_ERROR, CONFIG_KEY_NOT_FOUND_KEY_ERROR, CONFIG_VALUE_NOT_EMPTY_ERROR, SCHEMA_HAS_CONVERT_INFO, TIME_SERIES_QUERY_SERVICE_ERROR, ETL_VERIFY_ERROR, ETL_SYNTAX_UNSUPPORTED, ETL_FIELD_NOTFOUND, ETL_FAILED_PARSE_SQL, ETL_VAL_TYPE_ERROR, NOT_SUPPORT_GENERATE_COLUMNS, NOT_SUPPORT_UPDATE_ETL, LOCK_FAILED, OMS_USER_EXIST_ERROR, OMS_USER_NOT_FOUND_ERROR, OMS_USER_NAME_LENGTH_CONSTRAINT, OMS_USER_EMAIL_LENGTH_CONSTRAINT: 用户名, OMS_USER_PASSWORD_ERROR, LOGIN_EXPIRE, USER_NAME_OR_PASSWORD_ERROR, USER_NAME_OR_PASSWORD_LOGIN_FAILURE_TIMES_ERROR: 用户名或密码错误: 您的用户将在, OMS_USER_PASSWORD_HAS_EXPIRED_ERROR, OMS_USER_ROOT_PASSWORD_HAS_EXPIRED_ERROR, OMS_USER_PASSWORD_LOCKED_ERROR, OMS_USER_ROOT_PASSWORD_LOCKED_ERROR, OMS_USER_PASSWORD_VALIDATION_ERROR, OMS_USER_PASSWORD_DEFAULT_ERROR, CAPTCHA_EXPIRE_KEY, CAPTCHA_ERROR_KEY, OMS_USER_PERMISSION_DENIED_ERROR, OMS_USER_NOT_ACTIVE, OMS_USER_EDIT_ADMIN_ROLE_INFO_PERMISSION_DENIED_ERROR, OMS_USER_ILLEGAL_DELETED_ERROR, OMS_USER_FORBID_DELETED_ERROR, OMS_DEPARTMENT_ALREADY_EXIST_ERROR, OMS_DEPARTMENT_MAXIMUM_LIMIT, OMS_DEPARTMENT_USER_NOT_EMPTY, CONNECTOR_TASK_DELETE_ERROR, METRIC_SERVICE_ERROR, SYNC_PROJECT_TYPE_INVALID_ERROR, SYNC_SHARDING_COLUMNS_INVALID_ERROR, SYNC_PROJECT_PRODUCER_GROUP_INVALID_ERROR, SYNC_PROJECT_PRODUCER_GROUP_LIMIT_EXCEEDS_ERROR, SYNC_PROJECT_COMPLEMENT_CONFIG_ERROR, META_SCHEMA_CREATE_FAILED, RESUME_STEP_FAILED, SCHEMA_INCONSISTENCY, SCHEMA_CASCADE_MAPPING_NOT_SUPPORT_ERROR, SCHEMA_NOT_EXISTED, SCHEMA_EXISTED, SCHEMA_NOT_EXIST, BLACK_LIST_MATCH_ALL, BLACK_LIST_CONTAIN_NON_WHITE_SCHEMA, OPERATOR_ERROR, OPERATOR_DIMENSION_NOT_SUPPORT, OPERATOR_PULL_LOG_ERROR, OPERATOR_UPDATE_CONFIG_NOT_SUPPORT, UPDATE_CONFIG_NOT_SUPPORT_BLANK_CHAR, UPDATE_CONFIG_INVALID_NOT_NUMBER, UPDATE_CHECKER_CONCURRENCY_CONFIG_NOT_SATISFY, KAFKA_CREATE_TOPIC_ERROR, KAFKA_QUERY_TOPIC_ERROR, KAFKA_BUILD_PROPERTIES_ERROR, KAFKA_CHECK_SASL_USER_ERROR, ROCKETMQ_CREATE_TOPIC_ERROR, ROCKETMQ_QUERY_TOPIC_ERROR, SYNC_OBJECT_EMPTY_ERROR, WRITER_NUMBER_NOT_UNIQUE, WRITER_NOT_ACTIVE, PROJECT_NAME_DUPLICATE_ERROR, EMPTY_FAILED_STRUCT_MIGRATION_TABLES_ERROR, LOGIC_TABLE_NOT_SUPPORT_UPDATE_OBJECT_ERROR, LOGIC_REQUEST_ERROR, LOGIC_DTO_BUILD_ERROR, UNEXPECTED_REMOTE_API_RESULT, OCEANBASE_USER_UNEXPECTED, STORE_CREATE_FAILED_ERROR, STORE_START_FAILED, STORE_NOT_PULL_LOG_ERROR, ALL_HOSTS_STATUS_ERROR, ALARM_CHANNEL_NAME_LIST_DUPLICATE, ALARM_CHANNEL_NAME_LIST_CONFLICT, CUSTOMER_NOT_FOUND_ERROR, WORKER_ECS_NOT_FOUND_ERROR, WORKER_ECS_NOT_FOUND_FOR_USER_ERROR, WORKER_POD_NOT_FOUND_ERROR, WORKER_POD_NOT_FOUND_FOR_USER_ERROR, WORKER_INSTANCE_NOT_FOUND_ERROR_V2, WORKER_INSTANCE_NOT_FOUND_FOR_USER_ERROR, RELEASE_PLAN_CREATED_CONFLICT, INCR_SYNC_START_TIMESTAMP_INVALID, OMS_RESOURCE_OPERATION_BROKEN_ACCESS)', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'ErrorMsg' => [ + 'title' => '错误消息', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ErrorParam' => [ + 'title' => '错误相关参数', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'FailedTime' => [ + 'title' => '错误时间', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + 'StartTime' => [ + 'title' => '开始时间，UTC 格式："2020-05-22T17:04:18"', + 'description' => '', + 'type' => 'string', + 'example' => '2020-05-22T17:04:18', + ], + 'FinishTime' => [ + 'title' => '结束时间，UTC 格式："2020-05-22T17:04:18"', + 'description' => '', + 'type' => 'string', + 'example' => '2020-05-22T17:04:18', + ], + 'Progress' => [ + 'title' => '步骤进度', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'StepInfo' => [ + 'title' => '步骤详情,全量传输/增量传输/正向切换', + 'description' => '', + 'type' => 'object', + 'example' => '', + ], + ], + ], + ], + 'ExtraInfo' => [ + 'title' => '错误信息等补充信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RunningStep' => [ + 'title' => '正在处于 running step (PRE_CHECK, TRANSFER_PRECHECK, PREPARE, STRUCT_TRANSFER, STRUCT_MIGRATION, INDEX_MIGRATION, INDEX_TRANSFER, STRUCT_SYNC, FULL_MIGRATION, FULL_TRANSFER, APP_SWITCH, TRANSFER_APP_SWITCH, REVERSE_INCR_SYNC, REVERSE_INCR_TRANSFER, FULL_VALIDATION, FULL_VERIFIER, INCR_LOG_PULL, TRANSFER_INCR_LOG_PULL, INCR_SYNC, INCR_TRANSFER, INCR_VERIFIER, SYNC_PREPARE, TRANSFER_PREPARE, SYNC_INCR_LOG_PULL, CONNECTOR_FULL_SYNC, CONNECTOR_INCR_SYNC)', + 'description' => '', + 'type' => 'string', + 'example' => 'PRE-CHECK', + ], + 'RunningProgress' => [ + 'title' => 'running step 进度', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'MonitoringIncr' => [ + 'title' => '是否开始监控增量', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Subtopics' => [ + 'title' => '任务关联 store 的 subtopics', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + ], + 'ReverseSubtopics' => [ + 'title' => '任务关联反向 store 的 subtopics', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + ], + 'LogServiceStartCheckpoint' => [ + 'title' => '起始位点，对于', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1689214358', + ], + 'SourceStoreKeptHour' => [ + 'title' => '日志保存时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '24', + ], + 'SyncDelay' => [ + 'title' => '增量同步延时', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'null', + ], + 'SyncDelaySampleTimestamp' => [ + 'title' => '同步延迟的采集时间戳，秒级别', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1689214358', + ], + 'AccessObSource' => [ + 'title' => '是否能够直连OB源端，不能的话Store Source会变为LogProxy Source', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OverwriteConfig' => [ + 'title' => '是否允许完全覆盖更新配置', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IgnoreUnsupportDdl' => [ + 'title' => '对于connector，是否忽略不支持的ddl', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SubDbs' => [ + 'title' => '记录不同下游消费方的表配置，用于同步任务复用时的配置合并', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ClusterName' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'cluster_name', + ], + 'TenantName' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'tenant_name', + ], + 'DatabaseId' => [ + 'title' => '目前只有逻辑库才会具有 id，可能存在在一个 Endpoint 中库名相同，但是 id 不同，表示的是不同的 id 情况', + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + 'DatabaseName' => [ + 'title' => '数据库名称', + 'type' => 'string', + 'example' => 'db_name', + 'description' => '', + ], + 'MappingDatabaseName' => [ + 'title' => '数据库映射名', + 'type' => 'string', + 'description' => '', + 'example' => 'mapped_db', + ], + 'SourceClientId' => [ + 'title' => '用于标识是哪个 source client 来处理该 databaseName', + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + 'Tables' => [ + 'title' => '表名称', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableId' => [ + 'title' => '目前只有逻辑表才会存在 tableId，在逻辑表中可能存库表名完全相同，但是只能根据 id 才能区分的场景', + 'type' => 'string', + 'description' => '', + 'example' => 'fexg***', + ], + 'Database' => [ + 'title' => '库名称', + 'type' => 'string', + 'example' => 'db_name', + 'description' => '', + ], + 'TableName' => [ + 'title' => '表名', + 'type' => 'string', + 'description' => '', + 'example' => 'table_name', + ], + 'MappingTableName' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'mapped_table', + ], + 'Instance' => [ + 'title' => '逻辑表返回的 instance，只有逻辑表会存在, @link PhysicalTableDTO#url', + 'type' => 'string', + 'description' => '', + 'example' => 'g_i4kat***', + ], + 'Columns' => [ + 'title' => '表列信息，如果是逻辑表可能放在外层', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'title' => '列名', + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + 'Position' => [ + 'title' => '字段位置', + 'type' => 'integer', + 'format' => 'int32', + 'description' => '', + 'example' => 'null', + ], + 'ColumnType' => [ + 'title' => '列类型', + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + 'RecordFieldType' => [ + 'title' => '列类型引申 (INT8, INT16, INT24, INT32, INT64, BIGINT, BOOLEAN, FLOAT, DOUBLE, DECIMAL, NUMBER, MONEY, DEC_FLOAT, REAL, UCHAR_STRING, GRAPHIC_STRING, CHAR_STRING, NCHAR_STRING, VAR_GRAPHIC_STRING, VAR_UCHAR_STRING, VAR_STRING, VAR_CHAR_STRING, VAR_NCHAR_STRING, ROW_ID, UROWID, TEXT, UTEXT, TINY_TEXT, MEDIUM_TEXT, LONG_TEXT, BINARY_BYTES, VAR_BINARY_BYTES, RAW, LONG_RAW, BIT, VAR_BIT, BLOB, TINY_BLOB, MEDIUM_BLOB, LONG_BLOB, BFILE, IMAGE, JSONB, UUID, ENUM, SET, INTERVAL_DAY_TO_SECOND, INTERVAL_YEAR_TO_MONTH, INTERVAL_DATE_TIME, CLOB, NCLOB, XML, JSON, LONG_VAR_CHAR, LONG_VAR_GRAPHIC, GEOGRAPHY, GEOMETRY, POINT, LSEG, BOX, PATH, CIRCLE, LINESTRING, POLYGON, MULTIPOINT, MULTILINESTRING, MULTIPOLYGON, GEOMETRYCOLLECTION, CIDR, INET, MACADDR, MACADDR8, TSVERCTOR, TSQUERY, YEAR, DATE, MYSQL_NEW_DATE, TIME, TIME_WITH_NANOS, TIME_WITH_TIMEZONE, DATETIME, DATETIME_WITH_NONAS, TIMESTAMP_IN_LONG, TIMESTAMP_IN_LONG_WITH_NANOS, TIMESTAMP, TIMESTAMP_WITH_NANOS, TIMESTAMP_WITH_TIMEZONE, TIMESTAMP_WITH_LOCAL_TIMEZONE, ZONED_DATETIME, OID, REGCLASS, REGCOLLATION, REGCONFIG, REGDICTIONARY, REGNAMESPACE, REGOPER, REGOPERATOR, REGROLE, REGTYPE, INT4RANGE, INT8RANGE, NUMRANGE, TSRANGE, TSTZRANGE, DATERANGE, STRUCT, LIST, NULL, CUSTOM_TYPE, UNSUPPORTED_TYPE)', + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + 'RawColumnType' => [ + 'title' => '数据库记录的列类型原始字符串', + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + 'ColumnKey' => [ + 'title' => '索引类型 (PRI, UNI, MUL)', + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + 'Nullable' => [ + 'title' => '是否可为空', + 'type' => 'boolean', + 'example' => 'true', + 'description' => '', + ], + 'DefaultValue' => [ + 'title' => '默认值', + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + 'DataLength' => [ + 'title' => '字段长度', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'null', + 'description' => '', + ], + 'DataPrecision' => [ + 'title' => '精度', + 'type' => 'integer', + 'format' => 'int32', + 'description' => '', + 'example' => '64', + ], + 'DataScale' => [ + 'title' => '小数点', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + 'description' => '', + ], + 'Encoding' => [ + 'title' => '字符编码', + 'type' => 'string', + 'description' => '', + 'example' => 'utf8', + ], + 'ColumnComment' => [ + 'title' => '字段注释', + 'type' => 'string', + 'description' => '', + 'example' => 'comments', + ], + 'IsGenerateField' => [ + 'title' => '是否是隐藏列', + 'type' => 'boolean', + 'description' => '', + 'example' => 'false', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'SubConds' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TenantName' => [ + 'title' => '源端租户名称', + 'type' => 'string', + 'description' => '', + 'example' => 'tenant_name', + ], + 'Database' => [ + 'title' => '源端数据库名', + 'type' => 'string', + 'example' => 'db_name', + 'description' => '', + ], + 'DestDatabase' => [ + 'title' => '目标数据库名', + 'type' => 'string', + 'example' => 'dest_db', + 'description' => '', + ], + 'TableName' => [ + 'title' => '源端表名', + 'type' => 'string', + 'example' => 'table_name', + 'description' => '', + ], + 'DestName' => [ + 'title' => '目标端表名/Topic名', + 'type' => 'string', + 'example' => 'dest_name', + 'description' => '', + ], + 'WhereClause' => [ + 'title' => 'sql 语法', + 'type' => 'string', + 'example' => 'id>1', + 'description' => '', + ], + 'FilterColumns' => [ + 'title' => '过滤列，如果该集合空表示都需要，如果该集合有值表示保留值', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => 'col', + 'description' => '', + ], + 'description' => '', + ], + 'ShardColumns' => [ + 'title' => '分片键列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'col', + ], + 'description' => '', + ], + 'LogicTableId' => [ + 'title' => '针对逻辑表下，逻辑表 tableId', + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + 'SourceEndpointId' => [ + 'title' => '针对物理表下传递 endpointId', + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + 'SourceClientId' => [ + 'title' => 'connector client id', + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'SubIds' => [ + 'title' => '取代', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'MaxConnectorCount' => [ + 'title' => 'connector 最大数量，-1 表示不限制', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'StoreIncr' => [ + 'title' => '是否保存增量', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IncrSyncTimestamp' => [ + 'title' => '增量当前位点 秒级时间戳', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1689244596', + ], + ], + ], + 'AlarmStats' => [ + 'title' => '告警统计信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Target' => [ + 'title' => '被告警目标（项目、host）', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'Alarming' => [ + 'title' => '是否正在告警', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'RecentlyTriggerCount' => [ + 'title' => '最近告警消息总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RuleToRecentlyTriggerCount' => [ + 'title' => '分规则最近告警消息数', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'integer', + 'format' => 'int32', + 'description' => '', + 'example' => '0', + ], + ], + 'AlarmContent' => [ + 'title' => '最近告警内容', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'OpenMonitor' => [ + 'title' => '公有云下，是否开启监控告警开关', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"473469C7-XXXX-XXXX-B3DB-A3DC0DE3C83E\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": {\\n \\"WorkerGradeId\\": \\"g_i4wa7***\\\\n\\",\\n \\"WorkerGradeInfo\\": {\\n \\"Id\\": \\"g_i4wa7***\\\\n\\",\\n \\"Name\\": \\"i5fuij***\\",\\n \\"Grade\\": \\"OMS_G2_MIGRATION_LARGE\\",\\n \\"Spec\\": \\"LARGE\\",\\n \\"SpecName\\": \\"LARGE\\",\\n \\"SourceType\\": \\"OB_MYSQL\\",\\n \\"SourceRegion\\": \\"ap-southeast-1\\",\\n \\"DestType\\": \\"OB_MYSQL\\",\\n \\"DestRegion\\": \\"ap-southeast-1\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"AutoRenewal\\": false,\\n \\"Expired\\": false,\\n \\"EndTime\\": \\"2024-02-02T16:00:00\\",\\n \\"GmtCreate\\": \\"2024-01-28T14:07:44\\"\\n },\\n \\"Id\\": \\"np_fe****\\",\\n \\"Type\\": \\"SYNC\\",\\n \\"Name\\": \\"test\\",\\n \\"Labels\\": [\\n {\\n \\"Id\\": \\"l_dr****\\",\\n \\"Name\\": \\"test_tag\\"\\n }\\n ],\\n \\"Owner\\": \\"omsefry***\\",\\n \\"Importance\\": \\"HIGH\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"GmtCreate\\": \\"2023-07-13T06:26:15\\",\\n \\"GmtModified\\": \\"2023-07-13T06:26:15\\\\n\\",\\n \\"GmtStart\\": \\"2023-07-13T07:02:27\\",\\n \\"GmtFinish\\": \\"2023-07-13T07:02:27\\",\\n \\"DestConnId\\": \\"c_deg***\\",\\n \\"IsMerging\\": true,\\n \\"IsModifying\\": true,\\n \\"IsSubProject\\": false,\\n \\"SourceEndpointType\\": \\"OB_MYSQL\\",\\n \\"SinkEndpointType\\": \\"MYSQL\\",\\n \\"TransferMapping\\": {\\n \\"Mode\\": \\"SPECIFIC\\",\\n \\"Databases\\": [\\n {\\n \\"Type\\": \\"MYSQL\\",\\n \\"Id\\": \\"db_id\\",\\n \\"Name\\": \\"db_name\\",\\n \\"MappedName\\": \\"mapped_db\\",\\n \\"TenantName\\": \\"tenant_name\\",\\n \\"Tables\\": [\\n {\\n \\"Name\\": \\"table_name\\",\\n \\"MappedName\\": \\"mapped_table\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id > 1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col1\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col2\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ],\\n \\"Views\\": [\\n {\\n \\"Name\\": \\"view_name\\",\\n \\"MappedName\\": \\"mapped_view\\",\\n \\"Id\\": \\"fexdg***\\",\\n \\"WhereClause\\": \\"id < 1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col1\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col2\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ],\\n \\"SpecificTables\\": [\\n {\\n \\"Name\\": \\"table_name\\",\\n \\"MappedName\\": \\"mapped_table\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id>1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"col\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ],\\n \\"SpecificViews\\": [\\n {\\n \\"Name\\": \\"view_name\\",\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Id\\": \\"view_id\\",\\n \\"WhereClause\\": \\"id<3\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"DatabasesBlack\\": [\\n {\\n \\"Type\\": \\"DATABASE\\",\\n \\"Id\\": \\"db_id\\",\\n \\"Name\\": \\"db_name\\",\\n \\"MappedName\\": \\"mapped_db\\",\\n \\"TenantName\\": \\"mapped_tenant\\",\\n \\"Tables\\": [\\n {\\n \\"Name\\": \\"table_name\\",\\n \\"MappedName\\": \\"mapped_table\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id>1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ],\\n \\"Views\\": [\\n {\\n \\"Name\\": \\"view_name\\",\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Id\\": \\"view_id\\",\\n \\"WhereClause\\": \\"id>2\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ],\\n \\"SpecificTables\\": [\\n {\\n \\"Name\\": \\"table_name\\",\\n \\"MappedName\\": \\"mapped_table\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id<3\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ],\\n \\"SpecificViews\\": [\\n {\\n \\"Name\\": \\"view_name\\",\\n \\"MappedName\\": \\"mapped_view\\",\\n \\"Id\\": \\"view_id\\",\\n \\"WhereClause\\": \\"id>2\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\\\n\\",\\n \\"PartitionLifeCycle\\": \\"30\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"TableAndViewWhiteList\\": [\\n \\"null\\"\\n ],\\n \\"TableAndViewBlackList\\": [\\n \\"null\\"\\n ]\\n },\\n \\"CommonTransferConfig\\": {\\n \\"TableCategory\\": \\"ALL\\",\\n \\"ActiveActive\\": true,\\n \\"MqSerializerType\\": \\"DEFAULT\\",\\n \\"MqPartitionMode\\": \\"ONE\\",\\n \\"MqPartition\\": 0,\\n \\"DatahubTopicType\\": \\"TUPLE\\",\\n \\"RocketMqProducerGroup\\": \\"OMS\\",\\n \\"RocketMqMsgTags\\": \\"default_tag\\",\\n \\"RocketMqEnableMsgTrace\\": true,\\n \\"RocketMqSendMsgTimeout\\": 0,\\n \\"DataWorksBusinessName\\": \\"null\\",\\n \\"SinkStoreFormat\\": \\"null\\",\\n \\"SourceStoreFormat\\": \\"null\\"\\n },\\n \\"EnableStructTransfer\\": true,\\n \\"StructTransferConfig\\": {\\n \\"ByteCharConvertStrategy\\": \\"DO_NOTHING_IF_BYTE_USED\\",\\n \\"DeferIndexCreation\\": true\\n },\\n \\"EnableFullTransfer\\": true,\\n \\"EnableFullVerify\\": true,\\n \\"FullTransferConfig\\": {\\n \\"NonePkUkTruncateDstTable\\": false,\\n \\"AllowDestTableNotEmpty\\": true,\\n \\"FullTransferSpeedMode\\": \\"FAST\\",\\n \\"FullVerifySpeedMode\\": \\"FAST\\",\\n \\"WriteWorkerNum\\": 64,\\n \\"ReadWorkerNum\\": 64,\\n \\"ThrottleRps\\": 0,\\n \\"ThrottleIOPS\\": 0\\n },\\n \\"EnableIncrTransfer\\": true,\\n \\"EnableIncrVerify\\": true,\\n \\"EnableReverseIncrTransfer\\": true,\\n \\"IncrTransferConfig\\": {\\n \\"StartTimestamp\\": 1667286900,\\n \\"RecordTypeWhiteList\\": [\\n \\"INSERT\\"\\n ],\\n \\"StoreLogKeptHour\\": 24,\\n \\"EnableSequencingWithinTxn\\": false,\\n \\"IncrSyncConcurrency\\": 64,\\n \\"EnableIncrSyncStatistics\\": true,\\n \\"ThrottleRps\\": 0,\\n \\"ThrottleIOPS\\": 0,\\n \\"SupportDDLTypes\\": [\\n \\"CREATE_TABLE\\"\\n ]\\n },\\n \\"ReverseIncrTransferConfig\\": {\\n \\"StartTimestamp\\": 1687363200,\\n \\"RecordTypeWhiteList\\": [\\n \\"INSERT\\"\\n ],\\n \\"StoreLogKeptHour\\": 24,\\n \\"EnableSequencingWithinTxn\\": true,\\n \\"IncrSyncConcurrency\\": 64,\\n \\"EnableIncrSyncStatistics\\": true,\\n \\"ThrottleRps\\": 0,\\n \\"ThrottleIOPS\\": 0,\\n \\"SupportDDLTypes\\": [\\n \\"CREATE_TABLE\\"\\n ]\\n },\\n \\"SourceConnectInfo\\": {\\n \\"Id\\": \\"c_feg****\\",\\n \\"EndpointName\\": \\"migon****\\",\\n \\"EndpointId\\": \\"e_3kx5i***1s\\",\\n \\"EndpointSide\\": \\"source\\",\\n \\"DbEngine\\": \\"OB_MYSQL_PUBLIC\\",\\n \\"ConnectionInfo\\": \\"null\\",\\n \\"Username\\": \\"oms2027obmysql@oms_***\\",\\n \\"Version\\": \\"2.2.77\\",\\n \\"Timezone\\": \\"+08:00\\",\\n \\"Charset\\": \\"utf8mb4\\",\\n \\"NlsLengthSemantics\\": \\"null\\\\n\\",\\n \\"OperatingSystem\\": \\"Linux\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"OcpName\\": \\"null\\",\\n \\"ConnExtraAttributes\\": \\"null\\",\\n \\"Owner\\": \\"oms_test\\",\\n \\"ResourceOwner\\": \\"1325847***\\\\n\\",\\n \\"Host\\": \\"xxx.xxx.xxx.1\\",\\n \\"Port\\": 2883\\n },\\n \\"SinkConnectInfo\\": {\\n \\"Id\\": \\"e_4lgzuzi9znr4\\",\\n \\"EndpointName\\": \\"RATION12948*****\\",\\n \\"EndpointId\\": \\"e_4w1q****\\",\\n \\"EndpointSide\\": \\"sink\\",\\n \\"DbEngine\\": \\"MYSQL_PUBLIC\\",\\n \\"ConnectionInfo\\": \\"null\\",\\n \\"Username\\": \\"oms2027obmysql@oms_***\\\\n\\",\\n \\"Version\\": \\"2.2.77\\",\\n \\"Timezone\\": \\"+08:00\\",\\n \\"Charset\\": \\"utf8mb4\\",\\n \\"NlsLengthSemantics\\": \\"null\\",\\n \\"OperatingSystem\\": \\"Linux\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"OcpName\\": \\"null\\",\\n \\"ConnExtraAttributes\\": \\"null\\",\\n \\"Owner\\": \\"oms_test\\",\\n \\"ResourceOwner\\": \\"1325847***\\\\n\\",\\n \\"Host\\": \\"xxx.xxx.xxx.1\\\\n\\",\\n \\"Port\\": 2883\\n },\\n \\"Steps\\": [\\n {\\n \\"Order\\": 1,\\n \\"Name\\": \\"PRE_CHECK\\",\\n \\"Description\\": \\"预检查\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ExtraInfo\\": {\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"\\\\t\\\\nCM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\\\n\\\\n\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"INNER_ERROR\\",\\n \\"ErrorMsg\\": \\"A system error occurred.\\\\n\\",\\n \\"ErrorParam\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"FailedTime\\": \\"null\\"\\n },\\n \\"StartTime\\": \\"2020-05-22T17:04:18\\",\\n \\"FinishTime\\": \\"2020-05-22T17:04:18\\",\\n \\"Progress\\": 90,\\n \\"StepInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"ExtraInfo\\": {\\n \\"RunningStep\\": \\"PRE-CHECK\\",\\n \\"RunningProgress\\": 90,\\n \\"MonitoringIncr\\": true,\\n \\"Subtopics\\": [\\n \\"null\\"\\n ],\\n \\"ReverseSubtopics\\": [\\n \\"null\\"\\n ],\\n \\"LogServiceStartCheckpoint\\": 1689214358,\\n \\"SourceStoreKeptHour\\": 24,\\n \\"SyncDelay\\": 0,\\n \\"SyncDelaySampleTimestamp\\": 1689214358,\\n \\"AccessObSource\\": true,\\n \\"OverwriteConfig\\": true,\\n \\"IgnoreUnsupportDdl\\": false,\\n \\"SubDbs\\": {\\n \\"key\\": [\\n {\\n \\"ClusterName\\": \\"cluster_name\\",\\n \\"TenantName\\": \\"tenant_name\\",\\n \\"DatabaseId\\": \\"null\\",\\n \\"DatabaseName\\": \\"db_name\\",\\n \\"MappingDatabaseName\\": \\"mapped_db\\",\\n \\"SourceClientId\\": \\"null\\",\\n \\"Tables\\": [\\n {\\n \\"TableId\\": \\"fexg***\\",\\n \\"Database\\": \\"db_name\\",\\n \\"TableName\\": \\"table_name\\",\\n \\"MappingTableName\\": \\"mapped_table\\",\\n \\"Instance\\": \\"g_i4kat***\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"null\\",\\n \\"Position\\": 0,\\n \\"ColumnType\\": \\"null\\",\\n \\"RecordFieldType\\": \\"null\\",\\n \\"RawColumnType\\": \\"null\\",\\n \\"ColumnKey\\": \\"null\\",\\n \\"Nullable\\": true,\\n \\"DefaultValue\\": \\"null\\",\\n \\"DataLength\\": 0,\\n \\"DataPrecision\\": 64,\\n \\"DataScale\\": 0,\\n \\"Encoding\\": \\"utf8\\",\\n \\"ColumnComment\\": \\"comments\\",\\n \\"IsGenerateField\\": false\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"SubConds\\": {\\n \\"key\\": [\\n {\\n \\"TenantName\\": \\"tenant_name\\",\\n \\"Database\\": \\"db_name\\",\\n \\"DestDatabase\\": \\"dest_db\\",\\n \\"TableName\\": \\"table_name\\",\\n \\"DestName\\": \\"dest_name\\",\\n \\"WhereClause\\": \\"id>1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col\\"\\n ],\\n \\"LogicTableId\\": \\"null\\",\\n \\"SourceEndpointId\\": \\"null\\",\\n \\"SourceClientId\\": \\"null\\"\\n }\\n ]\\n },\\n \\"SubIds\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MaxConnectorCount\\": -1,\\n \\"StoreIncr\\": true,\\n \\"IncrSyncTimestamp\\": 1689244596\\n },\\n \\"AlarmStats\\": {\\n \\"Target\\": \\"null\\",\\n \\"Alarming\\": false,\\n \\"RecentlyTriggerCount\\": 0,\\n \\"RuleToRecentlyTriggerCount\\": {\\n \\"key\\": 0\\n },\\n \\"AlarmContent\\": \\"null\\",\\n \\"OpenMonitor\\": true\\n }\\n }\\n}","type":"json"}]', + ], + 'DescribeProjectSteps' => [ + 'summary' => '查询项目步骤', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'np_4w3a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Order' => [ + 'title' => '步骤顺序', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Name' => [ + 'title' => '步骤名 (PRE_CHECK, TRANSFER_PRECHECK, PREPARE, STRUCT_TRANSFER, STRUCT_MIGRATION, INDEX_MIGRATION, INDEX_TRANSFER, STRUCT_SYNC, FULL_MIGRATION, FULL_TRANSFER, APP_SWITCH, TRANSFER_APP_SWITCH, REVERSE_INCR_SYNC, REVERSE_INCR_TRANSFER, FULL_VALIDATION, FULL_VERIFIER, INCR_LOG_PULL, TRANSFER_INCR_LOG_PULL, INCR_SYNC, INCR_TRANSFER, INCR_VERIFIER, SYNC_PREPARE, TRANSFER_PREPARE, SYNC_INCR_LOG_PULL, CONNECTOR_FULL_SYNC, CONNECTOR_INCR_SYNC)', + 'description' => '', + 'type' => 'string', + 'example' => 'PRE_CHECK', + ], + 'Description' => [ + 'title' => '步骤描述（预检查/结构迁移/结构同步/全量迁移/全量同步/全量校验/索引迁移/增量日志拉取/增量同步/增量校验/正向切换）', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Status' => [ + 'title' => '步骤状态 (INIT: 初始化, RUNNING: 运行中, FAILED: 失败, FINISHED: 已完成, SUSPEND: 暂停中, MONITORING: 持续监控状态，用于增量同步和增量校验的持续监控态)', + 'description' => '', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'ExtraInfo' => [ + 'title' => '补充信息（json）', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ErrorDetails' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + 'ErrorCode' => [ + 'title' => '错误码 (AUTHENTICATION_ERROR, PARAM_ERROR, PARAM_ERROR_MESSAGE, NOT_IMPLEMENTED_ERROR, SHARD_COLUMNS_CONFLICT_MESSAGE, FAILED_PARSE_TOKEN_MESSAGE, CONNECT_CHECK_ERROR, NOT_SUPPORT_ERROR, CE_NOT_SUPPORT_ERROR, NOT_FOUND_ERROR, SHARDING_COLUMN_NOT_INCLUDED_ERROR, INNER_ERROR, OMS_META_DB_ACCESS_FAILED, DB_QUERY_ERROR, DATAHUB_QUERY_ERROR, USER_LACK_SYS_PRIV_ERROR, USER_LACK_TABLE_PRIV_ERROR, RM_API_ERROR, RM_TASK_ERROR, CM_API_ERROR, CM_API_NOT_SUCCESS, BAGUALU_API_ERROR, IDB_API_ERROR, SUPERVISOR_API_ERROR, OCP_API_ERROR, OCP_SERVICE_ERROR, OCP_QUERY_VERSION_FAILED, OCP_VERSION_INCORRECT_ERROR, OCP_VERSION_NOT_SUPPORTED_ERROR, OCP_API_USER_PASSWORD_INCORRECT_ERROR, OBSCHEMA_ERROR, EXECUTOR_THREAD_POOL_BUSY, NO_TABLE_SELECTED, NO_VIEW_SELECTED, SOURCE_CRAWLER_START_FAILED, SOURCE_CRAWLER_START_FAILED_DATA_EXPIRED, SOURCE_CRAWLER_START_TIMEOUT, DEST_WRITER_START_FAILED, WRITER_UNKNOWN_STATUS, DRC_TOPIC_EXISTS_ERROR, TOPIC_EMPTY_ERROR, REACH_WRITER_LIMIT_ERROR, FOUND_NO_FEASIBLE_STORE_ERROR, TOO_MANY_STORES_FOR_SUBTOPIC, TIMEOUT_EXCEPTION, KIPP_API_ERROR: KIPP 相关错误信息, KIPP_API_RESOURCE_NOT_FOUND, KIPP_API_INVALID_PARAM, KIPP_API_UNKNOWN_ERROR, KIPP_API_INTERNAL_ERROR, KIPP_API_SERVICE_UNAVAILABLE, OMS_AGENT_API_ERROR, KMS_API_ERROR, OMS_ENCRYPT_API_ERROR, OMS_DECRYPT_API_ERROR, ALIYUN_SDK_ERROR, YAOCHI_API_ERROR, AWS_SDK_ERROR, AWS_PRIVATE_LINK_SERVICE_INITIALIZING_ERROR, AWS_PRIVATE_LINK_SERVICE_UNAVAILABLE_ERROR, AWS_PRIVATE_LINK_SERVICE_NEED_ACCEPTANCE_ERROR, UNSUPPORTED_AWS_SERVICE_ERROR, RESOURCE_WITHOUT_STOCK_ERROR, RESOURCE_NO_AVAILABLE_ZONE, CM_SDK_ERROR, MIGRATION_PROJECT_STEP_PRECHECK_FAILED, PRE_CHECK_ERROR, FAILURES_CORRECT_ERROR, EXECUTE_DDL_FAILURE, EXECUTE_DDL_UNSUPPORTED_OR_FAILURE, STRUCT_RECORD_DDL_NOT_FOUND, STRUCT_RECORD_INDEX_NOT_FOUND, STRUCT_RECORD_NOT_FOUND, STRUCT_RECORD_NOT_FOUND_IN_DBCAT, STRUCT_RECORD_NOT_FOUND_IN_DBCAT_PUBLIC, SCHEMA_OBJECT_TYPE_NOT_SUPPORT_ERROR, POLAR_MYSQL_NETWORK_TYPE_NOT_SUPPORT_ERROR, RDS_NETWORK_TYPE_NOT_SUPPORT_ERROR, RDS_VPC_NETWORK_NOT_SUPPORT_ERROR, DB_TYPE_NOT_SUPPORT_ERROR, SYNC_TYPE_NOT_SUPPORT_ERROR, SLAVE_OPERATION_STEP_NOT_SUPPORT_ERROR, BYTE_USED_TYPE_NOT_SUPPORT_ERROR, MANY_TO_ONE_SCHEMA_TABLE_REVERSE_INCR_NOT_SUPPORT_ERROR, MANY_TO_ONE_SCHEMA_REVERSE_INCR_NOT_SUPPORT_ERROR, DUPLICATE_SCHEMA_TABLE_ERROR, OMS_STEP_NOT_SUPPORT_ERROR, ORACLE_DATABASE_ROLE_NOT_SUPPORT_ERROR, OLD_PRE_CHECK_NOT_SUPPORT_ERROR, SCHEMA_ONE_TO_MANY_NOT_SUPPORT_ERROR, PROJECT_NOT_FOUND_ERROR, SYNC_PROJECT_NOT_FOUND_ERROR, ENDPOINT_NOT_FOUND_ERROR, ENDPOINT_NAME_ALREADY_EXIST_ERROR, ENDPOINT_QUERY_ERROR, ENDPOINT_SQL_QUERY_ERROR, PROJECT_NAME_ALREADY_EXIST_ERROR, CHECKER_NOT_FOUND_ERROR, CHECKER_FAILED_ERROR, CHECKER_STATUS_UNEXPECTED_ERROR, CHECKER_NO_TASK_TYPE_ERROR, WORKER_INSTANCE_NOT_FOUND_ERROR, WORKER_INSTANCE_ALLOCATING_ERROR, LOG_SERVICE_TOPIC_NOT_FOUND_ERROR, CLUSTER_NOT_FOUND_ERROR, TENANT_NOT_FOUND_ERROR, DATABASE_NOT_FOUND_ERROR, TABLE_NOT_FOUND_ERROR, COLUMN_NOT_FOUND_ERROR, TABLE_META_NOT_FOUND_ERROR, SYBASE_CHARSET_NOT_FOUND_ERROR, OCP_NOT_FOUND_ERROR, REGION_NOT_FOUND_ERROR, OCP_ALREADY_EXIST_ERROR, ALARM_CHANNEL_NAME_ALREADY_EXIST_ERROR, SEND_MARKDOWN_TEXT_TO_WEBHOOK_FAILED_EXCEPTION_RESPONSE, SEND_MARKDOWN_TEXT_TO_WEBHOOK_FAILED_EXCEPTION_STATUS, LABEL_ALREADY_EXIST_ERROR, LABEL_NOT_EXIST_ERROR, OCP_ALREADY_USED_ERROR, REGION_INFO_INCONSISTENT_ERROR, OCP_NAME_EMPTY_ERROR, MASTER_SLAVE_ENDPOINT_NAME_INCONSISTENT_ERROR, LOG_FILE_NOT_FOUND_ERROR, CHECKER_METRICS_LOG_FILE_NOT_FOUND_ERROR, OPERATION_NOT_ALLOWED_ERROR, PROJECT_OPERATION_NOT_ALLOWED_ERROR, PROJECT_RELEASE_FAILED, STRUCT_MIGRATION_RETRY_NOT_ALLOWED_ERROR, WORKER_INSTANCE_OPERATION_NOT_ALLOWED_ERROR, USER_OPERATION_NOT_ALLOWED_ERROR, OCP_NAME_OR_REGION_NOT_ALLOWED_UPDATE, UPDATE_CONFIG_WITH_NEWLINE_NOT_ALLOWED, EXIST_UNRELEASED_PROJECT_ERROR, EXIST_UNRELEASED_TOPIC_ERROR, LABEL_CREATE_NOT_ALLOWED_ERROR, LABEL_UPDATE_NOT_ALLOWED_ERROR, LABEL_DELETE_NOT_ALLOWED_ERROR, TOPIC_NAME_INVALID_ERROR, MAPPING_INVALID_ERROR, INVALID_STATUS_ERROR, INVALID_CSV_HEAD_ERROR, INVALID_CSV_BODY_ERROR, DUPLICATE_SCHEMA_TABLE_SETTING_ERROR, MULTIPLE_TABLES_NOT_ALLOWED_ERROR, PROJECT_INVALID_STATUS_ERROR, PROJECT_INVALID_CONNECTOR_COUNT_ERROR, WORKER_INSTANCE_INVALID_STATUS_ERROR, LOG_SERVICE_INVALID_STATUS_ERROR, STEP_INVALID_STATUS_ERROR, UPDATE_ALLOW_DEST_TABLE_NOT_EMPTY_NOT_ALLOWED_ERROR, EXIST_INCONSISTENCY_ERROR, OMS_SWITCH_SUBSTEP_FAILED_ERROR, ENDPOINT_ID_INVALID_ERROR, DB_QUERY_VERSION_EMPTY_ERROR, ENDPOINT_NAME_INVALID_ERROR, CLOUD_ENDPOINT_NAME_INVALID_ERROR, ENDPOINT_SCHEMA_NOT_ALLOWED_ERROR, ENDPOINT_USERNAME_NOT_ALLOWED_ERROR, ENDPOINT_SCHEMA_CHAR_NOT_ALLOWED_ERROR, NAME_HAS_SPACE_EXCEPTION, CONFIG_CONVERT_VALUE_ERROR, CONFIG_VALUE_EXCEEDS_LIMIT_ERROR, CONFIG_KEY_NOT_FOUND_KEY_ERROR, CONFIG_VALUE_NOT_EMPTY_ERROR, SCHEMA_HAS_CONVERT_INFO, TIME_SERIES_QUERY_SERVICE_ERROR, ETL_VERIFY_ERROR, ETL_SYNTAX_UNSUPPORTED, ETL_FIELD_NOTFOUND, ETL_FAILED_PARSE_SQL, ETL_VAL_TYPE_ERROR, NOT_SUPPORT_GENERATE_COLUMNS, NOT_SUPPORT_UPDATE_ETL, LOCK_FAILED, OMS_USER_EXIST_ERROR, OMS_USER_NOT_FOUND_ERROR, OMS_USER_NAME_LENGTH_CONSTRAINT, OMS_USER_EMAIL_LENGTH_CONSTRAINT: 用户名, OMS_USER_PASSWORD_ERROR, LOGIN_EXPIRE, USER_NAME_OR_PASSWORD_ERROR, USER_NAME_OR_PASSWORD_LOGIN_FAILURE_TIMES_ERROR: 用户名或密码错误: 您的用户将在, OMS_USER_PASSWORD_HAS_EXPIRED_ERROR, OMS_USER_ROOT_PASSWORD_HAS_EXPIRED_ERROR, OMS_USER_PASSWORD_LOCKED_ERROR, OMS_USER_ROOT_PASSWORD_LOCKED_ERROR, OMS_USER_PASSWORD_VALIDATION_ERROR, OMS_USER_PASSWORD_DEFAULT_ERROR, CAPTCHA_EXPIRE_KEY, CAPTCHA_ERROR_KEY, OMS_USER_PERMISSION_DENIED_ERROR, OMS_USER_NOT_ACTIVE, OMS_USER_EDIT_ADMIN_ROLE_INFO_PERMISSION_DENIED_ERROR, OMS_USER_ILLEGAL_DELETED_ERROR, OMS_USER_FORBID_DELETED_ERROR, OMS_DEPARTMENT_ALREADY_EXIST_ERROR, OMS_DEPARTMENT_MAXIMUM_LIMIT, OMS_DEPARTMENT_USER_NOT_EMPTY, CONNECTOR_TASK_DELETE_ERROR, METRIC_SERVICE_ERROR, SYNC_PROJECT_TYPE_INVALID_ERROR, SYNC_SHARDING_COLUMNS_INVALID_ERROR, SYNC_PROJECT_PRODUCER_GROUP_INVALID_ERROR, SYNC_PROJECT_PRODUCER_GROUP_LIMIT_EXCEEDS_ERROR, SYNC_PROJECT_COMPLEMENT_CONFIG_ERROR, META_SCHEMA_CREATE_FAILED, RESUME_STEP_FAILED, SCHEMA_INCONSISTENCY, SCHEMA_CASCADE_MAPPING_NOT_SUPPORT_ERROR, SCHEMA_NOT_EXISTED, SCHEMA_EXISTED, SCHEMA_NOT_EXIST, BLACK_LIST_MATCH_ALL, BLACK_LIST_CONTAIN_NON_WHITE_SCHEMA, OPERATOR_ERROR, OPERATOR_DIMENSION_NOT_SUPPORT, OPERATOR_PULL_LOG_ERROR, OPERATOR_UPDATE_CONFIG_NOT_SUPPORT, UPDATE_CONFIG_NOT_SUPPORT_BLANK_CHAR, UPDATE_CONFIG_INVALID_NOT_NUMBER, UPDATE_CHECKER_CONCURRENCY_CONFIG_NOT_SATISFY, KAFKA_CREATE_TOPIC_ERROR, KAFKA_QUERY_TOPIC_ERROR, KAFKA_BUILD_PROPERTIES_ERROR, KAFKA_CHECK_SASL_USER_ERROR, ROCKETMQ_CREATE_TOPIC_ERROR, ROCKETMQ_QUERY_TOPIC_ERROR, SYNC_OBJECT_EMPTY_ERROR, WRITER_NUMBER_NOT_UNIQUE, WRITER_NOT_ACTIVE, PROJECT_NAME_DUPLICATE_ERROR, EMPTY_FAILED_STRUCT_MIGRATION_TABLES_ERROR, LOGIC_TABLE_NOT_SUPPORT_UPDATE_OBJECT_ERROR, LOGIC_REQUEST_ERROR, LOGIC_DTO_BUILD_ERROR, UNEXPECTED_REMOTE_API_RESULT, OCEANBASE_USER_UNEXPECTED, STORE_CREATE_FAILED_ERROR, STORE_START_FAILED, STORE_NOT_PULL_LOG_ERROR, ALL_HOSTS_STATUS_ERROR, ALARM_CHANNEL_NAME_LIST_DUPLICATE, ALARM_CHANNEL_NAME_LIST_CONFLICT, CUSTOMER_NOT_FOUND_ERROR, WORKER_ECS_NOT_FOUND_ERROR, WORKER_ECS_NOT_FOUND_FOR_USER_ERROR, WORKER_POD_NOT_FOUND_ERROR, WORKER_POD_NOT_FOUND_FOR_USER_ERROR, WORKER_INSTANCE_NOT_FOUND_ERROR_V2, WORKER_INSTANCE_NOT_FOUND_FOR_USER_ERROR, RELEASE_PLAN_CREATED_CONFLICT, INCR_SYNC_START_TIMESTAMP_INVALID, OMS_RESOURCE_OPERATION_BROKEN_ACCESS)', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'ErrorMsg' => [ + 'title' => '错误消息', + 'description' => '', + 'type' => 'string', + 'example' => 'The ResourceDirectoryId is invalid.', + ], + 'ErrorParam' => [ + 'title' => '错误相关参数', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'FailedTime' => [ + 'title' => '错误时间', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + 'StartTime' => [ + 'title' => '开始时间，UTC 格式："2020-05-22T17:04:18"', + 'description' => '', + 'type' => 'string', + 'example' => '2020-05-22T17:04:18', + ], + 'FinishTime' => [ + 'title' => '结束时间，UTC 格式："2020-05-22T17:04:18"', + 'description' => '', + 'type' => 'string', + 'example' => '2020-05-22T17:04:18', + ], + 'Progress' => [ + 'title' => '步骤进度', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'StepInfo' => [ + 'title' => '步骤详情,全量传输/增量传输/正向切换', + 'description' => '', + 'type' => 'object', + 'example' => 'null', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 4,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": [\\n {\\n \\"Order\\": 1,\\n \\"Name\\": \\"PRE_CHECK\\",\\n \\"Description\\": \\"预检查\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ExtraInfo\\": {\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"INNER_ERROR\\",\\n \\"ErrorMsg\\": \\"The ResourceDirectoryId is invalid.\\",\\n \\"ErrorParam\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"FailedTime\\": \\"null\\"\\n },\\n \\"StartTime\\": \\"2020-05-22T17:04:18\\",\\n \\"FinishTime\\": \\"2020-05-22T17:04:18\\",\\n \\"Progress\\": 100,\\n \\"StepInfo\\": null\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeProjectStepMetric' => [ + 'summary' => '查询项目步骤指标', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'np_dr****', + ], + ], + [ + 'name' => 'StepName', + 'in' => 'formData', + 'schema' => [ + 'title' => '步骤名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'FULL_TRANSFER', + ], + ], + [ + 'name' => 'MetricType', + 'in' => 'formData', + 'schema' => [ + 'title' => '指标类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'RPS', + ], + ], + [ + 'name' => 'Aggregator', + 'in' => 'formData', + 'schema' => [ + 'title' => '聚合算子 AVG-取平均值（平均数据折线图），NONE-取中位（瞬时数据折线图），默认 NONE', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'AVG', + 'enum' => [ + 'AVG', + 'NONE', + ], + ], + ], + [ + 'name' => 'BeginTimestamp', + 'in' => 'formData', + 'schema' => [ + 'title' => '开始时间（秒级时间戳）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1689244696', + ], + ], + [ + 'name' => 'EndTimestamp', + 'in' => 'formData', + 'schema' => [ + 'title' => '结束时间（秒级时间戳）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1689254646', + ], + ], + [ + 'name' => 'MaxPointNum', + 'in' => 'formData', + 'schema' => [ + 'title' => '最大查询点数（取值范围5~7*24*60, 建议值：时间段（单位分钟）/maxPointNum > 5）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '5', + 'example' => '6', + 'default' => '6', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator.', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ReferenceValue' => [ + 'title' => '基准值。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'null', + ], + 'Metrics' => [ + 'title' => '数据折线图。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'metric name', + 'description' => '', + 'type' => 'string', + 'example' => 'metric_name', + ], + 'Tags' => [ + 'title' => 'metrics tags', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'metric_tag', + ], + ], + 'DataPoints' => [ + 'title' => 'data point list', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Timestamp' => [ + 'title' => '毫秒级时间戳', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1689244696', + ], + 'Value' => [ + 'title' => '时间对应的值', + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + 'Aggregator' => [ + 'title' => 'AVG(平均)，NONE(瞬时) (AVG: 取平均值, NONE: 取中位)', + 'description' => '', + 'type' => 'string', + 'example' => 'AVG', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": {\\n \\"ReferenceValue\\": 0,\\n \\"Metrics\\": [\\n {\\n \\"Name\\": \\"metric_name\\",\\n \\"Tags\\": {\\n \\"key\\": \\"metric_tag\\"\\n },\\n \\"DataPoints\\": [\\n {\\n \\"Timestamp\\": 1689244696,\\n \\"Value\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Aggregator\\": \\"AVG\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeProjectProgress' => [ + 'summary' => '获取迁移/同步项目 Progress 信息', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'np_4w3a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111'."\n", + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'title' => '项目ID', + 'description' => '', + 'type' => 'string', + 'example' => 'np_fe****', + ], + 'Status' => [ + 'title' => '通用的项目状态枚举 (INIT: 未启动, RUNNING: 运行中, SUSPEND: 暂停中, FAILED: 已失败, FINISHED: 已完成, RELEASING: 释放中, RELEASED: 已释放, DELETED: 已删除, RUNNING_MODIFYING: 修改中, RUNNING_MERGING: 合并中)', + 'description' => '', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'AlarmLevel' => [ + 'title' => '告警保障等级 (HIGH: 高保护状态, MEDIUM: 中保护状态, LOW: 低保护状态, IGNORE: 无保护状态)', + 'description' => '', + 'type' => 'string', + 'example' => 'MEDIUM', + ], + 'EnableIncrSync' => [ + 'title' => '是否有正向增量同步', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CurrentStep' => [ + 'title' => '当前进行到哪一步 (PRE_CHECK, TRANSFER_PRECHECK, PREPARE, STRUCT_TRANSFER, STRUCT_MIGRATION, INDEX_MIGRATION, INDEX_TRANSFER, STRUCT_SYNC, FULL_MIGRATION, FULL_TRANSFER, APP_SWITCH, TRANSFER_APP_SWITCH, REVERSE_INCR_SYNC, REVERSE_INCR_TRANSFER, FULL_VALIDATION, FULL_VERIFIER, INCR_LOG_PULL, TRANSFER_INCR_LOG_PULL, INCR_SYNC, INCR_TRANSFER, INCR_VERIFIER, SYNC_PREPARE, TRANSFER_PREPARE, SYNC_INCR_LOG_PULL, CONNECTOR_FULL_SYNC, CONNECTOR_INCR_SYNC)', + 'description' => '', + 'type' => 'string', + 'example' => 'PRE_CHECK', + ], + 'IncrSyncCheckpoint' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1689248064', + ], + 'EnableStructTransfer' => [ + 'title' => '是否有结构传输', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableFullTransfer' => [ + 'title' => '是否有全量数据传输', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'StructTransferProgress' => [ + 'title' => '结构传输进度百分比，0~100', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'FullTransferProgress' => [ + 'title' => '全量传输进度百分比，0~100', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'EnableReverseIncrTransfer' => [ + 'title' => '是否有反向增量同步', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ReverseIncrTransferCheckpoint' => [ + 'title' => '反向增量同步位点，unix timestamp，单位秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1689248075', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": {\\n \\"ProjectId\\": \\"np_fe****\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"AlarmLevel\\": \\"MEDIUM\\",\\n \\"EnableIncrSync\\": true,\\n \\"CurrentStep\\": \\"PRE_CHECK\\",\\n \\"IncrSyncCheckpoint\\": 1689248064,\\n \\"EnableStructTransfer\\": true,\\n \\"EnableFullTransfer\\": true,\\n \\"StructTransferProgress\\": 100,\\n \\"FullTransferProgress\\": 100,\\n \\"EnableReverseIncrTransfer\\": true,\\n \\"ReverseIncrTransferCheckpoint\\": 1689248075\\n }\\n}","type":"json"}]', + ], + 'DescribeProjectComponents' => [ + 'summary' => '获取项目的组件信息', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'np_4w3a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111'."\n", + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '48', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'StoreList' => [ + 'title' => '增量拉取组件', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '名称', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1-7145:OB_ORACLE_np_4w3r***_4w:0000***97', + ], + 'Ip' => [ + 'title' => 'IP', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1', + ], + 'Region' => [ + 'title' => '所在地域', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'Topic' => [ + 'title' => 'Topic', + 'description' => 'Topic。', + 'type' => 'string', + 'example' => 'OB_ORACLE_np_4w3r29c_4w3****', + ], + 'Subtopic' => [ + 'title' => 'SubTopic', + 'description' => 'SubTopic。', + 'type' => 'string', + 'example' => 'OB_ORACLE_np_4w3***c_4w3**-0', + ], + 'Tps' => [ + 'title' => 'Tps', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Delay' => [ + 'title' => 'delay', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24', + ], + 'Gmt' => [ + 'title' => '位点采集时间。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1689250049', + ], + 'Conn' => [ + 'title' => '连接数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Status' => [ + 'title' => '状态 (EXCEPTION: Store 运行异常。, ACTIVE: Store 正常运行中。, STOP: Store 人为操作停止。, UNEXPECTED_EXIT: Store reader 非预期退出。, CHANGE_SOURCE: 按目前的实现来看，Ghana 中不会出现 CHANGE_SOURCE)', + 'description' => '', + 'type' => 'string', + 'example' => 'EXCEPTION', + ], + 'ErrorDetails' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + 'example' => 'null', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + 'ToSwitch' => [ + 'title' => '是否需要主备切换，供 HA 判断', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Port' => [ + 'title' => '对外服务端口', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2883', + ], + 'StorePort' => [ + 'title' => 'store 端口', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2882', + ], + 'BeginCheckpoint' => [ + 'title' => '开始安全位点 UTC', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T09:19:53', + ], + 'EndCheckpoint' => [ + 'title' => '结束安全位点 UTC', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T09:19:53', + ], + 'ErrMsg' => [ + 'title' => '当前错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'GmtCreate' => [ + 'title' => '创建时间（UTC 格式时间）', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T17:29:54', + ], + 'GmtModified' => [ + 'title' => '更新时间（UTC 格式时间）', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T17:29:54', + ], + 'LatelyHeartbeatTimeSec' => [ + 'title' => '最近一次心跳时间戳', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1689250071', + ], + ], + ], + ], + 'ReverseStoreList' => [ + 'title' => '反向增量拉取组件', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '名称', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1-9000:connector_v2:np_4w****9jxc-incr_trans-1-0:0000000277', + ], + 'Ip' => [ + 'title' => 'IP', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1', + ], + 'Region' => [ + 'title' => '所在地域', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'Topic' => [ + 'title' => 'Topic', + 'description' => 'Topic。', + 'type' => 'string', + 'example' => 'null', + ], + 'Subtopic' => [ + 'title' => 'SubTopic', + 'description' => 'SubTopic。', + 'type' => 'string', + 'example' => 'null', + ], + 'Tps' => [ + 'title' => 'Tps', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Delay' => [ + 'title' => 'delay', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Gmt' => [ + 'title' => '位点采集时间。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1689250071', + ], + 'Conn' => [ + 'title' => '连接数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Status' => [ + 'title' => '状态 (EXCEPTION: Store 运行异常, ACTIVE: Store 正常运行中, STOP: Store 人为操作停止, UNEXPECTED_EXIT: Store reader 非预期退出, CHANGE_SOURCE)', + 'description' => '', + 'type' => 'string', + 'example' => 'EXCEPTION', + ], + 'ErrorDetails' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + 'example' => 'null', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + 'ToSwitch' => [ + 'title' => '是否需要主备切换，供 HA 判断', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Port' => [ + 'title' => '对外服务端口', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2883', + ], + 'StorePort' => [ + 'title' => 'store 端口', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2882', + ], + 'BeginCheckpoint' => [ + 'title' => '开始安全位点 UTC', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T09:19:53', + ], + 'EndCheckpoint' => [ + 'title' => '结束安全位点 UTC', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T09:19:53', + ], + 'ErrMsg' => [ + 'title' => '当前错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'GmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T18:04:36', + ], + 'GmtModified' => [ + 'title' => '更新时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T18:04:36', + ], + 'LatelyHeartbeatTimeSec' => [ + 'title' => '最近一次心跳时间戳', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1689250071', + ], + ], + ], + ], + 'FullVerifyComponents' => [ + 'title' => '全量校验组件', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'title' => '所在地域', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'Name' => [ + 'title' => '名称', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1-9000:90247:0000000033', + ], + 'InconsistentQuantity' => [ + 'title' => '不一致数量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ConsistentQuantity' => [ + 'title' => '一致数量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Progress' => [ + 'title' => '表级别进度', + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + 'RecordProgress' => [ + 'title' => '记录级别的进度', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Status' => [ + 'title' => 'checker 状态 (INIT, RUNNING, DONE, FAILED, SHUTDOWNED, DELETED)', + 'description' => '', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'ErrorDetails' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + 'example' => 'null', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + 'Ip' => [ + 'title' => 'ip', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1', + ], + 'TaskId' => [ + 'title' => 'taskId', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1345***', + ], + ], + ], + ], + 'FullImportComponents' => [ + 'title' => '全量导入组件', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'title' => '所在地域', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Name' => [ + 'title' => '名称', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1-9000:connector_v2:np_4w8v****c-full_trans-1-0:0000000276', + ], + 'Ip' => [ + 'title' => 'ip', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1', + ], + 'Identity' => [ + 'title' => '正向：项目id', + 'description' => '', + 'type' => 'string', + 'example' => 'p_4w8v****', + ], + 'Progress' => [ + 'title' => '进度', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'Status' => [ + 'title' => '状态 (RUNNING, STOPPED, EXCEPTION, FINISHED)', + 'description' => '', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'GmtCreate' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T18:04:36', + ], + 'GmtModify' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T18:04:36', + ], + 'ErrorDetails' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + 'example' => 'null', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + ], + ], + ], + 'IncrSyncComponents' => [ + 'title' => '增量同步组件', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'title' => '所在地域', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-zhangjiakou', + ], + 'Name' => [ + 'title' => '名称', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1-9000:connector_v2:np_4w****jxc-incr_trans-1-0:0000000277', + ], + 'Ip' => [ + 'title' => '机器ip', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1', + ], + 'Identity' => [ + 'title' => '正向：项目id', + 'description' => '', + 'type' => 'string', + 'example' => 'np_4w***', + ], + 'Subtopics' => [ + 'title' => 'subtopic', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'SubTopic。', + 'type' => 'string', + 'example' => 'null', + ], + ], + 'Status' => [ + 'title' => '状态 (RUNNING, STOPPED, EXCEPTION, FINISHED)', + 'description' => '', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'Checkpoint' => [ + 'title' => '当前位点 UTC 时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T09:19:53', + ], + 'Tps' => [ + 'title' => '每秒处理事务数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Delay' => [ + 'title' => '延迟，单位秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'CheckpointSampleTimestamp' => [ + 'title' => '位点采集时间。单位秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1689250071', + ], + 'GmtCreate' => [ + 'title' => '创建时间 UTC时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T18:04:36', + ], + 'GmtModify' => [ + 'title' => '修改时间 UTC时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T18:04:36', + ], + 'ErrorDetails' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + 'example' => 'null', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + ], + ], + ], + 'ReverseIncrSyncComponents' => [ + 'title' => '反向增量同步组件', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'title' => '所在地域', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'Name' => [ + 'title' => '名称', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1-9000:connector_v2:np_4w8****9jxc-incr_trans-1-0:0000000277', + ], + 'Ip' => [ + 'title' => '机器ip', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1', + ], + 'Identity' => [ + 'title' => '正向：项目id', + 'description' => '', + 'type' => 'string', + 'example' => 'np_4w8****', + ], + 'Subtopics' => [ + 'title' => 'subtopic', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'Subtopic。', + 'type' => 'string', + 'example' => 'null', + ], + ], + 'Status' => [ + 'title' => '状态 (RUNNING, STOPPED, EXCEPTION, FINISHED)', + 'description' => '', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'Checkpoint' => [ + 'title' => '当前位点 UTC 时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T09:19:53', + ], + 'Tps' => [ + 'title' => '每秒处理事务数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Delay' => [ + 'title' => '延迟，单位秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'CheckpointSampleTimestamp' => [ + 'title' => '位点采集时间。单位秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1689250049', + ], + 'GmtCreate' => [ + 'title' => '创建时间 UTC时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T18:04:36', + ], + 'GmtModify' => [ + 'title' => '修改时间 UTC时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T18:04:36', + ], + 'ErrorDetails' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 9,\\n \\"Cost\\": \\"48\\",\\n \\"Data\\": {\\n \\"StoreList\\": [\\n {\\n \\"Name\\": \\"xxx.xxx.xxx.1-7145:OB_ORACLE_np_4w3r***_4w:0000***97\\",\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"Topic\\": \\"OB_ORACLE_np_4w3r29c_4w3****\\",\\n \\"Subtopic\\": \\"OB_ORACLE_np_4w3***c_4w3**-0\\",\\n \\"Tps\\": 0,\\n \\"Delay\\": 24,\\n \\"Gmt\\": 1689250049,\\n \\"Conn\\": 1,\\n \\"Status\\": \\"EXCEPTION\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ],\\n \\"ToSwitch\\": false,\\n \\"Port\\": 2883,\\n \\"StorePort\\": 2882,\\n \\"BeginCheckpoint\\": \\"2023-07-13T09:19:53\\",\\n \\"EndCheckpoint\\": \\"2023-07-13T09:19:53\\",\\n \\"ErrMsg\\": \\"null\\",\\n \\"GmtCreate\\": \\"2023-07-13T17:29:54\\",\\n \\"GmtModified\\": \\"2023-07-13T17:29:54\\",\\n \\"LatelyHeartbeatTimeSec\\": 1689250071\\n }\\n ],\\n \\"ReverseStoreList\\": [\\n {\\n \\"Name\\": \\"xxx.xxx.xxx.1-9000:connector_v2:np_4w****9jxc-incr_trans-1-0:0000000277\\",\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"Region\\": \\"cn-shenzhen\\",\\n \\"Topic\\": \\"null\\",\\n \\"Subtopic\\": \\"null\\",\\n \\"Tps\\": 1,\\n \\"Delay\\": 1,\\n \\"Gmt\\": 1689250071,\\n \\"Conn\\": 1,\\n \\"Status\\": \\"EXCEPTION\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ],\\n \\"ToSwitch\\": false,\\n \\"Port\\": 2883,\\n \\"StorePort\\": 2882,\\n \\"BeginCheckpoint\\": \\"2023-07-13T09:19:53\\",\\n \\"EndCheckpoint\\": \\"2023-07-13T09:19:53\\",\\n \\"ErrMsg\\": \\"null\\",\\n \\"GmtCreate\\": \\"2023-07-13T18:04:36\\",\\n \\"GmtModified\\": \\"2023-07-13T18:04:36\\",\\n \\"LatelyHeartbeatTimeSec\\": 1689250071\\n }\\n ],\\n \\"FullVerifyComponents\\": [\\n {\\n \\"Region\\": \\"cn-beijing\\",\\n \\"Name\\": \\"xxx.xxx.xxx.1-9000:90247:0000000033\\",\\n \\"InconsistentQuantity\\": 0,\\n \\"ConsistentQuantity\\": 100,\\n \\"Progress\\": \\"100\\",\\n \\"RecordProgress\\": 100,\\n \\"Status\\": \\"RUNNING\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ],\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"TaskId\\": 0\\n }\\n ],\\n \\"FullImportComponents\\": [\\n {\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Name\\": \\"xxx.xxx.xxx.1-9000:connector_v2:np_4w8v****c-full_trans-1-0:0000000276\\",\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"Identity\\": \\"p_4w8v****\\",\\n \\"Progress\\": 90,\\n \\"Status\\": \\"RUNNING\\",\\n \\"GmtCreate\\": \\"2023-07-13T18:04:36\\",\\n \\"GmtModify\\": \\"2023-07-13T18:04:36\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ]\\n }\\n ],\\n \\"IncrSyncComponents\\": [\\n {\\n \\"Region\\": \\"cn-zhangjiakou\\",\\n \\"Name\\": \\"xxx.xxx.xxx.1-9000:connector_v2:np_4w****jxc-incr_trans-1-0:0000000277\\",\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"Identity\\": \\"np_4w***\\",\\n \\"Subtopics\\": [\\n \\"null\\"\\n ],\\n \\"Status\\": \\"RUNNING\\",\\n \\"Checkpoint\\": \\"2023-07-13T09:19:53\\",\\n \\"Tps\\": 1,\\n \\"Delay\\": 1,\\n \\"CheckpointSampleTimestamp\\": 1689250071,\\n \\"GmtCreate\\": \\"2023-07-13T18:04:36\\",\\n \\"GmtModify\\": \\"2023-07-13T18:04:36\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ]\\n }\\n ],\\n \\"ReverseIncrSyncComponents\\": [\\n {\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"Name\\": \\"xxx.xxx.xxx.1-9000:connector_v2:np_4w8****9jxc-incr_trans-1-0:0000000277\\",\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"Identity\\": \\"np_4w8****\\",\\n \\"Subtopics\\": [\\n \\"null\\"\\n ],\\n \\"Status\\": \\"RUNNING\\",\\n \\"Checkpoint\\": \\"2023-07-13T09:19:53\\",\\n \\"Tps\\": 1,\\n \\"Delay\\": 1,\\n \\"CheckpointSampleTimestamp\\": 1689250049,\\n \\"GmtCreate\\": \\"2023-07-13T18:04:36\\",\\n \\"GmtModify\\": \\"2023-07-13T18:04:36\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListProjectFullVerifyResult' => [ + 'summary' => '查询项目的全量校验结果', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'np_4w5abs****', + ], + ], + [ + 'name' => 'SourceSchemas', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '源端数据库名', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'source_schema', + ], + 'required' => false, + ], + ], + [ + 'name' => 'DestSchemas', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '目标端数据库名', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'dest_schema', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'title' => '状态', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'FINISHED', + 'enum' => [ + 'RUNNING', + 'ERROR', + 'FINISHED', + 'SUSPEND', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页参数，当前页', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页参数，每页个数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '150', + 'minimum' => '1', + 'example' => '', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111'."\n", + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator.', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DifferentNumber' => [ + 'title' => '不一致数据总条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'FullVerifyTableStatistics' => [ + 'title' => '全量校验列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceTableName' => [ + 'title' => '源端表名', + 'description' => '', + 'type' => 'string', + 'example' => 'source_table', + ], + 'SourceSchemaName' => [ + 'title' => '源端数据库名', + 'description' => '', + 'type' => 'string', + 'example' => 'source_db', + ], + 'DestSchemaName' => [ + 'title' => '目标端数据库名', + 'description' => '', + 'type' => 'string', + 'example' => 'dest_db', + ], + 'SourceOnlyCount' => [ + 'title' => '仅源端存在数据条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'DestOnlyCount' => [ + 'title' => '仅目的端存在数据条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'MismatchedCount' => [ + 'title' => '两端不一致数据条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ConsistentCount' => [ + 'title' => '两端一致数据条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Progress' => [ + 'title' => '校验进度', + 'description' => '', + 'type' => 'string', + 'example' => '80', + ], + 'Message' => [ + 'title' => '相关信息', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'Status' => [ + 'title' => '迁移状态 (RUNNING, ERROR, FINISHED, SUSPEND)', + 'description' => '', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'ResultType' => [ + 'title' => '校验结果类别 (RUNNING, SCHEMA_MISMATCH, INDEX_CONFLICT, TARGET_TABLE_NOT_EXIST, RUNTIME_EXCEPTION, BOTH_EMPTY, CONSISTENT, INCONSISTENT, SOURCE_EMPTY, TARGET_EMPTY, MISMATCH_LIMIT, MISMATCH_LIMIT_NO_PK, NOT_CATEGORIZED)', + 'description' => '', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'ResultDesc' => [ + 'title' => '校验结果类别描述', + 'description' => '', + 'type' => 'string', + 'example' => 'desc', + ], + 'ErrorDetails' => [ + 'title' => '表失败信息和原因', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111'."\n", + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + 'example' => 'null', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": {\\n \\"DifferentNumber\\": 11,\\n \\"FullVerifyTableStatistics\\": [\\n {\\n \\"SourceTableName\\": \\"source_table\\",\\n \\"SourceSchemaName\\": \\"source_db\\",\\n \\"DestSchemaName\\": \\"dest_db\\",\\n \\"SourceOnlyCount\\": 0,\\n \\"DestOnlyCount\\": 0,\\n \\"MismatchedCount\\": 0,\\n \\"ConsistentCount\\": 200,\\n \\"Progress\\": \\"80\\",\\n \\"Message\\": \\"null\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ResultType\\": \\"RUNNING\\",\\n \\"ResultDesc\\": \\"desc\\",\\n \\"ErrorDetails\\": [\\n {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"null\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'StartProjectsByLabel' => [ + 'summary' => '启动该label下的所有未启动项目', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '标签ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'l_****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '79', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => '执行的总项目数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'SucceedProjectIds' => [ + 'title' => '执行成功的项目id', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'np_4w****'."\n", + ], + ], + 'FailedProjectIds' => [ + 'title' => '执行失败的项目id', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'np_3w****'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 79,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": {\\n \\"Total\\": 20,\\n \\"SucceedProjectIds\\": [\\n \\"np_4w****\\\\n\\"\\n ],\\n \\"FailedProjectIds\\": [\\n \\"np_3w****\\\\n\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'StopProjectsByLabel' => [ + 'summary' => '暂停该label下的所有运行中项目', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '标签ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'l_****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111'."\n", + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'A595F34C-XXXX-5D0C-8DA8-B3ED76', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '140', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => '执行的总项目数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'SucceedProjectIds' => [ + 'title' => '执行成功的项目id', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'np_4w****', + ], + ], + 'FailedProjectIds' => [ + 'title' => '执行失败的项目id', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'np_3w****', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"A595F34C-XXXX-5D0C-8DA8-B3ED76\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 140,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": {\\n \\"Total\\": 16,\\n \\"SucceedProjectIds\\": [\\n \\"np_4w****\\"\\n ],\\n \\"FailedProjectIds\\": [\\n \\"np_3w****\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetUploadOssUrl' => [ + 'summary' => '公有云上传OSS 获取一个临时上传url', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'title' => '作用类型（CREATE_PROJECT）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'CREATE_PROJECT', + ], + ], + [ + 'name' => 'EffectiveTimeMinutes', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => ' '."\n" + .'CM-RESOAT1111'."\n", + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator.', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '278', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OssUrl' => [ + 'title' => '上传文件的临时url', + 'description' => '', + 'type' => 'string', + 'example' => 'https://cn-hangzhou-pre-omsstore.oss-cn-hangzhou.aliyuncs.com/open_api_create_project/oacp_4x****pvk?Expires=169031&OSSAccessKeyId=LTAI5tMN52D***TBf&Signature=XdDFPz%2BXKC***%2B', + ], + 'OssKey' => [ + 'title' => 'ossKey', + 'description' => '', + 'type' => 'string', + 'example' => 'open_api_create_project/oacp_4xd****vk', + ], + 'ExpectedExpirationTime' => [ + 'title' => 'ossUrl 的预计失效时间 UTC 时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-26T06:33:11.175'."\n", + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"\\\\t\\\\nCM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"null\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"Cost\\": \\"278\\",\\n \\"Data\\": {\\n \\"OssUrl\\": \\"https://cn-hangzhou-pre-omsstore.oss-cn-hangzhou.aliyuncs.com/open_api_create_project/oacp******?Expires=169031&OSSAccessKeyId=LTAI****************&Signature=XdDF****************\\",\\n \\"OssKey\\": \\"open_api_create_project/oacp_4xd****\\",\\n \\"ExpectedExpirationTime\\": \\"2023-07-26T06:33:11.175\\\\n\\"\\n }\\n}","type":"json"}]', + ], + 'ListWorkerInstances' => [ + 'summary' => '查询传输实例列表', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'Specs', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '实例规格', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'oms.g2m.small' => 'oms.g2m.small', + 'oms.g2m.medium' => 'oms.g2m.medium', + 'oms.g2m.large' => 'oms.g2m.large', + 'oms.g2m.xlarge' => 'oms.g2m.xlarge', + ], + 'example' => 'oms.g2m.small', + 'enum' => [], + ], + 'required' => false, + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => [ + 'title' => '传输实例名称', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'i4katz****', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'formData', + 'schema' => [ + 'title' => '源端类型（OCEANBASE,TIDB,KAFKA,ROCKETMQ,POLARDB_X_1,POLARDB_X_2）', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'OCEANBASE', + 'enum' => [ + 'OCEANBASE', + 'KAFKA', + 'ROCKETMQ', + 'POLARDB_X_1', + 'TIDB', + 'POLARDB_X_2', + ], + ], + ], + [ + 'name' => 'DestType', + 'in' => 'formData', + 'schema' => [ + 'title' => '目标端类型（OCEANBASE,TIDB,KAFKA,ROCKETMQ,POLARDB_X_1,POLARDB_X_2）', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'KAFKA', + 'enum' => [ + 'OCEANBASE', + 'KAFKA', + 'ROCKETMQ', + 'POLARDB_X_1', + 'POLARDB_X_2', + 'TIDB', + ], + ], + ], + [ + 'name' => 'OnlyBindable', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否只查询可绑定的实例(默认 true)', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200'."\n", + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'FATAL', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'successful'."\n", + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null'."\n", + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'successful', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '237', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '71', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '传输实例ID', + 'description' => '', + 'type' => 'string', + 'example' => 'g_i4katzv***', + ], + 'Spec' => [ + 'title' => '传输实例规格', + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'oms.g2m.small' => 'oms.g2m.small', + 'oms.g2m.medium' => 'oms.g2m.medium', + 'oms.g2m.large' => 'oms.g2m.large', + 'oms.g2m.xlarge' => 'oms.g2m.xlarge', + ], + 'example' => 'oms.g2m.small', + ], + 'Name' => [ + 'title' => '传输实例名称', + 'description' => '', + 'type' => 'string', + 'example' => 'i4wa71k****', + ], + 'Status' => [ + 'title' => '状态', + 'description' => '', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'Region' => [ + 'title' => '地域', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProjectId' => [ + 'title' => '项目ID', + 'description' => '', + 'type' => 'string', + 'example' => 'np_4kb18w****', + ], + 'ProjectName' => [ + 'title' => '项目ID', + 'description' => '', + 'type' => 'string', + 'example' => 'j_migration_cloud-kafkavpc-ob', + ], + 'ProjectType' => [ + 'title' => '项目ID', + 'description' => '', + 'type' => 'string', + 'example' => 'MIGRATION', + ], + 'GmtCreate' => [ + 'title' => '创建时间 UTC', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-14T20:49:53'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"200\\\\n\\",\\n \\"Level\\": \\"FATAL\\",\\n \\"Message\\": \\"successful\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\\\n\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Advice\\": \\"null\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 237,\\n \\"Cost\\": \\"71\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"g_i4katzv***\\",\\n \\"Spec\\": \\"oms.g2m.small\\",\\n \\"Name\\": \\"i4wa71k****\\",\\n \\"Status\\": \\"ONLINE\\",\\n \\"Region\\": \\"null\\",\\n \\"ProjectId\\": \\"np_4kb18w****\\",\\n \\"ProjectName\\": \\"j_migration_cloud-kafkavpc-ob\\",\\n \\"ProjectType\\": \\"MIGRATION\\",\\n \\"GmtCreate\\": \\"2023-07-14T20:49:53\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateMySqlDataSource' => [ + 'summary' => '创建 MySQL 数据源', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'source_name', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'title' => '类型：INTERNET、VPC、RDS、POLARDB、DG', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'VPC', + 'enum' => [ + 'INTERNET', + 'VPC', + 'RDS', + 'DG', + 'POLARDB', + ], + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1d2q3mhg9i23ofi****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-t4****', + ], + ], + [ + 'name' => 'DgInstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'dg-x****', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx.xxx.xxx.1', + ], + ], + [ + 'name' => 'Port', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2883', + ], + ], + [ + 'name' => 'Schema', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'user_name', + ], + ], + [ + 'name' => 'Password', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pass_word', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'UseSsl', + 'in' => 'formData', + 'schema' => [ + 'type' => 'boolean', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111'."\n", + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator.', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator.', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'string', + 'example' => 'e_edz****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"null\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator.\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 24,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"e_edz****\\"\\n}","type":"json"}]', + ], + 'CreateOceanBaseDataSource' => [ + 'summary' => '创建 OceanBase 数据源', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'source_name', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'OB_MYSQL_VPC' => 'OB_MYSQL_VPC', + 'OB_ORACLE_VPC' => 'OB_ORACLE_VPC', + 'OB_ORACLE_TENANT' => 'OB_ORACLE_TENANT', + 'OB_ORACLE' => 'OB_ORACLE', + 'OB_MYSQL' => 'OB_MYSQL', + 'OB_MYSQL_TENANT' => 'OB_MYSQL_TENANT', + ], + 'example' => 'OB_MYSQL_VPC', + ], + ], + [ + 'name' => 'Tenant', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'tenant_name', + ], + ], + [ + 'name' => 'Cluster', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cluster_name', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'vpc ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1d2q3mhg9i23ofi****', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx.xxx.xxx.1', + ], + ], + [ + 'name' => 'Port', + 'in' => 'formData', + 'schema' => [ + 'title' => '端口', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2883', + ], + ], + [ + 'name' => 'LogProxyIp', + 'in' => 'formData', + 'schema' => [ + 'title' => 'LogProxy IP', + 'description' => 'LogProxy IP。', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + ], + [ + 'name' => 'LogProxyPort', + 'in' => 'formData', + 'schema' => [ + 'title' => 'LogProxy 端口', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库用户名', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'user_name', + ], + ], + [ + 'name' => 'Password', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库用户名密码（Base64编码）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pass_word', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源描述信息', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ConfigUrl', + 'in' => 'formData', + 'schema' => [ + 'title' => 'OB Server 地址', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://xxx.xxx.xxx.2:2883/services?Action=ObRootServiceInfo&User_ID=alibaba&UID=ocpmaster&ObRegion=ob_1***29.admin', + ], + ], + [ + 'name' => 'DrcUserName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'sys 租户下用户名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'user_na***', + ], + ], + [ + 'name' => 'DrcPassword', + 'in' => 'formData', + 'schema' => [ + 'title' => 'sys 租户下用户名密码（Base64编码）', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pas***', + ], + ], + [ + 'name' => 'InnerDrcPassword', + 'in' => 'formData', + 'schema' => [ + 'title' => '__oceanbase_inner_drc_user 的密码,使用base64编码', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'in***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111'."\n", + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'string', + 'example' => 'e_edz****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"null\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 30,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"e_edz****\\"\\n}","type":"json"}]', + ], + 'ListDataSource' => [ + 'summary' => '查询数据源列表 (MySql、OB_MYSQL、OB_ORACLE)', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'SearchKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源ID或名称', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'GRATI****89278244', + ], + ], + [ + 'name' => 'Types', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '数据源类型（MYSQL_PUBLIC,MYSQL_VPC,MYSQL_DG,OB_MYSQL_CE_PUBLIC,OB_MYSQL,OB_ORACLE,OB_MYSQL_TENANT,OB_ORACLE_TENANT,POSTGRESQL_PUBLIC,OB_MYSQL_VPC,OB_ORACLE_VPC,OB_MYSQL_PUBLIC,OB_ORACLE_PUBLIC,ORACLE_PUBLIC,ORACLE_VPC,ORACLE_DG,RDS_MYSQL,POLAR_MYSQL,ADB_MYSQL,TIDB_PUBLIC,TIDB_VPC,KAFKA_ALIYUN,KAFKA_VPC,KAFKA_PUBLIC,ROCKETMQ_PUBLIC,ROCKETMQ_ALIYUN,ROCKETMQ_VPC,DB2_LUW_PUBLIC,SYBASE_PUBLIC,DATAHUB_PUBLIC,DATAHUB_ALIYUN,DATAHUB_VPC,DBP_OP_ROUTE,DMS,IDB,POLARDB_X_1_ALIYUN,POLARDB_X_2_ALIYUN）', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'MYSQL_PUBLIC', + 'enum' => [ + 'MYSQL_PUBLIC', + 'MYSQL_VPC', + 'MYSQL_DG', + 'OB_MYSQL_CE_PUBLIC', + 'OB_MYSQL', + 'OB_ORACLE', + 'OB_MYSQL_TENANT', + 'OB_ORACLE_TENANT', + 'POSTGRESQL_PUBLIC', + 'OB_MYSQL_VPC', + 'OB_ORACLE_VPC', + 'OB_MYSQL_PUBLIC', + 'OB_ORACLE_PUBLIC', + 'ORACLE_PUBLIC', + 'ORACLE_VPC', + 'ORACLE_DG', + 'RDS_MYSQL', + 'POLAR_MYSQL', + 'ADB_MYSQL', + 'TIDB_PUBLIC', + 'TIDB_VPC', + 'KAFKA_ALIYUN', + 'KAFKA_VPC', + 'KAFKA_PUBLIC', + 'ROCKETMQ_PUBLIC', + 'ROCKETMQ_ALIYUN', + 'ROCKETMQ_VPC', + 'DB2_LUW_PUBLIC', + 'SYBASE_PUBLIC', + 'DATAHUB_PUBLIC', + 'DATAHUB_ALIYUN', + 'DATAHUB_VPC', + 'DBP_OP_ROUTE', + 'DMS', + 'IDB', + 'POLARDB_X_1_ALIYUN', + 'POLARDB_X_2_ALIYUN', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'SortField', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序字段（gmtCreate 、gmtModified），默认 gmtCreate', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'gmtModified' => 'gmtModified', + 'gmtCreate' => 'gmtCreate', + ], + 'example' => 'gmtCreate', + ], + ], + [ + 'name' => 'Order', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序（降序 descend ， 升序：asc），默认 descend', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'descend', + 'default' => 'descend', + 'enum' => [ + 'descend', + 'asc', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页参数，当前页', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页参数，每页个数，默认10，最大150', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + 'maxLength' => 150, + 'minLength' => 1, + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '132', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '28', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '数据源终端标识', + 'description' => '', + 'type' => 'string', + 'example' => 'e_4w****v', + ], + 'Name' => [ + 'title' => '数据源名称', + 'description' => '', + 'type' => 'string', + 'example' => 'RATION***1DBUTF11', + ], + 'Type' => [ + 'title' => '数据源类型 (MYSQL_PUBLIC,MYSQL_VPC,MYSQL_DG,OB_MYSQL_CE_PUBLIC,OB_MYSQL,OB_ORACLE,OB_MYSQL_TENANT,OB_ORACLE_TENANT,POSTGRESQL_PUBLIC,OB_MYSQL_VPC,OB_ORACLE_VPC,OB_MYSQL_PUBLIC,OB_ORACLE_PUBLIC,ORACLE_PUBLIC,ORACLE_VPC,ORACLE_DG,RDS_MYSQL,POLAR_MYSQL,ADB_MYSQL,TIDB_PUBLIC,TIDB_VPC,KAFKA_ALIYUN,KAFKA_VPC,KAFKA_PUBLIC,ROCKETMQ_PUBLIC,ROCKETMQ_ALIYUN,ROCKETMQ_VPC,DB2_LUW_PUBLIC,SYBASE_PUBLIC,DATAHUB_PUBLIC,DATAHUB_ALIYUN,DATAHUB_VPC,DBP_OP_ROUTE,DMS,IDB,POLARDB_X_1_ALIYUN,POLARDB_X_2_ALIYUN)', + 'description' => '', + 'type' => 'string', + 'example' => 'MYSQL_PUBLIC', + 'enum' => [ + 'MYSQL_PUBLIC', + 'MYSQL_VPC', + 'MYSQL_DG', + 'OB_MYSQL_CE_PUBLIC', + 'OB_MYSQL', + 'OB_ORACLE', + 'OB_MYSQL_TENANT', + 'OB_ORACLE_TENANT', + 'POSTGRESQL_PUBLIC', + 'OB_MYSQL_VPC', + 'OB_ORACLE_VPC', + 'OB_MYSQL_PUBLIC', + 'OB_ORACLE_PUBLIC', + 'ORACLE_PUBLIC', + 'ORACLE_VPC', + 'ORACLE_DG', + 'RDS_MYSQL', + 'POLAR_MYSQL', + 'ADB_MYSQL', + 'TIDB_PUBLIC', + 'TIDB_VPC', + 'KAFKA_ALIYUN', + 'KAFKA_VPC', + 'KAFKA_PUBLIC', + 'ROCKETMQ_PUBLIC', + 'ROCKETMQ_ALIYUN', + 'ROCKETMQ_VPC', + 'DB2_LUW_PUBLIC', + 'SYBASE_PUBLIC', + 'DATAHUB_PUBLIC', + 'DATAHUB_ALIYUN', + 'DATAHUB_VPC', + 'DBP_OP_ROUTE', + 'DMS', + 'IDB', + 'POLARDB_X_1_ALIYUN', + 'POLARDB_X_2_ALIYUN', + ], + ], + 'Role' => [ + 'title' => '数据源角色 (MASTER, SLAVE)', + 'description' => '', + 'type' => 'string', + 'example' => 'MASTER', + 'enum' => [ + 'MASTER', + 'SLAVE', + ], + ], + 'Owner' => [ + 'title' => '数据源Owner', + 'description' => '', + 'type' => 'string', + 'example' => 'admin', + ], + 'Tenant' => [ + 'title' => '租户名称或ID （专有云、VPC 对应名称）', + 'description' => '', + 'type' => 'string', + 'example' => 'tenant_name', + ], + 'Cluster' => [ + 'title' => '集群名称或ID (专有云、VPC 对应名称)', + 'description' => '', + 'type' => 'string', + 'example' => 'cluster_name', + ], + 'Schema' => [ + 'title' => '数据库名，若填写，后续迁移或者同步操作，只会针对该数据库操作； (专有云参数)', + 'description' => '', + 'type' => 'string', + 'example' => 'schema_name', + ], + 'VpcId' => [ + 'title' => 'vpc id （公有云参数）', + 'description' => '', + 'type' => 'string', + 'example' => 'vpc_t4***', + ], + 'Ip' => [ + 'title' => 'ip（专有云、VPC）', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1', + ], + 'Port' => [ + 'title' => '端口（专有云、VPC）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2883', + ], + 'UserName' => [ + 'title' => '数据库连接用户名', + 'description' => '', + 'type' => 'string', + 'example' => 'user_name', + ], + 'Region' => [ + 'title' => '地域', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'Description' => [ + 'title' => '自定义描述信息,最长 128 个字符', + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'OracleSid' => [ + 'title' => 'ORACLE的sid', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'OracleNlsLengthSemantics' => [ + 'title' => 'nls_length_semantics 属性，只针对 oracle、ob-oracle', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'OperatingSystem' => [ + 'title' => '操作系统，ob 没有。', + 'description' => '', + 'type' => 'string', + 'example' => 'Linux', + ], + 'Version' => [ + 'title' => '版本', + 'description' => '', + 'type' => 'string', + 'example' => '4.1.0', + ], + 'Timezone' => [ + 'title' => '时区', + 'description' => '', + 'type' => 'string', + 'example' => '+08:00', + ], + 'Charset' => [ + 'title' => '编码', + 'description' => '', + 'type' => 'string', + 'example' => 'utf8mb4', + ], + 'ResourceOwner' => [ + 'title' => '资源所有者', + 'description' => '', + 'type' => 'string', + 'example' => '178641****05809', + ], + 'GmtCreate' => [ + 'title' => '创建时间 UTC', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T20:27:28.000+00:00', + ], + 'GmtModified' => [ + 'title' => '修改时间 UTC', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T20:37:28.000+00:00', + ], + 'PartnerId' => [ + 'title' => '对应主备库ID', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ConnExtraAttributes' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 132,\\n \\"Cost\\": \\"28\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"e_4w****v\\",\\n \\"Name\\": \\"RATION***1DBUTF11\\",\\n \\"Type\\": \\"MYSQL_PUBLIC\\",\\n \\"Role\\": \\"MASTER\\",\\n \\"Owner\\": \\"admin\\",\\n \\"Tenant\\": \\"tenant_name\\",\\n \\"Cluster\\": \\"cluster_name\\",\\n \\"Schema\\": \\"schema_name\\",\\n \\"VpcId\\": \\"vpc_t4***\\",\\n \\"Ip\\": \\"xxx.xxx.xxx.1\\",\\n \\"Port\\": 2883,\\n \\"UserName\\": \\"user_name\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"Description\\": \\"test\\",\\n \\"OracleSid\\": \\"null\\",\\n \\"OracleNlsLengthSemantics\\": \\"null\\",\\n \\"OperatingSystem\\": \\"Linux\\",\\n \\"Version\\": \\"4.1.0\\",\\n \\"Timezone\\": \\"+08:00\\",\\n \\"Charset\\": \\"utf8mb4\\",\\n \\"ResourceOwner\\": \\"178641****05809\\",\\n \\"GmtCreate\\": \\"2023-07-13T20:27:28.000+00:00\\",\\n \\"GmtModified\\": \\"2023-07-13T20:37:28.000+00:00\\",\\n \\"PartnerId\\": \\"null\\",\\n \\"ConnExtraAttributes\\": \\"null\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateLabel' => [ + 'summary' => '创建标签', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111'."\n", + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'E3D924FB-52****B253-0C1A7EFB778C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'string', + 'example' => 'l_****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\\\n\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"E3D924FB-52****B253-0C1A7EFB778C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 24,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": \\"l_****\\"\\n}","type":"json"}]', + ], + 'ListAllLabels' => [ + 'summary' => '查询标签列表', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null ', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '29', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'ID', + 'description' => '', + 'type' => 'string', + 'example' => 'l_4w6r0***', + ], + 'Name' => [ + 'title' => '名称', + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null \\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 29,\\n \\"Cost\\": \\"1\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"l_4w6r0***\\",\\n \\"Name\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateOmsMysqlDataSource' => [ + 'summary' => 'You can call this operation to create a MySQL data source. ', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源名称。长度为2~128个英文或中文字符。可以包含数字、下划线（_）、半角句号（.）或者短划线（-）。不能包含“/”等非法字符', + 'description' => 'The name of the data source. '."\n" + .'It must be 2 to 128 characters in length and can contain letters, digits, underscores (_), periods (.), and hyphens (-). '."\n" + ."\n" + .'> <br>Invalid characters, such as slashes (/), are not allowed.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oms-mysql', + 'enum' => [], + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'title' => '所有 mysql 的类型 枚举：'."\n" + .'INTERNET、VPC、RDS、POLARDB、DG', + 'description' => 'The type of the MySQL data source. '."\n" + .'Valid values: INTERNET, VPC, RDS, PolarDB, and DG.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'INTERNET', + 'enum' => [], + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源所属VPC ID。若Type为VPC则该字段必填。', + 'description' => 'The ID of the VPC to which the data source belongs. '."\n" + ."\n" + .'> <br>If Type is set to VPC, this parameter is required. ', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-12345abcde*******', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源云实例ID。若Type为RDS、POLARDB、DG该字段必填。', + 'description' => 'The ID of the ECS instance of the data source. '."\n" + ."\n" + .'> <br>If Type is set to RDS, PolarDB, or DG, this parameter is required.', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-12ab34cd56******', + 'enum' => [], + ], + ], + [ + 'name' => 'DgDatabaseId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'database gateway，数据库网关实例 id。若Type为 DG，该字段必填。', + 'description' => 'The ID of the database gateway instance. '."\n" + ."\n" + .'> <br>If Type is set to DG, this parameter is required. ', + 'type' => 'string', + 'required' => false, + 'example' => 'dg-yhss6sdlaff****', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源 ip 地址。若Type为INTERNET、VPC该字段必填。', + 'description' => 'The IP address of the data source. '."\n" + ."\n" + .'> <br>If Type is set to INTERNET or VPC, this parameter is required. ', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.****', + ], + ], + [ + 'name' => 'Port', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源端口。若Type为INTERNET、VPC该字段必填。', + 'description' => 'The port number of the data source. '."\n" + ."\n" + .'> <br>If Type is set to INTERNET or VPC, this parameter is required. ', + 'type' => 'string', + 'required' => false, + 'example' => '3306', + ], + ], + [ + 'name' => 'Schema', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名。若填写，后续迁移或者同步操作，只会针对该数据库操作；', + 'description' => 'The name of the database. '."\n" + ."\n" + .'> <br>If you specify this parameter, subsequent migration or synchronization operations will take effect on this database only. ', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Username', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库连接用户名。', + 'description' => 'The username that is used to access the database. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'omsTestUser', + ], + ], + [ + 'name' => 'Password', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库连接密码，待加密明文（必须经过Base64编码）。', + 'description' => 'The password of the username that is used to access the database. It must be Base64 encoded. '."\n" + .'For example, for the password abcd123@!, the Base64-encoded value is YWJjZDEyM0Ah. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'YWJjZDEyM0Ah', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源的描述。长度为2~256个英文或中文字符。默认值为空。', + 'description' => 'The description of the data source. '."\n" + ."\n" + .'It must be 2 to 256 characters in length. The default value is null.', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL data source for OMS testing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Data' => [ + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'EndpointId' => [ + 'description' => 'The ID of the data source record. ', + 'type' => 'string', + 'example' => 'e_1234abcd*****', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Data\\": {\\n \\"EndpointId\\": \\"e_1234abcd*****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateOmsMysqlDataSourceResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n <Data>\\n <EndpointId>e_1234abcd*****</EndpointId>\\n </Data>\\n</CreateOmsMysqlDataSourceResponse>","errorExample":""}]', + 'title' => ' ', + 'description' => 'To call this operation, you must add the IP address of the OceanBase Migration Service (OMS) server to the whitelist of the Alibaba Cloud database instance, the security rules of the ECS instance, or the security settings of your self-managed database (usually the firewall of your self-managed database) to ensure that OMS can successfully access your database instance. To obtain the IP address of the OMS server, go to the OMS data source management page in the OMS console.', + ], + 'ReleaseWorkerInstance' => [ + 'summary' => '释放传输实例 （未绑定项目时才可以释放）', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '传输实例 ID （g_xxx）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'g_abcdefj***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"30\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + ], + 'CancelProjectModifyRecord' => [ + 'summary' => '根据记录id取消修改操作 （仅支持处于 PENDING 状态的修改记录）', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '修改记录 ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '344000005', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + 'Data' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"200\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"30\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + ], + 'RetryProjectModifyRecords' => [ + 'summary' => '根据修改记录 ID 重试修改操作（仅支持处于 FAILED 状态的修改记录）', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '修改记录 ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '344000005', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator.', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + 'Data' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"200\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"30\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + ], + 'StopProjectModifyRecords' => [ + 'summary' => '根据修改记录 ID 终止修改操作，不可恢复（仅支持处于 RUNNING / FAILED 状态的修改记录）', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '修改记录 ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '344000005', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator.', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator.', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + 'Data' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator.\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"30\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + ], + 'ListProjectModifyRecords' => [ + 'summary' => '根据项目 ID 查询项目的修改记录', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目 ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'np_598jmu****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '修改记录 id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '344000005', + ], + 'SubProjectId' => [ + 'title' => '子项目 id（增表时产生）', + 'description' => '', + 'type' => 'string', + 'example' => 'np_598qm***', + ], + 'MergeRequestId' => [ + 'title' => '合并父子项目的工单 id，用于加表场景', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'id', + ], + 'UpdateRequestId' => [ + 'title' => '更新父项目工单 id，用于减表或已有表对象更新场景', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'id', + ], + 'Type' => [ + 'title' => '修改记录任务类型 (INCREASE_OBJECT: 增加对象, DECREASE_OBJECT: 减少对象)', + 'description' => '', + 'type' => 'string', + 'example' => 'INCREASE_OBJECT', + ], + 'Status' => [ + 'title' => '修改记录状态 (PENDING: 待执行, MODIFYING: 修改中（减表修改父项目工单的执行，加表创建子项目）, RUNNING: 运行中（子项目运行中）, MERGING: 合并中（父子项目符合合并条件）, TERMINATED: 已终止, SUCCESS: 成功, FAILED: 失败, CANCEL: 已取消)', + 'description' => '', + 'type' => 'string', + 'example' => 'PENDING', + ], + 'ErrorDetail' => [ + 'title' => '错误详情，修改记录状态处于', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + 'example' => 'null', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Databases' => [ + 'title' => '减少的对象（同步）', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MappedName' => [ + 'title' => '映射对象 database', + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_db', + ], + 'Name' => [ + 'title' => '库名', + 'description' => '', + 'type' => 'string', + 'example' => 'db_name', + ], + 'Id' => [ + 'title' => '库 ID', + 'description' => '', + 'type' => 'string', + 'example' => 'db_id', + ], + 'Tables' => [ + 'title' => '当前库下的传输表对象配置', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MappedName' => [ + 'title' => '映射对象 table/topic', + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_name', + ], + 'Name' => [ + 'title' => '表名', + 'description' => '', + 'type' => 'string', + 'example' => 'table_name', + ], + 'Id' => [ + 'title' => '表 ID', + 'description' => '', + 'type' => 'string', + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'title' => '行过滤表', + 'description' => '', + 'type' => 'string', + 'example' => 'id < 1', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'ShardColumns' => [ + 'title' => '分片键列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col1', + ], + ], + 'Columns' => [ + 'title' => '列列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'title' => '列名', + 'description' => '', + 'type' => 'string', + 'example' => 'col_name', + ], + 'MappedName' => [ + 'title' => '列映射名', + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_col', + ], + 'Position' => [ + 'title' => '字段位置', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'ColumnType' => [ + 'title' => '列类型', + 'description' => '', + 'type' => 'string', + 'example' => 'FLOAT', + ], + 'RecordFieldType' => [ + 'title' => '列类型引申 (INT8, INT16, INT24, INT32, INT64, BIGINT, BOOLEAN, FLOAT, DOUBLE, DECIMAL, NUMBER, SMALL_MONEY, MONEY, DEC_FLOAT, REAL, UCHAR_STRING, GRAPHIC_STRING, CHAR_STRING, NCHAR_STRING, VAR_GRAPHIC_STRING, VAR_UCHAR_STRING, VAR_STRING, VAR_CHAR_STRING, VAR_NCHAR_STRING, ROW_ID, UROWID, TEXT, NTEXT, UTEXT, TINY_TEXT, MEDIUM_TEXT, LONG_TEXT, BINARY_BYTES, VAR_BINARY_BYTES, RAW, LONG_RAW, BIT, VAR_BIT, BLOB, TINY_BLOB, MEDIUM_BLOB, LONG_BLOB, BFILE, IMAGE, JSONB, UUID, ENUM, SET, INTERVAL_DAY_TO_SECOND, INTERVAL_YEAR_TO_MONTH, INTERVAL_DATE_TIME, CLOB, NCLOB, XML, JSON, LONG_VAR_CHAR, LONG_VAR_GRAPHIC, GEOGRAPHY, GEOMETRY, POINT, LSEG, BOX, PATH, CIRCLE, LINESTRING, POLYGON, MULTIPOINT, MULTILINESTRING, MULTIPOLYGON, GEOMETRYCOLLECTION, CIDR, INET, MACADDR, MACADDR8, TSVERCTOR, TSQUERY, YEAR, DATE, MYSQL_NEW_DATE, TIME, TIME_WITH_NANOS, TIME_WITH_TIMEZONE, SMALL_DATETIME, DATETIME, DATETIME_WITH_NONAS, TIMESTAMP_IN_LONG, TIMESTAMP_IN_LONG_WITH_NANOS, TIMESTAMP, TIMESTAMP_WITH_NANOS, TIMESTAMP_WITH_TIMEZONE, TIMESTAMP_WITH_LOCAL_TIMEZONE, ZONED_DATETIME, OID, REGCLASS, REGCOLLATION, REGCONFIG, REGDICTIONARY, REGNAMESPACE, REGOPER, REGOPERATOR, REGROLE, REGTYPE, INT4RANGE, INT8RANGE, NUMRANGE, TSRANGE, TSTZRANGE, DATERANGE, STRUCT, LIST, NULL, CUSTOM_TYPE, UNIQUEIDENTIFIER, UNSUPPORTED_TYPE)', + 'description' => '', + 'type' => 'string', + 'example' => 'INT8', + ], + 'RawColumnType' => [ + 'title' => '数据库记录的列类型原始字符串', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ColumnKey' => [ + 'title' => '索引类型 (PRI, UNI, MUL)', + 'description' => '', + 'type' => 'string', + 'example' => 'PRI', + ], + 'Nullable' => [ + 'title' => '是否可为空', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DefaultValue' => [ + 'title' => '默认值', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'DataLength' => [ + 'title' => '字段长度', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'null', + ], + 'DataPrecision' => [ + 'title' => '精度', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '64', + ], + 'DataScale' => [ + 'title' => '小数点', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'Encoding' => [ + 'title' => '字符编码', + 'description' => '', + 'type' => 'string', + 'example' => 'utf8', + ], + 'ColumnComment' => [ + 'title' => '字段注释', + 'description' => '', + 'type' => 'string', + 'example' => 'comments', + ], + 'IsGenerateField' => [ + 'title' => '是否是隐藏列', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Type' => [ + 'title' => 'DATABASE, TABLE', + 'description' => '', + 'type' => 'string', + 'example' => 'DATABASE', + ], + ], + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB table schema', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pk', + ], + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col2', + ], + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PARTITION BY VALUE(\'id\')', + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + ], + ], + ], + ], + ], + 'Views' => [ + 'title' => '当前库下的传输视图对象配置', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MappedName' => [ + 'title' => '映射对象 table/topic', + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_view', + ], + 'Name' => [ + 'title' => '表名', + 'description' => '', + 'type' => 'string', + 'example' => 'table_name', + ], + 'Id' => [ + 'title' => '表 ID', + 'description' => '', + 'type' => 'string', + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'title' => '行过滤表', + 'description' => '', + 'type' => 'string', + 'example' => 'id<1', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'ShardColumns' => [ + 'title' => '分片键列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col1', + ], + ], + 'Columns' => [ + 'title' => '列列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'title' => '列名', + 'description' => '', + 'type' => 'string', + 'example' => 'col_name', + ], + 'MappedName' => [ + 'title' => '列映射名', + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_name', + ], + 'Position' => [ + 'title' => '字段位置', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'ColumnType' => [ + 'title' => '列类型', + 'description' => '', + 'type' => 'string', + 'example' => 'FLOAT', + ], + 'RecordFieldType' => [ + 'title' => '列类型引申 (INT8, INT16, INT24, INT32, INT64, BIGINT, BOOLEAN, FLOAT, DOUBLE, DECIMAL, NUMBER, SMALL_MONEY, MONEY, DEC_FLOAT, REAL, UCHAR_STRING, GRAPHIC_STRING, CHAR_STRING, NCHAR_STRING, VAR_GRAPHIC_STRING, VAR_UCHAR_STRING, VAR_STRING, VAR_CHAR_STRING, VAR_NCHAR_STRING, ROW_ID, UROWID, TEXT, NTEXT, UTEXT, TINY_TEXT, MEDIUM_TEXT, LONG_TEXT, BINARY_BYTES, VAR_BINARY_BYTES, RAW, LONG_RAW, BIT, VAR_BIT, BLOB, TINY_BLOB, MEDIUM_BLOB, LONG_BLOB, BFILE, IMAGE, JSONB, UUID, ENUM, SET, INTERVAL_DAY_TO_SECOND, INTERVAL_YEAR_TO_MONTH, INTERVAL_DATE_TIME, CLOB, NCLOB, XML, JSON, LONG_VAR_CHAR, LONG_VAR_GRAPHIC, GEOGRAPHY, GEOMETRY, POINT, LSEG, BOX, PATH, CIRCLE, LINESTRING, POLYGON, MULTIPOINT, MULTILINESTRING, MULTIPOLYGON, GEOMETRYCOLLECTION, CIDR, INET, MACADDR, MACADDR8, TSVERCTOR, TSQUERY, YEAR, DATE, MYSQL_NEW_DATE, TIME, TIME_WITH_NANOS, TIME_WITH_TIMEZONE, SMALL_DATETIME, DATETIME, DATETIME_WITH_NONAS, TIMESTAMP_IN_LONG, TIMESTAMP_IN_LONG_WITH_NANOS, TIMESTAMP, TIMESTAMP_WITH_NANOS, TIMESTAMP_WITH_TIMEZONE, TIMESTAMP_WITH_LOCAL_TIMEZONE, ZONED_DATETIME, OID, REGCLASS, REGCOLLATION, REGCONFIG, REGDICTIONARY, REGNAMESPACE, REGOPER, REGOPERATOR, REGROLE, REGTYPE, INT4RANGE, INT8RANGE, NUMRANGE, TSRANGE, TSTZRANGE, DATERANGE, STRUCT, LIST, NULL, CUSTOM_TYPE, UNIQUEIDENTIFIER, UNSUPPORTED_TYPE)', + 'description' => '', + 'type' => 'string', + 'example' => 'INT8', + ], + 'RawColumnType' => [ + 'title' => '数据库记录的列类型原始字符串', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ColumnKey' => [ + 'title' => '索引类型 (PRI, UNI, MUL)', + 'description' => '', + 'type' => 'string', + 'example' => 'PRI', + ], + 'Nullable' => [ + 'title' => '是否可为空', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'DefaultValue' => [ + 'title' => '默认值', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'DataLength' => [ + 'title' => '字段长度', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'null', + ], + 'DataPrecision' => [ + 'title' => '精度', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '64', + ], + 'DataScale' => [ + 'title' => '小数点', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'Encoding' => [ + 'title' => '字符编码', + 'description' => '', + 'type' => 'string', + 'example' => 'utf16', + ], + 'ColumnComment' => [ + 'title' => '字段注释', + 'description' => '', + 'type' => 'string', + 'example' => 'comments', + ], + 'IsGenerateField' => [ + 'title' => '是否是隐藏列', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Type' => [ + 'title' => 'DATABASE, TABLE', + 'description' => '', + 'type' => 'string', + 'example' => 'DATABASE', + ], + ], + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB table schema', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pk', + ], + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col2', + ], + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PARTITION BY VALUE(\'id\')', + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + ], + ], + ], + ], + ], + 'SpecificTables' => [ + 'title' => '具体表对象配置', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MappedName' => [ + 'title' => '映射对象 table/topic', + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_name', + ], + 'Name' => [ + 'title' => '表名', + 'description' => '', + 'type' => 'string', + 'example' => 'table_name', + ], + 'Id' => [ + 'title' => '表 ID', + 'description' => '', + 'type' => 'string', + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'title' => '行过滤表', + 'description' => '', + 'type' => 'string', + 'example' => 'id<3', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'ShardColumns' => [ + 'title' => '分片键列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col2', + ], + ], + 'Columns' => [ + 'title' => '列列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'title' => '列名', + 'description' => '', + 'type' => 'string', + 'example' => 'col_name', + ], + 'MappedName' => [ + 'title' => '列映射名', + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_name', + ], + 'Position' => [ + 'title' => '字段位置', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'ColumnType' => [ + 'title' => '列类型', + 'description' => '', + 'type' => 'string', + 'example' => 'FLOAT', + ], + 'RecordFieldType' => [ + 'title' => '列类型引申 (INT8, INT16, INT24, INT32, INT64, BIGINT, BOOLEAN, FLOAT, DOUBLE, DECIMAL, NUMBER, SMALL_MONEY, MONEY, DEC_FLOAT, REAL, UCHAR_STRING, GRAPHIC_STRING, CHAR_STRING, NCHAR_STRING, VAR_GRAPHIC_STRING, VAR_UCHAR_STRING, VAR_STRING, VAR_CHAR_STRING, VAR_NCHAR_STRING, ROW_ID, UROWID, TEXT, NTEXT, UTEXT, TINY_TEXT, MEDIUM_TEXT, LONG_TEXT, BINARY_BYTES, VAR_BINARY_BYTES, RAW, LONG_RAW, BIT, VAR_BIT, BLOB, TINY_BLOB, MEDIUM_BLOB, LONG_BLOB, BFILE, IMAGE, JSONB, UUID, ENUM, SET, INTERVAL_DAY_TO_SECOND, INTERVAL_YEAR_TO_MONTH, INTERVAL_DATE_TIME, CLOB, NCLOB, XML, JSON, LONG_VAR_CHAR, LONG_VAR_GRAPHIC, GEOGRAPHY, GEOMETRY, POINT, LSEG, BOX, PATH, CIRCLE, LINESTRING, POLYGON, MULTIPOINT, MULTILINESTRING, MULTIPOLYGON, GEOMETRYCOLLECTION, CIDR, INET, MACADDR, MACADDR8, TSVERCTOR, TSQUERY, YEAR, DATE, MYSQL_NEW_DATE, TIME, TIME_WITH_NANOS, TIME_WITH_TIMEZONE, SMALL_DATETIME, DATETIME, DATETIME_WITH_NONAS, TIMESTAMP_IN_LONG, TIMESTAMP_IN_LONG_WITH_NANOS, TIMESTAMP, TIMESTAMP_WITH_NANOS, TIMESTAMP_WITH_TIMEZONE, TIMESTAMP_WITH_LOCAL_TIMEZONE, ZONED_DATETIME, OID, REGCLASS, REGCOLLATION, REGCONFIG, REGDICTIONARY, REGNAMESPACE, REGOPER, REGOPERATOR, REGROLE, REGTYPE, INT4RANGE, INT8RANGE, NUMRANGE, TSRANGE, TSTZRANGE, DATERANGE, STRUCT, LIST, NULL, CUSTOM_TYPE, UNIQUEIDENTIFIER, UNSUPPORTED_TYPE)', + 'description' => '', + 'type' => 'string', + 'example' => 'INT8', + ], + 'RawColumnType' => [ + 'title' => '数据库记录的列类型原始字符串', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ColumnKey' => [ + 'title' => '索引类型 (PRI, UNI, MUL)', + 'description' => '', + 'type' => 'string', + 'example' => 'PRI', + ], + 'Nullable' => [ + 'title' => '是否可为空', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'DefaultValue' => [ + 'title' => '默认值', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'DataLength' => [ + 'title' => '字段长度', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'null', + ], + 'DataPrecision' => [ + 'title' => '精度', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '64', + ], + 'DataScale' => [ + 'title' => '小数点', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'Encoding' => [ + 'title' => '字符编码', + 'description' => '', + 'type' => 'string', + 'example' => 'utf16', + ], + 'ColumnComment' => [ + 'title' => '字段注释', + 'description' => '', + 'type' => 'string', + 'example' => 'comments', + ], + 'IsGenerateField' => [ + 'title' => '是否是隐藏列', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Type' => [ + 'title' => 'DATABASE, TABLE', + 'description' => '', + 'type' => 'string', + 'example' => 'DATABASE', + ], + ], + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB table schema', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pk', + ], + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col2', + ], + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PARTITION BY VALUE(\'id\')', + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + ], + ], + ], + ], + ], + 'SpecificViews' => [ + 'title' => '具体视图对象配置', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MappedName' => [ + 'title' => '映射对象 table/topic', + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_name', + ], + 'Name' => [ + 'title' => '表名', + 'description' => '', + 'type' => 'string', + 'example' => 'table_name', + ], + 'Id' => [ + 'title' => '表 ID', + 'description' => '', + 'type' => 'string', + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'title' => '行过滤表', + 'description' => '', + 'type' => 'string', + 'example' => 'id < 1', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col1', + ], + ], + 'ShardColumns' => [ + 'title' => '分片键列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col2', + ], + ], + 'Columns' => [ + 'title' => '列列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'title' => '列名', + 'description' => '', + 'type' => 'string', + 'example' => 'col_name', + ], + 'MappedName' => [ + 'title' => '列映射名', + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_name', + ], + 'Position' => [ + 'title' => '字段位置', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'ColumnType' => [ + 'title' => '列类型', + 'description' => '', + 'type' => 'string', + 'example' => 'FLOAT', + ], + 'RecordFieldType' => [ + 'title' => '列类型引申 (INT8, INT16, INT24, INT32, INT64, BIGINT, BOOLEAN, FLOAT, DOUBLE, DECIMAL, NUMBER, SMALL_MONEY, MONEY, DEC_FLOAT, REAL, UCHAR_STRING, GRAPHIC_STRING, CHAR_STRING, NCHAR_STRING, VAR_GRAPHIC_STRING, VAR_UCHAR_STRING, VAR_STRING, VAR_CHAR_STRING, VAR_NCHAR_STRING, ROW_ID, UROWID, TEXT, NTEXT, UTEXT, TINY_TEXT, MEDIUM_TEXT, LONG_TEXT, BINARY_BYTES, VAR_BINARY_BYTES, RAW, LONG_RAW, BIT, VAR_BIT, BLOB, TINY_BLOB, MEDIUM_BLOB, LONG_BLOB, BFILE, IMAGE, JSONB, UUID, ENUM, SET, INTERVAL_DAY_TO_SECOND, INTERVAL_YEAR_TO_MONTH, INTERVAL_DATE_TIME, CLOB, NCLOB, XML, JSON, LONG_VAR_CHAR, LONG_VAR_GRAPHIC, GEOGRAPHY, GEOMETRY, POINT, LSEG, BOX, PATH, CIRCLE, LINESTRING, POLYGON, MULTIPOINT, MULTILINESTRING, MULTIPOLYGON, GEOMETRYCOLLECTION, CIDR, INET, MACADDR, MACADDR8, TSVERCTOR, TSQUERY, YEAR, DATE, MYSQL_NEW_DATE, TIME, TIME_WITH_NANOS, TIME_WITH_TIMEZONE, SMALL_DATETIME, DATETIME, DATETIME_WITH_NONAS, TIMESTAMP_IN_LONG, TIMESTAMP_IN_LONG_WITH_NANOS, TIMESTAMP, TIMESTAMP_WITH_NANOS, TIMESTAMP_WITH_TIMEZONE, TIMESTAMP_WITH_LOCAL_TIMEZONE, ZONED_DATETIME, OID, REGCLASS, REGCOLLATION, REGCONFIG, REGDICTIONARY, REGNAMESPACE, REGOPER, REGOPERATOR, REGROLE, REGTYPE, INT4RANGE, INT8RANGE, NUMRANGE, TSRANGE, TSTZRANGE, DATERANGE, STRUCT, LIST, NULL, CUSTOM_TYPE, UNIQUEIDENTIFIER, UNSUPPORTED_TYPE)', + 'description' => '', + 'type' => 'string', + 'example' => 'INT8', + ], + 'RawColumnType' => [ + 'title' => '数据库记录的列类型原始字符串', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ColumnKey' => [ + 'title' => '索引类型 (PRI, UNI, MUL)', + 'description' => '', + 'type' => 'string', + 'example' => 'PRI', + ], + 'Nullable' => [ + 'title' => '是否可为空', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DefaultValue' => [ + 'title' => '默认值', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'DataLength' => [ + 'title' => '字段长度', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'null', + ], + 'DataPrecision' => [ + 'title' => '精度', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '64', + ], + 'DataScale' => [ + 'title' => '小数点', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'Encoding' => [ + 'title' => '字符编码', + 'description' => '', + 'type' => 'string', + 'example' => 'utf16', + ], + 'ColumnComment' => [ + 'title' => '字段注释', + 'description' => '', + 'type' => 'string', + 'example' => 'comments', + ], + 'IsGenerateField' => [ + 'title' => '是否是隐藏列', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Type' => [ + 'title' => 'DATABASE, TABLE', + 'description' => '', + 'type' => 'string', + 'example' => 'DATABASE', + ], + ], + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB table schema', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pk', + ], + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col2', + ], + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PARTITION BY VALUE(\'id\')', + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'MigrationObjectsInfo' => [ + 'title' => '减少的对象（迁移）', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'WildcardMode' => [ + 'title' => '是否通配模式', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Tables' => [ + 'title' => '待迁移的 table 列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Schema' => [ + 'title' => '库名', + 'description' => '', + 'type' => 'string', + 'example' => 'schema_name', + ], + 'Name' => [ + 'title' => '对象名', + 'description' => '', + 'type' => 'string', + 'example' => 'table_name', + ], + ], + ], + ], + 'TablesBlack' => [ + 'title' => '待迁移的 table 黑名单列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Schema' => [ + 'title' => '库名', + 'description' => '', + 'type' => 'string', + 'example' => 'schema_name', + ], + 'Name' => [ + 'title' => '对象名', + 'description' => '', + 'type' => 'string', + 'example' => 'table_name', + ], + ], + ], + ], + 'Views' => [ + 'title' => '待迁移的 view 列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Schema' => [ + 'title' => '库名', + 'description' => '', + 'type' => 'string', + 'example' => 'schema_name', + ], + 'Name' => [ + 'title' => '对象名', + 'description' => '', + 'type' => 'string', + 'example' => 'view_name', + ], + ], + ], + ], + 'ViewsBlack' => [ + 'title' => '待迁移的 view 黑名单列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Schema' => [ + 'title' => '库名', + 'description' => '', + 'type' => 'string', + 'example' => 'schema_name', + ], + 'Name' => [ + 'title' => '对象名', + 'description' => '', + 'type' => 'string', + 'example' => 'view_name', + ], + ], + ], + ], + ], + ], + 'OmsProjectMappingInfo' => [ + 'title' => '减少的对象对应的匹配规则（迁移）', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SchemaMappings' => [ + 'title' => 'schema映射信息列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceName' => [ + 'title' => '源schema名', + 'description' => '', + 'type' => 'string', + 'example' => 'source_name', + ], + 'DestName' => [ + 'title' => '映射schema名', + 'description' => '', + 'type' => 'string', + 'example' => 'mapped_schema', + ], + ], + ], + ], + 'TableMappings' => [ + 'title' => '表映射信息列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceSchema' => [ + 'title' => '源schema名', + 'description' => '', + 'type' => 'string', + 'example' => 'source_schema', + ], + 'SourceName' => [ + 'title' => '源对象名', + 'description' => '', + 'type' => 'string', + 'example' => 'source_name', + ], + 'DestName' => [ + 'title' => '映射对象名', + 'description' => '', + 'type' => 'string', + 'example' => 'dest_name', + ], + ], + ], + ], + 'ColumnMappings' => [ + 'title' => '列映射信息列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceSchema' => [ + 'title' => '源schema名', + 'description' => '', + 'type' => 'string', + 'example' => 'source_schema', + ], + 'SourceTable' => [ + 'title' => '源table名', + 'description' => '', + 'type' => 'string', + 'example' => 'source_table', + ], + 'SourceName' => [ + 'title' => '源对象名', + 'description' => '', + 'type' => 'string', + 'example' => 'source_name', + ], + 'DestName' => [ + 'title' => '目的对象名', + 'description' => '', + 'type' => 'string', + 'example' => 'dest_name', + ], + ], + ], + ], + 'ViewMappings' => [ + 'title' => '视图映射信息列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceSchema' => [ + 'title' => '源schema名', + 'description' => '', + 'type' => 'string', + 'example' => 'schema_name', + ], + 'SourceName' => [ + 'title' => '源对象名', + 'description' => '', + 'type' => 'string', + 'example' => 'source_name', + ], + 'DestName' => [ + 'title' => '映射对象名', + 'description' => '', + 'type' => 'string', + 'example' => 'dest_name', + ], + ], + ], + ], + ], + ], + 'TableEtlList' => [ + 'title' => '减少对象的etl信息（迁移）', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TenantName' => [ + 'title' => '租户名', + 'description' => '', + 'type' => 'string', + 'example' => 'tenant_name', + ], + 'Database' => [ + 'title' => '数据库名', + 'description' => '', + 'type' => 'string', + 'example' => 'db_name', + ], + 'DestDatabase' => [ + 'title' => '目标数据库名', + 'description' => '', + 'type' => 'string', + 'example' => 'dest_db', + ], + 'TableName' => [ + 'title' => '表名', + 'description' => '', + 'type' => 'string', + 'example' => 'table_name', + ], + 'DestName' => [ + 'title' => '目标端表名/Topic名', + 'description' => '', + 'type' => 'string', + 'example' => 'dest_name', + ], + 'WhereClause' => [ + 'title' => 'sql 语法', + 'description' => '', + 'type' => 'string', + 'example' => 'id>1', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'col', + ], + ], + 'ShardColumns' => [ + 'title' => '分片键列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + ], + 'LogicTableId' => [ + 'title' => '针对逻辑表下，逻辑表 tableId', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'SourceEndpointId' => [ + 'title' => '针对物理表下传递 endpointId', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + 'GmtModified' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'string', + 'example' => '2023-07-13T06:26:15', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"30\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": 344000005,\\n \\"SubProjectId\\": \\"np_598qm***\\",\\n \\"MergeRequestId\\": 0,\\n \\"UpdateRequestId\\": 0,\\n \\"Type\\": \\"INCREASE_OBJECT\\",\\n \\"Status\\": \\"PENDING\\",\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\\\n\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Databases\\": [\\n {\\n \\"MappedName\\": \\"mapped_db\\",\\n \\"Name\\": \\"db_name\\",\\n \\"Id\\": \\"db_id\\",\\n \\"Tables\\": [\\n {\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Name\\": \\"table_name\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id < 1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col1\\"\\n ],\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"col_name\\",\\n \\"MappedName\\": \\"mapped_col\\",\\n \\"Position\\": 0,\\n \\"ColumnType\\": \\"FLOAT\\",\\n \\"RecordFieldType\\": \\"INT8\\",\\n \\"RawColumnType\\": \\"null\\",\\n \\"ColumnKey\\": \\"PRI\\",\\n \\"Nullable\\": true,\\n \\"DefaultValue\\": \\"null\\",\\n \\"DataLength\\": 0,\\n \\"DataPrecision\\": 64,\\n \\"DataScale\\": 0,\\n \\"Encoding\\": \\"utf8\\",\\n \\"ColumnComment\\": \\"comments\\",\\n \\"IsGenerateField\\": false,\\n \\"Type\\": \\"DATABASE\\"\\n }\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col2\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\",\\n \\"PartitionLifeCycle\\": 30\\n }\\n }\\n ],\\n \\"Views\\": [\\n {\\n \\"MappedName\\": \\"mapped_view\\",\\n \\"Name\\": \\"table_name\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id<1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col1\\"\\n ],\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"col_name\\",\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Position\\": 0,\\n \\"ColumnType\\": \\"FLOAT\\",\\n \\"RecordFieldType\\": \\"INT8\\",\\n \\"RawColumnType\\": \\"null\\",\\n \\"ColumnKey\\": \\"PRI\\",\\n \\"Nullable\\": false,\\n \\"DefaultValue\\": \\"null\\",\\n \\"DataLength\\": 0,\\n \\"DataPrecision\\": 64,\\n \\"DataScale\\": 0,\\n \\"Encoding\\": \\"utf16\\",\\n \\"ColumnComment\\": \\"comments\\",\\n \\"IsGenerateField\\": false,\\n \\"Type\\": \\"DATABASE\\"\\n }\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col2\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\",\\n \\"PartitionLifeCycle\\": 30\\n }\\n }\\n ],\\n \\"SpecificTables\\": [\\n {\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Name\\": \\"table_name\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id<3\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col2\\"\\n ],\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"col_name\\",\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Position\\": 0,\\n \\"ColumnType\\": \\"FLOAT\\",\\n \\"RecordFieldType\\": \\"INT8\\",\\n \\"RawColumnType\\": \\"null\\",\\n \\"ColumnKey\\": \\"PRI\\",\\n \\"Nullable\\": false,\\n \\"DefaultValue\\": \\"null\\",\\n \\"DataLength\\": 0,\\n \\"DataPrecision\\": 64,\\n \\"DataScale\\": 0,\\n \\"Encoding\\": \\"utf16\\",\\n \\"ColumnComment\\": \\"comments\\",\\n \\"IsGenerateField\\": false,\\n \\"Type\\": \\"DATABASE\\"\\n }\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col2\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\",\\n \\"PartitionLifeCycle\\": 30\\n }\\n }\\n ],\\n \\"SpecificViews\\": [\\n {\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Name\\": \\"table_name\\",\\n \\"Id\\": \\"table_id\\",\\n \\"WhereClause\\": \\"id < 1\\",\\n \\"FilterColumns\\": [\\n \\"col1\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"col2\\"\\n ],\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"col_name\\",\\n \\"MappedName\\": \\"mapped_name\\",\\n \\"Position\\": 0,\\n \\"ColumnType\\": \\"FLOAT\\",\\n \\"RecordFieldType\\": \\"INT8\\",\\n \\"RawColumnType\\": \\"null\\",\\n \\"ColumnKey\\": \\"PRI\\",\\n \\"Nullable\\": true,\\n \\"DefaultValue\\": \\"null\\",\\n \\"DataLength\\": 0,\\n \\"DataPrecision\\": 64,\\n \\"DataScale\\": 0,\\n \\"Encoding\\": \\"utf16\\",\\n \\"ColumnComment\\": \\"comments\\",\\n \\"IsGenerateField\\": false,\\n \\"Type\\": \\"DATABASE\\"\\n }\\n ],\\n \\"AdbTableSchema\\": {\\n \\"PrimaryKeys\\": [\\n \\"pk\\"\\n ],\\n \\"DistributedKeys\\": [\\n \\"col2\\"\\n ],\\n \\"PartitionStatement\\": \\"PARTITION BY VALUE(\'id\')\\",\\n \\"PartitionLifeCycle\\": 30\\n }\\n }\\n ]\\n }\\n ],\\n \\"MigrationObjectsInfo\\": {\\n \\"WildcardMode\\": true,\\n \\"Tables\\": [\\n {\\n \\"Schema\\": \\"schema_name\\",\\n \\"Name\\": \\"table_name\\"\\n }\\n ],\\n \\"TablesBlack\\": [\\n {\\n \\"Schema\\": \\"schema_name\\",\\n \\"Name\\": \\"table_name\\"\\n }\\n ],\\n \\"Views\\": [\\n {\\n \\"Schema\\": \\"schema_name\\",\\n \\"Name\\": \\"view_name\\"\\n }\\n ],\\n \\"ViewsBlack\\": [\\n {\\n \\"Schema\\": \\"schema_name\\",\\n \\"Name\\": \\"view_name\\"\\n }\\n ]\\n },\\n \\"OmsProjectMappingInfo\\": {\\n \\"SchemaMappings\\": [\\n {\\n \\"SourceName\\": \\"source_name\\",\\n \\"DestName\\": \\"mapped_schema\\"\\n }\\n ],\\n \\"TableMappings\\": [\\n {\\n \\"SourceSchema\\": \\"source_schema\\",\\n \\"SourceName\\": \\"source_name\\",\\n \\"DestName\\": \\"dest_name\\"\\n }\\n ],\\n \\"ColumnMappings\\": [\\n {\\n \\"SourceSchema\\": \\"source_schema\\",\\n \\"SourceTable\\": \\"source_table\\",\\n \\"SourceName\\": \\"source_name\\",\\n \\"DestName\\": \\"dest_name\\"\\n }\\n ],\\n \\"ViewMappings\\": [\\n {\\n \\"SourceSchema\\": \\"schema_name\\",\\n \\"SourceName\\": \\"source_name\\",\\n \\"DestName\\": \\"dest_name\\"\\n }\\n ]\\n },\\n \\"TableEtlList\\": [\\n {\\n \\"TenantName\\": \\"tenant_name\\",\\n \\"Database\\": \\"db_name\\",\\n \\"DestDatabase\\": \\"dest_db\\",\\n \\"TableName\\": \\"table_name\\",\\n \\"DestName\\": \\"dest_name\\",\\n \\"WhereClause\\": \\"id>1\\",\\n \\"FilterColumns\\": [\\n \\"col\\"\\n ],\\n \\"ShardColumns\\": [\\n \\"null\\"\\n ],\\n \\"LogicTableId\\": \\"null\\",\\n \\"SourceEndpointId\\": \\"null\\"\\n }\\n ],\\n \\"GmtModified\\": \\"2023-07-13T06:26:15\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateProjectModifyRecords' => [ + 'summary' => '修改传输对象（加减表）(仅支持处于 RUNNING/FAILED/SUSPEND 状态的项目)', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目 ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'np_fe****', + ], + ], + [ + 'name' => 'Databases', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '数据库信息（加减表时必填）', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '库ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'db_id', + ], + 'Name' => [ + 'title' => '数据库名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'db_name', + ], + 'MappedName' => [ + 'title' => '数据库映射名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mapped_db', + ], + 'Tables' => [ + 'title' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'table_name', + ], + 'MappedName' => [ + 'title' => '表映射名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mapped_table', + ], + 'Id' => [ + 'title' => '表ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'id<1', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col1', + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pk', + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col2', + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PARTITION BY VALUE(\'id\')', + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + 'required' => false, + ], + 'ObkvPartitionConfig' => [ + 'title' => 'Hbase 模式分区配置，仅迁移到OBKV场景下使用', + 'type' => 'object', + 'properties' => [ + 'PartitionType' => [ + 'type' => 'string', + 'enum' => [ + 'KEY', + 'RANGE', + 'NONE', + ], + ], + 'VirtualColumn' => [ + 'type' => 'string', + ], + 'PartitionSize' => [ + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '1024', + 'minimum' => '1', + ], + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Views' => [ + 'title' => '当前库下的传输视图对象配置', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '视图名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'view_name', + ], + 'MappedName' => [ + 'title' => '视图映射名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mapped_view', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'view_id', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'id<1', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col1', + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pk', + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col2', + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PARTITION BY VALUE(\'id\')', + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'SpecificTables' => [ + 'title' => '具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'table_name', + ], + 'MappedName' => [ + 'title' => '表映射名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mapped_table', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'id<1', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col1', + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pk', + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col2', + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PARTITION BY VALUE(\'id\')', + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'SpecificViews' => [ + 'title' => '具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '视图名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'view_name', + ], + 'MappedName' => [ + 'title' => '视图映射名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mapped_view', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'view_id', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'id <1', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col1', + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pk', + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'col2', + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PARTITION BY VALUE(\'id\')', + ], + 'PartitionLifeCycle' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'TransferMapping', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '传输对象列表（修改匹配规则时必填）', + 'type' => 'object', + 'properties' => [ + 'Mode' => [ + 'title' => '传输对象映射模式（SPECIFIC 指定对象、WILDCARD 匹配规则、COMPLEX 混合规则）', + 'type' => 'string', + 'required' => false, + 'example' => 'SPCEIFIC', + 'enum' => [ + 'SPECIFIC', + 'WILDCARD', + 'COMPLEX', + ], + ], + 'Databases' => [ + 'title' => '数据库信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '库ID', + 'type' => 'string', + ], + 'Name' => [ + 'title' => '数据库名', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '数据库映射名', + 'type' => 'string', + ], + 'ClusterName' => [ + 'title' => '映射对象集群（已废弃）', + 'type' => 'string', + ], + 'TenantName' => [ + 'title' => '映射对象租户（已废弃）', + 'type' => 'string', + ], + 'Tables' => [ + 'title' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '表映射名', + 'type' => 'string', + ], + 'Id' => [ + 'title' => '表ID', + 'type' => 'string', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'type' => 'string', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'PartitionStatement' => [ + 'type' => 'string', + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + ], + ], + ], + 'ObkvPartitionConfig' => [ + 'title' => 'Hbase 模式分区配置，仅迁移到OBKV场景下使用', + 'type' => 'object', + 'properties' => [ + 'PartitionType' => [ + 'type' => 'string', + 'enum' => [ + 'KEY', + 'RANGE', + 'NONE', + ], + ], + 'VirtualColumn' => [ + 'type' => 'string', + ], + 'PartitionSize' => [ + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '1024', + 'minimum' => '1', + ], + ], + ], + ], + ], + ], + 'Views' => [ + 'title' => '当前库下的传输视图对象配置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '视图名', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '视图映射名', + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'string', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'type' => 'string', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'PartitionStatement' => [ + 'type' => 'string', + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'SpecificTables' => [ + 'title' => '具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '表映射名', + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'string', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'type' => 'string', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'PartitionStatement' => [ + 'type' => 'string', + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'SpecificViews' => [ + 'title' => '具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '视图名', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '视图映射名', + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'string', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'type' => 'string', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'PartitionStatement' => [ + 'type' => 'string', + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'DatabasesBlack' => [ + 'title' => '匹配规则模式：数据库对象黑名单', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'type' => 'string', + ], + 'Name' => [ + 'title' => '库名', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '映射库名', + 'type' => 'string', + ], + 'ClusterName' => [ + 'title' => '映射对象集群（已废弃）', + 'type' => 'string', + ], + 'TenantName' => [ + 'title' => '映射对象租户（已废弃）', + 'type' => 'string', + ], + 'Tables' => [ + 'title' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '表映射名', + 'type' => 'string', + ], + 'Id' => [ + 'title' => '表ID', + 'type' => 'string', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'type' => 'string', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'PartitionStatement' => [ + 'type' => 'string', + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'Views' => [ + 'title' => '当前库下的传输视图对象配置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '视图名', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '视图映射名', + 'type' => 'string', + ], + 'Id' => [ + 'title' => '视图ID', + 'type' => 'string', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'type' => 'string', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'PartitionStatement' => [ + 'type' => 'string', + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'SpecificTables' => [ + 'title' => '具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'type' => 'string', + ], + 'Id' => [ + 'title' => '表ID', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '表映射名', + 'type' => 'string', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'type' => 'string', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'PartitionStatement' => [ + 'type' => 'string', + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'SpecificViews' => [ + 'title' => '具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '表映射名', + 'type' => 'string', + ], + 'Id' => [ + 'title' => '视图ID', + 'type' => 'string', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'type' => 'string', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'PartitionStatement' => [ + 'type' => 'string', + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'TableAndViewWhiteList' => [ + 'title' => '匹配规则模式：表、视图的通配白名单', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'TableAndViewBlackList' => [ + 'title' => '匹配规则模式：表、视图的通配黑名单', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'WhiteTableRules' => [ + 'title' => '表白名单规则', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaMapping' => [ + 'title' => 'schema 映射', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '对象名称', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '映射对象名称', + 'type' => 'string', + ], + ], + ], + 'ObjectMapping' => [ + 'title' => 'schema 下的对象映射', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '对象名称', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '映射对象名称', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'WhiteViewRules' => [ + 'title' => '视图白名单规则', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaMapping' => [ + 'title' => 'schema 映射', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '对象名称', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '映射对象名称', + 'type' => 'string', + ], + ], + ], + 'ObjectMapping' => [ + 'title' => 'schema 下的对象映射', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '对象名称', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '映射对象名称', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'BlackTableRules' => [ + 'title' => '表黑名单规则', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaMapping' => [ + 'title' => 'schema 映射', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '对象名称', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '映射对象名称', + 'type' => 'string', + ], + ], + ], + 'ObjectMapping' => [ + 'title' => 'schema 下的对象映射', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '对象名称', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '映射对象名称', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'BlackViewRules' => [ + 'title' => '视图黑名单规则', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaMapping' => [ + 'title' => 'schema 映射', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '对象名称', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '映射对象名称', + 'type' => 'string', + ], + ], + ], + 'ObjectMapping' => [ + 'title' => 'schema 下的对象映射', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '对象名称', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '映射对象名称', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'Schemas' => [ + 'title' => '精确库表对象设置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '库ID', + 'type' => 'string', + ], + 'Name' => [ + 'title' => '数据库名', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '数据库映射名', + 'type' => 'string', + ], + 'ClusterName' => [ + 'title' => '映射对象集群（已废弃）', + 'type' => 'string', + ], + 'TenantName' => [ + 'title' => '映射对象租户（已废弃）', + 'type' => 'string', + ], + 'Tables' => [ + 'title' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '表映射名', + 'type' => 'string', + ], + 'Id' => [ + 'title' => '表ID', + 'type' => 'string', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'type' => 'string', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'PartitionStatement' => [ + 'type' => 'string', + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + ], + ], + ], + 'ObkvPartitionConfig' => [ + 'title' => 'Hbase 模式分区配置，仅迁移到OBKV场景下使用', + 'type' => 'object', + 'properties' => [ + 'PartitionType' => [ + 'type' => 'string', + 'enum' => [ + 'KEY', + 'RANGE', + 'NONE', + ], + ], + 'VirtualColumn' => [ + 'type' => 'string', + ], + 'PartitionSize' => [ + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '1024', + 'minimum' => '1', + ], + ], + ], + ], + ], + ], + 'Views' => [ + 'title' => '当前库下的传输视图对象配置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '视图名', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '视图映射名', + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'string', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'type' => 'string', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'PartitionStatement' => [ + 'type' => 'string', + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'SpecificTables' => [ + 'title' => '具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '表映射名', + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'string', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'type' => 'string', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'PartitionStatement' => [ + 'type' => 'string', + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'SpecificViews' => [ + 'title' => '具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '视图名', + 'type' => 'string', + ], + 'MappedName' => [ + 'title' => '视图映射名', + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'string', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'type' => 'string', + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'PartitionStatement' => [ + 'type' => 'string', + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + 'example' => 'null', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '28', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"CM-RESOAT1111\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator. \\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"28\\",\\n \\"Data\\": 4\\n}","type":"json"}]', + ], + 'UpdateProjectConfig' => [ + 'summary' => '更新项目配置 Action=UpdateProjectConfig', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'np_fe****', + ], + ], + [ + 'name' => 'CommonTransferConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '高级配置', + 'type' => 'object', + 'properties' => [ + 'SinkStoreFormat' => [ + 'type' => 'string', + ], + 'SourceStoreFormat' => [ + 'type' => 'string', + ], + ], + ], + ], + [ + 'name' => 'FullTransferConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '全量传输配置', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'WriteWorkerNum' => [ + 'title' => '写入并发数 null 未配置', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '64', + ], + 'ReadWorkerNum' => [ + 'title' => '读取并发数 null 未配置', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '64', + ], + 'ThrottleRps' => [ + 'title' => '限制RPS null 不限速', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'null', + ], + 'ThrottleIOPS' => [ + 'title' => '限制流量，单位字节 null 不限速', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'null', + ], + 'MaxConcurrentIndexDDLs' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'IndexDDLConcurrencyLimit' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'IncrTransferConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '增量传输配置', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'IncrSyncThreadCount' => [ + 'title' => '写入并发数 null 未配置', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '64', + ], + 'ThrottleRps' => [ + 'title' => '限制RPS null 不限速', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'null', + ], + 'ThrottleIOPS' => [ + 'title' => '限制流量，单位字节 null 不限速', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'null', + ], + 'RecordTypeWhiteList' => [ + 'title' => '有增量同步阶段时，同步的增量数据类型', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'INSERT', + 'enum' => [ + 'HEARTBEAT', + 'INSERT', + 'UPDATE', + 'DELETE', + 'BEGIN', + 'COMMIT', + 'ROLLBACK', + 'DDL', + 'ROW', + ], + ], + 'required' => false, + ], + 'SupportDDLTypes' => [ + 'title' => '支持DDL类型', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CREATE_TABLE', + 'enum' => [ + 'CREATE_TABLE', + 'ALTER_TABLE', + 'DROP_TABLE', + 'RENAME_TABLE', + 'TRUNCATE_TABLE', + 'CREATE_INDEX', + 'DROP_INDEX', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ReverseIncrTransferConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '反向增量传输配置', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'IncrSyncThreadCount' => [ + 'title' => '写入并发数 null 未配置', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '64', + ], + 'ThrottleRps' => [ + 'title' => '限制RPS null 不限速', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'null', + ], + 'ThrottleIOPS' => [ + 'title' => '限制流量，单位字节 null 不限速', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'null', + ], + 'RecordTypeWhiteList' => [ + 'title' => '有增量同步阶段时，同步的增量数据类型', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'INSERT', + 'enum' => [ + 'HEARTBEAT', + 'INSERT', + 'UPDATE', + 'DELETE', + 'BEGIN', + 'COMMIT', + 'ROLLBACK', + 'DDL', + 'ROW', + ], + ], + 'required' => false, + ], + 'SupportDDLTypes' => [ + 'title' => '支持DDL类型', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CREATE_TABLE', + 'enum' => [ + 'CREATE_TABLE', + 'ALTER_TABLE', + 'DROP_TABLE', + 'RENAME_TABLE', + 'TRUNCATE_TABLE', + 'CREATE_INDEX', + 'DROP_INDEX', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CM-RESOAT1111'."\n", + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'WARN', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + '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"}]', + ], + 'DeleteDataSource' => [ + 'summary' => '删除数据源', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源 ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e_5anwndq', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator.', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'E3D924FB-52****B253-0C1A7EFB778C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '28', + ], + 'Data' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"Contact the administrator.\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator. \\",\\n \\"RequestId\\": \\"E3D924FB-52****B253-0C1A7EFB778C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"28\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + ], + 'CreateRdsPostgreSQLDataSource' => [ + 'summary' => '创建RDS PG 数据源', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'data_name', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '实例 ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'g_abcdefj***'."\n", + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Database Name', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'db_name', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'user_name', + ], + ], + [ + 'name' => 'Password', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pass_word', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '自定义描述信息', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a test database', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OmsApiReturnResult<T>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorDetail' => [ + 'title' => '错误详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '', + ], + ], + 'Proposal' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'Advice' => [ + 'title' => '建议', + 'description' => '', + 'type' => 'string', + 'example' => 'Contact the administrator.', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'PageNumber' => [ + 'title' => 'pageNumber', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'pageSize', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => 'TotalCount', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Cost' => [ + 'title' => '耗时', + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + 'Data' => [ + 'title' => '数据源 ID', + 'description' => '', + 'type' => 'string', + 'example' => 'e_5anwndq', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorDetail\\": {\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Level\\": \\"ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"ExtraContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"MessageMcmsKey\\": \\"null\\",\\n \\"MessageMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"ReasonMcmsKey\\": \\"null\\",\\n \\"ReasonMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"Proposal\\": \\"null\\",\\n \\"ProposalMcmsKey\\": \\"null\\",\\n \\"ProposalMcmsContext\\": {\\n \\"key\\": \\"null\\"\\n },\\n \\"UpstreamErrorDetail\\": \\"null\\"\\n },\\n \\"Code\\": \\"INNER_ERROR\\",\\n \\"Message\\": \\"A system error occurred.\\",\\n \\"Advice\\": \\"Contact the administrator.\\",\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Cost\\": \\"30\\",\\n \\"Data\\": \\"e_5anwndq\\"\\n}","type":"json"}]', + ], + 'DescribeBackupSetDownloadLink' => [ + 'summary' => 'You can call this operation to query the link for downloading a backup set of OceanBase Database.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + '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****', + ], + ], + [ + 'name' => 'DownloadTaskId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the download task corresponding to the target backup set.', + 'type' => 'string', + 'required' => true, + 'example' => '1000002', + ], + ], + ], + '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', + ], + 'DownloadTaskStatus' => [ + 'description' => 'The status of the download task corresponding to the target backup set.', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'DownloadTaskCreateTime' => [ + 'description' => 'The time when the download task corresponding to the target backup set was created.', + 'type' => 'string', + 'example' => '2020-05-22T17:04:18', + ], + 'BackupRestorableTime' => [ + 'description' => 'The restorable time of the backup set.', + 'type' => 'string', + 'example' => 'yyyy-MM-dd HH:mm:ss', + ], + 'BackupSetId' => [ + 'description' => 'The ID of the target backup set.', + 'type' => 'string', + 'example' => 'bak-4n****gacpa8', + ], + 'InternalUrl' => [ + 'description' => 'The internal URL.', + 'type' => 'string', + 'example' => 'http://bucket.oss-region-internal.aliyuncs.com/xxxxx', + ], + 'UrlExpiredTime' => [ + 'description' => 'The expiration time of the URL.', + 'type' => 'string', + 'example' => '2024-01-04 17:39:49', + ], + 'UrlAliveTime' => [ + 'description' => 'The validity period of the URL, in seconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3600', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"DownloadTaskId\\": 1000002,\\n \\"DownloadTaskStatus\\": \\"RUNNING\\",\\n \\"DownloadTaskCreateTime\\": \\"2020-05-22T17:04:18\\",\\n \\"BackupRestorableTime\\": \\"yyyy-MM-dd HH:mm:ss\\",\\n \\"BackupSetId\\": \\"bak-4n****gacpa8\\",\\n \\"InternalUrl\\": \\"http://bucket.oss-region-internal.aliyuncs.com/xxxxx\\",\\n \\"UrlExpiredTime\\": \\"2024-01-04 17:39:49\\",\\n \\"UrlAliveTime\\": 3600\\n }\\n}","type":"json"}]', + 'title' => 'DescribeBackupSetDownloadLink', + ], + 'DescribeDataBackupSet' => [ + 'summary' => 'You can call this operation to query the information about the backup sets of an OceanBase cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群ID', + 'description' => 'The ID of the OceanBase cluster.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'title' => '按照备份集状态查询', + 'description' => 'The status of the backup sets to be queried.', + 'type' => 'string', + 'required' => false, + 'example' => 'DONE', + 'enum' => [ + 'BEGINNING', + 'DOING', + 'DONE', + 'FAILED', + 'OVERDUE', + 'UNKNOWN', + ], + ], + ], + [ + 'name' => 'BackupObjectType', + 'in' => 'formData', + 'schema' => [ + 'title' => '按照备份对象类型查询', + 'description' => 'The object type of the backup sets to be queried.', + 'type' => 'string', + 'required' => false, + 'example' => 'tenant', + 'enum' => [ + 'cluster', + 'tenant', + 'table', + 'database', + ], + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The backup start time, in the format of *yyyy-MM-dd* T *HH:mm:ss* Z (UTC time).', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-12-27T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The backup end time.', + 'type' => 'string', + 'required' => false, + 'example' => '2023-01-06T15:59:59Z', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The page number, which takes effect in a pagination query.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of rows to return on each page.'."\n" + .'- Maximum value: 100.'."\n" + .'- Default value: 10.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total count. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of backup sets.', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'The backup end time.', + 'type' => 'string', + 'example' => '2023-04-13T03:38:10Z', + ], + 'Status' => [ + 'description' => 'The status of the backup set.', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'Type' => [ + 'description' => 'The backup type.', + 'type' => 'string', + 'example' => 'manual', + ], + 'StartTime' => [ + 'description' => 'The backup start time.', + 'type' => 'string', + 'example' => '2020-05-22T17:04:18', + ], + 'DataSize' => [ + 'description' => 'The size of the backup set.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '31457280', + ], + 'Policy' => [ + 'description' => 'The backup strategy.', + 'type' => 'string', + 'example' => 'automated', + ], + 'SetId' => [ + 'description' => 'The ID of the backup set.', + 'type' => 'string', + 'example' => 'imm-test-set-cb****ee-b7d7-11ed-956f-****3e10bd70', + ], + 'Method' => [ + 'description' => 'The backup method.', + 'type' => 'string', + 'example' => 'logical', + ], + 'Checkpoint' => [ + 'description' => 'The checkpoint.', + 'type' => 'string', + 'example' => '2023-05-15T07:11:08Z', + ], + 'DataVersion' => [ + 'description' => 'The data version.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1678847020352', + ], + 'BackupObjectType' => [ + 'title' => '备份对象类型', + 'description' => 'The backup object type.', + 'type' => 'string', + 'example' => 'cluster', + ], + 'BackupObjects' => [ + 'title' => '备份对象列表', + 'description' => 'The backup objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of backup objects.', + 'type' => 'object', + 'properties' => [ + 'ClusterName' => [ + 'description' => 'The name of the cluster.', + 'type' => 'string', + 'example' => 'test-****way', + ], + 'TenantName' => [ + 'description' => 'The name of the tenant.', + 'type' => 'string', + 'example' => 'ob2mr3oae0****', + ], + 'DatabaseTablesList' => [ + 'description' => 'The databases and tables in the backup set.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of databases and tables in the backup set.', + 'type' => 'object', + 'properties' => [ + 'Database' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'sms_pre', + ], + 'Tables' => [ + 'description' => 'The tables.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of tables.', + 'type' => 'string', + 'example' => '{\'Tables\': []}', + ], + ], + ], + ], + ], + ], + ], + ], + 'BackupResults' => [ + 'title' => '备份结果', + 'description' => 'The backup results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of backup results.', + 'type' => 'object', + 'properties' => [ + 'ClusterName' => [ + 'description' => 'The name of the cluster.'."\n", + 'type' => 'string', + 'example' => 'container-opa-****-02', + ], + 'TenantName' => [ + 'description' => 'The name of the tenant.', + 'type' => 'string', + 'example' => 'ob2mr3oae0****'."\n", + ], + 'TableBackupResults' => [ + 'description' => 'The table backup results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of table backup results.', + 'type' => 'object', + 'properties' => [ + 'Database' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'order_ce****_online', + ], + 'Table' => [ + 'description' => 'The name of the table.', + 'type' => 'string', + 'example' => 'tr_sale_order_****', + ], + 'Status' => [ + 'description' => 'The backup status.', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'Message' => [ + 'description' => 'The error description.', + 'type' => 'string', + 'example' => 'Create tag success', + ], + ], + ], + ], + ], + ], + ], + 'DownloadTaskStatus' => [ + 'title' => '目标备份集所对应的备份任务状态', + 'description' => 'The status of the download task corresponding to the target backup set.', + 'type' => 'string', + 'example' => 'not_exist', + ], + 'DownloadTaskId' => [ + 'title' => '目标备份集所对应的备份任务ID', + 'description' => 'The ID of the download task corresponding to the target backup set.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100***012', + ], + 'Validity' => [ + 'title' => '有效性，可空；', + 'description' => 'The validity, which can be left empty.', + 'type' => 'string', + 'example' => 'VALID', + 'enum' => [ + 'VALID', + 'INVALID', + ], + ], + 'Progress' => [ + 'title' => '备份进度', + 'description' => 'The backup progress.', + 'type' => 'string', + 'example' => '52', + ], + 'StorageClass' => [ + 'title' => '备份集类型，standard：一级备份、'."\n" + .'archive：归档（二级）备份', + 'description' => 'The type of the backup set. Valid values: '."\n" + .'* standard: level-1 backup '."\n" + .'* archive: second backup', + 'type' => 'string', + 'example' => 'standard', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": [\\n {\\n \\"EndTime\\": \\"2023-04-13T03:38:10Z\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"Type\\": \\"manual\\",\\n \\"StartTime\\": \\"2020-05-22T17:04:18\\",\\n \\"DataSize\\": 31457280,\\n \\"Policy\\": \\"automated\\",\\n \\"SetId\\": \\"imm-test-set-cb****ee-b7d7-11ed-956f-****3e10bd70\\",\\n \\"Method\\": \\"logical\\",\\n \\"Checkpoint\\": \\"2023-05-15T07:11:08Z\\",\\n \\"DataVersion\\": 1678847020352,\\n \\"BackupObjectType\\": \\"cluster\\",\\n \\"BackupObjects\\": [\\n {\\n \\"ClusterName\\": \\"test-****way\\",\\n \\"TenantName\\": \\"ob2mr3oae0****\\",\\n \\"DatabaseTablesList\\": [\\n {\\n \\"Database\\": \\"sms_pre\\",\\n \\"Tables\\": [\\n \\"{\'Tables\': []}\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"BackupResults\\": [\\n {\\n \\"ClusterName\\": \\"container-opa-****-02\\",\\n \\"TenantName\\": \\"ob2mr3oae0****\\\\n\\",\\n \\"TableBackupResults\\": [\\n {\\n \\"Database\\": \\"order_ce****_online\\",\\n \\"Table\\": \\"tr_sale_order_****\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"Message\\": \\"Create tag success\\"\\n }\\n ]\\n }\\n ],\\n \\"DownloadTaskStatus\\": \\"not_exist\\",\\n \\"DownloadTaskId\\": 0,\\n \\"Validity\\": \\"VALID\\",\\n \\"Progress\\": \\"52\\",\\n \\"StorageClass\\": \\"standard\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeDataBackupSet', + ], + 'CreateBackupSetDownloadLink' => [ + 'summary' => 'You can call this operation to create a backup set download link in OceanBase Database.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '目标备份集所属Oceanbase集群ID', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'i-bp67acfmxazb4p****', + ], + ], + [ + 'name' => 'BackupSetId', + 'in' => 'formData', + 'schema' => [ + 'title' => '目标备份集ID', + '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' => '请求ID', + '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", + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"DownloadTaskId\\": 0\\n }\\n}","type":"json"}]', + 'title' => 'The return result of the request.', + ], + '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' => 'Oceanbase集群ID。', + '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' => '备份集ID', + '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' => '目标解析集群是否在线。为兼容旧版本可以不填，不填时值为对isRemote取反', + 'description' => 'Specifies whether the target cluster is online. '."\n" + ."\n" + .'**Note** This parameter is used for compatibility with earlier versions and can be left empty. When left empty, it specifies negation for the value of `isRemote`.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + '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', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Tenants' => [ + 'description' => 'The information about the tenants.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of tenant information.', + 'type' => 'object', + 'properties' => [ + 'TenantName' => [ + 'description' => 'The name of the tenant.', + 'type' => 'string', + 'example' => 'sbtest1', + ], + 'Method' => [ + 'description' => 'The backup method.', + 'type' => 'string', + 'enumValueTitles' => [ + 'native_logical：库表逻辑备份' => '', + 'physical：物理备份' => '', + 'logical：逻辑备份（OB2276及以下）' => '', + ], + 'example' => 'logical', + ], + 'TenantId' => [ + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'TimeIntervalList' => [ + 'description' => 'The list of restorable periods of the tenant.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the restorable periods.', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => 'The start time of the restorable period.', + 'type' => 'string', + 'example' => '2023-01-20T16:00:00Z', + ], + 'EndTime' => [ + 'description' => 'The end time of the restorable period.', + 'type' => 'string', + 'example' => '2023-03-13T02:43:03Z', + ], + 'FromArchive' => [ + 'title' => '是否属于归档恢复', + 'description' => 'Indicates whether the restore is based on archiving.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'StorageType' => [ + 'description' => 'The storage type of backup data.', + 'type' => 'string', + 'enumValueTitles' => [ + 'standard：标准存储' => '', + 'archive：归档存储' => '', + ], + 'example' => 'standard', + ], + ], + ], + ], + 'ClusterId' => [ + 'title' => '集群ID', + 'description' => 'The ID of the cluster.', + 'type' => 'string', + 'example' => 'objnf3b2****', + ], + 'ObRpmVersion' => [ + 'title' => 'OB RPM版本号', + 'description' => 'The version of the OceanBase Database RPM package.', + 'type' => 'string', + 'example' => '3.2.3.1-2022080510****', + ], + 'ObVersion' => [ + 'title' => 'OB 大版本号', + 'description' => 'The major version of OceanBase Database.', + 'type' => 'string', + 'example' => '3.2.3.1', + ], + 'SourceRegion' => [ + 'title' => '集群所属地域', + 'description' => 'The region of the cluster.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'TenantAlias' => [ + 'title' => '租户别名', + 'description' => 'The alias of the tenant.', + 'type' => 'string', + 'example' => 'aaa', + ], + 'CpuNum' => [ + 'title' => '租户cpu规格', + 'description' => 'The number of CPU cores. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'MemoryNum' => [ + 'title' => '租户memory规格', + 'description' => 'The size of memory for the tenant.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'BackupBucketName' => [ + 'title' => '备份目录名', + 'description' => 'The name of the backup directory.', + 'type' => 'string', + 'example' => 'backup', + ], + 'ObTenantId' => [ + 'title' => '租户ID', + 'description' => 'The ID of the tenant.', + 'type' => 'string', + 'example' => 'tvd43v****', + ], + 'ClusterName' => [ + 'title' => '集群名', + 'description' => 'The name of the cluster.', + 'type' => 'string', + 'example' => 'testCluster', + ], + 'BackupSets' => [ + 'description' => 'The list of backup sets.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the backupsets.', + 'type' => 'object', + 'properties' => [ + 'Checkpoint' => [ + 'title' => '备份集的快照点', + 'description' => 'The checkpoint of the backup set.', + 'type' => 'string', + 'example' => '2024-01-01\'T\'12:10:10.000\'Z\'', + ], + 'SetId' => [ + 'title' => '备份集ID', + 'description' => 'The ID of the backup set.', + 'type' => 'string', + 'example' => 'bak-xxxxx', + ], + 'BackupSetId' => [ + 'description' => 'The ID of the full backup set used for restore.', + 'type' => 'string', + 'example' => 'bak-4n****gacpa8', + ], + 'TenantId' => [ + 'title' => '租户ID', + 'description' => 'The ID of the tenant.', + 'type' => 'string', + 'example' => 't5********', + ], + ], + ], + ], + 'UsedDisk' => [ + 'title' => '租户磁盘大小', + 'description' => 'The size of disk space for the tenant.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'UnitNum' => [ + 'title' => '租户节点数', + 'description' => 'The number of nodes of the tenant.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TenantMode' => [ + 'title' => '租户模式', + 'description' => 'The mode of the tenant.', + 'type' => 'string', + 'example' => 'Oracle', + ], + 'TenantDataBackupRemainDays' => [ + 'title' => '租户备份数据剩余有效天数', + 'description' => 'The remaining validity period, in days, of the backup data of the tenant.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'DescribeAnomalySQLList' => [ + 'summary' => 'You can call this operation to obtain the list of SQL statements that may have performance problems according to the diagnostic system. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'OceanBase集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'obsd23j4f****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't2mr3oae0****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '起始时间', + 'description' => 'The start time of the time range for querying suspicious SQL statements. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-06-13T15:40:43Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '结束时间', + 'description' => 'The end time of the time range for querying suspicious SQL statements. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-09-13T15:40:43Z', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名称', + 'description' => 'The name of the database. ', + 'type' => 'string', + 'required' => false, + 'example' => 'testdb', + ], + ], + [ + 'name' => 'SearchKeyWord', + 'in' => 'formData', + 'schema' => [ + 'title' => '关键字查询', + 'description' => 'The search keyword. ', + 'type' => 'string', + 'required' => false, + 'example' => 'update', + ], + ], + [ + 'name' => 'SearchParameter', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数查询', + 'description' => 'The search parameter. ', + 'type' => 'string', + 'required' => false, + 'example' => 'cputime', + ], + ], + [ + 'name' => 'SearchRule', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询规则', + 'description' => 'The search rule. '."\n" + .'Valid values: "=", ">", ">=", "<", and "<="', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + ], + [ + 'name' => 'SearchValue', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询值', + 'description' => 'The search value. ', + 'type' => 'string', + 'required' => false, + 'example' => '0.01', + ], + ], + [ + 'name' => 'SQLId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'SQLID', + 'description' => 'SQLID.', + 'type' => 'string', + 'required' => false, + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + ], + [ + 'name' => 'NodeIp', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点ip', + 'description' => 'The IP address of the node. ', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp19y05uq6xpacyqnlrc', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'description' => 'The number of rows to return on each page. '."\n" + .'- Maximum value: 100 '."\n" + .'- Default value: 10 ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => 'The number of the page to return. '."\n" + .'- Start value: 1 '."\n" + .'- Default value: 1 ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FilterCondition', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '过滤条件', + 'description' => 'The filter condition. '."\n" + .'> <br> - All fields in OceanBase Database support filtering. <br> - You can write the key-value pair of a parameter in a JSON string in the JSON format to filter the parameter. ', + 'type' => 'object', + 'required' => false, + 'enumValueTitles' => [ + 'UserName' => 'UserName', + 'Event' => 'Event', + 'SQLType' => 'SQLType', + 'ClientIp' => 'ClientIp', + ], + 'example' => '{'."\n" + .' "UserName":testUser'."\n" + .'}', + ], + ], + [ + 'name' => 'SortColumn', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序列', + 'description' => 'The sorted column. ', + 'type' => 'string', + 'required' => false, + 'example' => 'cputime', + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序规则', + 'description' => 'The sorting rule. ', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '{ "dbname":test, "SQLType":null }' => '{ "dbname":test, "SQLType":null }', + ], + 'example' => 'desc', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The language of the returned data. '."\n" + .'Default value: CN for a China site and EN for an International site. ', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数量', + 'description' => 'The total count. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'AnomalySQLList' => [ + 'title' => '可疑SQL列表', + 'description' => 'The list of suspicious SQL statements. ', + 'type' => 'array', + 'items' => [ + 'description' => ' ', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '返回数据序号', + 'description' => 'The sequence number of the returned SQL statement.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'DiagnosisRule' => [ + 'title' => '诊断规则', + 'description' => 'The diagnostic rule.', + 'type' => 'string', + 'example' => 'Utilization above threshold', + ], + 'SQLText' => [ + 'title' => 'sql文本', + 'description' => 'The SQL text. ', + 'type' => 'string', + 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC', + ], + 'Suggestion' => [ + 'title' => '建议', + 'description' => 'The suggestions. ', + 'type' => 'string', + 'example' => 'Check your business scenarios, data distribution changes, request surges, and execution plan changes.', + ], + 'DbName' => [ + 'title' => '数据库名', + 'description' => 'The name of the database. ', + 'type' => 'string', + 'example' => 'database1', + ], + 'RequestTimeUTCString' => [ + 'title' => '请求时间（零时区）', + 'description' => 'The request time in UTC +0. ', + 'type' => 'string', + 'example' => '2022-01-11T07:08:00Z', + ], + 'CpuTime' => [ + 'title' => '平均CPU时间（ms）', + 'description' => 'The average CPU time, in ms. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '50.13', + ], + 'SQLId' => [ + 'title' => 'SQLID', + 'description' => 'SQLID.', + 'type' => 'string', + 'example' => '99E9D3BF****B486239E6C7BC79B****', + ], + 'Diagnosis' => [ + 'title' => '诊断信息', + 'description' => 'The diagnosis information. ', + 'type' => 'string', + 'example' => 'Total number of executions = 80199, Average CPU time = 6.8 ms, Overall CPU utilization = 87%', + ], + 'RequestTime' => [ + 'title' => '请求时间', + 'description' => 'The request time, in ms. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '50.00', + ], + 'Executions' => [ + 'title' => '执行次数', + 'description' => 'The number of executions. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '89043', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => 'The username. ', + 'type' => 'string', + 'example' => 'tester', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AnomalySQLList\\": [\\n {\\n \\"Key\\": 1,\\n \\"DiagnosisRule\\": \\"全表扫描有索引未用\\",\\n \\"SQLText\\": \\"SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC\\",\\n \\"Suggestion\\": \\"请确认业务场景、数据分布变化、请求量突涨、执行计划变化等情况\\",\\n \\"DbName\\": \\"database1\\",\\n \\"RequestTimeUTCString\\": \\"2022-01-11T07:08:00Z\\",\\n \\"CpuTime\\": 50.13,\\n \\"SQLId\\": \\"99E9D3BF****B486239E6C7BC79B****\\",\\n \\"Diagnosis\\": \\"全表扫描有索引未用\\",\\n \\"RequestTime\\": 50,\\n \\"Executions\\": 89043,\\n \\"UserName\\": \\"tester\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeAnomalySQLListResponse>\\n <TotalCount>2</TotalCount>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n <AnomalySQLList>\\n <Key>1</Key>\\n <DiagnosisRule>整体占比超过百分比</DiagnosisRule>\\n <SQLText>SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC</SQLText>\\n <Suggestion>请确认业务场景、数据分布变化、请求量突涨、执行计划变化等情况</Suggestion>\\n <DbName>database1</DbName>\\n <RequestTimeUTCString>2022-01-11T07:08:00Z</RequestTimeUTCString>\\n <SQLId>99E9D3BF****B486239E6C7BC79B****</SQLId>\\n <Diagnosis>总执行次数=80199,平均CPU耗时=6.8毫秒,整体CPU消耗占比87%</Diagnosis>\\n <RequestTime>1641884880000</RequestTime>\\n <Executions>89043</Executions>\\n <UserName>tester</UserName>\\n </AnomalySQLList>\\n</DescribeAnomalySQLListResponse>","errorExample":""}]', + 'title' => 'DescribeAnomalySQLList', + ], + 'DescribeSQLDetails' => [ + 'summary' => 'You can call this operation to query the SQL text of an SQL statement based on the SQL ID. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID', + 'description' => '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' => '请求的返回结果', + 'description' => 'The name of the database. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeSQLDetails**. ', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'SQLDetails' => [ + 'title' => 'SQL详情', + 'description' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DescribeSQLDetails'."\n" + .'&TenantId=t2mr3oae0****'."\n" + .'&SQLId=8D6E84****0B8FB1823D199E2CA1****'."\n" + .'&Common request parameters'."\n" + .'```', + 'type' => 'array', + 'items' => [ + 'description' => ' ', + 'type' => 'object', + 'properties' => [ + 'SQLText' => [ + 'title' => 'SQL文本', + 'description' => '{"name":"DescribeSQLDetails","product":"OceanBasePro","version":"2019-09-01","path":"/","deprecated":0,"method":"POST|GET","protocol":"HTTP|HTTPS","hidden":0,"timeout":10000,"parameter_type":"Single","params":"[{\\"name\\":\\"Action\\",\\"position\\":\\"Query\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"description\\":\\"\\",\\"example\\":\\"DescribeSQLDetails\\"},{\\"name\\":\\"TenantId\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"t2mr3oae0****\\"},{\\"name\\":\\"SQLId\\",\\"position\\":\\"Body\\",\\"required\\":true,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"SQLID\\",\\"description\\":\\"SQLID。\\",\\"example\\":\\"8D6E84****0B8FB1823D199E2CA1****\\"}]","response_headers":"[]","response":"{\\"type\\":\\"Object\\",\\"children\\":[{\\"name\\":\\"RequestId\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"},{\\"name\\":\\"SQLDetails\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"Array\\",\\"subType\\":\\"Object\\",\\"description\\":\\" \\",\\"children\\":[{\\"name\\":\\"SQLText\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC\\"},{\\"name\\":\\"DbName\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"testdb\\"},{\\"name\\":\\"UserName\\",\\"required\\":false,\\"checkBlank\\":false,\\"visibility\\":\\"Public\\",\\"deprecated\\":false,\\"type\\":\\"String\\",\\"title\\":\\"\\",\\"description\\":\\"\\",\\"example\\":\\"tester\\"}],\\"title\\":\\"\\"}],\\"title\\":\\"\\",\\"description\\":\\"\\"}","errors":"{}"}', + 'type' => 'string', + 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC', + ], + 'DbName' => [ + 'title' => '数据库名', + 'description' => '', + 'type' => 'string', + 'example' => 'testdb', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => '', + 'type' => 'string', + 'example' => 'tester', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"SQLDetails\\": [\\n {\\n \\"SQLText\\": \\"SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC\\",\\n \\"DbName\\": \\"testdb\\",\\n \\"UserName\\": \\"tester\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeSQLDetailsResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n <SQLDetails>\\n <SQLText>SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC</SQLText>\\n <DbName>testdb</DbName>\\n <UserName>tester</UserName>\\n </SQLDetails>\\n</DescribeSQLDetailsResponse>","errorExample":""}]', + 'title' => 'DescribeSQLDetails', + ], + 'DescribeSQLPlans' => [ + 'summary' => 'You can call this operation to query the information about the SQL execution plans stored in the diagnostic system based on an SQL ID. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't2mr3oae0****', + ], + ], + [ + 'name' => 'SQLId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'SQLID', + 'description' => 'SQLID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'SQLPlans' => [ + 'title' => '执行计划信息', + 'description' => 'The information about the execution plan. ', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the execution plan. ', + 'type' => 'object', + 'properties' => [ + 'HitCount' => [ + 'title' => '命中次数', + 'description' => 'The number of hits. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'OutlineData' => [ + 'title' => 'Outline数据', + 'description' => 'The outline data. ', + 'type' => 'string', + 'example' => '/*+ BEGIN_OUTLINE_DATA FULL(@\\"SEL$1\\" \\"testdb1.bmsql_order_line\\"@\\"SEL$1\\") END_OUTLINE_DATA*/', + ], + 'AvgExecutionMS' => [ + 'title' => '平均执行时间 (ms)', + 'description' => 'The average execution duration, in ms. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'PlanUnionHash' => [ + 'title' => 'SQL执行计划在诊断系统内部的唯一标识', + 'description' => 'The unique identifier of the SQL execution plan in the diagnostic system. ', + 'type' => 'string', + 'example' => '859ef7ee****b23ac98cdeb2476f****', + ], + 'OutlineId' => [ + 'title' => 'OutlineID', + 'description' => 'OutlineID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'AvgExecutionTimeMS' => [ + 'title' => '平均执行时间', + 'description' => 'The average execution duration when the database uses this execution plan, in ms. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '288', + ], + 'PlanId' => [ + 'title' => 'SQL执行计划在数据库内部的ID', + 'description' => 'The ID of the SQL execution plan in the database. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9114', + ], + 'OutlineTime' => [ + 'title' => '绑定时间', + 'description' => 'The time when the plan was bound. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1641492303000', + ], + 'OutlineTimeUTCString' => [ + 'title' => '绑定时间(零时区)', + 'description' => 'The time when the plan was bound, in UTC +0. ', + 'type' => 'string', + 'example' => '2022-01-06T18:05:03Z', + ], + 'PlanFull' => [ + 'title' => 'SQL的完整执行计划', + 'description' => 'The complete execution plan of the SQL statement. ', + 'type' => 'string', + 'example' => 'PHY_TABLE_SCAN | bmsql_order_line | 40 ******', + ], + 'NodeIp' => [ + 'title' => '节点ip', + 'description' => 'The IP address of the node. ', + 'type' => 'string', + 'example' => 'i-bp16niirq4zdmgvm****', + ], + 'MergedVersion' => [ + 'title' => '合并版本', + 'description' => 'The major compaction version. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '132', + ], + 'QuerySQL' => [ + 'title' => '查询sql', + 'description' => 'The query SQL statement. ', + 'type' => 'string', + 'example' => 'SELECT ol_i_id, ***, *** FROM aaa', + ], + 'FirstLoadTimeUTCString' => [ + 'title' => '首次加载时间(零时区)', + 'description' => 'The time when the plan was loaded for the first time, in UTC +0. ', + 'type' => 'string', + 'example' => '2022-01-06T18:05:03Z', + ], + 'FirstLoadTime' => [ + 'title' => '首次加载时间', + 'description' => 'The time when the plan was loaded for the first time, . ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1641492303000', + ], + 'PlanInfo' => [ + 'title' => '计划信息', + 'description' => 'The information about the plan. ', + 'type' => 'string', + 'example' => 'PHY_TABLE_SCAN', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"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":"<DescribeSQLPlansResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <SQLPlans>\\n <HitCount>3</HitCount>\\n <OutlineData>/*+ BEGIN_OUTLINE_DATA FULL(@\\\\\\"SEL$1\\\\\\" \\\\\\"testdb1.bmsql_order_line\\\\\\"@\\\\\\"SEL$1\\\\\\") END_OUTLINE_DATA*/</OutlineData>\\n <AvgExecutionMS>1</AvgExecutionMS>\\n <PlanUnionHash>859ef7ee****b23ac98cdeb2476f****</PlanUnionHash>\\n <OutlineId>-1</OutlineId>\\n <AvgExecutionTimeMS>288</AvgExecutionTimeMS>\\n <PlanId>9114</PlanId>\\n <OutlineTime>1641492303000</OutlineTime>\\n <OutlineTimeUTCString>2022-01-06T18:05:03Z</OutlineTimeUTCString>\\n <PlanFull>PHY_TABLE_SCAN | bmsql_order_line | 40 ******</PlanFull>\\n <NodeIp>i-bp16niirq4zdmgvm****</NodeIp>\\n <MergedVersion>132</MergedVersion>\\n <QuerySQL>SELECT ol_i_id, ***, *** FROM aaa</QuerySQL>\\n <FirstLoadTimeUTCString>2022-01-06T18:05:03Z</FirstLoadTimeUTCString>\\n <FirstLoadTime>1641492303000</FirstLoadTime>\\n <PlanInfo>PHY_TABLE_SCAN</PlanInfo>\\n </SQLPlans>\\n</DescribeSQLPlansResponse>","errorExample":""}]', + 'title' => 'DescribeSQLPlans', + ], + 'DescribeSQLHistoryList' => [ + 'summary' => 'You can call this operation to query the execution history of an SQL statement in a specified period based on an SQL ID. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't2mr3oae0****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数历史查看的起始时间。', + 'description' => 'The start time of the time range for querying the SQL execution history. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-06-13T15:40:43Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数历史查看的结束时间。', + 'description' => 'The end time of the time range for querying the SQL execution history. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-09-13T15:40:43Z', + ], + ], + [ + 'name' => 'SQLId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'SQLID', + 'description' => 'SQLID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '页码', + 'description' => 'The page number. ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '每页数量', + 'description' => 'The number of entries returned on each page. '."\n" + .'Default value: 10. ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'SQLHistoryList' => [ + 'title' => 'SQL历史信息', + 'description' => 'The execution history of the SQL statement. ', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'title' => '列表', + 'description' => ' ', + 'type' => 'array', + 'items' => [ + 'description' => ' ', + 'type' => 'object', + 'properties' => [ + 'ExecPerSecond' => [ + 'title' => '每秒次数', + 'description' => 'The number of executions per second. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '163.0', + ], + 'MaxCpuTime' => [ + 'title' => '最大CPU时间', + 'description' => 'The maximum CPU time. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '257.967', + ], + 'BlockCacheHit' => [ + 'title' => 'BlockCache命中次数', + 'description' => 'The number of block cache hits. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + 'DecodeTime' => [ + 'title' => '解码等待', + 'description' => 'The time to wait for decoding. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'RemotePlans' => [ + 'title' => '远程计划数', + 'description' => 'The number of remote plans. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RPCCount' => [ + 'title' => 'RPC次数', + 'description' => 'The number of RPCs. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NetWaitTime' => [ + 'title' => '网络等待', + 'description' => 'The network latency. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'DiskRead' => [ + 'title' => '物理读', + 'description' => 'The number of physical reads. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NodeIp' => [ + 'title' => '节点IP', + 'description' => 'The IP address of the node. ', + 'type' => 'string', + 'example' => 'i-bp18qljorblo8es*****', + ], + 'ConcurrencyWaitTime' => [ + 'title' => '并发等待', + 'description' => 'The wait time in concurrent execution. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'DbName' => [ + 'title' => '数据库名', + 'description' => 'The name of the database. ', + 'type' => 'string', + 'example' => 'testdb', + ], + 'MemstoreReadRowCount' => [ + 'title' => '读内存行数', + 'description' => 'The number of rows read from the memory. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '527', + ], + 'AppWaitTime' => [ + 'title' => '客户端等待', + 'description' => 'The wait time of the client. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'ElapsedTime' => [ + 'title' => '平均响应时间', + 'description' => 'The average response time. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '76.382', + ], + 'MissPlans' => [ + 'title' => '未命中计划次数', + 'description' => 'The number of plan misses. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AffectedRows' => [ + 'title' => '影响行数', + 'description' => 'The number of rows affected. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ScheduleTime' => [ + 'title' => '调度时间', + 'description' => 'The scheduling duration. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'Event' => [ + 'title' => '等待事件', + 'description' => 'The wait event. ', + 'type' => 'string', + 'example' => 'mysql response wait client', + ], + 'TotalWaitTime' => [ + 'title' => '内部等待', + 'description' => 'The internal wait time. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '10.966', + ], + 'ReturnRows' => [ + 'title' => '返回行数', + 'description' => 'The number of rows returned. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExecuteTime' => [ + 'title' => '内部执行时间', + 'description' => 'The internal execution time. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '61.044', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => 'The username. ', + 'type' => 'string', + 'example' => 'tester', + ], + 'Executions' => [ + 'title' => '执行次数', + 'description' => 'The number of executions. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '89403', + ], + 'GetPlanTime' => [ + 'title' => '硬解析时间', + 'description' => 'The time spent in hard parsing. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.052', + ], + 'CpuTime' => [ + 'title' => '平均CPU时间', + 'description' => 'The average CPU time. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '50.13', + ], + 'MaxElapsedTime' => [ + 'title' => '最大响应时间', + 'description' => 'The maximum response time. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '260.44', + ], + 'BlockIndexCacheHit' => [ + 'title' => 'BlockIndexCache命中次数', + 'description' => 'The number of block index cache hits. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'EndTimeUTCString' => [ + 'title' => '结束时间（零时区）', + 'description' => 'The end time in UTC +0. ', + 'type' => 'string', + 'example' => '2021-12-28T02:08:18Z', + ], + 'EndTime' => [ + 'title' => '结束时间', + 'description' => 'The end time. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2021-12-28T02:08:18Z', + ], + 'RetryCount' => [ + 'title' => '重试次数', + 'description' => 'The number of retries. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ClientIp' => [ + 'title' => '客户端IP', + 'description' => 'The IP address of the client. ', + 'type' => 'string', + 'example' => '1*2.***.1*3.***', + ], + 'BloomFilterCacheHit' => [ + 'title' => 'BloomFilterCache命中次数', + 'description' => 'The number of Bloom filter cache hits. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'IOWaitTime' => [ + 'title' => 'IO等待', + 'description' => 'The I/O wait time. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'FailTimes' => [ + 'title' => '失败次数', + 'description' => 'The number of failures. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'QueueTime' => [ + 'title' => '队列等待', + 'description' => 'The queuing time. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '15.275', + ], + 'RowCacheHit' => [ + 'title' => 'RowCache命中次数', + 'description' => 'The number of row cache hits. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'LogicalRead' => [ + 'title' => '逻辑读', + 'description' => 'The number of logical reads. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19', + ], + 'SsstoreReadRowCount' => [ + 'title' => '读磁盘行数', + 'description' => 'The number of rows read from the disk. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '43086', + ], + ], + ], + ], + 'Count' => [ + 'title' => '数量', + 'description' => 'The quantity. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"SQLHistoryList\\": {\\n \\"List\\": [\\n {\\n \\"ExecPerSecond\\": 163,\\n \\"MaxCpuTime\\": 257.967,\\n \\"BlockCacheHit\\": 14,\\n \\"DecodeTime\\": 0,\\n \\"RemotePlans\\": 0,\\n \\"RPCCount\\": 0,\\n \\"NetWaitTime\\": 0,\\n \\"DiskRead\\": 0,\\n \\"NodeIp\\": \\"i-bp18qljorblo8es*****\\",\\n \\"ConcurrencyWaitTime\\": 0,\\n \\"DbName\\": \\"testdb\\",\\n \\"MemstoreReadRowCount\\": 527,\\n \\"AppWaitTime\\": 0,\\n \\"ElapsedTime\\": 76.382,\\n \\"MissPlans\\": 0,\\n \\"AffectedRows\\": 0,\\n \\"ScheduleTime\\": 0,\\n \\"Event\\": \\"mysql response wait client\\",\\n \\"TotalWaitTime\\": 10.966,\\n \\"ReturnRows\\": 1,\\n \\"ExecuteTime\\": 61.044,\\n \\"UserName\\": \\"tester\\",\\n \\"Executions\\": 89403,\\n \\"GetPlanTime\\": 0.052,\\n \\"CpuTime\\": 50.13,\\n \\"MaxElapsedTime\\": 260.44,\\n \\"BlockIndexCacheHit\\": 4,\\n \\"EndTimeUTCString\\": \\"2021-12-28T02:08:18Z\\",\\n \\"EndTime\\": 0,\\n \\"RetryCount\\": 0,\\n \\"ClientIp\\": \\"1*2.***.1*3.***\\",\\n \\"BloomFilterCacheHit\\": 0,\\n \\"IOWaitTime\\": 0,\\n \\"FailTimes\\": 0,\\n \\"QueueTime\\": 15.275,\\n \\"RowCacheHit\\": 0,\\n \\"LogicalRead\\": 19,\\n \\"SsstoreReadRowCount\\": 43086\\n }\\n ],\\n \\"Count\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSQLHistoryListResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n <SQLHistoryList>\\n <List>\\n <MaxCpuTime>257.967</MaxCpuTime>\\n <BlockCacheHit>14</BlockCacheHit>\\n <DecodeTime>0</DecodeTime>\\n <RemotePlans>0</RemotePlans>\\n <RPCCount>0</RPCCount>\\n <NetWaitTime>0</NetWaitTime>\\n <DiskRead>0</DiskRead>\\n <NodeIp>i-bp18qljorblo8es*****</NodeIp>\\n <ConcurrencyWaitTime>0</ConcurrencyWaitTime>\\n <DbName>testdb</DbName>\\n <MemstoreReadRowCount>527</MemstoreReadRowCount>\\n <AppWaitTime>0</AppWaitTime>\\n <ElapsedTime>76.382</ElapsedTime>\\n <MissPlans>0</MissPlans>\\n <AffectedRows>0</AffectedRows>\\n <ScheduleTime>0</ScheduleTime>\\n <Event>mysql response wait client</Event>\\n <TotalWaitTime>10.966</TotalWaitTime>\\n <ReturnRows>1</ReturnRows>\\n <ExecuteTime>61.044</ExecuteTime>\\n <UserName>tester</UserName>\\n <Executions>89403</Executions>\\n <GetPlanTime>0.052</GetPlanTime>\\n <CpuTime>50.13</CpuTime>\\n <MaxElapsedTime>260.44</MaxElapsedTime>\\n <BlockIndexCacheHit>4</BlockIndexCacheHit>\\n <EndTimeUTCString>2021-12-28T02:08:18Z</EndTimeUTCString>\\n <RetryCount>0</RetryCount>\\n <ClientIp>1*2.***.1*3.***</ClientIp>\\n <BloomFilterCacheHit>0</BloomFilterCacheHit>\\n <IOWaitTime>0</IOWaitTime>\\n <FailTimes>0</FailTimes>\\n <QueueTime>15.275</QueueTime>\\n <RowCacheHit>0</RowCacheHit>\\n <LogicalRead>19</LogicalRead>\\n <SsstoreReadRowCount>43086</SsstoreReadRowCount>\\n </List>\\n <Count>1</Count>\\n </SQLHistoryList>\\n</DescribeSQLHistoryListResponse>","errorExample":""}]', + 'title' => 'DescribeSQLHistoryList', + ], + 'DescribeTopSQLList' => [ + 'summary' => 'You can call this operation to query SQL execution performance data collected by the diagnostic system. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID', + 'description' => 'The average CPU time, in ms. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't2mr3oae0****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '起始时间。', + 'description' => 'The maximum response time, in ms. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-06-13T15:40:43Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '结束时间。', + 'description' => 'The SQL type. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-09-13T15:40:43Z', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名称', + 'description' => 'The number of block index cache hits. ', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'testdb', + ], + ], + [ + 'name' => 'SearchKeyWord', + 'in' => 'formData', + 'schema' => [ + 'title' => '关键字查询', + 'description' => 'The number of retries. ', + 'type' => 'string', + 'required' => false, + 'example' => 'update', + ], + ], + [ + 'name' => 'SearchParameter', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数查询', + 'description' => 'SQLID.', + 'type' => 'string', + 'required' => false, + 'example' => 'cputime', + ], + ], + [ + 'name' => 'SearchRule', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询规则', + 'description' => 'The IP address of the client.', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + ], + [ + 'name' => 'SearchValue', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询值', + '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' => '节点ip', + 'description' => 'The number of failures. ', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp19y05uq6xpacyqnlrc', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => 'The queuing time, in ms. ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'description' => 'The number of row cache hits. ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'FilterCondition', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '过滤条件', + 'description' => 'The average number of logical reads of the SQL statement during the specified period of time. '."\n" + .'The value covers the numbers of reads of different caches and the number of disk I/Os. It is an important metric for measuring the SQL filtering performance. '."\n" + ."\n" + .'> <br> 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' => '排序列', + 'description' => 'The number of rows read from the disk. ', + 'type' => 'string', + 'required' => false, + 'example' => 'cputime', + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序规则', + 'description' => 'The list of top SQL statements.', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'You can call this operation to query SQL execution performance data collected by the diagnostic system.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数量', + 'description' => 'It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate executable SDK code samples. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'Alibaba Cloud CLI', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'TopSQLList' => [ + 'title' => 'TOPSQL列表', + 'description' => 'The I/O wait time, in ms. ', + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address of the node. ', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '返回数据序号', + 'description' => 'The name of the database. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExecPerSecond' => [ + 'title' => '每秒次数', + 'description' => 'The operation that you want to perform. '."\n" + .'Set the value to **DescribeTopSQLList**. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '163.0', + ], + 'SQLText' => [ + 'title' => 'sql文本', + 'description' => 'The list of top SQL statements. ', + 'type' => 'string', + 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC', + ], + 'MaxCpuTime' => [ + 'title' => '最大CPU时间', + 'description' => 'SQLID.', + 'type' => 'number', + 'format' => 'float', + 'example' => '257.967', + ], + 'BlockCacheHit' => [ + 'title' => 'BlockCache命中次数', + 'description' => 'The average CPU time, in ms. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + 'DecodeTime' => [ + 'title' => '解码等待', + 'description' => 'The number of rows to return on each page. '."\n" + .'- Maximum value: 100 '."\n" + .'- Default value: 10 ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'RemotePlans' => [ + 'title' => '远程计划数', + 'description' => 'The return result of the request. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RPCCount' => [ + 'title' => 'RPC次数', + 'description' => 'The start time of the time range for querying TOP SQL statements. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NetWaitTime' => [ + 'title' => '网络等待', + 'description' => 'The end time of the time range for querying TOP SQL statements. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'DiskRead' => [ + 'title' => '物理读', + 'description' => 'The IP address of the client. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NodeIp' => [ + 'title' => '节点IP', + 'description' => 'The username. ', + 'type' => 'string', + 'example' => 'i-bp18qljorblo8es*****', + ], + 'ConcurrencyWaitTime' => [ + 'title' => '并发等待', + 'description' => 'The number of rows returned. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'MemstoreReadRowCount' => [ + 'title' => '读内存行数', + 'description' => 'The name of the database. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '527', + ], + 'DbName' => [ + 'title' => '数据库名', + 'description' => 'The number of remote plans. ', + 'type' => 'string', + 'example' => 'testdb', + ], + 'AppWaitTime' => [ + 'title' => '客户端等待', + 'description' => 'The wait time in concurrent execution, in ms. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'ElapsedTime' => [ + 'title' => '平均响应时间', + 'description' => 'The sorting rule. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '76.382', + ], + 'MissPlans' => [ + 'title' => '未命中计划次数', + 'description' => 'The total count. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AffectedRows' => [ + 'title' => '影响行数', + 'description' => 'The internal wait time, in ms. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ScheduleTime' => [ + 'title' => '调度时间', + 'description' => 'The search keyword. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'Event' => [ + 'title' => '等待事件', + 'description' => 'The number of rows read from the disk. ', + 'type' => 'string', + 'example' => 'mysql response wait client', + ], + 'TotalWaitTime' => [ + 'title' => '内部等待', + 'description' => '-', + 'type' => 'number', + 'format' => 'float', + 'example' => '10.966', + ], + 'ReturnRows' => [ + 'title' => '返回行数', + 'description' => 'The wait event. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExecuteTime' => [ + 'title' => '内部执行时间', + 'description' => 'The number of rows read from the memory. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '61.044', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => 'The number of Bloom filter cache hits. ', + 'type' => 'string', + 'example' => 'tester', + ], + 'Executions' => [ + 'title' => '执行次数', + 'description' => 'The number of executions per second. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '89403', + ], + 'GetPlanTime' => [ + 'title' => '硬解析时间', + 'description' => 'The queuing time, in ms. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.052', + ], + 'CpuTime' => [ + 'title' => '平均CPU时间', + 'description' => 'The maximum CPU time, in ms. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '50.13', + ], + 'MaxElapsedTime' => [ + 'title' => '最大响应时间', + 'description' => 'The sequence number of the returned SQL statement. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '260.044', + ], + 'SQLType' => [ + 'title' => 'sql类型', + 'description' => 'The request ID. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'BlockIndexCacheHit' => [ + 'title' => 'BlockIndexCache命中次数', + 'description' => '$.parameters[16].schema.example', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'RetryCount' => [ + 'title' => '重试次数', + 'description' => '$.parameters[13].schema.description', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SQLId' => [ + 'title' => 'SQLID', + 'description' => '$.parameters[13].schema.example', + 'type' => 'string', + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + 'ClientIp' => [ + 'title' => '客户端IP', + 'description' => '$.parameters[14].schema.description', + 'type' => 'string', + 'example' => '1*2.***.1*3.***', + ], + 'BloomFilterCacheHit' => [ + 'title' => 'BloomFilterCache命中次数', + 'description' => '$.parameters[14].schema.enumValueTitles', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'IOWaitTime' => [ + 'title' => 'IO等待', + 'description' => '$.parameters[15].schema.example', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'FailTimes' => [ + 'title' => '失败次数', + 'description' => '$.parameters[12].schema.description', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'QueueTime' => [ + 'title' => '队列等待', + 'description' => '$.parameters[12].schema.enumValueTitles', + 'type' => 'number', + 'format' => 'float', + 'example' => '15.275', + ], + 'RowCacheHit' => [ + 'title' => 'RowCache命中次数', + 'description' => '```'."\n" + .'http(s)://[Endpoint]/?Action=DescribeTopSQLList'."\n" + .'&TenantId=t2mr3oae0****'."\n" + .'&StartTime=2021-06-13 15:40:43'."\n" + .'&EndTime=2021-09-13 15:40:43'."\n" + .'&DbName=testdb'."\n" + .'&SearchKeyWord=update'."\n" + .'&SearchParameter=cputime'."\n" + .'&SearchRule=>'."\n" + .'&SearchValue=0.01'."\n" + .'&SQLId=8D6E84****0B8FB1823D199E2CA1****'."\n" + .'&NodeIp=i-bp19y05uq6xpacyqnlrc'."\n" + .'&PageNumber=1'."\n" + .'&PageSize=10'."\n" + .'&SortColumn=cputime'."\n" + .'&SortOrder=desc'."\n" + .'&Common request parameters'."\n" + .'```', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'LogicalRead' => [ + 'title' => '逻辑读', + 'description' => 'You can call this operation to query SQL execution performance data collected by the diagnostic system. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19', + ], + 'SsstoreReadRowCount' => [ + 'title' => '读磁盘行数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '43086', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 2014 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 9,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TopSQLList\\": [\\n {\\n \\"Key\\": 1,\\n \\"ExecPerSecond\\": 163,\\n \\"SQLText\\": \\"SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC\\",\\n \\"MaxCpuTime\\": 257.967,\\n \\"BlockCacheHit\\": 14,\\n \\"DecodeTime\\": 0,\\n \\"RemotePlans\\": 0,\\n \\"RPCCount\\": 0,\\n \\"NetWaitTime\\": 0,\\n \\"DiskRead\\": 0,\\n \\"NodeIp\\": \\"i-bp18qljorblo8es*****\\",\\n \\"ConcurrencyWaitTime\\": 0,\\n \\"MemstoreReadRowCount\\": 527,\\n \\"DbName\\": \\"testdb\\",\\n \\"AppWaitTime\\": 0,\\n \\"ElapsedTime\\": 76.382,\\n \\"MissPlans\\": 0,\\n \\"AffectedRows\\": 0,\\n \\"ScheduleTime\\": 0,\\n \\"Event\\": \\"mysql response wait client\\",\\n \\"TotalWaitTime\\": 10.966,\\n \\"ReturnRows\\": 1,\\n \\"ExecuteTime\\": 61.044,\\n \\"UserName\\": \\"tester\\",\\n \\"Executions\\": 89403,\\n \\"GetPlanTime\\": 0.052,\\n \\"CpuTime\\": 50.13,\\n \\"MaxElapsedTime\\": 260.044,\\n \\"SQLType\\": 1,\\n \\"BlockIndexCacheHit\\": 4,\\n \\"RetryCount\\": 0,\\n \\"SQLId\\": \\"8D6E84****0B8FB1823D199E2CA1****\\",\\n \\"ClientIp\\": \\"1*2.***.1*3.***\\",\\n \\"BloomFilterCacheHit\\": 0,\\n \\"IOWaitTime\\": 0,\\n \\"FailTimes\\": 0,\\n \\"QueueTime\\": 15.275,\\n \\"RowCacheHit\\": 0,\\n \\"LogicalRead\\": 19,\\n \\"SsstoreReadRowCount\\": 43086\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeTopSQLListResponse>\\n <TotalCount>9</TotalCount>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n <TopSQLList>\\n <Key>1</Key>\\n <ExecPerSecond>163</ExecPerSecond>\\n <SQLText>SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC</SQLText>\\n <MaxCpuTime>257.967</MaxCpuTime>\\n <BlockCacheHit>14</BlockCacheHit>\\n <DecodeTime>0</DecodeTime>\\n <RemotePlans>0</RemotePlans>\\n <RPCCount>0</RPCCount>\\n <NetWaitTime>0</NetWaitTime>\\n <DiskRead>0</DiskRead>\\n <NodeIp>i-bp18qljorblo8es*****</NodeIp>\\n <ConcurrencyWaitTime>0</ConcurrencyWaitTime>\\n <MemstoreReadRowCount>527</MemstoreReadRowCount>\\n <DbName>testdb</DbName>\\n <AppWaitTime>0</AppWaitTime>\\n <ElapsedTime>76.382</ElapsedTime>\\n <MissPlans>0</MissPlans>\\n <AffectedRows>0</AffectedRows>\\n <ScheduleTime>0</ScheduleTime>\\n <Event>mysql response wait client</Event>\\n <TotalWaitTime>10.966</TotalWaitTime>\\n <ReturnRows>1</ReturnRows>\\n <ExecuteTime>61.044</ExecuteTime>\\n <UserName>tester</UserName>\\n <Executions>89403</Executions>\\n <GetPlanTime>0.052</GetPlanTime>\\n <CpuTime>50.13</CpuTime>\\n <MaxElapsedTime>260.044</MaxElapsedTime>\\n <SQLType>1</SQLType>\\n <BlockIndexCacheHit>4</BlockIndexCacheHit>\\n <RetryCount>0</RetryCount>\\n <SQLId>8D6E84****0B8FB1823D199E2CA1****</SQLId>\\n <ClientIp>1*2.***.1*3.***</ClientIp>\\n <BloomFilterCacheHit>0</BloomFilterCacheHit>\\n <IOWaitTime>0</IOWaitTime>\\n <FailTimes>0</FailTimes>\\n <QueueTime>15.275</QueueTime>\\n <RowCacheHit>0</RowCacheHit>\\n <LogicalRead>19</LogicalRead>\\n <SsstoreReadRowCount>43086</SsstoreReadRowCount>\\n </TopSQLList>\\n</DescribeTopSQLListResponse>","errorExample":""}]', + 'title' => 'DescribeTopSQLList', + ], + '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' => '租户ID', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't2mr3oae0****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '开始时间', + 'description' => 'The start time of the time range for querying slow SQL statements. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-06-13T15:40:43Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '结束时间', + 'description' => 'The end time of the time range for querying slow SQL statements. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-09-13T15:40:43Z', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名称', + 'description' => 'The name of the database. ', + 'type' => 'string', + 'required' => false, + 'example' => 'testdb', + ], + ], + [ + 'name' => 'SearchKeyWord', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询关键字', + 'description' => 'The search keyword. ', + 'type' => 'string', + 'required' => false, + 'example' => 'update', + ], + ], + [ + 'name' => 'SearchParameter', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询参数', + 'description' => 'The search parameter. ', + 'type' => 'string', + 'required' => false, + 'example' => 'cputime', + ], + ], + [ + 'name' => 'SearchRule', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询规则', + 'description' => 'The search rule. ', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + ], + [ + 'name' => 'SearchValue', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询值', + 'description' => 'The search value. ', + 'type' => 'string', + 'required' => false, + 'example' => '0.01', + ], + ], + [ + 'name' => 'SQLId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'SQL唯一标识', + 'description' => 'The SQL ID, which uniquely identifies an SQL statement. ', + 'type' => 'string', + 'required' => false, + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + ], + [ + 'name' => 'NodeIp', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点ip', + 'description' => 'The IP address of the database node. ', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp18qljorblo8es*****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '页码', + 'description' => 'The number of rows to return on each page. '."\n" + .'- Maximum value: 100 '."\n" + .'- Default value: 10 ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '页大小', + 'description' => 'The number of the page to return. '."\n" + .'- Start value: 1 '."\n" + .'- Default value: 1 ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FilterCondition', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '过滤条件', + 'description' => 'The filter condition. ', + 'type' => 'object', + 'required' => false, + 'example' => '[dbName:sys]', + ], + ], + [ + 'name' => 'SortColumn', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序列', + 'description' => 'The sorted column. ', + 'type' => 'string', + 'required' => false, + 'example' => 'cputime', + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序顺序', + 'description' => 'The sorting rule. ', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数量', + 'description' => 'The total count. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'SlowSQLList' => [ + 'title' => '慢SQL列表信息', + 'description' => 'The list of slow SQL statements. ', + 'type' => 'array', + 'items' => [ + 'description' => ' ', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The sequence number of the returned SQL statement. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExecPerSecond' => [ + 'description' => 'The number of executions per second. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '163.0', + ], + 'SQLText' => [ + 'description' => 'The SQL text. ', + 'type' => 'string', + 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC', + ], + 'MaxCpuTime' => [ + 'description' => 'The maximum CPU time. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '257.967', + ], + 'BlockCacheHit' => [ + 'description' => 'The number of block cache hits. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + 'DecodeTime' => [ + 'description' => 'The time to wait for decoding. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'RemotePlans' => [ + 'description' => 'The number of remote plans. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RPCCount' => [ + 'description' => 'The number of RPCs. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NetWaitTime' => [ + 'description' => 'The network latency. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'DiskRead' => [ + 'description' => 'The number of physical reads. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NodeIp' => [ + 'description' => 'The IP address of the node. ', + 'type' => 'string', + 'example' => 'i-bp18qljorblo8es*****', + ], + 'ConcurrencyWaitTime' => [ + 'description' => 'The wait time in concurrent execution. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'MemstoreReadRowCount' => [ + 'description' => 'The number of rows read from the memory. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '527', + ], + 'DbName' => [ + 'description' => 'The name of the database. ', + 'type' => 'string', + 'example' => 'testdb', + ], + 'AppWaitTime' => [ + 'description' => 'The wait time of the client. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'ElapsedTime' => [ + 'description' => 'The average response time. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '76.382', + ], + 'MissPlans' => [ + 'description' => 'The number of plan misses. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AffectedRows' => [ + 'description' => 'The number of rows affected. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ScheduleTime' => [ + 'description' => 'The scheduling duration. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'Event' => [ + 'description' => 'The wait event. ', + 'type' => 'string', + 'example' => 'mysql response wait client', + ], + 'TotalWaitTime' => [ + 'description' => 'The internal wait time. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '10.966', + ], + 'ReturnRows' => [ + 'description' => 'The number of rows returned. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExecuteTime' => [ + 'description' => 'The internal execution time. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '61.044', + ], + 'UserName' => [ + 'description' => 'The username. ', + 'type' => 'string', + 'example' => 'tester', + ], + 'Executions' => [ + 'description' => 'The number of executions. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '89403', + ], + 'GetPlanTime' => [ + 'description' => 'The time spent in hard parsing. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.052', + ], + 'CpuTime' => [ + 'description' => 'The average CPU time. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '50.13', + ], + 'MaxElapsedTime' => [ + 'description' => 'The maximum response time. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '260.044', + ], + 'SQLType' => [ + 'description' => 'The SQL type. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'BlockIndexCacheHit' => [ + 'description' => 'The number of block index cache hits. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'RetryCount' => [ + 'description' => 'The number of retries. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SQLId' => [ + 'description' => 'SQLID.', + 'type' => 'string', + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + 'ClientIp' => [ + 'description' => 'The IP address of the client. ', + 'type' => 'string', + 'example' => '1*2.***.1*3.***', + ], + 'BloomFilterCacheHit' => [ + 'description' => 'The number of Bloom filter cache hits. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'IOWaitTime' => [ + 'description' => 'The I/O wait time. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'FailTimes' => [ + 'description' => 'The number of failures. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'QueueTime' => [ + 'description' => 'The queuing time. ', + 'type' => 'number', + 'format' => 'float', + 'example' => '15.275', + ], + 'RowCacheHit' => [ + 'description' => 'The number of row cache hits. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'LogicalRead' => [ + 'description' => 'The number of logical reads. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19', + ], + 'SsstoreReadRowCount' => [ + 'description' => 'The number of rows read from the disk. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '43086', + ], + ], + ], + ], + ], + ], + ], + ], + '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":"<DescribeSlowSQLListResponse>\\n <TotalCount>2</TotalCount>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n <SlowSQLList>\\n <Key>1</Key>\\n <ExecPerSecond>163</ExecPerSecond>\\n <SQLText>SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC</SQLText>\\n <MaxCpuTime>257.967</MaxCpuTime>\\n <BlockCacheHit>14</BlockCacheHit>\\n <DecodeTime>0</DecodeTime>\\n <RemotePlans>0</RemotePlans>\\n <RPCCount>0</RPCCount>\\n <NetWaitTime>0</NetWaitTime>\\n <DiskRead>0</DiskRead>\\n <NodeIp>i-bp18qljorblo8es*****</NodeIp>\\n <ConcurrencyWaitTime>0</ConcurrencyWaitTime>\\n <MemstoreReadRowCount>527</MemstoreReadRowCount>\\n <DbName>testdb</DbName>\\n <AppWaitTime>0</AppWaitTime>\\n <ElapsedTime>76.382</ElapsedTime>\\n <MissPlans>0</MissPlans>\\n <AffectedRows>0</AffectedRows>\\n <ScheduleTime>0</ScheduleTime>\\n <Event>mysql response wait client</Event>\\n <TotalWaitTime>10.966</TotalWaitTime>\\n <ReturnRows>1</ReturnRows>\\n <ExecuteTime>61.044</ExecuteTime>\\n <UserName>tester</UserName>\\n <Executions>89403</Executions>\\n <GetPlanTime>0.052</GetPlanTime>\\n <CpuTime>50.13</CpuTime>\\n <MaxElapsedTime>260.044</MaxElapsedTime>\\n <SQLType>1</SQLType>\\n <BlockIndexCacheHit>4</BlockIndexCacheHit>\\n <RetryCount>0</RetryCount>\\n <SQLId>8D6E84****0B8FB1823D199E2CA1****</SQLId>\\n <ClientIp>1*2.***.1*3.***</ClientIp>\\n <BloomFilterCacheHit>0</BloomFilterCacheHit>\\n <IOWaitTime>0</IOWaitTime>\\n <FailTimes>0</FailTimes>\\n <QueueTime>15.275</QueueTime>\\n <RowCacheHit>0</RowCacheHit>\\n <LogicalRead>19</LogicalRead>\\n <SsstoreReadRowCount>43086</SsstoreReadRowCount>\\n </SlowSQLList>\\n</DescribeSlowSQLListResponse>","errorExample":""}]', + 'title' => 'DescribeSlowSQLList', + ], + 'DescribeSlowSQLHistoryList' => [ + 'summary' => 'You can call this operation to query the execution history of an SQL statement by SQL ID that is determined as a slow SQL statement during a specified period of time. ', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户名', + 'description' => 'The ID of the tenant. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't384tolsj****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '开始时间', + 'description' => 'The start time of the time range for querying the execution history of the slow SQL statement. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-12-14T02:34:49Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '结束时间', + 'description' => 'The end time of the time range for querying the execution history of the slow SQL statement. '."\n" + .'The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-12-14T08:34:49Z', + ], + ], + [ + 'name' => 'SQLId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'SQL唯一标识', + 'description' => 'The SQL ID, which uniquely identifies an SQL statement. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8D6E84735C0****1823D199E2CA1****', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of rows to return on each page. '."\n" + .'- Maximum value: 100 '."\n" + .'- Default value: 10 ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID. ', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'SlowSQLHistoryList' => [ + 'title' => '慢SQL历史列表', + 'description' => 'The execution history of the slow SQL statement. ', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => 'The return result of the request.', + 'type' => 'array', + 'items' => [ + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'SqlId' => [ + 'description' => 'SQLID.', + 'type' => 'string', + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + 'SqlType' => [ + 'description' => 'The SQL type. ', + 'type' => 'string', + 'example' => '1', + ], + 'TenantName' => [ + 'description' => 'The name of the tenant. ', + 'type' => 'string', + 'example' => 'pay_online', + ], + 'UserName' => [ + 'description' => 'The username. ', + 'type' => 'string', + 'example' => 'tester', + ], + 'ClientIp' => [ + 'description' => 'The IP address of the client. ', + 'type' => 'string', + 'example' => '1*2.***.1*3.***', + ], + 'DbName' => [ + 'description' => 'The name of the database. ', + 'type' => 'string', + 'example' => 'testdb', + ], + 'Event' => [ + 'description' => 'The wait event. ', + 'type' => 'string', + 'example' => 'mysql response wait client', + ], + 'NodeIp' => [ + 'description' => 'The IP address of the node. ', + 'type' => 'string', + 'example' => 'i-bp18qljorblo8es*****', + ], + 'AffectedRows' => [ + 'description' => 'The number of rows affected. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'BlockCacheHit' => [ + 'description' => 'The number of block cache hits. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '14', + ], + 'BlockIndexCacheHit' => [ + 'description' => 'The number of block index cache hits. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '4', + ], + 'BloomFilterCacheHit' => [ + 'description' => 'The number of Bloom filter cache hits. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'Executions' => [ + 'description' => 'The number of executions. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '89403', + ], + 'FailTimes' => [ + 'description' => 'The number of failures. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RPCCount' => [ + 'description' => 'The number of RPCs. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemotePlans' => [ + 'description' => 'The number of remote plans. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MissPlans' => [ + 'description' => 'The number of plan misses. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'ReturnRows' => [ + 'description' => 'The number of rows returned. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'LogicalRead' => [ + 'description' => 'The number of logical reads. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '19', + ], + 'RetryCount' => [ + 'description' => 'The number of retries. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RowCacheHit' => [ + 'description' => 'The number of row cache hits. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DiskRead' => [ + 'description' => 'The number of physical reads. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MemstoreReadRowCount' => [ + 'description' => 'The number of rows read from the memory. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '527', + ], + 'SsstoreReadRowCount' => [ + 'description' => 'The number of rows read from the disk. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '43086', + ], + 'ExecPerSecond' => [ + 'description' => 'The number of executions per second. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '163.0', + ], + 'AppWaitTime' => [ + 'description' => 'The wait time of the client. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'ElapsedTime' => [ + 'description' => 'The average response time. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '76.382', + ], + 'ExecuteTime' => [ + 'description' => 'The internal execution time. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '61.044', + ], + 'QueueTime' => [ + 'description' => 'The queuing time. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '15.275', + ], + 'ConcurrencyWaitTime' => [ + 'description' => 'The wait time in concurrent execution. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'CpuTime' => [ + 'description' => 'The average CPU time. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '50.13', + ], + 'DecodeTime' => [ + 'description' => 'The time to wait for decoding. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'NetWaitTime' => [ + 'description' => 'The wait time for network.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'IOWaitTime' => [ + 'description' => 'The I/O wait time. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'GetPlanTime' => [ + 'description' => 'Hard parsing time.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.052', + ], + 'MaxElapsedTime' => [ + 'description' => 'The maximum response time. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '260.044', + ], + 'TotalWaitTime' => [ + 'description' => 'The internal wait time. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '10.966', + ], + 'ScheduleTime' => [ + 'description' => 'The scheduling duration. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxCpuTime' => [ + 'description' => 'The maximum CPU time. ', + 'type' => 'number', + 'format' => 'double', + 'example' => '257.967', + ], + 'EndTimeUTCString' => [ + 'description' => 'The end time. ', + 'type' => 'string', + 'example' => '2021-12-28T02:08:18Z', + ], + ], + ], + ], + 'Count' => [ + 'description' => 'The quantity. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + '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":"<DescribeSlowSQLHistoryListResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n <SlowSQLHistoryList>\\n <List>\\n <SqlId>8D6E84****0B8FB1823D199E2CA1****</SqlId>\\n <SqlType>1</SqlType>\\n <TenantName>pay_online</TenantName>\\n <UserName>tester</UserName>\\n <ClientIp>1*2.***.1*3.***</ClientIp>\\n <DbName>testdb</DbName>\\n <Event>mysql response wait client</Event>\\n <NodeIp>i-bp18qljorblo8es*****</NodeIp>\\n <AffectedRows>0</AffectedRows>\\n <BlockCacheHit>14</BlockCacheHit>\\n <BlockIndexCacheHit>4</BlockIndexCacheHit>\\n <BloomFilterCacheHit>0</BloomFilterCacheHit>\\n <Executions>89403</Executions>\\n <FailTimes>0</FailTimes>\\n <RPCCount>0</RPCCount>\\n <RemotePlans>0</RemotePlans>\\n <MissPlans>0</MissPlans>\\n <ReturnRows>1</ReturnRows>\\n <LogicalRead>19</LogicalRead>\\n <RetryCount>0</RetryCount>\\n <RowCacheHit>0</RowCacheHit>\\n <DiskRead>0</DiskRead>\\n <MemstoreReadRowCount>527</MemstoreReadRowCount>\\n <SsstoreReadRowCount>43086</SsstoreReadRowCount>\\n <ExecPerSecond>163</ExecPerSecond>\\n <AppWaitTime>0</AppWaitTime>\\n <ElapsedTime>76.382</ElapsedTime>\\n <ExecuteTime>61.044</ExecuteTime>\\n <QueueTime>15.275</QueueTime>\\n <ConcurrencyWaitTime>0</ConcurrencyWaitTime>\\n <CpuTime>50.13</CpuTime>\\n <DecodeTime>0</DecodeTime>\\n <NetwaitTime>0</NetwaitTime>\\n <IOWaitTime>0</IOWaitTime>\\n <GetplanTime>0.052</GetplanTime>\\n <MaxElapsedTime>260.044</MaxElapsedTime>\\n <TotalWaitTime>10.966</TotalWaitTime>\\n <ScheduleTime>0</ScheduleTime>\\n <MaxCpuTime>257.967</MaxCpuTime>\\n <EndTimeUTCString>2021-12-28T02:08:18Z</EndTimeUTCString>\\n </List>\\n <Count>1</Count>\\n </SlowSQLHistoryList>\\n</DescribeSlowSQLHistoryListResponse>","errorExample":""}]', + 'title' => 'DescribeSlowSQLHistoryList', + ], + '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' => '集群id', + 'description' => 'The ID of the OceanBase cluster. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => 'The return result of the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => 'The data list.', + 'type' => 'object', + 'properties' => [ + 'ProxyClusterId' => [ + 'title' => '代理集群id', + 'description' => 'The ID of the proxy cluster.', + 'type' => 'string', + 'example' => 'proxy-3t****zrieasg', + ], + 'ProxyMode' => [ + 'title' => '代理模式', + 'description' => 'The proxy mode.', + 'type' => 'string', + 'example' => 'shared', + ], + 'Zone' => [ + 'title' => '可用区', + 'description' => 'The zone.', + 'type' => 'string', + 'example' => 'cn-shanghai-e,cn-shanghai-f', + ], + 'UnitSpec' => [ + 'title' => '单元规格', + 'description' => 'Thsa config.', + 'type' => 'string', + 'example' => '4C8GB', + ], + 'UnitNum' => [ + 'title' => '单元数量', + 'description' => 'The number of resource units in the tenant. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'CurrentEndpointNum' => [ + 'title' => '当前地址数', + 'description' => 'The current number of endpoints.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'EndpointNumQuota' => [ + 'title' => '地址数量配额', + 'description' => 'The endpoint quota.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the proxy cluster was created.', + 'type' => 'string', + 'example' => '2023-07-05T08:23:10Z', + ], + 'Status' => [ + 'title' => '代理状态', + 'description' => 'The status of the proxy service.', + 'type' => 'string', + 'example' => 'ONLINE', + 'enum' => [ + 'ONLINE：运行中', + 'CREATING：创建中', + 'DELETING：关闭中', + 'DELETED：已关闭', + ], + ], + 'ProxyServiceVersion' => [ + 'title' => '代理服务版本', + 'description' => 'The version of the proxy service.', + 'type' => 'string', + 'example' => '1.0', + ], + 'ExpireTime' => [ + 'title' => '到期时间', + 'description' => 'The expiration time.', + 'type' => 'string', + 'example' => '2123-07-05T16:00:00', + ], + 'UnitNumLimit' => [ + 'title' => '单元数量上限', + 'description' => 'The maximum number of units.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'ProxyVersion' => [ + 'description' => 'The version of the database proxy.', + 'type' => 'string', + 'example' => '4.3.1.0-xxxxxxxxx', + ], + 'DeployMode' => [ + 'type' => 'string', + 'description' => 'Deployment mode.', + 'example' => 'share', + ], + 'ServerNumLimit' => [ + 'title' => '节点数量上限值', + 'description' => 'The maximum number of nodes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AllowModifyServerNum' => [ + 'title' => 'true：允许修改，且显示当前节点数量'."\n" + .'false：不允许修改，且不显示当前节点数量', + 'description' => 'Indicates whether the number of nodes can be changed. Valid values: `true` and `false`. The current number of nodes is displayed if the number of nodes can be changed, and is not displayed if otherwise.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SharedUnitNumLimit' => [ + 'title' => 'K8S 共享模式代理服务的单元数量上限', + 'description' => 'The maximum number of units of the proxy service in Kubernetes in shared mode.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ExclusiveUnitNumLimit' => [ + 'title' => 'K8S 独占模式代理服务的单元数量上限', + 'description' => 'The maximum number of units of the proxy service in Kubernetes in exclusive mode.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"ProxyClusterId\\": \\"proxy-3t****zrieasg\\",\\n \\"ProxyMode\\": \\"shared\\",\\n \\"Zone\\": \\"cn-shanghai-e,cn-shanghai-f\\",\\n \\"UnitSpec\\": \\"4C8GB\\",\\n \\"UnitNum\\": 1,\\n \\"CurrentEndpointNum\\": 1,\\n \\"EndpointNumQuota\\": 3,\\n \\"CreateTime\\": \\"2023-07-05T08:23:10Z\\",\\n \\"Status\\": \\"ONLINE\\",\\n \\"ProxyServiceVersion\\": \\"1.0\\",\\n \\"ExpireTime\\": \\"2123-07-05T16:00:00\\",\\n \\"UnitNumLimit\\": 4,\\n \\"ProxyVersion\\": \\"4.3.1.0-xxxxxxxxx\\",\\n \\"DeployMode\\": \\"\\",\\n \\"ServerNumLimit\\": 0,\\n \\"AllowModifyServerNum\\": true,\\n \\"SharedUnitNumLimit\\": 0,\\n \\"ExclusiveUnitNumLimit\\": 0\\n }\\n}","type":"json"}]', + 'title' => 'DescribeProxyService', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'oceanbasepro.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'oceanbasepro.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'oceanbasepro.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'oceanbasepro.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'oceanbasepro.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'oceanbasepro.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'oceanbasepro.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'oceanbasepro.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'oceanbasepro.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'oceanbasepro.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'oceanbasepro.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'oceanbasepro.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'oceanbasepro.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'oceanbasepro.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'oceanbasepro.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'oceanbasepro.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'oceanbasepro.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'oceanbasepro.me-central-1.aliyuncs.com', + ], + ], +]; |