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/zh_cn/oceanbasepro | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/oceanbasepro')
| -rw-r--r-- | data/zh_cn/oceanbasepro/2019-09-01/api-docs.php | 43111 |
1 files changed, 43111 insertions, 0 deletions
diff --git a/data/zh_cn/oceanbasepro/2019-09-01/api-docs.php b/data/zh_cn/oceanbasepro/2019-09-01/api-docs.php new file mode 100644 index 0000000..5805008 --- /dev/null +++ b/data/zh_cn/oceanbasepro/2019-09-01/api-docs.php @@ -0,0 +1,43111 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'OceanBasePro', + 'version' => '2019-09-01', + ], + 'directories' => [ + [ + 'id' => 191859, + 'title' => '标签管理', + 'type' => 'directory', + 'children' => [ + 'ModifyTagValueName', + 'ModifyTagName', + 'DescribeTagValues', + 'DeleteTagValue', + 'DeleteTag', + 'CreateTagValue', + 'CreateTag', + 'ModifyInstanceTags', + 'DescribeTenantTags', + 'ModifyTenantTags', + 'DescribeInstanceTags', + ], + ], + [ + 'id' => 134089, + 'title' => '集群管理', + 'type' => 'directory', + 'children' => [ + 'CreateInstance', + 'DescribeInstance', + 'DescribeInstances', + 'DescribeInstanceTopology', + 'DescribeAvailableSpec', + 'DescribeAvailableZone', + 'DescribeInstanceCreatableZone', + 'ModifyInstanceName', + 'ModifyInstanceSpec', + 'ModifyInstanceNodeNum', + 'ModifyInstanceTemporaryCapacity', + 'SwitchoverInstance', + 'RemoveStandbyInstance', + 'DeleteInstances', + 'DescribeInstanceSummary', + 'DescribeStandbyCreateMode', + ], + ], + [ + 'id' => 134094, + 'title' => '租户管理', + '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' => '租户账号管理', + 'type' => 'directory', + 'children' => [ + 'CreateTenantUser', + 'DescribeTenantUsers', + 'DescribeTenantUserRoles', + 'ModifyTenantUserDescription', + 'ModifyTenantUserPassword', + 'ModifyTenantUserRoles', + 'DeleteTenantUsers', + ], + ], + [ + 'id' => 134118, + 'title' => '数据库管理', + 'type' => 'directory', + 'children' => [ + 'CreateDatabase', + 'DescribeDatabases', + 'ModifyDatabaseDescription', + 'ModifyTenantUserStatus', + 'ModifyDatabaseUserRoles', + 'DeleteDatabases', + ], + ], + [ + 'id' => 134125, + 'title' => '参数管理', + 'type' => 'directory', + 'children' => [ + 'DescribeParameters', + 'DescribeParametersHistory', + 'ModifyParameters', + ], + ], + [ + 'id' => 181884, + 'title' => '会话连接', + 'type' => 'directory', + 'children' => [ + 'DescribeSessionList', + 'BatchKillSessionList', + 'BatchKillProcessList', + 'DescribeProcessStatsComposition', + 'KillProcessList', + ], + ], + [ + 'id' => 134137, + 'title' => '诊断管理', + 'type' => 'directory', + 'children' => [ + 'DescribeOasAnomalySQLList', + 'DescribeSampleSqlRawTexts', + 'DescribeOasSQLDetails', + 'DescribeOasSQLPlans', + 'DescribeSQLSamples', + 'DescribeOasSQLHistoryList', + 'DescribeOasTopSQLList', + 'DescribeOasSlowSQLList', + 'DescribeOutlineBinding', + 'DescribeRecommendIndex', + 'DescribeSQLTuningAdvices', + 'DescribeSqlAuditStat', + 'CreateOasOutlineTask', + ], + ], + [ + 'id' => 134129, + 'title' => '安全设置', + 'type' => 'directory', + 'children' => [ + 'ModifyInstanceSSL', + 'DescribeInstanceSSL', + 'CreateSecurityIpGroup', + 'DescribeSecurityIpGroups', + 'DescribeTenantSecurityConfigs', + 'DescribeTenantEncryption', + 'DescribeInstanceSecurityConfigs', + 'ModifySecurityIps', + 'ModifyTenantEncryption', + 'DeleteSecurityIpGroup', + 'DescribeBackupEncryptedString', + ], + ], + [ + 'id' => 134134, + 'title' => '监控管理', + 'type' => 'directory', + 'children' => [ + 'DescribeMetricsDataV2', + 'DescribeMetricsData', + 'DescribeNodeMetrics', + 'DescribeTenantMetrics', + ], + ], + [ + 'id' => 166104, + 'title' => '数据传输', + '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' => '备份恢复', + 'type' => 'directory', + 'children' => [ + 'DescribeBackupSetDownloadLink', + 'DescribeDataBackupSet', + 'CreateBackupSetDownloadLink', + 'DescribeRestorableTenants', + ], + ], + [ + 'id' => 192529, + 'title' => '未翻译(其他)', + 'type' => 'directory', + 'children' => [ + 'DescribeAnomalySQLList', + 'DescribeSQLDetails', + 'DescribeSQLPlans', + 'DescribeSQLHistoryList', + 'DescribeTopSQLList', + 'DescribeSlowSQLList', + 'DescribeSlowSQLHistoryList', + ], + ], + [ + 'id' => 195786, + 'title' => '其他', + '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' => [ + 'title' => '标签组名称', + 'description' => '标签组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '标签组 1', + ], + ], + [ + 'name' => 'Value', + 'in' => 'formData', + 'schema' => [ + 'title' => '标签名称', + 'description' => '标签名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '标签 1', + ], + ], + [ + 'name' => 'NewValue', + 'in' => 'formData', + 'schema' => [ + 'title' => '标签新名称', + 'description' => '标签新名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '标签 2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回的结果。', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '标签修改情况', + 'description' => '标签修改情况。', + 'type' => 'string', + 'example' => 'update tag-value name success', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', + ], + ], + ], + ], + ], + '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' => '修改标签名', + 'summary' => '该接口用于修改标签名称。', + ], + 'ModifyTagName' => [ + 'methods' => [ + 'post', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Key', + 'in' => 'formData', + 'schema' => [ + 'title' => '标签组名称', + 'description' => '标签组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '标签组 1', + ], + ], + [ + 'name' => 'NewKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '标签组新名称', + 'description' => '标签组新名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '标签组 2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回的结果。', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '标签组修改情况', + 'description' => '标签组修改情况。', + 'type' => 'string', + 'example' => 'update tag name success', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', + ], + ], + ], + ], + ], + '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' => '修改标签组名', + 'summary' => '该接口用于修改标签组的名称。', + ], + 'DescribeTagValues' => [ + 'methods' => [ + 'post', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源类型', + 'description' => '资源类型。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'tag', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Map' => [ + 'title' => '标签组与标签的映射关系', + 'description' => '标签组和标签的映射关系。', + 'type' => 'string', + 'example' => '"{\\"标签组2\\":[\\"标签值2-1\\",\\"标签值2-2\\"],\\"标签组1\\":[\\"标签值1-1\\"]}"', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', + ], + ], + ], + ], + ], + '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' => '查询标签', + 'summary' => '该接口用于查询标签。', + ], + 'DeleteTagValue' => [ + 'methods' => [ + 'post', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Key', + 'in' => 'formData', + 'schema' => [ + 'title' => '标签组名称', + 'description' => '标签组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '标签组 1', + ], + ], + [ + 'name' => 'Value', + 'in' => 'formData', + 'schema' => [ + 'title' => '标签名称', + 'description' => '标签名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '标签 2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回的结果。', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '标签删除情况', + 'description' => '标签删除情况。', + 'type' => 'string', + 'example' => 'delete tag-value success', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', + ], + ], + ], + ], + ], + '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' => '删除标签', + 'summary' => '该接口用于删除标签。', + ], + 'DeleteTag' => [ + 'methods' => [ + 'post', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Key', + 'in' => 'formData', + 'schema' => [ + 'title' => '标签组名称', + 'description' => '标签组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '标签组 2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => ' 标签组删除情况', + 'description' => '标签组删除情况。', + 'type' => 'string', + 'example' => 'delete tag success', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', + ], + ], + ], + ], + ], + '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' => '删除标签组', + 'summary' => '该接口用于删除标签组。', + ], + 'CreateTagValue' => [ + 'methods' => [ + 'post', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Value', + 'in' => 'formData', + 'schema' => [ + 'title' => '标签名称', + 'description' => '标签名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '标签 1', + ], + ], + [ + 'name' => 'Key', + 'in' => 'formData', + 'schema' => [ + 'title' => '标签组名称', + 'description' => '标签组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '标签组 1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '客户端标识。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回的结果。', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '标签创建情况', + 'description' => '标签创建情况。', + 'type' => 'string', + 'example' => 'create tag value success', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', + ], + ], + ], + ], + ], + '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' => '创建标签', + 'summary' => '该接口用于新建标签。', + ], + 'CreateTag' => [ + 'methods' => [ + 'post', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Key', + 'in' => 'formData', + 'schema' => [ + 'title' => '标签组名称', + 'description' => '标签组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '标签组 1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '客户端标识。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回的结果。', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '标签组创建情况', + 'description' => '标签组创建情况。', + 'type' => 'string', + 'example' => 'Create tag success', + ], + 'RequestId' => [ + 'title' => '请求 ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '4C91F7BA-xxxx-xxxx-xxxx-846ECA1A9908', + ], + ], + ], + ], + ], + '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' => '创建标签组', + 'summary' => '该接口用于新建标签组。', + ], + 'ModifyInstanceTags' => [ + 'summary' => '该接口用于修改集群的标签值。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'schema' => [ + 'title' => '标签值', + 'description' => '标签值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"Key": "xxx", "Value": "xxx"},{}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Message' => [ + 'title' => '打标情况', + 'description' => '标签更新情况。', + 'type' => 'string', + 'example' => 'add resource tag relation success', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Message\\": \\"add resource tag relation success\\"\\n}","type":"json"}]', + 'title' => '修改集群标签值', + ], + 'DescribeTenantTags' => [ + 'summary' => '该接口用于查询租户的标签值。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantIds', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户id的json串', + 'description' => '租户 ID 的数组字符串。', + 'type' => 'string', + 'required' => true, + 'example' => '["t5r0x2f6q****", "t33h8y08k****", "t5r41rtl7****"]', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'schema' => [ + 'title' => '标签值', + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '[{"Key": "xxx", "Value", "xxx"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'TagResources' => [ + 'title' => '标签列表', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'title' => '资源id', + 'description' => '资源 ID。', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'instance', + ], + 'Tag' => [ + 'title' => '资源标签', + 'description' => '资源标签。', + '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' => '查询租户标签值', + ], + 'ModifyTenantTags' => [ + 'summary' => '该接口用于修改租户的标签值。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户id', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't33h8y08k****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'schema' => [ + 'title' => '标签值', + 'description' => '标签值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"Key": "xxx", "Value", "xxx"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Message' => [ + 'title' => '打标情况', + 'description' => '标签更新情况。', + 'type' => 'string', + 'example' => 'done', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\",\\n \\"Message\\": \\"done\\"\\n}","type":"json"}]', + 'title' => '修改租户标签值', + ], + 'DescribeInstanceTags' => [ + 'summary' => '查询集群的标签值。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceIds', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id列表', + 'description' => '集群 ID 列表。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '["ob3za5w73as8rk"]', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'schema' => [ + 'title' => '标签值', + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '[{"Key": "xxx", "Value", "xxx"},{}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'TagResources' => [ + 'title' => '标签列表', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'title' => '资源id', + 'description' => '资源 ID。', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'instance', + ], + 'Tag' => [ + 'title' => '资源标签', + 'description' => '资源标签。', + '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' => '查询集群标签值', + ], + 'CreateInstance' => [ + 'summary' => '创建一个 OceanBase 数据库集群。', + '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' => '实例的付费方式。取值范围： '."\n" + .'- PrePay：包年包月。选择该类付费方式时，必须确认自己的账号支持余额支付 / 信用支付，否则将返回 InvalidPayMethod 的错误提示。'."\n" + .'- PostPay（默认）：按量付费（默认按小时计费）。', + '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' => '实例的系列。'."\n" + .'- normal（默认）：标准集群版（云盘）。'."\n" + .'- normal_ssd：标准集群版（本地盘）。'."\n" + .'- history：历史库集群版。'."\n" + .'- normal_kv：obkv 集群。'."\n" + .'- normal_hg：信创集群（需要添加白名单开放）。', + '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' => '实例所属的可用区 ID。 '."\n" + .'输入多个可用区时注意以逗号分隔。'."\n" + .'更多详情，请参见 [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' => '集群规格信息。<br> 当前支持以下套餐：'."\n" + .'- 4C16GB：4 核 16GB。'."\n" + .'- 8C32GB：8 核 32GB。'."\n" + .'- 14C70GB：14 核 70GB。'."\n" + .'- 24C120GB：24 核 120GB。'."\n" + .'- 30C180GB：30 核 180GB。'."\n" + .'- 62C400GB：62 核 400GB。'."\n" + .'- 104C600GB：104 核 600GB。'."\n" + .'- 16C70GB：16 核 70GB。'."\n" + .'- 32C160GB：32 核 160GB。'."\n" + .'- 64C380GB：64 核 380GB。'."\n" + .'- 20C32GB：20 核 32GB。'."\n" + .'- 40C64GB：40 核 64GB。'."\n" + .'- 16C32GB：16 核 32GB。'."\n" + .'- 32C70GB：32 核 70GB。'."\n" + .'- 64C180GB：64 核 180GB。'."\n" + .'- 32C180GB：32 核 180GB。'."\n" + .'- 64C400GB：64 核 400GB。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + '64C380GB' => '64 核 380GB', + '64C400GB' => '64 核 400GB', + '32C70GB' => '32 核 70GB', + '14C70GB' => '14 核 70GB', + '16C32GB' => '16 核 32GB', + '4C16GB' => '4 核 16GB', + '32C160GB' => '32 核 160GB', + '8C32GB' => '8 核 32GB', + '16C70GB' => '16 核 70GB', + '24C120GB' => '24 核 120GB', + '32C180GB' => '32 核 180GB', + '30C180GB' => '30 核 180GB', + '40C64GB' => '40 核 64GB', + '62C400GB' => '62 核 400GB', + '20C32GB' => '20 核 32GB', + '104C600GB' => '104 核 600GB', + '64C180GB' => '64 核 180GB', + ], + 'example' => '14C70GB', + 'enum' => [ + '8C32GB', + '14C70GB', + '30C180GB', + '62C400GB', + '16C70GB', + '24C120GB', + '32C160GB', + '64C380GB', + '20C32GB', + '40C64GB', + '4C16GB', + '32C180GB', + '64C400GB', + '16C32GB', + '32C70GB', + '64C180GB', + '104C600GB', + '8C32G', + '14C70G', + '30C180G', + '62C400G', + '16C70G', + '24C120G', + '32C160G', + '64C380G', + '20C32G', + '40C64G', + '4C16G', + '32C180G', + '64C400G', + '16C32G', + '32C70G', + '64C180G', + '104C600G', + '24C48GB', + '24C48G', + '8C16G(generalspec)', + '16C32G(generalspec)', + '24C48G(generalspec)', + '32C70G(generalspec)', + '64C180G(generalspec)', + '8C16GB', + '8C16G', + ], + ], + ], + [ + 'name' => 'DiskSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '存储空间大小，单位GB。 存储空间的限制根据集群规格不同而不同，具体如下： - 8C32GB：100GB~10000GB - 14C70GB：200GB~10000GB - 30C180GB：400GB~10000GB - 62C400G：800GB-10000GB。 各套餐的存储空间默认值为其最小值。', + 'description' => '存储空间大小，单位 GB。'."\n" + .'存储空间的限制根据集群规格不同而不同，具体如下：'."\n" + .'- 8C32GB：100GB~10000GB。'."\n" + .'- 14C70GB：200GB~10000GB。'."\n" + .'- 30C180GB：400GB~10000GB。'."\n" + .'- 62C400G：800GB-10000GB。'."\n" + .'各套餐的存储空间默认值为其最小值。', + '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' => '购买资源的时长，单位由 PeriodUnit 指定。 '."\n" + .'当参数 InstanceChargeType 取值为 PrePaid 时才生效且为必选值。'."\n" + .'取值范围： '."\n" + .'- PeriodUnit=Month 时，Period 取值：{“1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”}。'."\n" + .'- PeriodUnit=Year 时，Period 取值：{“1”, “2”, “3”}。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'formData', + 'schema' => [ + 'title' => '购买资源的时长。'."\n" + .'包年包月取值范围：Month 或者 Year。'."\n" + .'默认值：包年包月为 Month，按量计费，默认周期为 Hour。', + 'description' => '购买资源的时长。 '."\n" + .'包年包月取值范围：Month 或者 Year。 '."\n" + .'默认值：包年包月为 Month，按量计费，默认周期为 Hour。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否要自动续费。当参数ChargeType取值PrePaid时生效。取值范围： true：自动续费。 false（默认）：不自动续费。', + 'description' => '是否要自动续费。'."\n" + .'当参数 ChargeType 取值 PrePaid 时生效。取值范围：'."\n" + .'- true：自动续费。'."\n" + .'- false（默认）：不自动续费。', + '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' => '每次自动续费的时长，当参数 AutoRenew 取值 True 时，该参数为必填参数。'."\n" + .'- PeriodUnit 为 Year 时，AutoRenewPeriod 取值范围为 {"1", "2", "3"}。 '."\n" + .'- PeriodUnit 为 Month 时，AutoRenewPeriod 取值范围为 {"1", "2", "3", "6", "12"}。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '实例所在的企业资源组ID', + 'description' => '实例所在的企业资源组 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-bp67acfmxazb4p****', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群名称, 最大长度为20字符。', + 'description' => 'OceanBase 集群名称。'."\n" + .'长度为 1~20 个英文或中文字符。'."\n" + .'如未指定该参数，默认值为集群的 InstanceId。', + 'type' => 'string', + 'required' => false, + 'example' => 'amap_aos_tx_ob', + 'maxLength' => 64, + 'minLength' => 0, + ], + ], + [ + 'name' => 'ObVersion', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase Server的版本号。', + 'description' => 'OceanBase Server 版本号。', + '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' => '集群的存储类型。仅在标准集群版（云盘）下生效。 '."\n" + .'当前支持两种类型： '."\n" + .'- cloud_essd_pl1：云盘 ESSD PL1。 '."\n" + .'- cloud_essd_pl0：云盘 ESSD PL0。默认值为 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' => '是否只预检此次请求, 默认为 false。取值范围：'."\n" + .'- true：发送检查请求，不会创建实例。如果检查通过，则返回 DryRunResult=true, 如果检查不通过，则返回相应错误的错误码。'."\n" + .'- false（默认）：发送正常请求，通过检查后直接创建实例。如为 false, 则表示不进行预检查, DryRunResult 默认返回 false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ReplicaMode', + 'in' => 'formData', + 'schema' => [ + 'title' => '全功能型副本数。3: 表示3个全功能型副本; 2: 表示2个全功能型副本.', + 'description' => '全功能型副本数。返回值仅包含 3 和 2。'."\n" + .'- 3：表示 3 个全功能型副本。'."\n" + .'- 2：表示 2 个全功能型副本。'."\n" + .'三可用区部署时，只支持 3 个全功能型副本，双可用区部署时，仅支持 2 个全功能型副本，单可用区部署时，可以支持 2 个或者 3 个全功能型副本。', + 'type' => 'string', + 'required' => false, + 'example' => '3', + 'enum' => [ + '3', + '2', + ], + ], + ], + [ + 'name' => 'IsolationOptimization', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => '是否开启 Cgroup。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'enum' => [ + 'true', + 'false', + ], + ], + ], + [ + 'name' => 'PrimaryInstance', + 'in' => 'formData', + 'schema' => [ + 'title' => '主实例id', + 'description' => '主实例 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ob3h8ytroxxxxx', + ], + ], + [ + 'name' => 'PrimaryRegion', + 'in' => 'formData', + 'schema' => [ + 'title' => '主实例Region', + 'description' => '主实例 Region。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'CpuArch', + 'in' => 'formData', + 'schema' => [ + 'title' => 'cpu架构', + 'description' => 'cpu架构', + 'type' => 'string', + 'required' => false, + 'example' => 'x86', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'title' => '返回数据', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => '实例ID', + 'description' => '实例 ID。', + 'type' => 'string', + 'example' => 'i-bp67acfmxazb4p****', + ], + 'OrderId' => [ + 'title' => '订单ID。该参数只有创建包年包月ECS实例（请求参数InstanceChargeType=PrePaid）时有返回值。', + 'description' => '订单 ID。<br>该参数在创建预付费和后付费集群时包含返回值。', + 'type' => 'string', + 'example' => '1234567890', + ], + 'ResourceGroupId' => [ + 'title' => '资源组ID', + 'description' => '资源组 ID。', + 'type' => 'string', + 'example' => 'rg-***************', + ], + 'DryRunResult' => [ + 'title' => '预检查请求的结果. 如果DryRun填写为true, 当预检查请求通过, 则DryRunResult返回true, 否则返回相应的错误码信息.', + 'description' => '预检查请求的结果。'."\n" + .'- 如果 DryRun 填写为 true，当预检查请求通过，则 DryRunResult 返回 true，否则返回相应的错误码信息。'."\n" + .'- 如果 DryRun 填写为 false, 则表示不进行预检查, DryRunResult 默认返回 false。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + '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' => '创建集群', + ], + 'DescribeInstance' => [ + 'summary' => '查询一个 OceanBase 集群的详细信息。', + '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' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。<br>起始值：1， 默认值：1', + 'description' => '分页查询的页码。'."\n" + .'- 起始值：1。'."\n" + .'- 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Instance' => [ + 'title' => 'OceanBase 集群信息。', + 'description' => 'OceanBase 集群信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => 'OceanBase 集群 ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'InstanceName' => [ + 'title' => 'OceanBase 集群名称。', + 'description' => 'OceanBase 集群名称。', + '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' => '集群规格信息。<br> 当前支持以下套餐：'."\n" + .'- 4C16GB：4 核 16GB。'."\n" + .'- 8C32GB：8 核 32GB。'."\n" + .'- 14C70GB：14 核 70GB。'."\n" + .'- 24C120GB：24 核 120GB。'."\n" + .'- 30C180GB：30 核 180GB。'."\n" + .'- 62C400GB：62 核 400GB。'."\n" + .'- 104C600GB：104 核 600GB。'."\n" + .'- 16C70GB：16 核 70GB。'."\n" + .'- 32C160GB：32 核 160GB。'."\n" + .'- 64C380GB：64 核 380GB。'."\n" + .'- 20C32GB：20 核 32GB。 '."\n" + .'- 40C64GB：40 核 64GB。'."\n" + .'- 16C32GB：16 核 32GB。'."\n" + .'- 32C70GB：32 核 70GB。'."\n" + .'- 64C180GB：64 核 180GB。'."\n" + .'- 32C180GB：32 核 180GB。'."\n" + .'- 64C400GB：64 核 400GB。', + 'type' => 'string', + 'example' => '14C70G', + ], + 'Series' => [ + 'title' => '实例的系列 - normal（默认）：标准集群版（云盘） - normal_ssd：标准集群版（本地盘） - history：历史库集群版, normal_kv: obkv集群, normal_hg: 信创集群。', + 'description' => '实例的系列。'."\n" + .'- normal（默认）：标准集群版（云盘）。'."\n" + .'- normal_ssd：标准集群版（本地盘）。'."\n" + .'- history：历史库集群版。'."\n" + .'- normal_kv: obkv 集群。'."\n" + .'- normal_hg：信创集群。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'PayType' => [ + 'title' => 'OceanBase 集群的付费类型 <br>- PREPAY：预付费 <br>- POSTPAY：按量付费', + 'description' => 'OceanBase 集群的付费类型。'."\n" + .'- PREPAY：预付费。'."\n" + .'- POSTPAY：按量付费。', + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'CreateTime' => [ + 'title' => '集群的创建时间（UTC时间）。', + 'description' => '集群的创建时间（UTC 时间）。', + 'type' => 'string', + 'example' => '2021-10-19T07:13:41Z', + ], + 'ExpireTime' => [ + 'title' => '集群过期时间（UTC格式）。', + 'description' => '集群过期时间（UTC 格式）。', + 'type' => 'string', + 'example' => '2021-10-17T16:00:00Z', + ], + 'Version' => [ + 'title' => 'OBServer 版本信息。', + 'description' => 'OBServer 版本信息。', + 'type' => 'string', + 'example' => '2.2.77', + ], + 'DeployType' => [ + 'title' => '集群的部署类型。<br> - multiple：多机房 <br>- single：单机房 <br>- dual：双机房', + 'description' => '集群的部署类型。'."\n" + .'- multiple：多机房。'."\n" + .'- single：单机房。'."\n" + .'- dual：双机房。', + 'type' => 'string', + 'example' => 'multiple', + ], + 'DeployMode' => [ + 'title' => '集群的数据副本模式。 单机房为n，双机房为n-n，多机房为n-n-n，其中n为各机房的observer节点数。', + 'description' => '集群的数据副本模式。'."\n" + .'- 单机房为 n。'."\n" + .'- 双机房为 n-n。'."\n" + .'- 多机房为 n-n-n。'."\n" + ."\n" + .'> <br>其中，n 为各机房的 OBServer 节点数。', + 'type' => 'string', + 'example' => '1-1-1', + ], + 'DiskType' => [ + 'title' => '集群部署的存储类型。默认为cloud_essd_pl1：ESSD云盘。', + 'description' => '集群部署的存储类型。'."\n" + ."\n" + .'默认为 cloud_essd_pl1：ESSD 云盘。', + 'type' => 'string', + 'example' => 'cloud_essd_pl1', + ], + 'MaintainTime' => [ + 'title' => '集群的每天例行维护时间，UTC时间。', + 'description' => '集群的每天例行维护时间，UTC 时间。', + 'type' => 'string', + 'example' => '19:00Z-20:00Z', + ], + 'DataMergeTime' => [ + 'title' => '集群的数据合并时间。', + 'description' => '集群的数据合并时间。', + 'type' => 'string', + 'example' => '02:00', + ], + 'AutoRenewal' => [ + 'title' => '是否开启自动续费。该参数只在预付费（PREPAY）集群有意义。', + 'description' => '是否开启自动续费。'."\n" + ."\n" + .'该参数只在预付费（PREPAY）集群有意义。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsTrustEcs' => [ + 'title' => '是否使用可信ecs', + 'description' => '是否使用可信 ecs。', + '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' => '集群状态。'."\n" + .'- PENDING_CREATE: 创建中。'."\n" + .'- ONLINE: 运行中。'."\n" + .'- TENANT_CREATING：租户创建中 。'."\n" + .'- TENANT_SPEC_MODIFYING：租户规格修改中。'."\n" + .'- EXPANDING: 节点扩容中。'."\n" + .'- REDUCING: 节点缩容中。'."\n" + .'- SPEC_UPGRADING:套餐规格扩容中。'."\n" + .'- DISK_UPGRADING:存储规格扩容中。'."\n" + .'- WHITE_LIST_MODIFYING: 修改白名单中。'."\n" + .'- PARAMETER_MODIFYING: 修改参数中。'."\n" + .'- SSL_MODIFYING: SSL 变更中。'."\n" + .'- PREPAID_EXPIRE_CLOSED: 预付费集群欠费中。'."\n" + .'- ARREARS_CLOSED: 后付费集群欠费中。'."\n" + .'- PENDING_DELETE: 删除中。'."\n" + .'集群一般为运行中的状态（ONLINE）。', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'Resource' => [ + 'title' => '集群的资源信息', + 'description' => '集群的资源信息。', + 'type' => 'object', + 'properties' => [ + 'Cpu' => [ + 'title' => '集群的CPU资源信息', + 'description' => '集群的 CPU 资源信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCpu' => [ + 'title' => '集群总CPU，单位：核数', + 'description' => '集群总 CPU，单位：核数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + 'UsedCpu' => [ + 'title' => '集群已使用的CPU，单位：核数', + 'description' => '集群已使用的 CPU，单位：核数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'UnitCpu' => [ + 'title' => '集群中每个副本节点的CPU，单位：核数', + 'description' => '集群中每个副本节点的 CPU，单位：核数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'OriginalTotalCpu' => [ + 'title' => '原始CPU', + 'description' => '原始 CPU。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + ], + ], + 'Memory' => [ + 'title' => '集群的内存资源信息', + 'description' => '集群的内存资源信息。', + 'type' => 'object', + 'properties' => [ + 'TotalMemory' => [ + 'title' => '集群总内存，单位：GB', + 'description' => '集群总内存，单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '70', + ], + 'UsedMemory' => [ + 'title' => '集群已使用的内存，单位：GB', + 'description' => '集群已使用的内存，单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'UnitMemory' => [ + 'title' => '集群中每个副本的内存，单位：GB', + 'description' => '集群中每个副本的内存，单位：GB', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'OriginalTotalMemory' => [ + 'title' => '原始内存', + 'description' => '原始内存。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '72', + ], + ], + ], + 'DiskSize' => [ + 'title' => '集群的存储资源信息', + 'description' => '集群的存储资源信息。', + 'type' => 'object', + 'properties' => [ + 'TotalDiskSize' => [ + 'title' => '集群总存储空间，单位：GB', + 'description' => '集群总存储空间，单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'UsedDiskSize' => [ + 'title' => '集群已使用的存储空间，单位：GB', + 'description' => '集群已使用的存储空间，单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'UnitDiskSize' => [ + 'title' => '集群每个副本的存储空间，单位：GB', + 'description' => '集群每个副本的存储空间，单位：GB', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'DataUsedSize' => [ + 'description' => '数据盘大小规格，单位 GB。', + 'type' => 'number', + 'format' => 'double', + 'example' => '200', + ], + 'MaxDiskUsedPercent' => [ + 'description' => '磁盘使用率最大值（百分比）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.14', + ], + 'MaxDiskUsedObServer' => [ + 'description' => '磁盘服务器使用率最大值。', + 'type' => 'array', + 'items' => [ + 'description' => '数据盘使用量最大的 OB Server 节点列表。', + 'type' => 'string', + 'example' => 'i-bp1fhj23fs32dfbg4****', + ], + ], + 'OriginalTotalDiskSize' => [ + 'title' => '原始磁盘', + 'description' => '原始磁盘。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'MaxDiskSize' => [ + 'title' => '最大可创建磁盘大小', + 'description' => '最大可创建磁盘大小。', + 'type' => 'number', + 'format' => 'double', + 'example' => '80000', + ], + ], + ], + 'UnitCount' => [ + 'title' => '集群的资源Unit数量。', + 'description' => '集群的资源 Unit 数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'LogDiskSize' => [ + 'title' => '集群的日志盘资源信息', + 'description' => '集群的日志盘资源信息。', + 'type' => 'object', + 'properties' => [ + 'TotalDiskSize' => [ + 'title' => '集群总日志盘空间，单位GB。', + 'description' => '集群总日志盘空间，单位 GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '400', + ], + 'UnitDiskSize' => [ + 'title' => '集群每个副本的日志存储空间，单位：GB', + 'description' => '集群每个副本的日志存储空间，单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'LogAssignedSize' => [ + 'description' => '分配的日志存储空间，单位：GB。', + 'type' => 'string', + 'example' => '0.0', + ], + 'MaxLogAssignedObServer' => [ + 'description' => '分配的服务器最大存储空间信息。', + 'type' => 'array', + 'items' => [ + 'description' => '日志盘使用量最大的 OB Server 节点列表。', + 'type' => 'string', + 'example' => '["i-bp1g****","i-bp11****","i-bp19****"]', + ], + ], + 'MaxLogAssignedPercent' => [ + 'description' => '分配的最大日志存储空间百分比。', + 'type' => 'string', + 'example' => '6.68', + ], + 'OriginalTotalDiskSize' => [ + 'title' => '日志盘原始大小', + 'description' => '日志盘原始大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + 'CapacityUnit' => [ + 'description' => '容量单元。', + 'type' => 'object', + 'properties' => [ + 'MaxCapacityUnit' => [ + 'description' => '最大容量单元。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'MinCapacityUnit' => [ + 'description' => '最小容量单元。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'UsedCapacityUnit' => [ + 'description' => '已用容量单位。', + 'type' => 'string', + 'example' => '2', + ], + ], + ], + ], + ], + 'AutoUpgradeObVersion' => [ + 'title' => '是否开启自动升级 OBServer 版本。', + 'description' => '是否开启自动升级 OBServer 版本。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ObRpmVersion' => [ + 'title' => 'OBServer 详细版本信息。', + 'description' => 'OBServer 详细版本信息。', + 'type' => 'string', + 'example' => '2.2.77-20210526202046', + ], + 'IsLatestObVersion' => [ + 'title' => 'OBServer版本是否为最新版本。', + 'description' => 'OBServer 版本是否为最新版本。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AvailableZones' => [ + 'title' => '可用区列表。', + 'description' => '可用区列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可用区列表。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + ], + 'EnableUpgradeLogDisk' => [ + 'title' => '是否允许升级日志盘规格。', + 'description' => '是否允许升级日志盘规格。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Zones' => [ + 'description' => '实例所属的可用区 ID。 '."\n" + .'更多详情，请参见 [DescribeZones](~~25610~~) 获取可用区列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例所属的可用区 ID。 '."\n" + .'更多详情，请参见 [DescribeZones](https://www.alibabacloud.com/help/zh/doc-detail/25610.htm) 获取可用区列表。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j', + ], + ], + 'InstanceRole' => [ + 'title' => '实例角色', + 'description' => '实例角色。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'NodeNum' => [ + 'description' => '集群节点个数信息。 '."\n" + .'如果部署模式为 n-n-n，则节点个数为 n * 3。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'ReplicaMode' => [ + 'description' => '全功能型副本数。'."\n" + .'返回值仅包含 3 和 2。'."\n" + .'- 3：表示 3 个全功能型副本。'."\n" + .'- 2：表示 2 个全功能型副本。'."\n" + ."\n" + .'三可用区部署时，只支持 3 个全功能型副本，双可用区部署时，仅支持 2 个全功能型副本，单可用区部署时，可以支持 2 个或者 3 个全功能型副本。', + 'type' => 'string', + 'example' => '2', + ], + 'IsolationOptimization' => [ + 'title' => '是否开启Cgroup', + 'description' => '是否开启 Cgroup。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'EnableIsolationOptimization' => [ + 'title' => '是否允许开通隔离优化', + 'description' => '是否允许开通隔离优化。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'InTempCapacityStatus' => [ + 'description' => '临时容量状态。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'DataDiskAutoScale' => [ + 'title' => '是否开启数据自动协调', + 'description' => '是否开启数据自动协调。'."\n" + .'> <br>此参数已废弃。', + 'type' => 'boolean', + 'example' => '-', + ], + 'TenantCreatable' => [ + 'description' => '可创建的租户。', + 'type' => 'object', + 'properties' => [ + 'EnableCreateTenant' => [ + 'title' => '集群是否允许创建租户', + 'description' => '集群是否允许创建租户。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DisableCreateTenantReason' => [ + 'title' => '集群不允许创建租户的原因', + 'description' => '集群不允许创建租户的原因。', + 'type' => 'string', + 'example' => 'CPU_NOT_ENOUGH、 MEMORY_NOT_ENOUGH、TENANT_COUNT_EXCEEDS_LIMIT', + ], + ], + ], + 'DataDiskAutoScaleConfig' => [ + 'title' => '数据盘自动协调配置', + 'description' => '数据盘自动协调配置。', + 'type' => 'object', + 'properties' => [ + 'AutoScale' => [ + 'title' => '是否开启', + 'description' => '是否开启。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Upperbound' => [ + 'title' => '扩容上限', + 'description' => '扩容上限。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16', + ], + 'UpperThreshold' => [ + 'title' => '日常扩容阈值', + 'description' => '日常扩容阈值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '80', + ], + 'UpperMergeThreshold' => [ + 'title' => '合并扩容阈值', + 'description' => '合并扩容阈值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90', + ], + 'MaxDiskSize' => [ + 'title' => '磁盘最大值', + 'description' => '磁盘最大值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '80000', + ], + 'ScaleStepInNormal' => [ + 'title' => '日常扩容步长', + 'description' => '日常扩容步长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'ScaleStepInMerge' => [ + 'title' => '合并扩容步长', + 'description' => '合并扩容步长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'UpperScaleStrategy' => [ + 'title' => '扩容策略（RAW/PERCENTAGE）', + 'description' => '扩容策略（RAW/PERCENTAGE）', + 'type' => 'string', + 'example' => 'RAW', + ], + 'UpperScaleStep' => [ + 'title' => '扩容步长', + 'description' => '扩容步长', + 'type' => 'string', + 'example' => '5', + ], + ], + ], + 'EnableProxyService' => [ + 'description' => '是否 Enable 代理服务。'."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ProxyServiceStatus' => [ + 'title' => '代理服务状态', + 'description' => '代理服务状态。', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'ProxyClusterId' => [ + 'title' => '代理集群 ID', + 'description' => 'Proxy 集群 ID。'."\n" + .'> 仅 EnableProxyService 为 true 时，才会包含该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'proxy-56****a6tg2o', + ], + 'CpuArchitecture' => [ + 'title' => '集群的 CPU 架构', + 'description' => '集群的 CPU 架构。', + 'type' => 'string', + 'example' => 'X86', + 'enum' => [ + 'X86', + 'ARM', + ], + ], + 'ReadOnlyResource' => [ + 'title' => '集群的资源信息', + 'description' => '集群的资源信息', + 'type' => 'object', + 'properties' => [ + 'Cpu' => [ + 'title' => '集群的CPU资源信息', + 'description' => '集群的CPU资源信息', + 'type' => 'object', + 'properties' => [ + 'TotalCpu' => [ + 'title' => '集群总CPU，单位：核数', + 'description' => '集群总CPU，单位：核数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + 'UsedCpu' => [ + 'title' => '集群已使用的CPU，单位：核数', + 'description' => '集群已使用的CPU，单位：核数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'UnitCpu' => [ + 'title' => '集群中每个副本节点的CPU，单位：核数', + 'description' => '集群中每个副本节点的CPU，单位：核数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'OriginalTotalCpu' => [ + 'title' => '原始CPU', + 'description' => '原始CPU', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + ], + ], + 'Memory' => [ + 'title' => '集群的内存资源信息', + 'description' => '集群的内存资源信息', + 'type' => 'object', + 'properties' => [ + 'TotalMemory' => [ + 'title' => '集群总内存，单位：GB', + 'description' => '集群总内存，单位：GB', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '70', + ], + 'UsedMemory' => [ + 'title' => '集群已使用的内存，单位：GB', + 'description' => '集群已使用的内存，单位：GB', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'UnitMemory' => [ + 'title' => '集群中每个副本的内存，单位：GB', + 'description' => '集群中每个副本的内存，单位：GB', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'OriginalTotalMemory' => [ + 'title' => '原始内存', + 'description' => '原始内存', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '72', + ], + ], + ], + 'DiskSize' => [ + 'title' => '集群的存储资源信息', + 'description' => '集群的存储资源信息', + 'type' => 'object', + 'properties' => [ + 'TotalDiskSize' => [ + 'title' => '集群总存储空间，单位：GB', + 'description' => '集群总存储空间，单位：GB', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'UsedDiskSize' => [ + 'title' => '集群已使用的存储空间，单位：GB', + 'description' => '集群已使用的存储空间，单位：GB', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'UnitDiskSize' => [ + 'title' => '集群每个副本的存储空间，单位：GB', + 'description' => '集群每个副本的存储空间，单位：GB', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'DataUsedSize' => [ + 'description' => '已使用的存储空间，单位：GB。', + 'type' => 'number', + 'format' => 'double', + 'example' => '200', + ], + 'MaxDiskUsedPercent' => [ + 'description' => '磁盘使用率最大值（百分比）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.14', + ], + 'MaxDiskUsedObServer' => [ + 'description' => '磁盘服务器使用率最大值。', + 'type' => 'array', + 'items' => [ + 'description' => '磁盘服务器使用率最大值。', + 'type' => 'string', + 'example' => 'i-bp1fhj23fs32dfbg4****', + ], + ], + 'OriginalTotalDiskSize' => [ + 'title' => '原始磁盘', + 'description' => '原始磁盘。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'MaxDiskSize' => [ + 'title' => '最大可创建磁盘大小', + 'description' => '最大可创建磁盘大小。', + 'type' => 'number', + 'format' => 'double', + 'example' => '80000', + ], + ], + ], + 'UnitCount' => [ + 'title' => '集群的资源Unit数量。', + 'description' => '集群的资源 Unit 数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'LogDiskSize' => [ + 'title' => '集群的日志盘资源信息', + 'description' => '集群的日志盘资源信息。', + 'type' => 'object', + 'properties' => [ + 'TotalDiskSize' => [ + 'title' => '集群总日志盘空间，单位GB。', + 'description' => '集群总日志盘空间，单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '400', + ], + 'UnitDiskSize' => [ + 'title' => '集群每个副本的日志存储空间，单位：GB', + 'description' => '集群每个副本的日志存储空间，单位：GB', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'LogAssignedSize' => [ + 'description' => '已分配的日志存储空间.。', + 'type' => 'string', + 'example' => '0.0', + ], + 'MaxLogAssignedObServer' => [ + 'description' => '已分配的最大 OBServer。', + 'type' => 'array', + 'items' => [ + 'description' => '已分配的最大 OBServer。', + 'type' => 'string', + 'example' => '["i-bp1g****","i-bp11****","i-bp19****"]', + ], + ], + 'MaxLogAssignedPercent' => [ + 'description' => '已分配的最大日志百分比。', + 'type' => 'string', + 'example' => '6.68', + ], + ], + ], + 'CapacityUnit' => [ + 'description' => '容量单元。', + 'type' => 'object', + 'properties' => [ + 'MaxCapacityUnit' => [ + 'description' => '最大容量单元。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'MinCapacityUnit' => [ + 'description' => '最小容量单元。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'UsedCapacityUnit' => [ + 'description' => '已用容量单位。', + 'type' => 'string', + 'example' => '2', + ], + ], + ], + ], + ], + 'UnitSpec' => [ + 'title' => '代理服务的单元规格', + 'description' => '代理服务的单元规格', + 'type' => 'string', + 'example' => '2C4G', + ], + 'SharedUnitNumLimit' => [ + 'title' => '共享模式代理服务的单元数量上限', + 'description' => '共享模式代理服务的单元数量上限', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ExclusiveUnitNumLimit' => [ + 'title' => '独占模式代理服务的单元数量上限', + 'description' => '独占模式代理服务的单元数量上限', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EnableReadOnlyReplica' => [ + 'description' => '是否支持只读副本', + 'type' => 'boolean', + 'example' => 'true'."\n", + ], + 'EnableReadOnlyReplicaManagement' => [ + 'description' => '该集群是否允许购买只读副本。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'PrimaryInstance' => [ + 'title' => "\n" + .'主实例Id', + 'description' => "\n" + .'主实例Id', + 'type' => 'string', + 'example' => 'ob3h8ytroxxxxx', + ], + 'PrimaryRegion' => [ + 'title' => '主实例Region', + 'description' => '主实例Region', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'SpecType' => [ + 'title' => '规格类型', + 'description' => '规格类型', + 'type' => 'string', + 'example' => 'dedicatedspec', + ], + 'AllowModifyInternetAddressConnectionLimit' => [ + 'title' => '是否允许修改公网最大连接数', + 'description' => '是否允许修改公网最大连接数', + 'type' => 'boolean', + 'example' => 'false', + ], + 'AllowCreateProxySqlFirewallRule' => [ + 'title' => '是否允许使用 ODP SQL 防火墙', + 'description' => '是否允许使用 ODP SQL 防火墙', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Iops' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'InstanceType' => [ + 'title' => '实例类型', + 'description' => '实例类型', + 'type' => 'string', + ], + 'MigrationInfo' => [ + 'title' => '切换到云市场信息', + 'description' => '切换到云市场信息', + 'type' => 'object', + 'properties' => [ + 'Migratable' => [ + 'title' => '是否可切换', + 'description' => '是否可切换', + 'type' => 'boolean', + ], + 'CheckResult' => [ + 'title' => '如果不支持切换，此处有详细原因', + 'description' => '如果不支持切换，此处有详细原因', + 'type' => 'object', + 'properties' => [ + 'Level' => [ + 'title' => '结果等级', + 'description' => '结果等级', + 'type' => 'string', + ], + 'Code' => [ + 'title' => '检查项代码', + 'description' => '检查项代码', + 'type' => 'string', + ], + 'CodeName' => [ + 'title' => '检查项文案', + 'description' => '检查项文案', + 'type' => 'string', + ], + 'Module' => [ + 'title' => '模块名', + 'description' => '模块名', + 'type' => 'string', + ], + 'ModuleName' => [ + 'title' => '模块名文案', + 'description' => '模块名文案', + 'type' => 'string', + ], + 'SubModule' => [ + 'title' => '子模块名', + 'description' => '子模块名', + 'type' => 'string', + ], + 'SubModuleName' => [ + 'title' => '子模块文案', + 'description' => '子模块文案', + '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' => '查询集群信息', + ], + 'DescribeInstances' => [ + 'summary' => '查询 OceanBase 集群列表信息。', + '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' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组ID信息。如果不填写，返回全部资源。', + 'description' => '资源组 ID 信息。'."\n" + .'如果不填写，返回全部资源。', + 'type' => 'string', + 'required' => false, + 'example' => 'group1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'description' => '分页查询时设置的每页行数。'."\n" + .'- 最大值：100。 '."\n" + .'- 默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => '分页查询的页码。'."\n" + .'- 起始值：1。'."\n" + .'- 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群名称。 长度为1~20个英文或中文字符。如果没有指定该参数，默认值为集群的InstanceId。', + 'description' => 'OceanBase 集群名称。'."\n" + .'长度为 1~20 个英文或中文字符。'."\n" + .'如未指定该参数，默认值为集群的 InstanceId。', + 'type' => 'string', + 'required' => false, + 'example' => 'ob4prod', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询列表的删选关键字。', + 'description' => '根据实例 ID、实例名称、租户 ID 和租户名称进行模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'pay', + ], + ], + [ + 'name' => 'WithOBCloudInstances', + 'in' => 'formData', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Instances' => [ + 'title' => 'Oceanbase集群列表。', + 'description' => 'OceanBase 集群信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'OceanBase 集群信息。', + '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' => 'OceanBase 集群的产品码。'."\n" + .'- oceanbase_oceanbasepre_public_cn：中国站云数据库包年包月套餐。'."\n" + .'- oceanbase_oceanbasepost_public_cn：中国站云数据库按小时付费套餐。'."\n" + .'- oceanbase_obpre_public_intl：国际站云数据库包年包月套餐。'."\n" + .'- oceanbase_obpost_public_intl：国际站云数据库按小时付费套餐。', + 'type' => 'string', + 'example' => 'oceanbase_oceanbasepost_public_cn', + ], + 'ExpireTime' => [ + 'title' => '集群过期时间（UTC格式）。', + 'description' => '集群过期时间（UTC 格式）。'."\n" + .'> 该参数仅适用于包年包月付费方式的实例。', + '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' => '集群状态。 '."\n" + .'- ONLINE("online") : 运行中。'."\n" + .'- PENDING_CREATE("pending_create"): 创建中。'."\n" + .'- ARREARS_CLOSED("arrears_closed")：后付费逾期欠费关闭。'."\n" + .'- PREPAID_EXPIRE_CLOSED("prepaid_expire_closed")：预付费到期关闭。'."\n" + .'- WHITE_LIST_MODIFYING("white_list_modifying")：白名单修改中。'."\n" + .'- SSL_MODIFYING("ssl_modifying")：ssl 配置变更中。'."\n" + .'- PARAMETER_MODIFYING("parameter_modifying")：参数修改中。'."\n" + .'- TENANT_CREATING("tenant_creating")：租户创建中。'."\n" + .'- TENANT_SPEC_MODIFYING("tenant_spec_modifying")：租户规格修改中。'."\n" + .'- EXPANDING("expanding")：节点扩容中。'."\n" + .'- REDUCING("reducing")：节点缩容中。'."\n" + .'- ZONE_CHANGING("zone_changing")：可用区变更中。'."\n" + .'- SPEC_UPGRADING("spec_upgrading")：套餐规格扩容中。'."\n" + .'- SPEC_DOWNGRADING("spec_downgrading")：套餐规格缩容中。'."\n" + .'- DISK_UPGRADING("disk_upgrading")：存储规格扩容中。'."\n" + .'- UPGRADING("upgrading")：版本升级中。'."\n" + .'- PENDING_DELETE("pending_delete")：集群删除中。'."\n" + .'- DELETED("deleted")：集群已删除。'."\n" + .'- ABNORMAL("abnormal")：异常。'."\n" + .'- OFFLINE("offline")：下线。'."\n" + .'- STANDBY_CREATING("standby_creating")：备集群创建中。'."\n" + .'- STANDBY_DELETING("standby_deleting")：备集群删除中。'."\n" + .'- SWITCHOVER_SWITCHING("switchover_switching")：主备切换中。'."\n" + .'- STANDBY_DISCONNECTING("standby_disconnecting")：备库解耦中。'."\n" + .'- LOG_DISK_UPGRADING("log_disk_upgrading")：日志盘扩容中。'."\n" + .'- ISOLATION_OPTIMIZATION_MODIFYING("isolation_optimization_modifying")：隔离优化变更中。'."\n" + .'- DISKTYPE_MODIFYING("disktype_modifying")：数据盘类型变更中。'."\n" + .'- PROXY_SERVICE_CREATING("proxy_service_creating")：代理服务开通中。'."\n" + .'- PROXY_SERVICE_DELETING("proxy_service_deleting")：代理服务关闭中。'."\n" + .'- PROXY_SERVICE_SPEC_MODIFYING("proxy_service_spec_modifying")：代理服务规格修改中。'."\n" + .'- READONLY_ADD_NODE("readonly_add_node")：新增只读节点中。'."\n" + .'- READONLY_REDUCE_NODE("readonly_reduce_node")：删除只读节点中。'."\n" + .'- READONLY_REDUCE_ZONE("readonly_reduce_zone")：删除只读副本可用区中。'."\n" + .'- READONLY_ADD_ZONE("readonly_add_zone")：新增只读副本可用区。'."\n" + .'- READONLY_UPGRADE_SPEC("readonly_upgrade_spec")：只读副本规格升配中。'."\n" + .'- READONLY_UPGRADE_DISK("readonly_upgrade_disk")：只读副本存储扩容中。'."\n" + .'- READONLY_DOWNGRADE_SPEC("readonly_downgrade_spec")：只读副本规格降配中。'."\n" + .'- READONLY_DOWNGRADE_DISK("readonly_downgrade_disk")：只读副本磁盘缩容中。'."\n" + .'- CREATING_TENANT_READONLY_REPLICA("creating_tenant_readonly_replica")：租户创建只读副本中。'."\n" + .'- DELETING_TENANT_READONLY_REPLICA("deleting_tenant_readonly_replica")：租户删除只读副本中。'."\n" + .'- DISK_DOWNGRADING("disk_downgrading")：磁盘缩容中。'."\n" + .'- DEPLOY_MODE_MODIFYING("deploy_mode_modifying")：部署模式切换中。'."\n" + .'> 集群一般为运行中的状态（ONLINE）。', + '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' => '集群规格信息。<br> 当前支持以下套餐：'."\n" + .'- 4C16GB：4 核 16GB。'."\n" + .'- 8C32GB：8 核 32GB。'."\n" + .'- 14C70GB：14 核 70GB。'."\n" + .'- 24C120GB：24 核 120GB。'."\n" + .'- 30C180GB：30 核 180GB。'."\n" + .'- 62C400GB：62 核 400GB。'."\n" + .'- 104C600GB：104 核 600GB。'."\n" + .'- 16C70GB：16 核 70GB。'."\n" + .'- 32C160GB：32 核 160GB。'."\n" + .'- 64C380GB：64 核 380GB。'."\n" + .'- 20C32GB：20 核 32GB。 '."\n" + .'- 40C64GB：40 核 64GB。'."\n" + .'- 16C32GB：16 核 32GB。'."\n" + .'- 32C70GB：32 核 70GB。'."\n" + .'- 64C180GB：64 核 180GB。'."\n" + .'- 32C180GB：32 核 180GB。'."\n" + .'- 64C400GB：64 核 400GB。', + 'type' => 'string', + 'example' => '14C70G', + ], + 'CreateTime' => [ + 'title' => '集群的创建时间，UTC时间。', + 'description' => '集群的创建时间，UTC 时间。', + 'type' => 'string', + 'example' => '2021-10-19T07:13:41Z', + ], + 'DeployMode' => [ + 'title' => '集群的数据副本模式。 单机房为n，双机房为n-n，多机房为n-n-n，其中n为各机房的observer节点数。', + 'description' => '集群的数据副本模式。'."\n" + .'无论集群为单机房、双机房或多机房部署，返回值均为 n-n-n，其中 n 为各机房的 OBServer 节点数。', + 'type' => 'string', + 'example' => '1-1-1', + ], + 'CpuArchitecture' => [ + 'title' => '集群的 CPU 架构', + 'description' => '集群的 CPU 架构', + 'type' => 'string', + 'example' => 'X86_64、 AARCH64', + ], + 'MaintainTime' => [ + 'title' => '集群的每天例行维护时间，UTC时间。', + 'description' => '集群的每天例行维护时间，UTC 时间。', + 'type' => 'string', + 'example' => '19:00Z-20:00Z', + ], + 'DeployType' => [ + 'title' => '集群的部署类型。 - multiple：多机房 - single：单机房 - dual：双机房', + 'description' => '集群的部署类型。 '."\n" + .'- multiple：多机房； '."\n" + .'- single：单机房； '."\n" + .'- dual：双机房。', + 'type' => 'string', + 'example' => 'multiple', + ], + 'PayType' => [ + 'title' => 'Oceanbase集群的付费类型 - PREPAY：预付费 - POSTPAY：按量付费', + 'description' => 'OceanBase 集群的付费类型： '."\n" + .'- PREPAY：预付费； '."\n" + .'- POSTPAY：按量付费。', + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'DiskSize' => [ + 'description' => '存储空间大小，单位 GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'DiskType' => [ + 'title' => '集群部署的存储类型。默认为cloud_essd_pl1：ESSD云盘。', + 'description' => '集群部署的存储类型。', + 'type' => 'string', + 'example' => 'cloud_essd_pl1', + ], + 'InstanceId' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'ExpireSeconds' => [ + 'title' => '集群已过期时间，单位：秒(s)。', + 'description' => '集群已过期时间，单位：秒(s)。'."\n" + .'> 包年包月付费模式下，若集群还未到期，该参数表示集群剩余有效使用时间。集群过期后，该参数表示集群已过期时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2606682', + ], + 'Mem' => [ + 'title' => '实例的内存大小，单位GB。', + 'description' => '实例的内存大小，单位 GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '70', + ], + 'EnableUpgradeNodes' => [ + 'title' => '是否允许新增节点。', + 'description' => '是否允许新增节点。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Cpu' => [ + 'title' => '集群的CPU核数。', + 'description' => '集群的 CPU 核数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '14', + ], + 'AvailableZones' => [ + 'title' => '集群部署所在的可用区信息。', + 'description' => '集群部署所在的可用区信息。', + 'type' => 'array', + 'items' => [ + 'description' => '集群部署所在的可用区信息。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + ], + 'Version' => [ + 'title' => 'Observer版本信息。', + 'description' => 'OBServer 版本信息。', + 'type' => 'string', + 'example' => '2.2.77', + ], + 'InstanceName' => [ + 'title' => 'Oceanbase集群名称。', + 'description' => 'OceanBase 集群名称。'."\n" + .'长度为 1~20 个英文或中文字符。如果没有指定该参数，默认值为集群的 InstanceId。', + 'type' => 'string', + 'example' => 'ob4test', + ], + 'Series' => [ + 'title' => '实例的系列 - normal（默认）：标准集群版（云盘） - normal_ssd：标准集群版（本地盘） - history：历史库集群版, normal_kv: obkv集群, normal_hg: 信创集群。', + 'description' => 'Oceanbase 实例的系列。'."\n" + .'- normal（默认）：标准集群版（云盘）。'."\n" + .'- normal_ssd：标准集群版（本地盘）。'."\n" + .'- history：历史库集群版。'."\n" + .'- normal_kv：obkv 集群。'."\n" + .'- normal_hg：信创集群。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'UsedDiskSize' => [ + 'title' => '已使用的存储空间，单位GB。', + 'description' => '已使用的存储空间，单位 GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'ResourceGroupId' => [ + 'title' => '资源组ID信息。', + 'description' => '资源组 ID 信息。', + 'type' => 'string', + 'example' => 'group1', + ], + 'Resource' => [ + 'title' => '集群的资源信息', + 'description' => '集群的资源信息。', + 'type' => 'object', + 'properties' => [ + 'Cpu' => [ + 'title' => '集群的CPU资源信息', + 'description' => '集群的 CPU 资源信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCpu' => [ + 'description' => '集群总 CPU，单位：核数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '14', + ], + 'UsedCpu' => [ + 'description' => '集群已使用的 CPU，单位：核数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10', + ], + 'UnitCpu' => [ + 'description' => '集群中每个副本节点的 CPU，单位：核数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10', + ], + 'OriginalTotalCpu' => [ + 'description' => '原始 CPU。', + 'type' => 'number', + 'format' => 'double', + 'example' => '14', + ], + ], + ], + 'Memory' => [ + 'title' => '集群的内存资源信息', + 'description' => '集群的内存资源信息。', + 'type' => 'object', + 'properties' => [ + 'TotalMemory' => [ + 'description' => '集群总内存，单位：GB。', + 'type' => 'number', + 'format' => 'double', + 'example' => '70', + ], + 'UsedMemory' => [ + 'title' => '集群已使用的内存，单位：GB', + 'description' => '集群已使用的内存，单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'UnitMemory' => [ + 'title' => '集群中每个副本的内存，单位：GB', + 'description' => '集群中每个副本的内存，单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'OriginalTotalMemory' => [ + 'description' => '原始内存。', + 'type' => 'number', + 'format' => 'double', + 'example' => '72', + ], + ], + ], + 'DiskSize' => [ + 'title' => '集群的存储资源信息', + 'description' => '集群的存储资源信息。', + 'type' => 'object', + 'properties' => [ + 'TotalDiskSize' => [ + 'description' => '集群总存储空间，单位：GB。', + 'type' => 'number', + 'format' => 'double', + 'example' => '200', + ], + 'UsedDiskSize' => [ + 'title' => '集群已使用的存储空间，单位：GB', + 'description' => '集群已使用的存储空间，单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'UnitDiskSize' => [ + 'description' => '集群每个副本的存储空间，单位：GB。', + 'type' => 'number', + 'format' => 'double', + 'example' => '200', + ], + 'OriginalTotalDiskSize' => [ + 'description' => '原始磁盘。', + 'type' => 'number', + 'format' => 'double', + 'example' => '200', + ], + ], + ], + 'UnitCount' => [ + 'title' => '集群的资源Unit数量。', + 'description' => '集群的资源 Unit 数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'CapacityUnit' => [ + 'description' => '容量单元。', + 'type' => 'object', + 'properties' => [ + 'MaxCapacityUnit' => [ + 'description' => '最大容量单元。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'MinCapacityUnit' => [ + 'description' => '最小容量单元。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'UsedCapacityUnit' => [ + 'description' => '已用容量单位。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'InstanceType' => [ + 'description' => '实例类型。'."\n" + .'- cluster：集群实例。'."\n" + .'- mtenant：MySQL 模式的租户实例。'."\n" + .'- mtenant_serverless：MySQL 模式的 Serverless 实例。', + 'type' => 'string', + 'example' => 'CLUSTER', + ], + 'InstanceRole' => [ + 'description' => '实例角色。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'InTempCapacityStatus' => [ + 'description' => '临时容量状态。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'DataDiskAutoScaleConfig' => [ + 'title' => '数据盘自动协调配置', + 'description' => '数据盘自动协调配置。', + 'type' => 'object', + 'properties' => [ + 'AutoScale' => [ + 'title' => '是否开启', + 'description' => '是否开启。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Upperbound' => [ + 'description' => '扩容上限。', + 'type' => 'number', + 'format' => 'double', + 'example' => '16', + ], + 'UpperThreshold' => [ + 'description' => '日常扩容阈值。', + 'type' => 'number', + 'format' => 'double', + 'example' => '80', + ], + 'UpperMergeThreshold' => [ + 'description' => '合并扩容阈值。', + 'type' => 'number', + 'format' => 'double', + 'example' => '90', + ], + 'MaxDiskSize' => [ + 'title' => '磁盘最大值', + 'description' => '磁盘最大值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '80000', + ], + 'ScaleStepInNormal' => [ + 'description' => '日常扩容步长。', + 'type' => 'number', + 'format' => 'double', + 'example' => '50', + ], + 'ScaleStepInMerge' => [ + 'description' => '合并扩容步长。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'UpperScaleStrategy' => [ + 'title' => '扩容策略（RAW/PERCENTAGE）', + 'description' => '扩容策略（RAW/PERCENTAGE）', + 'type' => 'string', + 'example' => 'RAW', + ], + ], + ], + 'EnableReadOnlyReplicaManagement' => [ + 'description' => '该集群是否允许购买只读副本。', + 'type' => 'boolean', + 'example' => 'yes', + ], + 'SpecType' => [ + 'title' => '规格类型', + 'description' => '规格类型', + 'type' => 'string', + 'example' => 'dedicatedspec', + ], + 'ObRpmVersion' => [ + 'title' => '集群的RPM版本信息'."\n" + ."\n", + 'description' => '集群的RPM版本信息'."\n" + ."\n", + 'type' => 'string', + 'example' => '4.2.1.7-107030032024062709', + ], + 'ReplicaMode' => [ + 'title' => '集群的副本模式', + 'description' => '集群的副本模式', + 'type' => 'string', + 'example' => '3F、2F1A', + ], + 'Migratable' => [ + 'type' => 'boolean', + ], + 'MigrationInfo' => [ + 'title' => '切换到云市场信息', + 'description' => '切换到云市场信息', + 'type' => 'object', + 'properties' => [ + 'Migratable' => [ + 'title' => '是否可切换', + 'description' => '是否可切换', + 'type' => 'boolean', + ], + 'CheckResult' => [ + 'title' => '如果不支持切换，此处有详细原因', + 'description' => '如果不支持切换，此处有详细原因', + 'type' => 'object', + 'properties' => [ + 'Level' => [ + 'title' => '结果等级', + 'description' => '结果等级', + 'type' => 'string', + ], + 'Code' => [ + 'title' => '检查项代码', + 'description' => '检查项代码', + 'type' => 'string', + ], + 'CodeName' => [ + 'title' => '检查项文案', + 'description' => '检查项文案', + 'type' => 'string', + ], + 'Module' => [ + 'title' => '模块名', + 'description' => '模块名', + 'type' => 'string', + ], + 'ModuleName' => [ + 'title' => '模块名文案', + 'description' => '模块名文案', + 'type' => 'string', + ], + 'SubModule' => [ + 'title' => '子模块名', + 'description' => '子模块名', + 'type' => 'string', + ], + 'SubModuleName' => [ + 'title' => '子模块文案', + 'description' => '子模块文案', + 'type' => 'string', + ], + ], + ], + ], + ], + 'Iops' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + ], + ], + ], + 'TotalCount' => [ + 'title' => '查询到的Oceanbase集群个数。', + 'description' => '所查询的 OceanBase 集群个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-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' => '查询集群列表', + ], + 'DescribeInstanceTopology' => [ + 'summary' => '查询某个 OceanBase 集群的拓扑信息。', + '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' => 'Oceanbase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'InstanceTopology' => [ + 'title' => '集群的拓扑信息。', + 'description' => '集群的拓扑信息。', + 'type' => 'object', + 'properties' => [ + 'Tenants' => [ + 'title' => '租户信息。', + 'description' => '租户列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'example' => 't33h8y08k****', + ], + 'TenantName' => [ + 'title' => '租户名称。', + 'description' => '租户名称。', + 'type' => 'string', + 'example' => 'pay_online', + ], + 'TenantCpu' => [ + 'title' => '租户CPU，单位：核。', + 'description' => '租户 CPU，单位：核。', + 'type' => 'number', + 'format' => 'float', + 'example' => '2', + ], + 'TenantMemory' => [ + 'title' => '租户内存大小，单位：GB。', + 'description' => '租户内存大小，单位：GB。', + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'TenantMode' => [ + 'title' => '租户模式。 - Oracle：Oracle模式 - MySQL：MySQL模式。', + 'description' => '租户模式。 '."\n" + .'- Oracle：Oracle模式。 '."\n" + .'- MySQL：MySQL模式。', + 'type' => 'string', + 'example' => 'Oracle', + ], + 'TenantZones' => [ + 'title' => '租户的可用区信息。', + 'description' => '租户的可用区列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'TenantZoneRole' => [ + 'title' => '可用区的访问角色。 - ReadWrite：可读可写 - ReadOnly：只读。', + 'description' => '可用区的访问角色。 '."\n" + .' - ReadWrite：可读可写；'."\n" + .' - ReadOnly：只读。', + 'type' => 'string', + 'example' => 'ReadWrite', + ], + 'IsPrimaryTenantZone' => [ + 'description' => '是否为主可用区。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TenantZoneId' => [ + 'title' => '可用区ID。', + 'description' => '可用区 ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'Units' => [ + 'title' => '资源节点信息列表', + 'description' => '资源节点信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'UnitId' => [ + 'title' => '资源节点ID', + 'description' => '资源节点 ID。', + 'type' => 'string', + 'example' => '1002', + ], + 'UnitStatus' => [ + 'title' => '资源节点的状态。 ONLINE: 运行中 IMMIGRATING 迁入中 EMIGRATING: 迁出中 CANCEL_EMIGRATING: 取消迁入中 CANCEL_EMIGRATING：取消迁出中 DELETING：删除中', + 'description' => '资源节点的状态。'."\n" + .'- ONLINE: 运行中；'."\n" + .'- IMMIGRATING：迁入中；'."\n" + .'- EMIGRATING: 迁出中；'."\n" + .'- CANCEL_EMIGRATING: 取消迁入中；'."\n" + .'- CANCEL_EMIGRATING：取消迁出中；'."\n" + .'- DELETING：删除中。', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'NodeId' => [ + 'title' => '资源节点所在的observer节点ID', + 'description' => '资源节点所在的 OBServer 节点 ID。', + 'type' => 'string', + 'example' => 'i-bp16niirq4zdmgvm****', + ], + 'UnitCpu' => [ + 'title' => '资源节点CPU，单位：核。', + 'description' => '资源节点CPU，单位：核。', + 'type' => 'number', + 'format' => 'float', + 'example' => '2', + ], + 'UnitMemory' => [ + 'title' => '资源节点内存大小，单位：GB。', + 'description' => '资源节点内存大小，单位：GB。', + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'EnableMigrateUnit' => [ + 'title' => '是否可做迁移。', + 'description' => '是否可做迁移。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ManualMigrate' => [ + 'title' => '是否为手动迁移。', + 'description' => '是否为手动迁移。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableCancelMigrateUnit' => [ + 'title' => '是否可以取消迁移。该字段只对正在手动迁入中或手动迁出中的unit有效。', + 'description' => '是否可以取消迁移。 '."\n" + .'该字段只对正在手动迁入中或手动迁出中的 unit 有效。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'UnitDataSize' => [ + 'title' => 'Unit使用的数据量大小。', + 'description' => 'Unit使用的数据量大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'ReplicaType' => [ + 'description' => '副本类型。<br>'."\n" + .'OceanBase 集群监控根据副本类型设置节点过滤条件。'."\n" + .'- 默认不传, 可用于 OceanBase 监控或查询访问代理监控，查询 OceanBase 监控时，表示查询所有副本类型节点的监控数据。'."\n" + .'- FULL，仅对 OceanBase 监控生效，表示只查询全功能副本节点上的监控数据。 '."\n" + .'- READONLY，仅对 OceanBase 监控生效，表示只查询只读副本节点上的监控数据。', + 'type' => 'string', + 'example' => 'FULL', + ], + ], + ], + ], + 'LogicalZone' => [ + 'title' => '副本ID', + 'description' => '副本ID', + 'type' => 'string', + 'example' => 'cn-hangzhou-h-z0', + ], + 'ReplicaType' => [ + 'title' => '租户的副本类型', + 'description' => '租户的副本类型', + 'type' => 'string', + 'example' => 'FULL', + ], + 'ReadOnlyReplicaType' => [ + 'description' => '只读副本类型', + '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' => '租户状态。 '."\n" + .'- PENDING_CREATE: 创建中。 '."\n" + .'- RESTORE: 恢复中。 '."\n" + .'- ONLINE: 运行中。 '."\n" + .'- SPEC_MODIFYING: 规格修改中。 '."\n" + .'- ALLOCATING_INTERNET_ADDRESS: 公网地址分配中。 '."\n" + .'- PENDING_OFFLINE_INTERNET_ADDRESS: 公网地址关闭中。 '."\n" + .'- PRIMARY_ZONE_MODIFYING: 切主可用区中。 '."\n" + .'- PARAMETER_MODIFYING: 参数修改中。 '."\n" + .'- WHITE_LIST_MODIFING: 白名单修改中。 ', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'TenantDeployType' => [ + 'title' => '租户的部署类型。 - multiple：多机房 - single：单机房 - dual：双机房。', + 'description' => '租户的部署类型。'."\n" + .'- multiple：多机房。 '."\n" + .'- single：单机房。 '."\n" + .'- dual：双机房。', + 'type' => 'string', + 'example' => 'multiple', + ], + 'TenantUnitNum' => [ + 'title' => '租户的unit个数。', + 'description' => '租户的 unit 个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PrimaryZoneDeployType' => [ + 'title' => '主可用区部署模式', + 'description' => '主可用区部署模式。', + 'type' => 'string', + 'enumValueTitles' => [ + 'RANDOM' => 'RANDOM', + 'STATIC' => 'STATIC', + ], + 'example' => 'RANDOM', + ], + 'TenantDiskSize' => [ + 'title' => '租户数据量', + 'description' => '租户数据量', + 'type' => 'number', + 'format' => 'float', + 'example' => '2', + ], + 'TenantUnitCpu' => [ + 'title' => '租户单节点CPU', + 'description' => '租户单节点CPU', + 'type' => 'number', + 'format' => 'float', + 'example' => '4', + ], + 'TenantUnitMemory' => [ + 'title' => '租户单节点内存', + 'description' => '租户单节点内存', + 'type' => 'number', + 'format' => 'float', + 'example' => '16', + ], + ], + ], + ], + 'Zones' => [ + 'title' => '集群的可用区信息。', + 'description' => '集群的可用区信息。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'title' => '可用区ID。', + 'description' => '可用区 ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'Region' => [ + 'title' => '地域ID。', + 'description' => '地域 ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ZoneDisk' => [ + 'title' => '可用区的存储容量。', + 'description' => '可用区的存储容量。', + 'type' => 'string', + 'example' => '200 GB', + ], + 'Nodes' => [ + 'title' => '节点信息。', + 'description' => '节点列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'NodeId' => [ + 'title' => '节点ID。', + 'description' => '节点 ID。', + 'type' => 'string', + 'example' => 'i-bp16niirq4zdmgvm****', + ], + 'NodeCopyId' => [ + 'title' => '节点归属的副本ID。', + 'description' => '节点归属的副本 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'NodeStatus' => [ + 'title' => '节点运行状态。', + 'description' => '节点运行状态。', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'NodeResource' => [ + 'title' => '节点资源列表信息', + 'description' => '节点资源列表信息。', + 'type' => 'object', + 'properties' => [ + 'Cpu' => [ + 'title' => '节点CPU资源信息。', + 'description' => '节点CPU资源信息。', + 'type' => 'object', + 'properties' => [ + 'UsedCpu' => [ + 'title' => '节点已使用的CPU，单位：核。', + 'description' => '节点已使用的CPU，单位：核。', + 'type' => 'number', + 'format' => 'float', + 'example' => '4', + ], + 'TotalCpu' => [ + 'title' => '节点总的CPU，单位：核。', + 'description' => '节点总的CPU，单位：核。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '14', + ], + ], + ], + 'Memory' => [ + 'title' => '节点内存资源信息。', + 'description' => '节点内存资源信息。', + 'type' => 'object', + 'properties' => [ + 'UsedMemory' => [ + 'title' => '节点已使用的内存，单位：GB。', + 'description' => '节点已使用的内存，单位：GB。', + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'TotalMemory' => [ + 'title' => '节点的总内存，单位：GB。', + 'description' => '节点的总内存，单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '70', + ], + ], + ], + 'DiskSize' => [ + 'title' => '节点存储资源信息。', + 'description' => '节点存储资源信息。', + 'type' => 'object', + 'properties' => [ + 'TotalDiskSize' => [ + 'title' => '节点总存储空间，单位：GB。', + 'description' => '节点总存储空间，单位：GB。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'UsedDiskSize' => [ + 'title' => '节点已使用的存储空间，单位：GB。', + 'description' => '节点已使用的存储空间，单位：GB。', + 'type' => 'number', + 'format' => 'double', + 'example' => '50', + ], + ], + ], + ], + ], + 'ReplicaType' => [ + 'description' => '副本类型。支持的副本类型：'."\n" + .'- FULL'."\n" + .'- READONLY', + 'type' => 'string', + 'example' => 'FULL', + ], + 'FullCopyId' => [ + 'description' => '全功能副本 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ReadOnlyCopyId' => [ + 'description' => '只读副本 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'LogicalZone' => [ + 'title' => '副本ID', + 'description' => '副本ID', + 'type' => 'string', + 'example' => 'cn-hangzhou-h-z0', + ], + 'ReadOnlyReplicaType' => [ + 'description' => '只读副本类型', + 'type' => 'string', + 'example' => 'ROW_STORE', + ], + ], + ], + ], + 'ZoneResource' => [ + 'title' => 'zone资源信息', + 'description' => '可用区信息。', + 'type' => 'object', + 'properties' => [ + 'DiskSize' => [ + 'title' => '存储资源信息', + 'description' => '节点存储资源信息。', + 'type' => 'object', + 'properties' => [ + 'MaxDiskUsedPercent' => [ + 'title' => '最大磁盘使用量百分比', + 'description' => '磁盘使用率最大值（百分比）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.14', + ], + 'MaxDiskUsedObServer' => [ + 'description' => '磁盘服务器使用率最大值。', + 'type' => 'array', + 'items' => [ + 'description' => '磁盘服务器使用率最大值。', + 'type' => 'string', + 'example' => 'i-bp1fhj23fs32dfbg4****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Replicas' => [ + 'description' => '副本信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LogicalZone' => [ + 'title' => '副本ID', + 'description' => '副本ID', + 'type' => 'string', + 'example' => 'cn-hangzhou-h-z0', + ], + 'NodeNum' => [ + 'title' => '副本节点数', + 'description' => '副本节点数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ZoneLogicalName' => [ + 'title' => '副本地域', + 'description' => '副本地域', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'ZoneRegionName' => [ + 'title' => '副本可用区', + 'description' => '副本可用区', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'ReplicaResource' => [ + 'description' => '副本资源信息', + 'type' => 'object', + 'properties' => [ + 'Memory' => [ + 'description' => '副本内存资源', + 'type' => 'object', + 'properties' => [ + 'UsedMemory' => [ + 'title' => '副本已使用内存', + 'description' => '副本已使用内存', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16', + ], + 'TotalMemory' => [ + 'title' => '副本总内存', + 'description' => '副本总内存', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + ], + ], + 'DiskSize' => [ + 'description' => '副本数据盘资源', + 'type' => 'object', + 'properties' => [ + 'UsedDiskSize' => [ + 'title' => '副本已使用数据量', + 'description' => '副本已使用数据量', + 'type' => 'number', + 'format' => 'float', + 'example' => '50', + ], + 'TotalDiskSize' => [ + 'title' => '副本总数据量', + 'description' => '副本总数据量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + 'Cpu' => [ + 'description' => '副本CPU资源', + 'type' => 'object', + 'properties' => [ + 'TotalCpu' => [ + 'title' => '副本总CPU', + 'description' => '副本总CPU', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'UsedCpu' => [ + 'title' => '副本已使用CPU', + 'description' => '副本已使用CPU', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + ], + ], + ], + ], + 'ZoneLogicalId' => [ + 'title' => '副本编号', + 'description' => '副本编号', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1'."\n", + ], + 'ReplicaType' => [ + 'title' => '副本类型', + 'description' => '副本类型', + 'type' => 'string', + 'example' => 'FULL', + ], + 'Status' => [ + 'title' => '副本状态，返回枚举类型（ACTIVE/INACTIVE/UNKNOWN）', + 'description' => '副本状态，返回枚举类型（ACTIVE/INACTIVE/UNKNOWN）', + 'type' => 'string', + 'example' => 'ACTIVE', + 'enum' => [ + 'ACTIVE', + 'INACTIVE', + 'UNKNOWN', + ], + ], + 'ReadOnlyReplicaType' => [ + 'description' => '只读副本类型', + 'type' => 'string', + 'example' => 'ROW_STORE', + 'enum' => [ + 'ROW_STORE', + 'COLUMN_STORE', + 'NOT_READONLY_REPLICA', + ], + ], + 'OnlineNodeNum' => [ + 'title' => '在线节点数', + 'description' => '在线节点数', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询集群拓扑信息', + ], + 'DescribeAvailableSpec' => [ + 'summary' => '查询 OceanBase 集群变配页可选配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群ID', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'UpgradeType', + 'in' => 'formData', + 'schema' => [ + 'title' => '变配类型', + 'description' => '变配类型。', + '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' => '节点规格。', + 'type' => 'string', + 'required' => false, + 'example' => 'oceanbase.cluster.cd8.xlarge', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AvailableSpecifications' => [ + 'title' => '返回数据', + 'description' => '集群可选配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '集群可选配置信息列表。', + 'type' => 'object', + 'properties' => [ + 'Spec' => [ + 'description' => '传输实例的规格。', + 'type' => 'string', + 'example' => 'oceanbase.cluster.cd8.xlarge', + ], + 'InstanceClass' => [ + 'description' => '集群规格信息。', + 'type' => 'string', + 'example' => '4C16GB', + ], + 'NodeNum' => [ + 'title' => '节点个数', + 'description' => '节点个数。', + 'type' => 'array', + 'items' => [ + 'title' => '节点个数', + 'description' => '节点个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + 'DiskSizeRange' => [ + 'description' => '存储大小。', + 'type' => 'object', + 'properties' => [ + 'Step' => [ + 'title' => '最小调整粒度', + 'description' => '最小调整粒度。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Max' => [ + 'title' => '最大值', + 'description' => '最大值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40000', + ], + 'Min' => [ + 'title' => '最小值', + 'description' => '最小值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + ], + 'LogDiskSizeRange' => [ + 'description' => '日志盘大小。', + 'type' => 'object', + 'properties' => [ + 'Step' => [ + 'title' => '最小调整粒度', + 'description' => '最小调整粒度。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Max' => [ + 'title' => '最大值', + 'description' => '最大值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4000', + ], + 'Min' => [ + 'title' => '最小值', + 'description' => '最小值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + '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' => '查询集群变配可选配置', + ], + 'DescribeAvailableZone' => [ + 'summary' => '查询 OceanBase 集群售卖页可选配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceType', + 'in' => 'formData', + 'schema' => [ + 'title' => '实例类型', + 'description' => '实例类型。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'cluster' => 'cluster', + ], + 'example' => 'cluster', + ], + ], + [ + 'name' => 'Series', + 'in' => 'formData', + 'schema' => [ + 'title' => '系列', + 'description' => '系列。', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'DeployType', + 'in' => 'formData', + 'schema' => [ + 'title' => '部署方案', + 'description' => '部署方案。', + 'type' => 'string', + 'required' => false, + 'example' => 'multiple', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点规划', + 'description' => '节点规划。', + 'type' => 'string', + 'required' => false, + 'example' => 'oceanbase.cluster.cd8.xlarge', + ], + ], + [ + 'name' => 'ObVersion', + 'in' => 'formData', + 'schema' => [ + 'title' => '版本', + 'description' => 'OceanBase 版本号。', + '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' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AvailableZones' => [ + 'title' => '返回数据', + 'description' => '可用区信息。', + 'type' => 'array', + 'items' => [ + 'description' => '可用区列表信息。', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'title' => '地域', + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Zones' => [ + 'title' => '可用区列表', + 'description' => '可用区列表。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j', + ], + 'Channel' => [ + 'description' => '订单来源。'."\n" + ."\n" + .'- PUBLIC'."\n" + ."\n" + .'- FINANCE', + 'type' => 'string', + 'example' => 'PUBLIC', + ], + 'DeployType' => [ + 'title' => '部署方案', + 'description' => '部署方案。', + 'type' => 'string', + 'example' => 'multiple', + ], + 'InstanceType' => [ + 'title' => '实例类型', + 'description' => '实例类型。', + 'type' => 'string', + 'example' => 'cluster', + ], + 'Series' => [ + 'title' => '系列', + 'description' => '系列。', + 'type' => 'string', + 'example' => 'normal', + ], + 'SupportSpecifications' => [ + 'title' => '节点规格', + 'description' => '节点规格。', + 'type' => 'array', + 'items' => [ + 'description' => '节点规格列表信息。', + 'type' => 'object', + 'properties' => [ + 'Spec' => [ + 'description' => '节点规格。', + 'type' => 'string', + 'example' => 'oceanbase.cluster.cd8.xlarge', + ], + 'InstanceClass' => [ + 'description' => '集群规格信息。', + 'type' => 'string', + 'example' => '4C16GB', + ], + 'DiskTypes' => [ + 'title' => '存储类型', + 'description' => '存储类型。', + 'type' => 'array', + 'items' => [ + 'description' => '存储类型列表信息。', + 'type' => 'string', + 'example' => 'cloud_essd_pl1', + ], + ], + 'DiskSizeRange' => [ + 'title' => '存储大小', + 'description' => '存储大小。', + 'type' => 'object', + 'properties' => [ + 'Step' => [ + 'title' => '最小调整粒度', + 'description' => '最小调整粒度。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Max' => [ + 'title' => '最大值', + 'description' => '最大值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40000', + ], + 'Min' => [ + 'title' => '最小值', + 'description' => '最小值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + ], + 'SupportEngineVersions' => [ + 'title' => '版本', + 'description' => '版本。', + 'type' => 'array', + 'items' => [ + 'description' => '版本列表信息。', + 'type' => 'object', + 'properties' => [ + 'ObVersion' => [ + 'description' => 'OceanBase Server 版本号。', + 'type' => 'string', + 'example' => '3.2.4.4', + ], + 'SupportIsolationOptimization' => [ + 'title' => '是否支持隔离', + 'description' => '是否支持隔离。', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'false', + ], + 'SupportReplicaModes' => [ + 'title' => '全功能型副本数', + 'description' => '全功能型副本数。', + 'type' => 'array', + 'items' => [ + 'title' => '全功能型副本数', + 'description' => '全功能型副本数。', + 'type' => 'string', + 'example' => '3F', + ], + ], + ], + ], + ], + ], + ], + ], + 'CpuArch' => [ + 'title' => 'cpu架构', + 'description' => 'cpu架构', + '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' => '查询创建集群可选配置', + ], + 'DescribeInstanceCreatableZone' => [ + 'summary' => '查询集群可创建主可用区的可用区信息。', + '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' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'ZoneList' => [ + 'title' => '可用区列表信息。', + 'description' => '可用区列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'IsInCluster' => [ + 'title' => '是否是集群部署的可用区。', + 'description' => '是否是集群部署的可用区。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Zone' => [ + 'title' => '可用区ID。', + 'description' => '物理可用区名称。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'FullCopyId' => [ + 'title' => '副本序号', + 'description' => '副本序号。', + 'type' => 'string', + 'example' => '1', + ], + 'LogicalZoneName' => [ + 'title' => '逻辑副本', + 'description' => '逻辑可用区名称。', + 'type' => 'string', + 'example' => 'cn-shanghai-g-z0,cn-shanghai-g-z1, cn-shanghai-g-z2', + ], + 'ReplicateZoneIndex' => [ + 'title' => '副本可用区序号', + 'description' => '副本可用区索引。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + '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' => '查询可用区信息', + ], + 'ModifyInstanceName' => [ + 'summary' => '修改 OceanBase 的集群名称。', + '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' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群名称。 长度为1~20个英文或中文字符。如果没有指定该参数，默认值为集群的InstanceId。', + 'description' => 'OceanBase 集群名称。 '."\n" + .'长度必须为 1 到 20 个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob4prod', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + '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' => '修改集群名称', + ], + 'ModifyInstanceSpec' => [ + 'summary' => '修改集群规格和存储空间。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群的ID。', + 'description' => 'OceanBase 集群的 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + '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' => '集群规格信息。<br> 当前支持以下套餐：'."\n" + .'- 4C16GB：4 核 16GB。'."\n" + .'- 8C32GB：8 核 32GB。'."\n" + .'- 14C70GB：14 核 70GB。'."\n" + .'- 24C120GB：24 核 120GB。'."\n" + .'- 30C180GB：30 核 180GB。'."\n" + .'- 62C400GB：62 核 400GB。'."\n" + .'- 104C600GB：104 核 600GB。'."\n" + .'- 16C70GB：16 核 70GB。'."\n" + .'- 32C160GB：32 核 160GB。'."\n" + .'- 64C380GB：64 核 380GB。'."\n" + .'- 20C32GB：20 核 32GB。 '."\n" + .'- 40C64GB：40 核 64GB。'."\n" + .'- 16C32GB：16 核 32GB。'."\n" + .'- 32C70GB：32 核 70GB。'."\n" + .'- 64C180GB：64 核 180GB。'."\n" + .'- 32C180GB：32 核 180GB。'."\n" + .'- 64C400GB：64 核 400GB。', + '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' => '存储空间大小，单位 GB。 存储空间的限制根据集群规格不同而不同，具体如下： '."\n" + .'- 8C32G：100GB~10TB。'."\n" + .'- 14C70G：200GB~10TB。'."\n" + .'- 30C180G：400GB~10TB。'."\n" + .'- 62C400G：800GB-10TB。 '."\n" + .'各套餐的存储空间默认值为其最小值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否只预检此次请求, 默认为false。取值范围：'."\n" + .'true：发送检查请求，不会更改实例配置。如果检查通过，则返回DryRunResult=true, 如果检查不通过, 则返回相应错误的错误码。'."\n" + .'false（默认）：发送正常请求，通过检查后直接更改实例配置。', + 'description' => '是否只预检此次请求, 默认为 false。取值范围：'."\n" + .'- true：发送检查请求，不会更改实例配置。如果检查通过，则返回 DryRunResult=true，如果检查不通过，则返回相应错误的错误码。'."\n" + .'- false（默认）：如果 DryRun 填写为 false, 则表示不进行预检查, DryRunResult 默认返回 false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'DiskType', + 'in' => 'formData', + 'schema' => [ + 'title' => '存储类型', + 'description' => '存储类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd_pl1', + ], + ], + [ + 'name' => 'UpgradeSpecNative', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否原地变配', + 'description' => '是否原地变配', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'title' => '请求返回的数据。', + 'description' => '请求返回的数据。', + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'title' => '订单ID。', + 'description' => '订单 ID。', + 'type' => 'string', + 'example' => '21329031xxxxxxx', + ], + 'DryRunResult' => [ + 'title' => '预检查请求的结果. 如果DryRun填写为true, 当预检查请求通过, 则DryRunResult返回true, 否则返回相应的错误码信息.', + 'description' => '预检查请求的结果。'."\n" + .'- 如果 DryRun 填写为 true，当预检查请求通过，则 DryRunResult 返回 true，否则返回相应的错误码信息。'."\n" + .'- 如果 DryRun 填写为 false, 则表示不进行预检查, DryRunResult 默认返回 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' => '修改集群规格和存储空间', + ], + 'ModifyInstanceNodeNum' => [ + 'summary' => '修改集群节点个数。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群的ID', + 'description' => 'OceanBase 集群的 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'NodeNum', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群节点个数信息。 如果部署模式为n-n-n，则节点个数为n * 3', + 'description' => '集群节点个数信息。 '."\n" + .'如果部署模式为 n-n-n，则节点个数为 n * 3。', + 'type' => 'string', + 'required' => true, + 'example' => '6', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否只预检此次请求, 默认为false。取值范围：'."\n" + .'true：发送检查请求，不会更改实例节点数。如果检查通过，则返回DryRunResult=true, 如果检查不通过, 则返回相应错误的错误码。'."\n" + .'false（默认）：发送正常请求，通过检查后直接更改实例节点数。', + 'description' => '是否只预检此次请求, 默认为 false。取值范围：'."\n" + .'- true：发送检查请求，不会更改实例节点数。如果检查通过，则返回 DryRunResult=true， 如果检查不通过，则返回相应错误的错误码。'."\n" + .'- false（默认）：发送正常请求，通过检查后直接更改实例节点数。如为 false, 则表示不进行预检查, DryRunResult 默认返回 false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Data' => [ + 'title' => '请求返回的信息。', + 'description' => '请求返回的信息。', + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'title' => '订单号。', + 'description' => '订单号。', + 'type' => 'string', + 'example' => '21329031xxxxxxxx', + ], + 'DryRunResult' => [ + 'title' => '预检查请求的结果. 如果DryRun填写为true, 当预检查请求通过, 则DryRunResult返回true, 否则返回相应的错误码信息.', + 'description' => '预检查请求的结果。'."\n" + .'- 如果 DryRun 填写为 true，当预检查请求通过，则 DryRunResult 返回 true，否则返回相应的错误码信息。'."\n" + .'- 如果 DryRun 填写为 false, 则表示不进行预检查, DryRunResult 默认返回 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' => '修改集群节点个数', + ], + 'ModifyInstanceTemporaryCapacity' => [ + 'summary' => '修改 OceanBase 集群临时容量。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'title' => '规格', + 'description' => '规格。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oceanbase.cluster.i2.small', + ], + ], + [ + 'name' => 'DiskSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '磁盘大小，单位G', + 'description' => '磁盘大小，单位：GB。', + 'type' => 'string', + 'required' => false, + 'example' => '400', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => [ + 'description' => '支持的语言。取值：'."\n" + .'- 中文：zh-CN'."\n" + .'- 英文：en-US', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => '修改集群临时容量', + ], + 'SwitchoverInstance' => [ + 'summary' => '切换 OceanBase 主备实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '主备实例统一服务名', + 'description' => '主备实例 ID，默认可以使用需要切换为主实例的实例 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TargetInstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '需要切换为主集群实例的实例ID', + 'description' => '需要切换为主实例的实例 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob4bv8o7sp****', + ], + ], + [ + 'name' => 'Forced', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否强制切换主备实例。取值范围：'."\n" + ."\n" + .'- **true**：表示强制切换主备实例。'."\n" + ."\n" + .'- **false**：表示不强制切换主备实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '473469**-AA6F-4D**-B3DB-A***********', + ], + 'Data' => [ + 'description' => '切换主备实例数据列表。', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '切换主备实例信息。', + 'type' => 'string', + 'example' => 'delete tag-value success', + ], + 'Success' => [ + 'description' => '是否修改成功。 '."\n" + .'- true：修改成功。'."\n" + .'- false：修改失败。', + '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' => '切换主备实例', + ], + 'RemoveStandbyInstance' => [ + 'summary' => '备实例解耦', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '主实例 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob608fgj1q****', + ], + ], + [ + 'name' => 'TargetInstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '待解耦的备实例 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob4bv8o7sp****', + ], + ], + [ + 'name' => 'Forced', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否强制解耦。', + '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' => '解耦备实例', + ], + 'DeleteInstances' => [ + 'summary' => '调用接口释放 OceanBase 实例。', + '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' => '需删除的集群 ID。 '."\n" + .'格式为 JSON 数组的字符串。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["ob317v4uif****","ob627v4uif****"]', + ], + ], + [ + 'name' => 'BackupRetainMode', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群删除后的备份保留策略。取值如下： - receive_all：保留全部备份集; - delete_all：删除全部备份集； - receive_last：保留最后一个备份集。 默认值为delete_all。', + 'description' => '集群删除后的备份保留策略。取值如下： '."\n" + .'- receive_all：保留全部备份集; '."\n" + .'- delete_all：删除全部备份集；'."\n" + .'- receive_last：保留最后一个备份集。'."\n" + ."\n" + .'> <br>默认值为 delete_all。', + 'type' => 'string', + 'required' => false, + 'example' => 'delete_all', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否只预检此次请求, 默认为false。取值范围：'."\n" + .'true：发送检查请求，不会删除实例。如果检查通过，则返回DryRunResult=true, 如果检查不通过, 则返回相应错误的错误码。'."\n" + .'false（默认）：发送正常请求，通过检查后直接删除实例。', + 'description' => '是否只预检此次请求, 默认为 false。取值范围：'."\n" + .'- true：发送检查请求，不会删除实例。如果检查通过，则返回DryRunResult=true, 如果检查不通过, 则返回相应错误的错误码。'."\n" + .'- false（默认）：发送正常请求，通过检查后直接删除实例。如果 DryRun 填写为 false, 则表示不进行预检查, DryRunResult 默认返回 false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'DryRunResult' => [ + 'title' => '预检查请求的结果. 如果DryRun填写为true, 当预检查请求通过, 则DryRunResult返回true, 否则返回相应的错误码信息.', + 'description' => '预检查请求的结果。'."\n" + .'- 如果 DryRun 填写为 true，当预检查请求通过，则 DryRunResult 返回 true，否则返回相应的错误码信息。'."\n" + .'- 如果 DryRun 填写为 false, 则表示不进行预检查, DryRunResult 默认返回 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' => '释放 OceanBase 实例', + 'description' => '调用该接口时，实例必须满足以下条件，否则将操作失败：'."\n" + .'- 实例状态为运行中；'."\n" + .'- 实例类型为主实例（按量付费类型）。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeInstanceSummary' => [ + 'summary' => '获取 OceanBase 实例概览信息。', + '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' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => '分页查询的页码。 起始值：1 默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'InstanceSummary' => [ + 'description' => '实例概览信息。', + 'type' => 'object', + 'properties' => [ + 'TotalInstancesCount' => [ + 'description' => '实例总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'OverLoadInstancesCount' => [ + 'description' => '超载实例数量（个）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ImmediatelyExpiredInstancesCount' => [ + 'description' => '过期待释放实例总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RunningInstancesCount' => [ + 'description' => '运行中的实例数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'InsufficientDiskInstancesCount' => [ + 'description' => '具有容量风险的集群总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ExpiredInstancesCount' => [ + 'description' => '已过期的实例数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AlarmSummaryCount' => [ + 'description' => '在查询时间范围内每条记录的条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AnomalySQLCount' => [ + 'description' => 'anomalysql总数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ClusterInstancesCount' => [ + 'title' => '集群实例数量', + 'description' => '集群实例数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TenantInstancesCount' => [ + 'title' => '租户实例数量', + 'description' => '租户实例数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalOmsInstancesCount' => [ + 'description' => '数据传输实例数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RegionalInstanceSummaryList' => [ + 'description' => '地域实例概要列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '地域 ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'TotalInstancesCount' => [ + 'description' => '实例总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'ImmediatelyExpiredInstancesCount' => [ + 'description' => '即将过期实例数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RunningInstancesCount' => [ + 'description' => '运行中实例总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExpiredInstancesCount' => [ + 'description' => '已过期实例数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RecentCreatedInstancesCount' => [ + 'description' => '近期创建实例数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取实例概览信息', + ], + 'DescribeStandbyCreateMode' => [ + 'summary' => '获取 OceanBase 创建备集群模式', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID', + 'type' => 'string', + 'required' => true, + 'example' => 'ob4wibn0abo9uo', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID', + 'description' => '租户ID', + 'type' => 'string', + 'required' => true, + 'example' => 'txxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'CreateMode' => [ + 'title' => '创建模式', + 'description' => '创建模式', + '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' => '获取创建备集群模式', + ], + 'DescribeTenantReadableScn' => [ + 'summary' => '该接口用于查询租户的最大可读位点。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户id', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 't33h8y08k****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '8442BB1E-3171-1192-B9DC-F6F4E53B2673', + ], + 'Data' => [ + 'description' => '请求返回的相关信息。', + 'type' => 'object', + 'properties' => [ + 'ReadableScn' => [ + 'description' => '最大可读位点。', + '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' => '查询租户的最大可读位点', + ], + 'CreateTenant' => [ + 'summary' => '创建一个租户。', + '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' => '租户名称。<br>'."\n" + .'长度为 2~20 个字符，支持英文字母、数字和下划线，区分大小写，必须以字母或下划线开头。 不可设置为 sys。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pay_online', + ], + ], + [ + 'name' => 'Cpu', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户的CPU大小，单位：核数（Cores）', + 'description' => '租户的 CPU 大小，单位：核数（Cores）。 '."\n" + ."\n" + .'> <br>单个租户的 CPU 不能超过所属集群的规格。<br>例如：集群为 14C70GB，则 CPU 不超过 14C。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'Memory', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户内存大小，单位GB。', + 'description' => '租户内存大小，单位 GB。 '."\n" + ."\n" + .'> <br>单个租户的内存不能超过所属集群的规格。<br>例如：集群为 14C70GB，则内存不超过 70GB。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'TimeZone', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户所在时区。 详细参见：DescribeTimeZones。', + 'description' => '租户所在时区。 详情参见 [DescribeTimeZones](~~410361~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Asia/Shanghai', + ], + ], + [ + 'name' => 'TenantMode', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户模式。 当前支持Oracle模式（Oracle）、MySQL模式（MySQL） 详细参见：DescribeInstanceTenantModes。', + 'description' => '租户模式。'."\n" + .'当前支持 Oracle 模式（Oracle）、MySQL 模式（MySQL）。 '."\n" + .'详情参见 [DescribeInstanceTenantModes](~~410354~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Oracle', + ], + ], + [ + 'name' => 'Charset', + 'in' => 'formData', + 'schema' => [ + 'title' => '字符集。 详细参见：DescribeCharset。', + 'description' => '字符集。'."\n" + .'详情参见：DescribeCharset。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'utf8mb4', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'UserVpcId', + 'in' => 'formData', + 'schema' => [ + 'title' => '专有网络（VPC） ID。 如果没有合适的 VPC，请根据页面提示创建一个 VPC，详情参见 什么是专有网络', + 'description' => '专有网络（VPC） ID。 '."\n" + .' 如无合适的 VPC，请根据页面提示创建一个 VPC。 '."\n" + .'详情参见什么是专有网络。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-bp1d2q3mhg9i23ofi****', + ], + ], + [ + 'name' => 'UserVSwitchId', + 'in' => 'formData', + 'schema' => [ + 'title' => '虚拟交换机（VSwitch） ID。 如果没有合适的 VSwitch，请根据页面提示创建一个，详情参见 使用交换机。', + 'description' => '虚拟交换机（VSwitch）ID。 '."\n" + .'如无合适的 VSwitch，请根据页面提示创建一个。 '."\n" + .'详情参见使用交换机。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vsw-bp11k1aypnzu1l3whi****', + ], + ], + [ + 'name' => 'PrimaryZone', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户的主可用区。 其为集群部署可用区中的一个。', + 'description' => '租户的主可用区。'."\n" + .'其为集群部署可用区中的一个。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户描述信息。', + 'description' => '数据库描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a test database', + ], + ], + [ + 'name' => 'UnitNum', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户的资源分布节点数。 其与集群的部署模式相耦合，如集群模式为2-2-2，则最后分布节点数最多为2个。', + 'description' => '租户的资源分布节点数。'."\n" + .'其与集群的部署模式相耦合，如集群模式为 2-2-2，则最后分布节点数最多为 2 个。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'default' => '1', + ], + ], + [ + 'name' => 'ReadOnlyZoneList', + 'in' => 'formData', + 'schema' => [ + 'title' => 'ReadOnlyZoneList 即将下线，请勿使用，引导用户使用 ModifyTenantReadonlyReplica', + 'description' => '创建只读副本的可用区，当传入多个可用区的时候，以逗号分隔。'."\n" + .'><notice>此参数暂时不可用。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-g-ro,cn-shanghai-h-ro', + ], + ], + [ + 'name' => 'LogDisk', + 'in' => 'formData', + 'schema' => [ + 'title' => '日志盘大小', + 'description' => '租户的已分配日志盘大小，单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '128', + ], + ], + [ + 'name' => 'CreateParams', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '创建租户时，初始化参数', + 'description' => '创建租户时，初始化参数', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'title' => '', + 'description' => '创建租户时，初始化参数', + 'type' => 'string', + 'example' => '{\\"LOWER_CASE_TABLE_NAMES\\":\\"1\\"}', + ], + ], + ], + [ + 'name' => 'UserVpcOwnerId', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户vpc的ownerId', + 'description' => '用户vpc的ownerId', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'example' => 't33h8y08k****', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 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' => '[{"errorExample":"","example":"{\\n \\"TenantId\\": \\"t33h8y08k****\\",\\n \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => '创建租户', + ], + 'CreateTenantReadOnlyConnection' => [ + 'summary' => '为指定租户创建一个只读地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'Oceanbase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'formData', + 'schema' => [ + 'title' => '可用区的ZoneId。 详细参见DescribeInstance中的AvailableZones。', + 'description' => '可用区的 ZoneId。'."\n" + .'详细参见 DescribeInstance 中的 AvailableZones。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou-i', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => [ + 'title' => '专有网络（VPC） ID。', + 'description' => '专有网络（VPC） ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'vpc-bp1d2q3mhg9i23ofi****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'formData', + 'schema' => [ + 'title' => '虚拟交换机（VSwitch）ID。', + 'description' => '虚拟交换机（VSwitch）ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vsw-bp11k1aypnzu1l3whi****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 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 \\"RequestId\\": \\"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateTenantReadOnlyConnectionResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</CreateTenantReadOnlyConnectionResponse>","errorExample":""}]', + 'title' => '创建只读地址', + ], + 'CreateTenantSecurityIpGroup' => [ + 'summary' => '创建租户安全白名单信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'SecurityIpGroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP安全白名单组的组名。 由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', + 'description' => 'IP 安全白名单组的组名。 '."\n" + ."\n" + .'由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', + 'type' => 'string', + 'required' => true, + 'example' => 'paytest', + ], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP安全白名单列表。 其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。最多可设置 40 个。', + 'description' => 'IP 安全白名单列表。 '."\n" + ."\n" + .'其为一个 JSON 格式的数组，数组中每个对象为一个 IP 字符串或者 IP 段。最多可设置 40 个。', + 'type' => 'string', + 'required' => true, + 'example' => '["192.***.*.*"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'SecurityIpGroup' => [ + 'title' => '白名单分组信息。', + 'description' => '白名单分组信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'example' => 't4louaeei****', + ], + 'SecurityIpGroupName' => [ + 'title' => '安全白名单分组名称。', + 'description' => '安全白名单分组名称。', + 'type' => 'string', + 'example' => 'paytest', + ], + 'SecurityIps' => [ + 'title' => '白名单列表。其为一个用逗号分隔的字符串，每个对象为一个IP字符串或者IP段。', + 'description' => '白名单列表。其为一个用逗号分隔的字符串，每个对象为一个 IP 字符串或者 IP 段。', + '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' => '创建租户安全白名单信息', + ], + 'DescribeTenants' => [ + 'summary' => '查询指定 OceanBase 集群列表下的租户列表信息。', + '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' => 'Oceanbase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantName', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户名称。 长度为2~20 个字符，支持英文字母、数字和下划线，区分大小写，必须以字母或下划线开头。 不可设置为 sys。', + 'description' => '租户名称。 '."\n" + .'长度为 2~20 个字符，支持英文字母、数字和下划线，区分大小写，必须以字母或下划线开头。 不可设置为 sys。', + 'type' => 'string', + 'required' => false, + 'example' => 'pay_online', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'description' => '分页查询时设置的每页行数。 '."\n" + .'- 最大值：100'."\n" + .'- 默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => '分页查询的页码。 '."\n" + .'- 起始值：1。'."\n" + .'- 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询列表的删选关键字。', + 'description' => '查询列表的筛选关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'pay', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '查询到的指定Oceanbase集群的租户总数。', + 'description' => '查询到的指定 OceanBase 集群的租户总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Tenants' => [ + 'title' => '租户的列表信息。', + 'description' => '租户的列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '租户的列表信息。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'title' => '专有网络（VPC） ID。 如果没有合适的 VPC，请根据页面提示创建一个 VPC，详情参见 什么是专有网络', + 'description' => '专有网络（VPC） ID。 <br>如无合适的 VPC，请根据页面提示创建一个 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' => '租户的状态。 <br>'."\n" + .'- PENDING_CREATE: 创建中'."\n" + .'- RESTORE: 恢复中'."\n" + .'- ONLINE: 运行中'."\n" + .'- SPEC_MODIFYING: 规格修改中'."\n" + .'- ALLOCATING_INTERNET_ADDRESS: 公网地址分配中'."\n" + .'- PENDING_OFFLINE_INTERNET_ADDRESS: 公网地址关闭中'."\n" + .'- PRIMARY_ZONE_MODIFYING: 切主可用区中'."\n" + .'- PARAMETER_MODIFYING: 参数修改中'."\n" + .'- WHITE_LIST_MODIFYING: 白名单修改中', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'PrimaryZone' => [ + 'title' => '租户的主可用区。', + 'description' => '租户的主可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'DeployType' => [ + 'title' => '租户的部署类型。 multiple：多机房 single：单机房 dual：双机房', + 'description' => '租户的部署类型。<br>'."\n" + .'- multiple：多机房'."\n" + .'- single：单机房'."\n" + .'- dual：双机房', + 'type' => 'string', + 'example' => 'multiple', + ], + 'DeployMode' => [ + 'title' => '租户的数据副本模式。 对于高可用版本：三地域为N-N-N，两可用区和单可用区均为N-N； 对于基础版为N。 其中，N为单可用区内的节点数。', + 'description' => '租户的数据副本模式。 '."\n" + ."\n" + .'- 对于高可用版本：三地域为 N-N-N，两可用区和单可用区均为 N-N；'."\n" + .'- 对于基础版为 N。'."\n" + ."\n" + .'> <br>其中，N 为单可用区内的节点数。', + 'type' => 'string', + 'example' => '1-1-1', + ], + 'CreateTime' => [ + 'title' => '租户的创建时间。', + 'description' => '租户的创建时间。', + 'type' => 'string', + 'example' => '2021-09-17 15:52:17.0', + ], + 'TenantName' => [ + 'title' => '租户名称。', + 'description' => '租户名称。', + 'type' => 'string', + 'example' => 'pay_online', + ], + 'Mem' => [ + 'title' => '租户总的内存大小，单位：GB。', + 'description' => '租户总的内存大小，单位：GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Cpu' => [ + 'title' => '租户总的CPU核数，单位：Core。', + 'description' => '租户总的 CPU 核数，单位：Core。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Description' => [ + 'title' => '租户描述信息。', + 'description' => '租户描述信息。', + 'type' => 'string', + 'example' => 'paycore database', + ], + 'TenantMode' => [ + 'title' => '租户模式。 当前支持： Oracle：Oracle模式 MySQL: MySQL模式', + 'description' => '租户模式。 '."\n" + .'当前支持：'."\n" + .'- Oracle：Oracle 模式；'."\n" + .'- MySQL: MySQL 模式。', + 'type' => 'string', + 'example' => 'Oracle', + ], + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'example' => 't33h8y08k****', + ], + 'UnitCpu' => [ + 'title' => '租户每个Unit的CPU核数，单位：Core。', + 'description' => '租户每个 Unit 的 CPU 核数，单位：Core。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'UnitMem' => [ + 'title' => '租户每个Unit的内存大小，单位：GB。', + 'description' => '租户每个 Unit 的内存大小，单位：GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'UnitNum' => [ + 'title' => '租户的unit个数。', + 'description' => '租户的 unit 个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'UsedDiskSize' => [ + 'title' => '租户已使用磁盘量', + 'description' => '租户已使用磁盘量。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10', + ], + 'Charset' => [ + 'title' => '字符集', + 'description' => '字符集', + 'type' => 'string', + 'example' => 'utf8mb4', + ], + 'Collation' => [ + 'title' => '字符序', + 'description' => '字符序', + 'type' => 'string', + 'example' => 'utf8mb4_general_ci', + ], + 'EnableReadOnlyReplica' => [ + 'type' => 'boolean', + ], + 'ParameterTemplate' => [ + 'title' => '参数模板', + 'description' => '参数模板', + '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' => '查询集群下的租户列表信息', + ], + 'DescribeInstanceTenantModes' => [ + 'summary' => '该接口用于查询租户模式列表信息。', + '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' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'InstanceModes' => [ + 'title' => '租户模式列表。Oracle，Mysql', + 'description' => '租户列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '租户模式列表。', + 'type' => 'string', + 'enumValueTitles' => [ + 'MySQL' => 'MySQL', + 'Oracle' => 'Oracle', + ], + 'example' => 'Oracle', + ], + 'enumValueTitles' => [], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + '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' => '查询租户模式列表信息', + ], + 'DescribeTenant' => [ + 'summary' => '查看指定集群下的指定租户信息。', + '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' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4pnum****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => ' 租户的详细信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Tenant' => [ + 'title' => '租户信息。', + 'description' => '租户信息。', + 'type' => 'object', + 'properties' => [ + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'example' => 't4louaeei****', + ], + 'TenantName' => [ + 'title' => '租户名称。', + 'description' => '租户名称。', + 'type' => 'string', + 'example' => 'forMySQLTenant', + ], + 'TenantMode' => [ + 'title' => '租户模式。 当前支持： Oracle：Oracle模式 MySQL: MySQL模式', + 'description' => '租户模式。 '."\n" + .'当前支持：'."\n" + .'- Oracle：Oracle 模式。 '."\n" + .'- MySQL: MySQL 模式。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'VpcId' => [ + 'title' => '专有网络（VPC） ID。 如果没有合适的 VPC，请根据页面提示创建一个 VPC，详情参见 什么是专有网络', + 'description' => '专有网络（VPC） ID。'."\n" + .'如无合适的 VPC，请根据页面提示创建一个 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' => '租户状态： '."\n" + .'- ONLINE：运行中。'."\n" + .'- PENDING_CREATE：创建中。'."\n" + .'- WAITING_ALLOCATE_MASTER_ADDRESS：（备库）等待创建主地址。'."\n" + .'- ALLOCATING_MASTER_ADDRESS：主地址创建中。'."\n" + .'- DELETING_MASTER_ADDRESS：主地址删除中。'."\n" + .'- ALLOCATING_INTERNET_ADDRESS：公网地址创建中。'."\n" + .'- PENDING_OFFLINE_INTERNET_ADDRESS：公网地址删除中。'."\n" + .'- ALLOCATING_READONLY_ADDRESS：只读地址创建中。'."\n" + .'- DELETING_READONLY_ADDRESS：只读地址删除中。'."\n" + .'- ALLOCATING_READWRITE_ADDRESS：读写分离地址创建中。'."\n" + .'- DELETING_READWRITE_ADDRESS：读写分离地址删除中。'."\n" + .'- ALLOCATING_CLOGSERVICE_ADDRESS：事务日志地址创建中。'."\n" + .'- DELETING_CLOGSERVICE_ADDRESS：事务日志地址删除中。'."\n" + .'- MODIFYING_ADDRESS：地址域名修改中。'."\n" + .'- MODIFYING_PRIMARY_ZONE：主可用区切换中。'."\n" + .'- MODIFYING_READONLY_ADDRESS：只读地址修改中。'."\n" + .'- MODIFYING_READWRITE_ADDRESS：读写分离地址修改中。'."\n" + .'- SPEC_MODIFYING：规格修改中。'."\n" + .'- WHITE_LIST_MODIFYING：白名单修改中。'."\n" + .'- CREATING_BINLOG：Binlog 创建中。', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'EnableInternetAddressService' => [ + 'title' => '是否可开启租户公网地址。', + 'description' => '是否可开启租户公网地址。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PrimaryZone' => [ + 'title' => '租户的主可用区。', + 'description' => '租户的主可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'DeployType' => [ + 'title' => '集群的部署类型。 multiple：多机房 single：单机房 dual：双机房', + 'description' => '集群的部署类型。'."\n" + .'- multiple：多机房。 '."\n" + .'- single：单机房。 '."\n" + .'- dual：双机房。', + 'type' => 'string', + 'example' => 'multiple', + ], + 'DeployMode' => [ + 'title' => '租户的数据副本模式。 对于高可用版本：三地域为N-N-N，两可用区和单可用区均为N-N； 对于基础版为N。 其中，N为单可用区内的节点数。', + 'description' => '租户的数据副本模式。'."\n" + ."\n" + .'- 对于高可用版本：三地域为 N-N-N，两可用区和单可用区均为 N-N；'."\n" + .'- 对于基础版为 N。'."\n" + ."\n" + .'> <br>其中 N 为单可用区内的节点数。', + 'type' => 'string', + 'example' => 'FULL{1}@cn-hangzhou-h,FULL{1}@cn-hangzhou-i,FULL{1}@cn-hangzhou-j', + ], + 'Description' => [ + 'title' => '租户描述信息。', + 'description' => '租户描述信息。', + 'type' => 'string', + 'example' => 'paycore database', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '租户的创建时间。', + 'type' => 'string', + 'example' => '2023-04-21 11:15:47.0', + ], + 'TenantResource' => [ + 'title' => '租户的资源信息。', + 'description' => '租户的资源信息。', + 'type' => 'object', + 'properties' => [ + 'UnitNum' => [ + 'title' => '租户的unit个数。', + 'description' => '租户的 unit 个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Cpu' => [ + 'title' => '租户的CPU资源信息。', + 'description' => '租户的 CPU 资源信息。', + 'type' => 'object', + 'properties' => [ + 'UsedCpu' => [ + 'title' => '租户已使用的CPU核数，单位：Core。', + 'description' => '租户已使用的 CPU 核数，单位：Core。', + 'type' => 'number', + 'format' => 'float', + 'example' => '8', + ], + 'TotalCpu' => [ + 'title' => '租户总的CPU核数，单位：Core。', + 'description' => '租户总的 CPU 核数，单位：Core。', + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'UnitCpu' => [ + 'title' => '租户每个Unit的CPU核数，单位：Core。', + 'description' => '租户每个 Unit 的 CPU 核数，单位：Core。', + 'type' => 'number', + 'format' => 'float', + 'example' => '8', + ], + ], + ], + 'Memory' => [ + 'title' => '租户内存资源信息。', + 'description' => '租户内存资源信息。', + 'type' => 'object', + 'properties' => [ + 'UsedMemory' => [ + 'title' => '租户已使用的内存，单位：GB。', + 'description' => '租户已使用的内存，单位：GB。', + 'type' => 'number', + 'format' => 'float', + 'example' => '30', + ], + 'TotalMemory' => [ + 'title' => '租户总的内存大小，单位：GB。', + 'description' => '租户总的内存大小，单位：GB。', + 'type' => 'number', + 'format' => 'float', + 'example' => '64', + ], + 'UnitMemory' => [ + 'title' => '租户每个Unit的内存大小，单位：GB。', + 'description' => '租户每个 Unit 的内存大小，单位：GB。', + 'type' => 'number', + 'format' => 'float', + 'example' => '32', + ], + ], + ], + 'DiskSize' => [ + 'title' => '租户磁盘资源信息。', + 'description' => '租户磁盘资源信息。', + 'type' => 'object', + 'properties' => [ + 'UsedDiskSize' => [ + 'title' => '租户已使用的磁盘大小，单位：GB。', + 'description' => '租户已使用的磁盘大小，单位：GB。', + 'type' => 'number', + 'format' => 'float', + 'example' => '86', + ], + ], + ], + 'CapacityUnit' => [ + 'title' => '容量单元', + 'description' => '容量单元。', + 'type' => 'object', + 'properties' => [ + 'MaxCapacityUnit' => [ + 'title' => '最大容量单元', + 'description' => '最大容量单元。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'MinCapacityUnit' => [ + 'title' => '最小容量单元', + 'description' => '最小容量单元。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'UsedCapacit' => [ + 'title' => '已使用容量单元', + 'description' => '已使用容量单元。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'LogDiskSize' => [ + 'description' => '租户日志盘资源信息。', + 'type' => 'object', + 'properties' => [ + 'TotalLogDisk' => [ + 'description' => '租户总的日志盘分配大小，单位：GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8.0', + ], + 'UnitLogDisk' => [ + 'description' => '租户每个 Unit 的日志盘分配大小，单位：GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8.0', + ], + ], + ], + ], + ], + 'TenantConnections' => [ + 'title' => '租户的连接访问信息。', + 'description' => '租户的连接信息。', + 'type' => 'array', + 'items' => [ + 'description' => '租户的连接信息。', + 'type' => 'object', + 'properties' => [ + 'IntranetAddress' => [ + 'title' => '访问租户的私网连接地址。', + 'description' => '访问租户的私网连接地址。', + 'type' => 'string', + 'example' => 't4nunwxr0****.oceanbase.aliyuncs.com', + ], + 'IntranetPort' => [ + 'title' => '访问租户的私网连接端口。', + 'description' => '访问租户的私网连接端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2983', + ], + 'InternetAddress' => [ + 'title' => '访问租户的公网连接地址。', + 'description' => '访问租户的公网连接地址。', + 'type' => 'string', + 'example' => 't4nunwxr0****-mi.oceanbase.aliyuncs.com', + ], + 'InternetPort' => [ + 'title' => '访问租户的公网连接端口。', + 'description' => '访问租户的公网连接端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3306', + ], + 'VpcId' => [ + 'title' => '专有网络（VPC） ID。', + 'description' => '专有网络（VPC）ID。', + 'type' => 'string', + 'example' => 'vpc-bp1qiail1asmfe23t****', + ], + 'VSwitchId' => [ + 'title' => '虚拟交换机（VSwitch） ID。', + 'description' => '虚拟交换机（VSwitch）ID。', + 'type' => 'string', + 'example' => 'vsw-bp1i7b94u2et716yl****', + ], + 'IntranetAddressMasterZoneId' => [ + 'title' => '访问租户的连接地址对应的主可用区。', + 'description' => '访问租户的连接地址对应的主可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'IntranetAddressSlaveZoneId' => [ + 'title' => '访问租户的连接地址对应的备可用区。', + 'description' => '访问租户的连接地址对应的备可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + ], + 'IntranetAddressStatus' => [ + 'title' => '访问租户的私网连接地址状态。 ONLINE: 服务中', + 'description' => '访问租户的私网连接地址状态。'."\n" + .'ONLINE: 服务中。', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'ConnectionZones' => [ + 'title' => '租户连接对应的访问可用区列表。', + 'description' => '租户连接对应的访问可用区列表。', + 'type' => 'array', + 'items' => [ + 'description' => '租户连接对应的可用区。', + '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' => '访问租户的公网连接开通状态。 '."\n" + .'- CLOSED：关闭。 '."\n" + .'- ALLOCATING_INTERNET_ADDRESS：申请中。 '."\n" + .'- PENDING_OFFLINE_INTERNET_ADDRESS: 公网地址关闭中。 '."\n" + .'- ONLINE：服务中。', + 'type' => 'string', + 'example' => 'CLOSED', + ], + 'TransactionSplit' => [ + 'title' => '是否开启事务拆分', + 'description' => '是否开启事务拆分。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'AddressType' => [ + 'title' => '地址类型', + 'description' => '地址类型。'."\n" + ."\n" + .'- MASTER：主地址，可读可写。'."\n" + ."\n" + .'- READONLY：只读地址，只读。'."\n" + ."\n" + .'- READWRITE：读写分离地址，自动读写分离。'."\n" + ."\n" + .'- CLOGSERVICE：事务日志服务地址。', + 'type' => 'string', + 'enumValueTitles' => [ + 'MASTER' => 'MASTER', + 'READWRITE' => 'READWRITE', + 'CLOGSERVICE' => 'CLOGSERVICE', + 'READONLY' => 'READONLY', + ], + 'example' => 'READONLY', + ], + 'EnableTransactionSplit' => [ + 'title' => '是否开启事务拆分', + 'description' => '是否开启事务拆分。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ParallelQueryDegree' => [ + 'title' => '并行度', + 'description' => '并行度。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'default' => '2', + ], + 'TenantEndpointId' => [ + 'title' => '租户地址id', + 'description' => '租户地址 ID。', + 'type' => 'string', + 'example' => 'obe-4tw51gp7****', + ], + 'MaxConnectionNum' => [ + 'title' => '最大连接数', + 'description' => '最大连接数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5000', + ], + 'ConnectionReplicaType' => [ + 'title' => '链接对应的副本类型', + 'description' => '链接对应的副本类型。', + 'type' => 'string', + 'example' => 'FULL', + ], + 'ProxyClusterId' => [ + 'description' => 'ODP 集群 ID。', + 'type' => 'string', + 'example' => 'proxy-xxxxxxx', + ], + 'MaxConnectionLimit' => [ + 'title' => '私网最大连接数的当前值', + 'description' => '私网最大连接数的当前值', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'InternetMaxConnectionLimit' => [ + 'title' => '公网最大连接数的上限', + 'description' => '公网最大连接数的上限', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4000', + ], + 'IntranetRpcPort' => [ + 'description' => '私网旁路导入端口', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3307'."\n", + ], + 'InternetMaxConnectionNum' => [ + 'title' => '公网最大连接数的当前值', + 'description' => '公网最大连接数的当前值', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2500', + ], + 'InternetRpcPort' => [ + 'description' => '公网旁路导入端口', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3307', + ], + 'ConnectionLogicalZones' => [ + 'description' => '地址所在的逻辑 zone', + 'type' => 'array', + 'items' => [ + 'description' => '地址所在的逻辑 zone 信息', + 'type' => 'string', + 'example' => 'cn-bejing-3-z0,cn-bejing-4-z0', + ], + ], + 'IntranetSqlPort' => [ + 'title' => "\n", + 'description' => '私网 SQL 端口', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3306', + ], + 'OdpVersion' => [ + 'description' => 'ODP 版本', + 'type' => 'string', + 'example' => '4.3.1-xxxxxxxxx', + ], + 'InternetSqlPort' => [ + 'title' => '公网sql端口', + 'description' => '公网sql端口', + 'type' => 'integer', + 'format' => 'int32', + ], + 'InternetAddressServiceType' => [ + 'title' => '公网地址地址类型', + 'description' => '公网地址地址类型', + 'type' => 'string', + ], + 'IntranetAddressServiceType' => [ + 'title' => '私网地址地址类型', + 'description' => '私网地址地址类型', + 'type' => 'string', + ], + ], + ], + ], + 'TenantZones' => [ + 'title' => '租户可用区信息。', + 'description' => '租户的可用区信息。', + 'type' => 'array', + 'items' => [ + 'description' => '租户的可用区信息。', + 'type' => 'object', + 'properties' => [ + 'TenantZoneId' => [ + 'title' => '租户可用区ID。', + 'description' => '租户可用区 ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'Region' => [ + 'title' => '租户可用区所属的地域。', + 'description' => '租户可用区所属的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'TenantZoneRole' => [ + 'title' => '租户可用区的请求类型。 ReadWrite：可读可写 ReadOnly：只读 对于多机房高可用集群，其主可用区为ReadWrite。备可用区为ReadOnly; 对于单机房高可用集群，其所有可用区均为ReadWrite。', + 'description' => '租户可用区的角色。', + 'type' => 'string', + 'example' => 'ReadWrite', + ], + 'TenantZoneReplicas' => [ + 'description' => '租户可用区副本信息。', + 'type' => 'array', + 'items' => [ + 'description' => '租户可用区副本信息。', + 'type' => 'object', + 'properties' => [ + 'ZoneReplicaType' => [ + 'description' => '可用区副本类型。', + 'type' => 'string', + 'example' => 'FULL', + ], + 'ZoneNodes' => [ + 'description' => '可用区节点。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'LogicZoneName' => [ + 'description' => '逻辑可用区名称。', + 'type' => 'string', + 'example' => 'cn-shanghai-f-z0', + ], + 'ZoneCopyId' => [ + 'description' => '可用区副本 ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'FullCopyId' => [ + 'description' => '全功能副本 ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ReadOnlyCopyId' => [ + 'description' => '只读副本 ID。', + 'type' => 'string', + 'example' => '3', + ], + 'ReadOnlyReplicaType' => [ + 'description' => '只读副本类型。', + 'type' => 'string', + 'example' => 'ROW_STORE', + ], + ], + ], + ], + ], + ], + ], + 'ClogServiceStatus' => [ + 'title' => 'Clog服务开启状态。 CLOSED: 关闭 ONLINE：服务中', + 'description' => 'Clog 服务开启状态。'."\n" + .'- CLOSED: 关闭。 '."\n" + .'- ONLINE：服务中。', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'EnableClogService' => [ + 'title' => '是否可使用Clog服务，如需开启，请工单联系。', + 'description' => '是否可使用 Clog 服务，如需开启，请工单联系。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Charset' => [ + 'title' => '字符集', + 'description' => '字符集。', + 'type' => 'string', + 'example' => 'gb18030', + ], + 'Collation' => [ + 'title' => '字符序', + 'description' => '字符序。', + 'type' => 'string', + 'example' => 'gb18030_chinese_ci', + ], + 'PrimaryZoneDeployType' => [ + 'title' => '租户主可用区部署模式', + 'description' => '租户主可用区部署模式。', + 'type' => 'string', + 'enumValueTitles' => [ + 'RANDOM' => 'RANDOM', + 'STATIC' => 'STATIC', + ], + 'example' => 'STATIC', + ], + 'MasterIntranetAddressZone' => [ + 'title' => '租户主地址可用区', + 'description' => 'Master 节点所在可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'PayType' => [ + 'title' => '付费类型', + 'description' => '付费类型。', + 'type' => 'string', + 'example' => 'POSTPAY', + ], + 'InstanceType' => [ + 'title' => '实例类型', + 'description' => '实例类型。', + 'type' => 'string', + 'example' => 'KAFKA_PUBLIC', + ], + 'Series' => [ + 'title' => '实例系列', + 'description' => '实例系列。', + 'type' => 'string', + 'example' => 'normal', + ], + 'DiskType' => [ + 'title' => '磁盘类型', + 'description' => '磁盘类型。', + 'type' => 'string', + 'example' => 'cloud_essd_pl1', + ], + 'AvailableZones' => [ + 'title' => '可用区', + 'description' => '可用区列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '可用区列表信息。', + 'type' => 'string', + 'example' => '["cn-hangzhou-i"]', + ], + ], + 'EnableReadWriteSplit' => [ + 'title' => '是否允许开启读写分离地址', + 'description' => '是否允许开启读写分离地址。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableParallelQuery' => [ + 'title' => '是否允许开通并行查询', + 'description' => '是否允许开通并行查询。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MaxParallelQueryDegree' => [ + 'title' => '并行度设置上限', + 'description' => '并行度设置上限。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + 'EnableBinlogService' => [ + 'title' => '是否可以申请Binlog服务', + 'description' => '是否可以申请 Binlog 服务。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TimeZone' => [ + 'title' => '租户所在时区。 详细参见：DescribeTimeZones。', + 'description' => '时区。', + 'type' => 'string', + 'example' => 'Asia/Shanghai', + ], + 'DataMergeTime' => [ + 'title' => '租户合并时间，仅对4.0以上OB版本有效', + 'description' => '租户合并时间，仅支持 OceanBase V4.0.0 及之后的版本。', + 'type' => 'string', + 'example' => '02:36Z', + ], + 'ReadOnlyResource' => [ + 'description' => '只读资源信息。', + 'type' => 'object', + 'properties' => [ + 'UnitNum' => [ + 'title' => '租户的unit个数。', + 'description' => '租户的 unit 个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Cpu' => [ + 'description' => '集群中每个副本节点的 CPU，单位：Core。', + 'type' => 'object', + 'properties' => [ + 'UsedCpu' => [ + 'description' => '集群已使用的 CPU，单位：Core。', + 'type' => 'number', + 'format' => 'float', + 'example' => '8', + ], + 'TotalCpu' => [ + 'title' => '租户总的CPU核数，单位：Core。', + 'description' => '租户总的 CPU 核数，单位：Core。', + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'UnitCpu' => [ + 'title' => '租户每个Unit的CPU核数，单位：Core。', + 'description' => '租户每个 Unit 的 CPU 核数，单位：Core。', + 'type' => 'number', + 'format' => 'float', + 'example' => '8', + ], + ], + ], + 'Memory' => [ + 'description' => '集群内存信息。', + 'type' => 'object', + 'properties' => [ + 'UsedMemory' => [ + 'title' => '租户已使用的内存，单位：GB。', + 'description' => '租户已使用的内存，单位：GB。', + 'type' => 'number', + 'format' => 'float', + 'example' => '30', + ], + 'TotalMemory' => [ + 'title' => '租户总的内存大小，单位：GB。', + 'description' => '租户总的内存大小，单位：GB。', + 'type' => 'number', + 'format' => 'float', + 'example' => '64', + ], + 'UnitMemory' => [ + 'title' => '租户每个Unit的内存大小，单位：GB。', + 'description' => '租户每个Unit的内存大小，单位：GB。', + 'type' => 'number', + 'format' => 'float', + 'example' => '32', + ], + ], + ], + 'DiskSize' => [ + 'description' => '数据盘大小规格。', + 'type' => 'object', + 'properties' => [ + 'UsedDiskSize' => [ + 'title' => '租户已使用的磁盘大小，单位：GB。', + 'description' => '租户已使用的磁盘大小，单位：GB。', + 'type' => 'number', + 'format' => 'float', + 'example' => '86', + ], + ], + ], + 'CapacityUnit' => [ + 'description' => '容量单元信息。', + 'type' => 'object', + 'properties' => [ + 'MaxCapacityUnit' => [ + 'title' => '最大容量单元', + 'description' => '最大容量单元。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'MinCapacityUnit' => [ + 'title' => '最小容量单元', + 'description' => '最小容量单元。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'UsedCapacit' => [ + 'title' => '已使用容量单元', + 'description' => '已使用容量单元。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'LogDiskSize' => [ + 'description' => '日志盘大小信息。', + 'type' => 'object', + 'properties' => [ + 'TotalLogDisk' => [ + 'description' => '总日志盘大小，单位：GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8.0', + ], + 'UnitLogDisk' => [ + 'description' => '日志盘单元。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8.0', + ], + ], + ], + ], + ], + 'EnableReadOnlyReplica' => [ + 'description' => '是否支持只读副本', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RecycleBinStatus' => [ + 'title' => '表示租户回收站状态，ON表示开启，OFF表示关闭', + 'description' => '表示租户回收站状态，ON表示开启，OFF表示关闭', + 'type' => 'string', + 'example' => 'ON', + ], + 'LowerCaseTableNames' => [ + 'description' => '表名是否区分大小写，取值范围如下：'."\n" + .'* **1**：不区分大小写'."\n" + .'* **0**：区分大小写', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Version' => [ + 'title' => '版本信息', + 'description' => '版本信息', + 'type' => 'string', + 'example' => '4.2.1', + ], + 'OdpVersion' => [ + 'description' => 'ODP 版本', + 'type' => 'string', + 'example' => '4.3.1-xxxxxxxxx', + ], + 'TenantMaxConnections' => [ + 'description' => '租户允许的最大连接数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600', + ], + 'ParameterTemplate' => [ + 'title' => '参数模板', + 'description' => '参数模板', + 'type' => 'string', + 'example' => 'express_oltp', + ], + 'Iops' => [ + 'title' => '租户IOPS', + 'description' => '租户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' => '查询指定集群下的指定租户信息', + ], + 'DescribeAvailableCpuResource' => [ + 'summary' => '查询创建租户允许的 CPU 资源信息。', + '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' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 't4pnum**** ', + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户权限修改类型。 可支持以下几种方式： update：全量更新权限，默认值； add：新增权限； delete：删除权限。 默认值：update。', + 'description' => '用户权限修改类型。 支持以下几种方式：'."\n" + .'- unitNum：unit 数量；'."\n" + .'- resource：资源分配。', + 'type' => 'string', + 'required' => false, + 'example' => 'resource', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'title' => '可用的CPU资源信息。', + 'description' => '可用的 CPU 资源列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '可用的 CPU 资源列表信息。', + 'type' => 'object', + 'properties' => [ + 'UnitNum' => [ + 'title' => 'unit数量', + 'description' => '租户的 unit 个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'MinCpu' => [ + 'title' => '单个unit最小需要申请的CPU核数。', + 'description' => '单个 unit 最小需申请的 CPU 核数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'MaxCpu' => [ + 'title' => '单个unit最大可申请的CPU核数。', + 'description' => '单个 unit 最大可申请的 CPU 核数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'ReviewCode' => [ + 'title' => 'unitnum变更检查结果', + 'description' => 'unitnum变更检查结果', + 'type' => 'string', + 'example' => 'UnitNum.Change.Accept', + 'enum' => [ + 'UnitNum.Change.Accept', + 'UnitNum.Change.Reject', + 'UnitNum.Change.NotRecommend', + ], + ], + 'Comment' => [ + 'title' => '建议', + 'description' => '建议', + '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' => '查询可用的 CPU 资源信息', + ], + 'DescribeAvailableMemResource' => [ + 'summary' => '查询 OceanBase 租户的内存资源信息。', + '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' => 'Oceanbase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'UnitNum', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户的资源分布节点数。 其与集群的部署模式相耦合，如集群模式为2-2-2，则最后分布节点数最多为2个。', + 'description' => '租户的资源分布节点数。 '."\n" + .'其与集群的部署模式相耦合，如集群模式为 2-2-2，则最后分布节点数最多为 2 个。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'CpuNum', + 'in' => 'formData', + 'schema' => [ + 'description' => 'cpu 数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '14', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Data' => [ + 'title' => '可用的内存资源信息。', + 'description' => '可用的内存资源信息。', + 'type' => 'object', + 'properties' => [ + 'MinMem' => [ + 'title' => '单个unit最小需要申请的内存大小，单位：GB。', + 'description' => '单个 unit 最小需要申请的内存大小，单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'MaxMem' => [ + 'title' => '单个unit最大可申请的内存大小，单位：GB。', + 'description' => '单个 unit 最大可申请的内存大小，单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'UsedMem' => [ + 'title' => '租户的unit个数。', + 'description' => '租户的 unit 个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'SafeMem' => [ + 'title' => '内存安全水位', + 'description' => '内存安全水位。', + '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' => '查询内存资源信息', + ], + 'DescribeCharset' => [ + 'summary' => '查询 OceanBase 租户的字符集信息。', + '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' => '租户模式。'."\n" + .'当前支持 Oracle 模式（Oracle）、MySQL模式（MySQL）。 '."\n" + .'详情参见：DescribeInstanceTenantModes。', + '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' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Charset' => [ + 'title' => '字符集列表。', + 'description' => '字符集列表。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Charset' => [ + 'title' => '字符集名称。', + 'description' => '字符集名称。', + 'type' => 'string', + 'example' => 'utf8', + ], + 'Collations' => [ + 'title' => '字符序集合', + 'description' => '字符序集合。', + 'type' => 'array', + 'items' => [ + 'description' => '字符序集合。', + 'type' => 'string', + 'example' => '["utf8mb4_general_ci","utf8mb4_bin","binary"]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取字符集', + ], + 'DescribeInstanceAvailableZones' => [ + 'summary' => '查询集群可创建主可用区的可用区信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '实例ID。', + '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' => '请求的返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Zone' => [ + 'description' => '物理可用区名称。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'IsInCluster' => [ + 'description' => '是否是集群部署的可用区。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ReplicateZoneIndex' => [ + 'description' => '副本可用区索引。', + 'type' => 'string', + 'example' => '1', + ], + 'LogicalZoneName' => [ + 'description' => '逻辑可用区名称。', + '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' => '查询可用区信息', + ], + 'DescribeTenantZonesRead' => [ + 'summary' => '查询租户的只读可用区信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4louaeei****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'TenantZones' => [ + 'title' => '租户可用区信息。', + 'description' => '租户可用区列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'IsElectable' => [ + 'title' => '是否可选为主库。', + 'description' => '是否可选为主库。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsPrimary' => [ + 'title' => '是否为主可用区。', + 'description' => '是否为主可用区。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Zone' => [ + 'title' => '可用区ID。', + 'description' => '可用区 ID。', + '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' => '查询租户只读可用区信息', + ], + 'DescribeTimeZones' => [ + 'summary' => '查询 OceanBase 租户的时区信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'TimeZones' => [ + 'title' => '租户允许的时区信息。', + 'description' => '租户允许的时区信息。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'title' => '时区列表信息。', + 'description' => '时区列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'TimeZone' => [ + 'title' => '时区名称。', + 'description' => '时区名称。', + 'type' => 'string', + 'example' => 'Asia/Shanghai', + ], + 'Description' => [ + 'title' => '时区描述。', + 'description' => '时区描述。', + 'type' => 'string', + 'example' => '(GMT+8:00) Asia/Shanghai', + ], + ], + ], + 'example' => '', + ], + 'Default' => [ + 'title' => '默认时区。', + 'description' => '默认时区。', + 'type' => 'string', + 'example' => 'Asia/Shanghai', + ], + ], + 'example' => '', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 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 \\"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' => '获取时区列表', + ], + 'DescribeTenantSecurityIpGroups' => [ + 'summary' => '查看租户白名单分组列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 't4louaeei****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'TotalCount' => [ + 'title' => '白名单分组个数。', + 'description' => '白名单分组个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SecurityIpGroups' => [ + 'title' => '白名单分组列表。', + 'description' => '白名单分组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单分组列表。', + 'type' => 'object', + 'properties' => [ + 'SecurityIpGroupName' => [ + 'title' => '分组名称', + 'description' => '分组名称。', + 'type' => 'string', + 'example' => 'test1', + ], + 'SecurityIps' => [ + 'title' => '白名单列表。其为一个用逗号分隔的字符串，每个对象为一个IP字符串或者IP段。\'', + 'description' => '白名单列表。其为一个用逗号分隔的字符串，每个对象为一个 IP 字符串或者 IP 段。', + 'type' => 'string', + 'example' => '192.***.*.*', + ], + 'SecurityIpGroupType' => [ + 'title' => '白名单分组类型。- instance: 集成自集群的白名单分组；- tenant：本租户的白名单分组', + 'description' => '白名单分组类型。'."\n" + ."\n" + .'- instance: 集成自集群的白名单分组。'."\n" + .'- tenant：本租户的白名单分组。', + 'type' => 'string', + 'example' => 'tenant', + ], + 'TenantId' => [ + 'title' => '租户id', + 'description' => '租户 ID。', + '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' => '查看租户白名单分组列表', + ], + 'DescribeZones' => [ + 'summary' => '获取一个阿里云地域下可创建集群的可用区信息。', + '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' => 'OceanBase 集群系列。'."\n" + .'NORMAL（默认）：高可用版本。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'NORMAL' => 'NORMAL', + ], + 'example' => 'NORMAL', + 'enum' => [ + 'normal', + 'basic', + ], + ], + ], + [ + 'name' => 'DeployType', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群的部署类型。- multiple：多机房 - single：单机房 - dual：双机房', + 'description' => '集群的部署类型。 '."\n" + .'- multiple：多机房。 '."\n" + .'- single：单机房。 '."\n" + .'- dual：双机房。', + 'type' => 'string', + 'required' => false, + 'example' => 'single', + 'enum' => [ + 'multiple', + 'single', + 'dual', + ], + ], + ], + [ + 'name' => 'CpuArch', + 'in' => 'formData', + 'schema' => [ + 'title' => 'cpu架构', + 'description' => 'cpu架构', + 'type' => 'string', + 'required' => false, + 'example' => 'x86', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => ' 请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Zones' => [ + 'title' => '可用区列表信息', + 'description' => '可用区列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'title' => '可用区ID列表。对于多可用区集群，其可用区名称以逗号连接', + 'description' => '可用区 ID 列表。 '."\n" + .'对于多可用区集群，其可用区名称以逗号连接。', + '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' => 'OceanBase 集群系列。'."\n" + .'NORMAL（默认）：高可用版本。', + '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' => '获取可用区信息', + ], + 'ModifyTenantPrimaryZone' => [ + 'summary' => '切换租户的主可用区。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'PrimaryZone', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户的主可用区。 其为集群部署可用区中的一个。', + 'description' => '租户的主可用区。'."\n" + .'其为集群部署可用区中的一个。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'UserVSwitchId', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户交换机ID', + 'description' => '用户交换机 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-xxx', + ], + ], + [ + 'name' => 'MasterIntranetAddressZone', + 'in' => 'formData', + 'schema' => [ + 'title' => '主内网地址可用区', + 'description' => 'Master 节点所在可用区。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'TenantEndpointId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户地址id', + 'description' => '租户地址 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'obe-4tw51gp7****', + ], + ], + [ + 'name' => 'TenantEndpointDirectId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户直连地址endpoint id', + 'description' => '租户直连地址 endpoint ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'obe-***', + ], + ], + [ + 'name' => 'UserDirectVSwitchId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户直连地址vswitch id', + 'description' => '租户直连地址 vswitch ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-***', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => [ + 'description' => '专有网络（VPC） ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-wz9a8***********', + ], + ], + [ + 'name' => 'UserVpcOwnerId', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户vpc的ownerId', + 'description' => '用户vpc的ownerId', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-********'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-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' => '切换租户主可用区', + ], + 'ModifyTenantResource' => [ + 'summary' => '修改指定 OceanBase 集群的一个租户的规格。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'Cpu', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户的 CPU 大小，单位：核数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'Memory', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户内存大小，单位GB。', + 'description' => '租户内存大小，单位 GB。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'LogDisk', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户分配日志盘大小，单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '128', + ], + ], + [ + 'name' => 'ReadOnlyZoneList', + 'in' => 'formData', + 'schema' => [ + 'title' => '非必要不使用该参数，推荐使用接口 ModifyTenantReadonlyReplica管理只读副本', + 'description' => '创建只读副本的可用区,当传入多个可用区的时候，以英文逗号分隔。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'cn-shanghai-g-ro,cn-shanghai-h-ro', + ], + ], + [ + 'name' => 'Iops', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'example' => 't33h8y08k****', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + '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' => '修改租户资源', + ], + 'ModifyTenantSecurityIpGroup' => [ + 'summary' => '修改租户白名单分组信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'SecurityIpGroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP安全白名单组的组名。 由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', + 'description' => 'IP 安全白名单组的组名。'."\n" + ."\n" + .'由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', + 'type' => 'string', + 'required' => true, + 'example' => 'paytest', + ], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP安全白名单列表。 其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。最多可设置 40 个。', + 'description' => 'IP 安全白名单列表。 '."\n" + ."\n" + .'其为一个 JSON 格式的数组，数组中每个对象为一个 IP 字符串或者 IP 段。最多可设置 40 个。', + 'type' => 'string', + 'required' => true, + 'example' => '["192.***.*.*"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'SecurityIpGroup' => [ + 'title' => '白名单分组信息。', + 'description' => '白名单分组信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'example' => 't4louaeei****', + ], + 'SecurityIpGroupName' => [ + 'title' => '安全白名单分组名称。', + 'description' => '安全白名单分组名称。', + 'type' => 'string', + 'example' => 'paytest', + ], + 'SecurityIps' => [ + 'title' => '白名单列表。其为一个用逗号分隔的字符串，每个对象为一个IP字符串或者IP段。', + 'description' => '白名单列表。'."\n" + ."\n" + .'其为一个用逗号分隔的字符串，每个对象为一个 IP 字符串或者 IP 段。', + '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' => '修改租户白名单分组信息', + ], + 'DeleteTenants' => [ + 'summary' => '删除指定 OceanBase 集群下的一个或多个租户。', + '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' => '租户的 TenantId 列表。 '."\n" + .'其为 JSON 格式的数组，数组中每个对象均为租户名称的字符串。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["ob2mr3oae0****", "ob2mr3oae1****"]', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'TenantIds' => [ + 'title' => '租户的ID列表。', + 'description' => '租户的 ID 列表。', + 'type' => 'array', + 'items' => [ + 'description' => '租户的 ID。', + 'type' => 'string', + 'example' => 'tjd3da45kc****', + ], + ], + ], + ], + ], + ], + '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' => '删除租户', + ], + 'DeleteTenantSecurityIpGroup' => [ + 'summary' => '删除租户白名单分组信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'SecurityIpGroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => '安全白名单分组的组名。 由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', + 'description' => '安全白名单分组的组名。'."\n" + ."\n" + .'由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', + 'type' => 'string', + 'required' => true, + 'example' => 'paytest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'SecurityIpGroup' => [ + 'title' => '白名单分组信息。', + 'description' => '白名单分组信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'example' => 't4louaeei****', + ], + 'SecurityIpGroupName' => [ + 'title' => '安全白名单分组名称。', + 'description' => '安全白名单分组名称。', + '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' => '删除租户白名单分组信息', + ], + 'CreateTenantUser' => [ + 'summary' => '在指定租户下创建一个访问数据库的账号。', + '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' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4pnum****', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库账号名称。 不能使用某些预留关键字，如 SYS、root等。', + 'description' => '数据库账号名称。 '."\n" + .'不能使用某些预留关键字，如 SYS、root 等。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pay_test', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库账户的类型 Admin：超级账户 Normal：普通账户', + 'description' => '用户类型。 '."\n" + ."\n" + .'- Normal：普通账户。'."\n" + .'- Admin：超级账户。'."\n" + .'- ReadonlyAccount：只读账户，仅 MySQL 租户包含只读账户。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'UserPassword', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库账号访问密码。 必须包含大写英文字符、小写英文字符、数字、特殊字符占三种，长度为 10-32 位； 特殊字符为：!@#$%^&* ()_ +-=', + 'description' => '数据库账号访问密码。'."\n" + ."\n" + .'> <br>必须包含大写英文字符、小写英文字符、数字、特殊字符占三种，长度为 10-32 位； 特殊字符为：!@#$%^\\*()_+-=', + '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' => '用户的角色信息。 '."\n" + .'普通用户填写账户的信息，其为 JSON 格式的字符串，默认为一个数组，数组内包含 Database（MySQL 模式）信息和角色信息（Role）。角色包含以下几类： '."\n" + .' - 读写权限（ReadWrite）：ALL PRIVILEGES。'."\n" + .' - 只读权限（ReadOnly）：SELECT。'."\n" + .' - DDL 权限（DDL）：CREATE,DROP,ALTER,SHOW VIEW,CREATE VIEW。'."\n" + .'- DML 权限：SELECT, INSERT, UPDATE, DELETE, SHOW VIEW。'."\n" + .'- DML 权限（DML）：SELECT,INSERT,UPDATE,DELETE,SHOW VIEW。'."\n" + ."\n" + .'> <br><ul><li> Oracle 模式：无需填写。</li><li> MySQL 模式：超级账户默认为 ALL PRIVILEGES，无需填写。 </li></ul>', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '[{"Database":"oceanbase1","Role":"readwrite"},{"Database":"oceanbase2","Role":"readonly"}]', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库描述信息。', + 'description' => '数据库描述信息。', + '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' => '全局权限信息', + 'description' => '全局权限信息', + 'type' => 'string', + 'required' => false, + 'example' => 'Encrypt,Decrypt', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'TenantUser' => [ + 'description' => '租户中的数据库账号列表信息。', + 'type' => 'object', + 'properties' => [ + 'UserType' => [ + 'description' => '用户类型。'."\n" + .'- Normal：普通账户。'."\n" + .'- Admin：超级账户。'."\n" + .'- ReadonlyAccount：只读账户，仅 MySQL 租户包含只读账户。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Roles' => [ + 'title' => '账户对应的角色权限信息', + 'description' => '账户对应的角色权限信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Database' => [ + 'title' => '数据库名称', + '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' => '拥有的角色。 '."\n" + .'- 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。'."\n" + .'> Oracle 账户对自己的 Schema 有默认的读写权限，此处不会列出。', + 'type' => 'string', + 'example' => 'ReadOnly', + ], + ], + ], + 'example' => '', + ], + 'UserStatus' => [ + 'title' => '数据库账号的状态。 - Locked：锁定 - ONLINE：解锁 创建完的账户默认为ONLINE状态', + 'description' => '数据库账号的状态。'."\n" + .'- LOCKED：锁定。'."\n" + .'- ONLINE：解锁。'."\n" + .'> 创建完成的账户默认状态为 ONLINE。', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'UserName' => [ + 'title' => '数据库账号名称。', + 'description' => '数据库账号名称。', + 'type' => 'string', + 'example' => 'pay_test', + ], + 'GlobalPermissions' => [ + 'title' => '全局权限', + 'description' => '全局权限', + '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' => '创建租户用户', + 'requestParamsDescription' => '有关请求 Endpoint 列表，请参见 API 参考 > 调用方式。', + ], + 'DescribeTenantUsers' => [ + 'summary' => '查询一个租户下所有数据库访问的账号列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询列表的删选关键字。', + 'description' => '模糊查询列表的筛选关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'pay', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => '分页查询的页码。'."\n" + .'起始值：1，默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'description' => '分页查询时设置的每页行数。'."\n" + .'最大值：100，默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库账号名称。 不能使用某些预留关键字，如 SYS、root等。', + 'description' => '数据库账号名称。'."\n" + .'不能使用某些预留关键字，如 SYS、root 等。', + 'type' => 'string', + 'required' => false, + 'example' => 'pay_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '租户中的数据库账号总数。', + 'description' => '租户中的数据库账号总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'TenantUsers' => [ + 'title' => '租户中的数据库账号信息', + 'description' => '租户中的数据库账号列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'UserType' => [ + 'title' => '数据库账号类型。 - Admin：超级账户 - Normal：普通账户', + 'description' => '数据库账号类型。'."\n" + .'- Admin：超级账户。'."\n" + .'- Normal：普通账户。', + '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' => '数据库（schema）名称', + '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' => '拥有的角色。 '."\n" + .'对于 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。 '."\n" + ."\n" + .'> <br>另外， Oracle 账户对自己的 Schema 有默认的读写权限，此处不会列出。', + 'type' => 'string', + 'example' => 'ReadOnly', + ], + 'Table' => [ + 'title' => '表的名称。', + 'description' => '表的名称。', + 'type' => 'string', + 'example' => 'tbl_pay1', + ], + 'Privileges' => [ + 'description' => '用户授予数据库自定义权限时，privileges 返回自定义的权限内容，以逗号 "," 分割；其余时间 privileges 不返回数据。', + 'type' => 'string', + 'example' => 'select,delete,update', + ], + ], + ], + ], + 'UserStatus' => [ + 'title' => '数据库账号的状态。 - LOCKED：锁定 - ONLINE：解锁', + 'description' => '数据库账号的状态。'."\n" + .'- LOCKED：锁定。'."\n" + .'- ONLINE：解锁。', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'UserName' => [ + 'title' => '数据库账号名称。', + 'description' => '数据库账号名称。', + 'type' => 'string', + 'example' => 'pay_test', + ], + 'TenantId' => [ + 'title' => '所属租户Id', + 'description' => '所属租户 ID。', + 'type' => 'string', + 'example' => 't4pnum**** ', + ], + 'InstanceId' => [ + 'title' => '所属集群Id', + 'description' => '所属集群 ID。', + 'type' => 'string', + 'example' => 'obshc32****', + ], + 'GlobalPermissions' => [ + 'title' => '全局权限信息', + 'description' => '全局权限信息', + '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' => '查询租户账号列表', + ], + 'DescribeTenantUserRoles' => [ + 'summary' => '获取普通用户的权限配置信息。', + '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' => '租户 ID。 '."\n" + .'如果传入的是 MySQL 模式租户 ID，则返回 MySQL 模式下普通用户的权限配置信息；如果传入的是 Oracle 租户 ID，则返回的是 Oracle 普通用户的权限配置信息。', + 'type' => 'string', + 'required' => false, + 'example' => 't4pnum****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + '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' => '用户的角色列表。 '."\n" + .'对于 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" + ."\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。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'string', + 'example' => 'DDL', + ], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 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' => '获取普通用户的权限配置信息', + ], + 'ModifyTenantUserDescription' => [ + 'summary' => '修改租户下指定的数据库账号的备注信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4pnum****', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库账号名称。 不能使用某些预留关键字，如 SYS、root等。', + 'description' => '数据库账号名称。 '."\n" + .'不能使用某些预留关键字，如 SYS、root 等。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pay_test', + ], + ], + [ + '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' => '请求 ID。', + '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 \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTenantUserDescriptionResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</ModifyTenantUserDescriptionResponse>","errorExample":""}]', + 'title' => '修改租户账号备注信息', + ], + 'ModifyTenantUserPassword' => [ + 'summary' => '修改租户下指定的数据库账号的登录密码。', + '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' => '数据库账号名称。'."\n" + .'不能使用某些预留关键字，如 SYS、root 等。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pay_test', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4pnum****', + ], + ], + [ + 'name' => 'UserPassword', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库账号访问密码。 必须包含大写英文字符、小写英文字符、数字、特殊字符占三种，长度为 10-32 位； 特殊字符为：!@#$%^&* ()_ +-=', + 'description' => '数据库账号访问密码。'."\n" + .'必须包含大写英文字符、小写英文字符、数字、特殊字符占三种，长度为 10-32 位； 特殊字符为：!@#$%^&* ()_ +-=', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '!Aliyun4Oceanbase', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + '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' => '请求 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":"<ModifyTenantUserPasswordResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</ModifyTenantUserPasswordResponse>","errorExample":""}]', + 'title' => '修改租户用户密码', + ], + 'ModifyTenantUserRoles' => [ + 'summary' => '修改租户下指定账号可访问的数据库权限信息。', + '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' => '数据库账号名称。 '."\n" + .'不能使用某些预留关键字，如 SYS、root 等。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pay_test', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4pnum****', + ], + ], + [ + 'name' => 'UserRole', + 'in' => 'formData', + 'schema' => [ + 'title' => '如果是mysql模式, 则传入所有的数据库和对应的权限, 如果有没传入的数据库, 则视为撤销在该数据库上的权限, 如果取消所有的数据库权限, 则传入为空, 即UserRole:[];'."\n" + .'如果是oracle模式, 则只传入对应需要修改的数据库名, 表名, 以及相应的权限.', + 'description' => '数据库的账号角色信息。'."\n" + .'- OceanBase MySQL 模式下, 传入所有的数据库和对应的权限, 如果有未传入的数据库, 则视为撤销在该数据库上的权限, 如果取消所有的数据库权限, 则传入为空, 即 UserRole:[]。'."\n" + .'- OceanBase Oracle 模式下, 只传入对应需要修改的数据库名、表名，以及相应的权限。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '- OceanBase MySQL 模式：[{"Database":"oceanbase1","Role":"readwrite"},{"Database":"oceanbase2","Role":"readonly"}]'."\n" + .'- OceanBase Oracle 模式：[{"database":"xxx","table":"xxx","role":"readonly"}]'."\n" + .'并且 modifyType 需要传入相应的值', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'formData', + 'schema' => [ + 'title' => '如果是mysql模式, 则不传该值;'."\n" + .'如果是oracle模式, 则传入对应的操作: * 添加:ADD'."\n" + .'* 删除: DELETE'."\n" + .'* 更新: UPDATE ', + 'description' => '用户权限修改类型。 '."\n" + .'OceanBase MySQL 模式下, 不传入该值；OceanBase Oracle 模式下，传入对应的操作：'."\n" + .'- 添加：ADD。'."\n" + .'- 删除：DELETE。'."\n" + .'- 更新：UPDATE。', + 'type' => 'string', + 'required' => false, + 'example' => 'UPDATE', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户类型', + 'description' => '用户类型', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + 'enum' => [], + ], + ], + [ + 'name' => 'GlobalPermissions', + 'in' => 'formData', + 'schema' => [ + 'title' => '全局权限', + 'description' => '全局权限', + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'TenantUser' => [ + 'title' => '租户中的数据库账号信息。', + 'description' => '租户中的数据库账号信息。', + 'type' => 'object', + 'properties' => [ + 'UserRole' => [ + 'title' => '账号类型。 Admin：超级账户 Normal：普通账户', + 'description' => '账号类型。'."\n" + .'- Admin：超级账户。'."\n" + .'- Normal：普通账户。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Database' => [ + 'title' => '数据库(schema)名称', + 'description' => '数据库（schema）名称。', + 'type' => 'string', + 'example' => 'db_pay1', + ], + 'Role' => [ + 'title' => '拥有的角色。', + 'description' => '拥有的角色。', + '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' => '租户 ID。', + 'type' => 'string', + 'example' => 't4pnum****', + ], + ], + 'example' => '', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 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 \\"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' => '修改租户用户角色', + ], + 'DeleteTenantUsers' => [ + 'summary' => '删除一个或多个数据库账号列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4pnum****', + ], + ], + [ + 'name' => 'Users', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户名及具备的角色列表。', + 'description' => '用户名列表。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["testUser"]', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 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' => '删除租户用户', + ], + 'CreateDatabase' => [ + 'summary' => '在指定租户下创建一个新的数据库。', + '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' => '数据库名称。 '."\n" + ."\n" + .'> <br>不能使用某些预留关键字。例如：test, sys,oceanbase, information_schema, mysql, performance_schema。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sms_pre', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户id, 仅支持mysql模式;', + 'description' => '租户 ID。仅支持 OceanBase MySQL 模式。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4pnum****', + ], + ], + [ + 'name' => 'Encoding', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库编码方式。目前支持utf8mb4, utf16, gbk, gb18030, binary ', + 'description' => '数据库编码方式。 '."\n" + .'目前支持 utf8mb4, utf16, gbk, gb18030, binary。', + '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' => '字符序。目前支持的字符序为：'."\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。', + 'type' => 'string', + 'required' => false, + 'example' => 'utf8mb4_general_ci', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。', + 'description' => '保证请求幂等性。 '."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。 '."\n" + ."\n" + .'> <br>ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-****-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库描述信息。', + 'description' => '数据库描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a test database', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'DatabaseName' => [ + 'title' => '数据库名称。', + 'description' => '数据库名称。', + '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' => '创建数据库', + ], + 'DescribeDatabases' => [ + 'summary' => '查询租户下的数据库列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 't4pnum****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => '分页查询的页码。 '."\n" + .'- 起始值：1。'."\n" + .'- 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'description' => '分页查询时设置的每页行数。 '."\n" + .'- 最大值：100 '."\n" + .'- 默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名称。 不能使用某些预留关键字，如 test、mysql。', + 'description' => '数据库名称。'."\n" + .'不能使用某些预留关键字，如 test、mysql。', + 'type' => 'string', + 'required' => false, + 'example' => 'sms_pre', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询列表的删选关键字。', + 'description' => '查询列表的删选关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'pay', + ], + ], + [ + 'name' => 'WithTables', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否返回数据库中的表信息。'."\n" + .'默认值：false。如果表的数量过大则可能导致接口超时', + 'description' => '是否返回数据库中的表信息。 '."\n" + .'默认值：false。'."\n" + .'> <br>'."\n" + .'> 如果表的数量过大则可能导致接口超时。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id', + 'description' => '集群 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ob****n0abo9uo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '租户中的数据库总数。', + 'description' => '租户中的数据库总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Databases' => [ + 'title' => '租户中的数据库列表。', + 'description' => '租户中的数据库列表。', + 'type' => 'array', + 'items' => [ + 'description' => '租户中的数据库列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '数据库的状态。 - ONLINE: 运行中 - DELETING: 删除中', + 'description' => '数据库的状态。'."\n" + .'- ONLINE: 运行中。'."\n" + .'- DELETING: 删除中。', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'Description' => [ + 'title' => '数据库的描述信息。', + 'description' => '数据库的描述信息。', + 'type' => 'string', + 'example' => 'test db', + ], + 'Encoding' => [ + 'title' => '数据库的编码。目前支持utf8mb4、gbk等编码。', + 'description' => '数据库的编码。目前支持 utf8mb4、gbk 等编码。', + 'type' => 'string', + 'example' => 'utf8mb4', + ], + 'DbType' => [ + 'title' => '数据库类型', + 'description' => '数据库类型。', + 'type' => 'string', + 'example' => 'mysql', + ], + 'DatabaseName' => [ + 'title' => '数据库名称。', + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'sms_pre', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-02-21 15:41:06', + ], + 'Users' => [ + 'title' => '对该数据库赋权的账号信息。', + 'description' => '对该数据库赋权的账号列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '对该数据库赋权的账号列表信息。', + 'type' => 'object', + 'properties' => [ + 'UserType' => [ + 'title' => '账号类型。 - Admin：超级账户 - Normal：普通账户', + 'description' => '账号类型。'."\n" + .' - Admin：超级账户。'."\n" + .'- Normal：普通账户。', + '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' => '账号赋予该库的角色权限。'."\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。', + 'type' => 'string', + 'example' => 'ReadOnly', + ], + 'UserName' => [ + 'title' => '账号名称。', + 'description' => '账号名称。', + 'type' => 'string', + 'example' => 'user_pay_ro', + ], + 'Privileges' => [ + 'description' => '用户授予数据库自定义权限时，privileges 返回自定义的权限内容，以逗号 "," 分割；其余时间 privileges 不返回数据。', + 'type' => 'string', + 'example' => 'select,delete,update', + ], + ], + ], + ], + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'example' => 't4pnum****', + ], + 'Tables' => [ + 'title' => '数据库表信息', + 'description' => '数据库表列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库表列表信息。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'title' => '数据库表名', + 'description' => '数据库表名。', + 'type' => 'string', + 'example' => 'testTables', + ], + ], + ], + ], + 'RequiredSize' => [ + 'title' => '所需容量 单位（GB）', + 'description' => '所需容量，单位：GB。', + 'type' => 'number', + 'format' => 'double', + 'example' => '5.67 GB', + ], + 'DataSize' => [ + 'title' => '实际数据大小单位（GB）', + 'description' => '实际数据大小，单位：GB。'."\n" + ."\n" + .'><notice>该字段后期后台不再输出, 请使用 RequiredSize。></notice>', + 'type' => 'number', + 'format' => 'double', + 'example' => '5.67 GB', + ], + 'Collation' => [ + 'title' => '字符序', + 'description' => '字符序。', + 'type' => 'string', + 'example' => 'utf8mb4_general_ci', + ], + 'InstanceId' => [ + 'title' => '所属集群Id', + 'description' => '所属集群 ID。', + 'type' => 'string', + 'example' => 'obsdh2f****', + ], + 'TenantName' => [ + 'title' => '租户名', + 'description' => '租户名。', + 'type' => 'string', + 'example' => 'tenantABC', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + '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' => '查询数据库列表', + ], + 'ModifyDatabaseDescription' => [ + 'summary' => '修改数据库的描述信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名称。 不能使用某些预留关键字，如 test、mysql。', + 'description' => '数据库名称。'."\n" + .'不能使用某些预留关键字，如 test、mysql。', + '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' => '请求 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":"<ModifyDatabaseDescriptionResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</ModifyDatabaseDescriptionResponse>","errorExample":""}]', + 'title' => '修改数据库描述', + ], + 'ModifyTenantUserStatus' => [ + 'summary' => '该接口用于锁定或解锁指定的数据库账号。', + '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' => '数据库账号名称。'."\n" + .'不能使用某些预留关键字，如 SYS、root 等。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pay_test', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'UserStatus', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库账号的状态。 Locked：锁定 Normal：解锁', + 'description' => '数据库账号的状态。 '."\n" + .'- LOCKED：锁定。'."\n" + .'- ONLINE：解锁。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'LOCKED', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'TenantUser' => [ + 'title' => '租户中的数据库账号信息', + 'description' => '租户中的数据库账号列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'UserStatus' => [ + 'title' => '数据库账号的状态。 - LOCKED：锁定 - ONLINE：解锁', + 'description' => '数据库账号的状态。 '."\n" + .'- LOCKED：锁定。'."\n" + .'- ONLINE：解锁。', + 'type' => 'string', + 'example' => 'LOCKED', + ], + 'UserName' => [ + 'title' => '账号名称。', + 'description' => '账号名称。', + 'type' => 'string', + 'example' => 'pay_test', + ], + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + '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' => '锁定或解锁指定的数据库账号', + ], + 'ModifyDatabaseUserRoles' => [ + 'summary' => '修改某一数据库的账号权限信息。', + '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' => '数据库名称。'."\n" + .'不能使用某些预留关键字，如 test、mysql。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sms_pre', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。仅支持 OceanBase MySQL 模式。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'Users', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户名及具备的角色列表。', + 'description' => '用户名及具备的角色列表。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"UserName":"oceanbase1","Role":"readwrite"},{"UserName":"oceanbase2","Role":"readonly"}]', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'TenantUser' => [ + 'title' => '账号信息。', + 'description' => '账号信息。', + 'type' => 'object', + 'properties' => [ + 'DatabaseName' => [ + 'title' => '数据库名称。', + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'sms_pre', + ], + 'Users' => [ + 'title' => '对数据库有赋权的账户信息', + 'description' => '对数据库有赋权的账户列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + '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' => '账号赋予该库的角色权限。 '."\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。', + 'type' => 'string', + 'example' => 'ReadOnly', + ], + 'UserName' => [ + 'title' => '账号名称。', + 'description' => '账号名称。', + 'type' => 'string', + 'example' => 'user_pay_ro', + ], + ], + ], + 'example' => '', + ], + 'TenantId' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'example' => 't33h8y08k****', + ], + ], + 'example' => '', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 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 \\"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' => '修改数据库用户角色', + ], + 'DeleteDatabases' => [ + 'summary' => '删除一个或多个已创建的数据库。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'DatabaseNames', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名称列表。 其为Json格式的数组，数组中每个对象都为数据库名称的字符串。', + 'description' => '数据库名称列表。'."\n" + .'其为 JSON 格式的数组，数组中每个对象都为数据库名称的字符串。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[\\"sms_pre\\", \\"pay_pre\\"]', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 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":"<DeleteDatabasesResponse>\\n <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>\\n</DeleteDatabasesResponse>","errorExample":""}]', + 'title' => '删除数据库', + ], + 'DescribeParameters' => [ + 'summary' => '查看参数信息列表。', + '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' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'Dimension', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数类型。 当前支持集群（CLUSTER)和租户（TENANT）', + 'description' => '参数类型。'."\n" + .'当前支持集群（CLUSTER）和租户（TENANT）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TENANT', + ], + ], + [ + 'name' => 'DimensionValue', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数类型的资源标识。 如果为集群参数可以不填，若为租户的参数，则传入租户的TenantId。', + 'description' => '参数类型的资源标识。 '."\n" + .'如果为集群参数可以不填，若为租户的参数，则传入租户的 TenantId。', + 'type' => 'string', + 'required' => false, + 'example' => 'ob2mr3oae0****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Parameters' => [ + 'title' => '参数列表信息', + 'description' => '参数列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => '参数的描述信息。', + 'description' => '参数的描述信息。', + 'type' => 'string', + 'example' => '弱读允许的最大时间延迟时间', + ], + 'ValueType' => [ + 'title' => '参数取值的类型。 其支持： - ENUM: 数值枚举 - RANGE: 数值范围 - TIME: 时间 - CAPACITY：存储容量值（K，M，G）', + 'description' => '参数取值的类型。其支持：'."\n" + .'- ENUM: 数值枚举。 '."\n" + .'- RANGE: 数值范围。 '."\n" + .'- TIME: 时间。 '."\n" + .'- STRING：字符串。'."\n" + .'- ENUM_MULTIPLE：数值枚举多选。'."\n" + .'- CAPACITY：存储容量值（K，M，G）。', + 'type' => 'string', + 'example' => 'CAPACITY', + ], + 'CurrentValue' => [ + 'title' => '参数的当前取值。', + 'description' => '参数的当前取值。', + 'type' => 'string', + 'example' => '600', + ], + 'NeedReboot' => [ + 'title' => '修改此参数是否需要重启 - true：需要重启 - false：不需要重启', + 'description' => '修改此参数是否需要重启。 '."\n" + .'- true：需要重启。 '."\n" + .'- false：不需要重启。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Name' => [ + 'title' => '参数名称。', + 'description' => '参数名称。', + 'type' => 'string', + 'example' => 'connect_timeout', + ], + 'DefaultValue' => [ + 'title' => '参数的默认取值。', + 'description' => '参数的默认取值。', + 'type' => 'string', + 'example' => '600s', + ], + 'RejectedValue' => [ + 'title' => '参数的不允许取值范围。 其格式为具备两个字符串元素的数组类型，表示一个范围值，第一个元素为最小值，第二个元素为最大值。', + 'description' => '参数的不允许取值范围。'."\n" + .'其格式为具备两个字符串元素的数组类型，表示一个范围值，第一个元素为最小值，第二个元素为最大值。', + 'type' => 'array', + 'items' => [ + 'description' => '参数的不允许取值范围。', + 'type' => 'string', + 'example' => '1s', + ], + ], + 'AcceptableValue' => [ + 'title' => '参数的可接受取值范围。 其格式为具备两个字符串元素的数组类型，表示一个范围值，第一个元素为最小值，第二个元素为最大值。', + 'description' => '参数的可接受取值范围。', + 'type' => 'array', + 'items' => [ + 'title' => 'ob317v4uif****', + 'description' => '参数的可接受取值范围。', + 'type' => 'string', + 'example' => '2s', + ], + ], + 'Readonly' => [ + 'title' => '参数是否只读', + 'description' => '参数是否只读。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Unit' => [ + 'title' => '参数值单位', + 'description' => '当前参数值单位。', + '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' => '查看参数信息列表', + ], + 'DescribeParametersHistory' => [ + 'summary' => '查看集群或租户的参数修改历史。', + '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' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'Dimension', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数类型。 当前支持集群（CLUSTER)和租户（TENANT）', + 'description' => '参数类型。 '."\n" + .'当前支持集群（CLUSTER）和租户（TENANT）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TENANT', + ], + ], + [ + 'name' => 'DimensionValue', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数类型的资源标识。 如果为集群参数可以不填，若为租户的参数，则传入租户的TenantId。', + 'description' => '参数类型的资源标识。 '."\n" + .'如为集群参数可不填，若为租户的参数，则传入租户的 TenantId。', + 'type' => 'string', + 'required' => false, + 'example' => 't4qx8****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数历史查看的起始时间。', + 'description' => '参数历史查看的起始时间。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-06-13 15:40:43', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数历史查看的结束时间。', + 'description' => '参数历史查看的结束时间。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-09-13 15:40:43', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'description' => '分页查询时设置的每页行数。 '."\n" + .'- 最大值：100。 '."\n" + .'- 默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => '分页查询的页码。'."\n" + .'- 起始值：1。 '."\n" + .'- 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999999', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Respond' => [ + 'description' => '参数修改历史列表。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总数，分页查询时生效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PageNumber' => [ + 'description' => '分页查询的页码。'."\n" + .'- 起始值：1。'."\n" + .'- 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Parameters' => [ + 'description' => '参数的描述信息。', + 'type' => 'array', + 'items' => [ + 'description' => '参数的描述信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '修改状态。 - APPLIED：成功 - SCHEDULING：待修改。', + 'description' => '修改状态。 - APPLIED：成功 - SCHEDULING：待修改。', + 'type' => 'string', + 'example' => 'APPLIED', + ], + 'OldValue' => [ + 'title' => '参数修改前的值。', + 'description' => '参数修改前的值。', + 'type' => 'string', + 'example' => '10', + ], + 'UpdateTime' => [ + 'title' => '参数修改的生效时间。', + 'description' => '参数修改的生效时间。', + 'type' => 'string', + 'example' => '2024-11-26T08:03:34Z', + ], + 'CreateTime' => [ + 'title' => '参数修改的发起时间。', + 'description' => '参数修改的发起时间。', + 'type' => 'string', + 'example' => '2024-11-26T08:03:34Z', + ], + 'DimensionValue' => [ + 'title' => '参数类型的资源标识。 如果为集群则为DEFAULT_DIMENSION_VALUE，若为租户的参数，则传入租户的TenantId。', + 'description' => '参数类型的资源标识。 如果为集群则为DEFAULT_DIMENSION_VALUE，若为租户的参数，则传入租户的TenantId。', + 'type' => 'string', + 'example' => 't69uo********', + ], + 'Name' => [ + 'title' => '参数名称。', + 'description' => '参数名称。', + 'type' => 'string', + 'example' => 'connect_timeout', + ], + 'NewValue' => [ + 'title' => '参数修改后的值', + 'description' => '参数修改后的值', + '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' => '查看参数修改历史', + ], + 'ModifyParameters' => [ + 'summary' => '修改集群或租户的参数。', + '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' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'DimensionValue', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数类型的资源标识。 如果为集群参数可以不填，若为租户的参数，则传入租户的TenantId。', + 'description' => '参数类型的资源标识。'."\n" + .'如为集群参数可不填，如为租户的参数，则传入租户的 TenantId。', + 'type' => 'string', + 'required' => false, + 'example' => 't4qx8****', + ], + ], + [ + 'name' => 'Dimension', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数类型。 当前支持集群（CLUSTER)和租户（TENANT）', + 'description' => '参数类型。 '."\n" + .'当前支持集群（CLUSTER）和租户（TENANT）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TENANT', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数信息。 其为一个Json格式的数组，数组中每个对象包括两个元素：参数名称（Name）和参数值（Value）。 注意：集群和租户可修改的参数名称和参数值的范围不同，详见DescribeParameters。', + 'description' => '参数信息。 '."\n" + .'其为一个 JSON 格式的数组，数组中每个对象包括两个元素：参数名称（Name）和参数值（Value）。'."\n" + ."\n" + .'> <br>集群和租户可修改的参数名称和参数值的范围不同，详见 DescribeParameters。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"Name":"connect_timeout","Value":"20"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Results' => [ + 'title' => '修改结果信息。', + 'description' => '修改结果信息。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否修改成功。 - true：修改成功 - false：修改失败', + 'description' => '是否修改成功。 '."\n" + .'- true：修改成功。'."\n" + .'- false：修改失败。', + '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' => '修改参数', + ], + 'DescribeSessionList' => [ + 'summary' => '该接口用于展示 OceanBase 云服务和业务之间的会话信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 't4louaeei****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => '查询对象信息。', + 'type' => 'array', + 'items' => [ + 'description' => '查询对象结果。', + 'type' => 'object', + 'properties' => [ + 'SessionId' => [ + 'title' => '代理服务的sesson Id', + 'description' => '代理服务的 Session ID。', + 'type' => 'string', + 'example' => '4325', + ], + 'Host' => [ + 'title' => '客户端地址，ip:port格式', + 'description' => '客户端地址，格式：ip:port。', + 'type' => 'string', + 'example' => '192.***.**.100:80', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询会话列表', + ], + 'BatchKillSessionList' => [ + 'summary' => '该接口用于批量关闭 OceanBase 云服务和业务之间的会话信息。该接口为异步执行，需要用户通过 DescribeSessionList 验证会话是否关闭成功。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'SessionList', + 'in' => 'formData', + 'schema' => [ + 'title' => '会话列表，用逗号拼接数组内容', + 'description' => '会话列表，用逗号拼接数组内容。'."\n" + ."\n" + .'> 会话信息来源于 DescribeSessionList 接口的返回结果。', + 'type' => 'string', + 'required' => true, + 'example' => '342,354,343', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\"\\n}","type":"json"}]', + 'title' => '批量关闭会话列表', + ], + 'BatchKillProcessList' => [ + 'summary' => '该接口为异步执行，用于批量关闭会话，需要用户通过接口 DescribeProcessStatsComposition 二次确认。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'SessionList', + 'in' => 'formData', + 'schema' => [ + 'description' => '会话列表。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"ProxySessId":"752113700739156671","SessionId":3221555062,"ServerIp":"10.***.**.***"}] ', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 't33h8y08k****', + ], + ], + [ + 'name' => 'ByObSessionId', + 'in' => 'formData', + 'schema' => [ + 'title' => '表示是否根据指定的数据库连接ID来进行kill操作。默认为false，根据代理链接ID来进行KILL对应的所有数据库连接；', + 'description' => '表示是否根据指定的数据库连接ID来进行kill操作。默认为false，根据代理链接ID来进行KILL对应的所有数据库连接；', + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => '返回结果数组。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '是否调用成功。', + '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' => '批量关闭会话', + ], + 'DescribeProcessStatsComposition' => [ + 'summary' => '该接口用于查询会话信息。', + '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' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob********', + ], + ], + [ + 'name' => 'UId', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'OceanBase 数据库用户标识符。', + 'type' => 'string', + 'required' => false, + 'example' => '139*************', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户(如果是集群任务就不填)', + 'description' => '租户 ID，必填选项。', + 'type' => 'string', + 'required' => false, + 'example' => 't********', + ], + ], + [ + 'name' => 'SqlText', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询结束时间', + 'description' => 'SQL 语句，支持 LIKE 查询，可以只指定 SQL 语句的部分子句。', + 'type' => 'string', + 'required' => false, + 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC', + ], + ], + [ + 'name' => 'ClientIp', + 'in' => 'formData', + 'schema' => [ + 'description' => '客户端 IP。', + 'type' => 'string', + 'required' => false, + 'example' => '127.*.*.*', + ], + ], + [ + 'name' => 'ServerIp', + 'in' => 'formData', + 'schema' => [ + 'description' => '服务器 IP。', + 'type' => 'string', + 'required' => false, + 'example' => '127.*.*.*', + ], + ], + [ + 'name' => 'Users', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据库用户名。', + 'type' => 'string', + 'required' => false, + 'example' => '["test_user"]', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '会话状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'ACTIVE', + ], + ], + [ + 'name' => 'MergeDynamicSql', + 'in' => 'formData', + 'schema' => [ + 'description' => '返回结果时，是否合并动态 SQL。'."\n" + .'> <br>表示输出结果时，是否聚合 in 查询的SQL 的结果。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalSessionCount' => [ + 'description' => '总会话数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'ActiveSessionCount' => [ + 'description' => '活跃会话数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '60', + ], + 'IdleSessionCount' => [ + 'description' => 'SLEEP 状态会话数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'AllProcessList' => [ + 'description' => '所有会话详细信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SqlText' => [ + 'description' => 'SQL 文本。', + 'type' => 'string', + 'example' => 'select * from c1 where id = 100;', + ], + 'TenantId' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'example' => 't********', + ], + 'Database' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'c1', + ], + 'User' => [ + 'description' => '该会话所属的用户。', + 'type' => 'string', + 'example' => 'test_user', + ], + 'ExecuteTime' => [ + 'description' => '根据是否执行命令：'."\n" + ."\n" + .'- 如果是在接收请求后且在返回客户端之前，表示从接收请求到当前时间的间隔'."\n" + ."\n" + .'- 如果是非接受请求情况下的状态, 表示当前状态的持续时间'."\n" + ."\n" + .'单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'CpuTime' => [ + 'description' => '当前命令执行 CPU 使用时间，单位：s。 '."\n" + .'> '."\n" + .'> 该字段从 V3.2.4 BP5 版本开始引入', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ServerIp' => [ + 'description' => '服务器 IP 地址。', + 'type' => 'string', + 'example' => 'xx.xx.xx.xx', + ], + 'ClientIp' => [ + 'description' => '客户端 IP。', + 'type' => 'string', + 'example' => 'xx.xx.xx.xx', + ], + 'SessionId' => [ + 'description' => '会话 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '322441****', + ], + 'ProxySessId' => [ + 'description' => '如果当前客户端是 ODP，则本列展示 ODP 的 Session ID。', + 'type' => 'string', + 'example' => '7521015416********', + ], + 'Command' => [ + 'description' => '该会话正在执行的命令。', + 'type' => 'string', + 'example' => 'Query', + ], + 'Status' => [ + 'description' => '该会话当前的状态。', + 'type' => 'string', + 'example' => 'ACTIVE', + ], + 'SqlId' => [ + 'description' => 'SQL ID。', + 'type' => 'string', + 'example' => '45CCBDC7DEBDCDAXXXXAFC********', + ], + 'TraceId' => [ + 'description' => 'Trace ID。', + 'type' => 'string', + 'example' => 'YB420XXX128-00062XXXX8313XXX1-X-X', + ], + 'PlanId' => [ + 'description' => '执行计划 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1898', + ], + 'DynamicSql' => [ + 'description' => '是否为动态 SQL。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ProcessSqlLists' => [ + 'title' => '子 SQL 列表', + 'description' => '子 SQL 列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SqlText' => [ + 'description' => 'SQL 文本。', + 'type' => 'string', + 'example' => 'select * from c1 where id = 100;', + ], + 'TenantId' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'example' => 't********', + ], + 'Database' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'c2', + ], + 'User' => [ + 'description' => '该会话所属的用户。', + 'type' => 'string', + 'example' => 'test_user', + ], + 'ExecuteTime' => [ + 'description' => '根据是否执行命令：'."\n" + ."\n" + .'- 如果是在接收请求后且在返回客户端之前，表示从接收请求到当前时间的间隔'."\n" + ."\n" + .'- 如果是非接受请求情况下的状态, 表示当前状态的持续时间'."\n" + ."\n" + .'单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'CpuTime' => [ + 'description' => '当前命令执行 CPU 使用时间，单位：s。 '."\n" + .'> '."\n" + .'> 该字段从 V3.2.4 BP5 版本开始引入', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ServerIp' => [ + 'description' => '服务器 IP 地址。', + 'type' => 'string', + 'example' => 'xx.xx.xx.xx', + ], + 'ClientIp' => [ + 'description' => '客户端 IP。', + 'type' => 'string', + 'example' => 'xx.xx.xx.xx', + ], + 'SessionId' => [ + 'description' => '会话 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '322441****', + ], + 'ProxySessId' => [ + 'description' => '如果当前客户端是 ODP，则本列展示 ODP 的 Session ID。', + 'type' => 'string', + 'example' => '7521015416********', + ], + 'Command' => [ + 'description' => '该会话正在执行的命令。', + 'type' => 'string', + 'example' => 'Query', + ], + 'Status' => [ + 'description' => '该会话当前的状态。', + 'type' => 'string', + 'example' => 'ACTIVE', + ], + 'SqlId' => [ + 'description' => 'SQL ID。', + 'type' => 'string', + 'example' => '45CCBDC7DEBDCDAXXXXAFC********', + ], + 'TraceId' => [ + 'description' => 'Trace ID。', + 'type' => 'string', + 'example' => 'YB420XXX128-00062XXXX8313XXX1-X-X', + ], + 'PlanId' => [ + 'description' => '执行计划 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1898', + ], + 'DynamicSql' => [ + 'description' => '是否为动态 SQL。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ProcessSqlList' => [ + 'title' => '子 SQL 列表', + 'description' => '子 SQL 列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SqlText' => [ + 'description' => 'SQL 文本。', + 'type' => 'string', + 'example' => 'select * from c1 where id = 100;', + ], + 'TenantId' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'example' => 't********', + ], + 'Database' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'c3', + ], + 'User' => [ + 'description' => '该会话所属的用户。', + 'type' => 'string', + 'example' => 'test_user', + ], + 'ExecuteTime' => [ + 'description' => '根据是否执行命令：'."\n" + ."\n" + .'- 如果是在接收请求后且在返回客户端之前，表示从接收请求到当前时间的间隔'."\n" + ."\n" + .'- 如果是非接受请求情况下的状态, 表示当前状态的持续时间'."\n" + ."\n" + .'单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'CpuTime' => [ + 'description' => '当前命令执行 CPU 使用时间，单位：s。 '."\n" + .'> '."\n" + .'> 该字段从 V3.2.4 BP5 版本开始引入', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ServerIp' => [ + 'description' => '服务器 IP 地址。', + 'type' => 'string', + 'example' => 'xx.xx.xx.xx', + ], + 'ClientIp' => [ + 'description' => '客户端 IP。', + 'type' => 'string', + 'example' => 'xx.xx.xx.xx', + ], + 'SessionId' => [ + 'description' => '会话 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '322441****', + ], + 'ProxySessId' => [ + 'description' => '如果当前客户端是 ODP，则本列展示 ODP 的 Session ID。', + 'type' => 'string', + 'example' => '7521015416********', + ], + 'Command' => [ + 'description' => '该会话正在执行的命令。', + 'type' => 'string', + 'example' => 'Query', + ], + 'Status' => [ + 'description' => '该会话当前的状态。', + 'type' => 'string', + 'example' => 'ACTIVE', + ], + 'SqlId' => [ + 'description' => 'SQL ID。', + 'type' => 'string', + 'example' => '45CCBDC7DEBDCDAXXXXAFC********'."\n", + ], + 'TraceId' => [ + 'description' => 'Trace ID。', + 'type' => 'string', + 'example' => 'YB420XXX128-00062XXXX8313XXX1-X-X', + ], + 'PlanId' => [ + 'description' => '执行计划 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1898', + ], + 'DynamicSql' => [ + 'description' => '是否为动态 SQL。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + 'ServerSn' => [ + 'description' => '节点 ID。', + 'type' => 'string', + 'example' => 'i-bp1*****sw64dhb*****', + ], + ], + ], + ], + 'SessionStatistics' => [ + 'description' => '按照不同来源的会话统计。', + 'type' => 'object', + 'properties' => [ + 'UserStatistics' => [ + 'description' => '按照用户维度的会话统计。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricValue' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'test_user', + ], + 'ActiveCount' => [ + 'description' => '活跃会话数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25', + ], + 'TotalCount' => [ + 'description' => '总数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'Type' => [ + 'description' => 'user。', + 'type' => 'string', + 'example' => 'user', + ], + ], + ], + ], + 'SourceStatistics' => [ + 'description' => '按照 Client 维度的会话统计。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricValue' => [ + 'description' => '用户客户端 IP。', + 'type' => 'string', + 'example' => 'xx.xx.xx.xx', + ], + 'ActiveCount' => [ + 'description' => '活跃会话数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25', + ], + 'TotalCount' => [ + 'description' => '总数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'Type' => [ + 'description' => 'client。', + 'type' => 'string', + 'example' => 'client', + ], + ], + ], + ], + 'DataBaseStatistics' => [ + 'description' => '按照数据库维度的会话统计。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricValue' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'test_database', + ], + 'ActiveCount' => [ + 'description' => '活跃会话数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25', + ], + 'TotalCount' => [ + 'description' => '总数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'Type' => [ + 'description' => 'database。', + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + 'ObVersion' => [ + 'title' => 'Ob版本号', + 'description' => 'Ob版本号', + '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' => '查询会话信息', + ], + 'KillProcessList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'SessionList', + 'in' => 'formData', + 'schema' => [ + 'description' => '需要关闭的会话列表。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '['."\n" + .' {'."\n" + .' "ServerIp": "192.***.**.***",'."\n" + .' "SessionId": "322161****"'."\n" + .' }'."\n" + .']', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 't4louaeei****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '请求返回的信息。', + 'type' => 'object', + 'properties' => [ + 'SessionId' => [ + 'description' => '会话 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1123', + ], + 'ServerIp' => [ + 'description' => '服务器 IP。', + 'type' => 'string', + 'example' => '127.*.*.*', + ], + 'Status' => [ + 'description' => '任务状态。', + 'type' => 'string', + 'example' => 'SLEEP', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Instance not found.', + ], + 'ClientIp' => [ + 'description' => '客户端 IP。', + 'type' => 'string', + 'example' => '127.*.*.*', + ], + 'TenantId' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'example' => 't3ogq******n4', + ], + 'User' => [ + 'description' => '数据库用户名。', + 'type' => 'string', + 'example' => 'oas', + ], + 'Database' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'SqlText' => [ + 'description' => 'SQL 语句。', + 'type' => 'string', + 'example' => ':', + ], + 'Command' => [ + 'description' => '应用容器启动命令。', + 'type' => 'string', + 'example' => 'select 1', + ], + 'ExecuteTime' => [ + 'description' => '执行时间 (UTC+8)，为空立即执行。', + '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' => '关闭指定的会话', + 'summary' => '关闭指定的会话。', + 'description' => '<props="china">为优化用户体验，云数据库对会话功能进行了升级，本接口将下线并由新的接口替代，详情请参见 [【通知】云数据库会话管理 API 接口变更说明'."\n" + .'](https://help.aliyun.com/document_detail/2788792.html?spm=a2c4g.292641.0.0.391b4719nop80f)。</props>'."\n" + .'<props="intl">为优化用户体验，云数据库对会话功能进行了升级，本接口将下线并由新的接口替代，详情请参见 [【通知】云数据库会话管理 API 接口变更说明'."\n" + .'](https://www.alibabacloud.com/help/zh/apsaradb-for-oceanbase/latest/notification-cloud-database-session-management-api-interface-downline)。</props>', + ], + 'DescribeOasAnomalySQLList' => [ + 'summary' => '该接口用于查询诊断系统判定可能存在性能问题的 SQL 列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '监控数据的起始时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T04:38:38Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '监控数据的结束时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T05:38:38Z', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'db_****', + ], + ], + [ + 'name' => 'SearchKeyWord', + 'in' => 'formData', + 'schema' => [ + 'description' => '关键字查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'update', + ], + ], + [ + 'name' => 'SearchParam', + 'in' => 'formData', + 'schema' => [ + 'description' => '参数查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'cputime', + ], + ], + [ + 'name' => 'SearchRule', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询规则。 '."\n" + .'该参数取值包括："="，">"， “>=”， “<”，“<="', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + ], + [ + 'name' => 'SearchValue', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询值。', + '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' => '节点 IP。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp19y05uq6x*********', + ], + ], + [ + 'name' => 'FilterCondition', + 'in' => 'formData', + 'schema' => [ + 'description' => '所有字段通过 @ 来引用。可选字段请参考[查询 SQL 的性能统计](https://www.oceanbase.com/docs/community-ocp-cn-10000000001832433)接口返回的所有列。', + 'type' => 'string', + 'required' => false, + 'example' => '@avgCpuTime > 20 and @executions > 100', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => [ + 'description' => '返回数据的语言。 '."\n" + .'默认值：中国 CN，国外 EN。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + [ + 'name' => 'SqlTextLength', + 'in' => 'formData', + 'schema' => [ + 'description' => '返回 SQL 文本的最大长度。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '65535', + ], + ], + [ + 'name' => 'Current', + 'in' => 'formData', + 'schema' => [ + 'description' => '当前页。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询的页码。'."\n" + .'- 起始值：1。'."\n" + .'- 默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否动态SQL', + 'description' => '是否动态 SQL。'."\n" + .'> <br>表示传入的 SQL ID 是否为动态 SQL 的 ID。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'MergeDynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '返回结果时，是否合并动态 SQL', + 'description' => '返回结果时，是否合并动态 SQL。'."\n" + .'> <br>表示输出结果时，是否聚合 in 查询的SQL 的结果。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '可疑SQL的个数', + 'description' => '可疑 SQL 信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可疑 SQL 信息。', + 'type' => 'object', + 'properties' => [ + 'AvgCpuTime' => [ + 'title' => '可疑SQL的平均cpu时间', + 'description' => '可疑 SQL 的平均 CPU 时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.24', + ], + 'AvgElapsedTime' => [ + 'title' => '可疑SQL的平均响应时间', + 'description' => '可疑 SQL 的平均响应时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.28', + ], + 'AvgGetPlanTime' => [ + 'title' => '可疑SQL的平均获取执行计划的时间', + 'description' => '可疑 SQL 的平均获取执行计划的时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CpuTime' => [ + 'title' => '可疑SQL的cpu时间', + 'description' => '可疑 SQL 的 CPU 时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.23', + ], + 'DbName' => [ + 'title' => '数据库名', + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'db_***', + ], + 'DiagTypes' => [ + 'title' => '诊断类型', + 'description' => '诊断类型。', + 'type' => 'array', + 'items' => [ + 'description' => '诊断类型。', + 'type' => 'string', + 'example' => '['."\n" + .' "CPU_TIME_PROPORTION_HIGH"'."\n" + .']', + ], + ], + 'Diagnosis' => [ + 'title' => '诊断详情', + 'description' => '诊断详情。'."\n" + .'> <br>此参数已废弃。', + 'type' => 'string', + 'example' => '-', + ], + 'Executions' => [ + 'title' => '可疑SQL的总执行次数', + 'description' => '可疑 SQL 的总执行次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'LastExecutedTime' => [ + 'description' => '最后一次执行可疑 SQL 的时间。', + 'type' => 'string', + 'example' => '2023-04-12T04:38:38Z', + ], + 'RiskLevel' => [ + 'title' => '危险等级', + 'description' => '危险等级。', + 'type' => 'string', + 'example' => 'high', + ], + 'SqlId' => [ + 'title' => 'sql id ', + 'description' => 'SQL ID。', + 'type' => 'string', + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + 'SqlTextShort' => [ + 'title' => 'sql文本前缀', + 'description' => 'SQL 文本前缀。', + 'type' => 'string', + 'example' => 'delete /*+ XXX PARALLEL(4) */ from', + ], + 'Suggestion' => [ + 'title' => '可疑SQL的建议', + 'description' => '可疑 SQL 的建议。', + 'type' => 'string', + 'example' => 'review', + ], + 'SumElapsedTime' => [ + 'description' => '可疑 SQL 的总响应时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '11452126.36', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'test_user', + ], + 'DynamicSql' => [ + 'title' => '是否动态SQL', + 'description' => '是否动态 SQL。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SqlList' => [ + 'description' => 'SQL 列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'SQL 列表。', + 'type' => 'object', + 'properties' => [ + 'AvgCpuTime' => [ + 'title' => '可疑SQL的平均cpu时间', + 'description' => '平均 CPU 时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.24', + ], + 'AvgElapsedTime' => [ + 'title' => '可疑SQL的平均响应时间', + 'description' => '平均响应时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.28', + ], + 'AvgGetPlanTime' => [ + 'title' => '可疑SQL的平均获取执行计划的时间', + 'description' => '生成计划的平均时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CpuTime' => [ + 'title' => '可疑SQL的cpu时间', + 'description' => '总 CPU 时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.23', + ], + 'DbName' => [ + 'title' => '数据库名', + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'test_hsp****eway', + ], + 'DiagTypes' => [ + 'title' => '诊断类型', + 'description' => '诊断类型。', + 'type' => 'array', + 'items' => [ + 'description' => '诊断类型。', + 'type' => 'string', + 'example' => '['."\n" + .' "CPU_TIME_PROPORTION_HIGH"'."\n" + .' ]', + ], + ], + 'Diagnosis' => [ + 'title' => '诊断详情', + 'description' => '诊断详情。'."\n" + .'> <br>此参数已废弃。', + 'type' => 'string', + 'example' => '-', + ], + 'Executions' => [ + 'title' => '可疑SQL的总执行次数', + 'description' => '总执行次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'LastExecutedTime' => [ + 'description' => '最后一次运行时间。', + 'type' => 'string', + 'example' => '2023-04-12T04:38:38Z', + ], + 'RiskLevel' => [ + 'title' => '危险等级', + 'description' => '危险等级。', + 'type' => 'string', + 'example' => 'LOW', + ], + 'SqlId' => [ + 'title' => 'sql id ', + 'description' => 'SQL ID', + 'type' => 'string', + 'example' => '3A645****789F13DE0CF6D084FF9****', + ], + 'SqlTextShort' => [ + 'title' => 'sql文本前缀', + 'description' => 'SQL 文本。', + 'type' => 'string', + 'example' => 'select * from test', + ], + 'Suggestion' => [ + 'title' => '可疑SQL的建议', + 'description' => '可疑 SQL 的建议。', + 'type' => 'string', + 'example' => '{\'Role\': \'eSG\', \'Result\': \'100\', \'Suggestion\': \'TRACER_OTHER_ERR\'}', + ], + 'SumElapsedTime' => [ + 'description' => '总响应时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '11452126.36', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'test_user', + ], + 'AvgDbTime' => [ + 'title' => '平均数据库时间', + 'description' => '平均数据库时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SumDbTime' => [ + 'title' => '总数据库时间', + 'description' => '总数据库时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'AvgRetryCount' => [ + 'description' => '平均重试次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '4', + ], + 'SumRetryCount' => [ + 'description' => '总重试次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '6', + ], + 'AvgLogicalReads' => [ + 'description' => '平均逻辑读次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '25', + ], + 'FormatSqlId' => [ + 'title' => 'FormatSqlId', + 'description' => 'FormatSqlId', + 'type' => 'string', + ], + ], + ], + ], + 'AvgDbTime' => [ + 'description' => '平均数据库时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SumDbTime' => [ + 'title' => '总数据库时间', + 'description' => '总数据库时间', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'AvgRetryCount' => [ + 'description' => '平均重试次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '4', + ], + 'SumRetryCount' => [ + 'description' => '总重试次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '6', + ], + 'AvgLogicalReads' => [ + 'description' => '平均逻辑读次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '25', + ], + 'FormatSqlId' => [ + 'title' => 'FormatSqlId', + 'description' => 'FormatSqlId', + 'type' => 'string', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '473469**-AA6F-4D**-B3DB-A***********', + ], + 'TotalCount' => [ + 'description' => '总数量。', + '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' => '查询可疑 SQL 列表', + ], + 'DescribeSampleSqlRawTexts' => [ + 'summary' => '该接口用于查询采样 SQL 的原始文本。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '起始时间。'."\n" + ."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-04-12T04:38:38Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '结束时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-04-12T05:38:38Z', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'SqlId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'SQL ID。', + 'type' => 'string', + 'required' => true, + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + ], + [ + 'name' => 'TraceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '执行查询的 traceId， 对应 Slow SQL 明细中的 traceId。'."\n" + .'> '."\n" + .'> 并非所有 Slow SQL 的 traceId 都能查询到原始文本。', + 'type' => 'string', + 'required' => false, + 'example' => 'YB420A700EFB-00060D53E42D0C61-0-0', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'formData', + 'schema' => [ + 'description' => '用于控制 SQL 返回行数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否为聚合sql', + 'description' => '是否为聚合sql', + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => '数据列表信息。', + 'type' => 'object', + 'properties' => [ + 'SqlText' => [ + 'description' => 'SQL 语句。', + 'type' => 'array', + 'items' => [ + 'description' => 'SQL 语句。', + 'type' => 'string', + 'example' => '{'."\n" + .' "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",'."\n" + .' "Data": {'."\n" + .' "SqlText": ['."\n" + .' "\\"INSERT INTO test (id, k, c, pad) VALUES (36, 87, 11,62582 )\\""'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询采样SQL的原始文本', + ], + 'DescribeOasSQLDetails' => [ + 'summary' => '查询 SQL 详细信息，包括 SQL 文本、涉及的表名等信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Oceanbase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户 ID。', + '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' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询 SQL 执行计划的起始时间。'."\n" + ."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T04:38:38Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询 SQL 执行计划的结束时间。'."\n" + ."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T05:38:38Z', + ], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否动态SQL', + 'description' => '是否为动态 SQL。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ParseTable', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否解析表结构', + 'description' => '是否解析表结构', + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => 'SQL 执行计划信息列表。', + 'type' => 'object', + 'properties' => [ + 'Fulltext' => [ + 'title' => 'SQL 文本', + 'description' => '由于脱敏，内容与参数 statement 一致。', + 'type' => 'string', + 'example' => 'select * from test where id = ?', + ], + 'Tables' => [ + 'title' => 'SQL 涉及的表名', + 'description' => 'SQL 涉及的表名。', + 'type' => 'array', + 'items' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => '[{"xxxx","xxxx","xxxx"},{...}...]', + ], + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => '用户名称。', + 'type' => 'string', + 'example' => 'test_user', + ], + 'Statement' => [ + 'title' => '参数化后的文本', + 'description' => '参数化后的文本。', + 'type' => 'string', + 'example' => 'select * from test where id = ?', + ], + 'DbName' => [ + 'description' => '数据库名称。', + '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' => '查询 SQL 详细信息', + ], + 'DescribeOasSQLPlans' => [ + 'summary' => '根据 SQLID 查询诊断系统存储的 SQL 执行计划信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询 SQL 执行计划的起始时间。'."\n" + ."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T04:38:38Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询 SQL 执行计划的结束时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T05:38:38Z', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据库名称。', + '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' => '支持的语言。取值：'."\n" + .'- 中文：zh-CN'."\n" + .'- 英文：en-US', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否动态SQL', + 'description' => '是否为动态 SQL。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PlanUnionHash', + 'in' => 'formData', + 'schema' => [ + 'description' => '执行计划的唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'c4e9aaa797428df9a5a41828********', + ], + ], + [ + 'name' => 'ReturnBriefInfo', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否返回简要的执行计划信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'FormatSqlId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'format sqlId', + 'description' => 'format sqlId', + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => 'SQL 执行计划信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'SQL 执行计划信息。', + 'type' => 'object', + 'properties' => [ + 'PlanHash' => [ + 'description' => 'SQL 执行计划在诊断系统内部的标识。', + 'type' => 'string', + 'example' => '1758****24913166****', + ], + 'Plans' => [ + 'title' => '执行计划列表', + 'description' => '执行计划列表。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Uid' => [ + 'title' => 'Plan的唯一标识', + 'description' => 'Plan 的唯一标识。', + 'type' => 'string', + 'example' => 'AAAAAAAAAAI****AAFoT2QAF--7W****', + ], + 'PlanId' => [ + 'description' => '计划 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '590****', + ], + 'FirstLoadTime' => [ + 'title' => 'Plan首次被加载的时间', + 'description' => 'Plan 首次被加载的时间。', + 'type' => 'string', + 'example' => '2023-04-12T04:46:38Z', + ], + 'PlanType' => [ + 'title' => 'Plan的类型：LOCAL、REMOTE、DIST', + 'description' => 'Plan 类型：LOCAL、REMOTE、DIST。', + 'type' => 'string', + 'example' => 'LOCAL', + ], + 'PlanHash' => [ + 'description' => 'SQL 执行计划在诊断系统内部的标识。', + 'type' => 'string', + 'example' => '-86290582****886880', + ], + 'PlanSize' => [ + 'description' => '计划大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10****', + ], + 'SchemaVersion' => [ + 'description' => 'Schema 版本。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16838****3550464', + ], + 'MergedVersion' => [ + 'description' => '合并版本。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '513', + ], + 'ObServerId' => [ + 'description' => 'server ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ObDbId' => [ + 'description' => '数据库 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11006****828', + ], + 'ServerId' => [ + 'description' => '后端服务器实例 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'FirstLoadTimeUs' => [ + 'description' => '首次加载时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1684****03289441', + ], + 'HitDiagnosis' => [ + 'description' => '是否命中诊断。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'OutlineData' => [ + 'title' => 'Plan的outline_data字段', + 'description' => 'SQL 执行计划的 outline_data 字段。', + 'type' => 'string', + 'example' => '/*+ BEGIN_OUTLINE_DATA INDEX(@\\"SEL$1\\', + ], + 'OutlineId' => [ + 'description' => 'Outline ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'CollectTimeUs' => [ + 'description' => '收集时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1684368****00000', + ], + 'Server' => [ + 'title' => 'server信息', + 'description' => 'SQL 执行所在的 Server。', + 'type' => 'string', + 'example' => 'i-bp1db1a9us038****jio', + ], + 'HitPercentage' => [ + 'description' => '命中率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.0', + ], + 'Executions' => [ + 'description' => '期间的总执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExecPs' => [ + 'description' => '期间的平均每秒执行次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.31', + ], + 'AvgDiskReads' => [ + 'description' => '期间内的平均物理读次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgDiskWrites' => [ + 'description' => '期间内的平均物理写入次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgBufferGets' => [ + 'description' => '计划在期间内的平均缓存读次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '30137.03', + ], + 'AvgApplicationWaitTime' => [ + 'description' => '期间内的平均 Application 事件等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgConcurrencyWaitTime' => [ + 'description' => '期间内的平均 Concurrency 事件等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgUserIoWaitTime' => [ + 'description' => '期间内的平均 UserIo 事件等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgRowProcessed' => [ + 'description' => '期间内的平均行处理等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.0', + ], + 'AvgElapsedTime' => [ + 'description' => '期间内的平均间隔等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1876.78', + ], + 'AvgCpuTime' => [ + 'description' => '期间内的平均 CPU 时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1875.34', + ], + 'LargeQueryPercentage' => [ + 'description' => '长时间执行查询的完成百分比。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'DelayedLargeQueryPercentage' => [ + 'description' => '长时间执行查询的延迟百分比。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'TimeoutPercentage' => [ + 'description' => '超时百分比。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'TableScan' => [ + 'description' => '是否全表扫描。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'PlanUnionHash' => [ + 'description' => 'SQL 执行计划在诊断系统内部的唯一标识。', + 'type' => 'string', + 'example' => '"52c7c53****53e61b3f7586b17****ad"', + ], + 'SqlId' => [ + 'description' => 'SQL ID。', + 'type' => 'string', + 'example' => '46939C87ECA****95ED0FF64F44B****', + ], + 'SqlText' => [ + 'type' => 'string', + ], + ], + ], + ], + 'MergedVersion' => [ + 'description' => '合并版本。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '513', + ], + 'FirstLoadTime' => [ + 'title' => '首次加载时间', + 'description' => '首次加载时间', + 'type' => 'string', + 'example' => '2023-04-12T04:46:38Z', + ], + 'PlanType' => [ + 'title' => '执行计划类型', + 'description' => '执行计划类型。', + 'type' => 'string', + 'example' => 'LOCAL', + ], + 'HitDiagnosis' => [ + 'description' => '是否命中诊断。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'HitPercentage' => [ + 'description' => '命中率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.0', + ], + 'AvgCpuTime' => [ + 'description' => '期间内的平均 CPU 时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1875.34', + ], + 'PlanExplain' => [ + 'title' => '执行计划', + 'description' => '执行计划。', + 'type' => 'object', + 'properties' => [ + 'PlanJsonString' => [ + 'description' => 'SQL 执行计划的 JSON 字符串。', + 'type' => 'string', + 'example' => '"PlanJsonString":"{\\"RootOperations\\":[{\\"Children\\":[{\\"Children\\":[{\\"Cost\\":2000,\\"ObjectName\\":\\"TR\\",\\"Operator\\":\\"PHY_TABLE_SCAN\\",\\"Property\\":\\"table_rows:8593, physical_range_rows:85, logical_range_rows:85, index_back_rows:0, output_rows:85, est_method:default_stat, avaiable_index_name[ALL_VIRTUAL_AGENT]\\",\\"Rows\\":86},{\\"Children\\":[{\\"Cost\\":2000,\\"ObjectName\\":\\"NA\\",\\"Operator\\":\\"PHY_TABLE_SCAN\\",\\"Property\\":\\"table_rows:1750, physical_range_rows:17, logical_range_rows:17, index_back_rows:0, output_rows:17, est_method:default_stat, avaiable_index_name[ALL_VIRTUAL_AGENT]\\",\\"Rows\\":18}],\\"Cost\\":2013,\\"ObjectName\\":\\"NULL\\",\\"Operator\\":\\"PHY_SORT\\",\\"Property\\":\\"NULL\\",\\"Rows\\":18}],\\"Cost\\":4024,\\"ObjectName\\":\\"NULL\\",\\"Operator\\":\\"PHY_MERGE_JOIN\\",\\"Property\\":\\"NULL\\",\\"Rows\\":26}],\\"Cost\\":4025,\\"ObjectName\\":\\"NULL\\",\\"Operator\\":\\"PHY_SCALAR_AGGREGATE\\",\\"Property\\":\\"NULL\\",\\"Rows\\":1}]}"', + ], + ], + ], + 'Executions' => [ + 'description' => '执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PlanUnionHash' => [ + 'description' => 'SQL 执行计划在诊断系统内部的唯一标识。', + 'type' => 'string', + 'example' => '"52c7c53****53e61b3f7586b17****ad"', + ], + 'QuerySql' => [ + 'description' => '查询语句。'."\n" + .'> <br>暂未使用，恒为空。', + 'type' => 'string', + 'example' => '"select 1 from t"', + ], + 'Bounded' => [ + 'description' => '是否绑定该执行计划。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'TableScan' => [ + 'title' => '该计划是否包含全表扫描', + 'description' => '该计划是否包含全表扫描', + 'type' => 'boolean', + 'example' => 'false', + ], + 'OutlineId' => [ + 'title' => '该计划使用的 outline id', + 'description' => '该计划使用的 outline id', + 'type' => 'string', + 'example' => '3********', + ], + 'OutlineStatus' => [ + 'title' => '该计划使用outline时的状态，“已生效” 表示该计划的 outline_data 与 outline的 outlIne_content 能完全匹配上，“未知” 表示，无法判断状态。', + 'description' => '该计划使用outline时的状态，“已生效” 表示该计划的 outline_data 与 outline的 outlIne_content 能完全匹配上，“未知” 表示，无法判断状态。', + 'type' => 'string', + 'example' => '已生效', + ], + 'ByFormatSqlId' => [ + 'title' => '是否为模糊绑定', + 'description' => '是否为模糊绑定', + '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' => '查询 SQL 执行计划', + ], + 'DescribeSQLSamples' => [ + 'summary' => '查询慢 SQL 执行明细的采样数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查看慢 SQL 执行的起始时间。'."\n" + ."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T04:38:38Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查看慢 SQL 执行的结束时间。'."\n" + ."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T05:38:38Z', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据库名称。', + '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' => '是否返回 SQL 文本。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '请求的返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => '慢 SQL 执行明细的采样信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '慢 SQL 执行明细的采样信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'TraceId' => [ + 'title' => 'TraceId', + 'description' => '跟踪 ID。', + 'type' => 'string', + 'example' => 'YB42C****-0005E303D1****-0-0', + ], + 'RequestTime' => [ + 'title' => 'SQL的请求时间', + 'description' => 'SQL 的请求时间。', + 'type' => 'string', + 'example' => '2023-04-12T04:46:38Z', + ], + 'Server' => [ + 'title' => 'String SQL执行所在的Server（svr_ip:svr_port）', + 'description' => 'SQL 执行所在的 Server。', + 'type' => 'string', + 'example' => 'i-bp1db1****8uemejio', + ], + 'ClientIp' => [ + 'title' => '客户端Ip', + 'description' => '客户端 IP。', + 'type' => 'string', + 'example' => 'i-bp1db****38uemejio', + ], + 'ClientPort' => [ + 'description' => '客户端端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4****', + ], + 'DbName' => [ + 'title' => 'SQL访问的数据库', + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'test_db', + ], + 'UserName' => [ + 'title' => 'SQL的用户', + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'test_user', + ], + 'SqlType' => [ + 'title' => 'SQL的类型', + 'description' => 'SQL 类型。', + 'type' => 'string', + 'example' => 'select', + ], + 'PlanId' => [ + 'description' => '执行计划 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '590****', + ], + 'AffectedRows' => [ + 'description' => '期间内平均更新行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000.0', + ], + 'ReturnRows' => [ + 'description' => '期间内平均返回行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0.0', + ], + 'PartitionCount' => [ + 'description' => '期间内平均访问分区数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1.0', + ], + 'RetCode' => [ + 'description' => '结果码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'WaitEvent' => [ + 'title' => '期间内的最长等待事件', + 'description' => '期间内的最长等待事件。', + 'type' => 'string', + 'example' => 'none', + ], + 'WaitTime' => [ + 'title' => '等待时间（毫秒)', + 'description' => '等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'WaitCount' => [ + 'description' => '等待次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0.0', + ], + 'RpcCount' => [ + 'description' => '发送 RPC 次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8.0', + ], + 'PlanType' => [ + 'title' => '计划类型', + 'description' => '计划类型。', + 'type' => 'string', + 'example' => 'LOCAL', + ], + 'Inner' => [ + 'title' => '是否内部SQL', + 'description' => '是否内部 SQL。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ExecutorRpc' => [ + 'description' => '是否发起 RPC。', + 'type' => 'boolean', + 'example' => '0.0', + ], + 'HitPlan' => [ + 'description' => '是否命中执行计划。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ElapsedTime' => [ + 'title' => '响应时间（毫秒）', + 'description' => '响应时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '2182.66', + ], + 'CpuTime' => [ + 'title' => 'CPU时间（毫秒）', + 'description' => 'CPU 时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3377.57', + ], + 'NetTime' => [ + 'title' => '网络传输时间（毫秒）', + 'description' => '网络传输时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'NetWaitTime' => [ + 'title' => '网络入队时间（毫秒）', + 'description' => '网络入队时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'QueueTime' => [ + 'title' => '排队时间（毫秒）', + 'description' => '排队时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.02', + ], + 'DecodeTime' => [ + 'title' => '语法解析时间（毫秒）', + 'description' => '语法解析时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'GetPlanTime' => [ + 'title' => '计划生成时间（毫秒）', + 'description' => '计划生成时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.19', + ], + 'ExecuteTime' => [ + 'title' => '计划执行时间（毫秒）', + 'description' => '计划执行时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '8262.01', + ], + 'ApplicationWaitTime' => [ + 'title' => 'Application事件等待时间（毫秒）', + 'description' => 'Application 事件等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'ConcurrencyWaitTime' => [ + 'title' => 'Concurrency事件等待时间（毫秒）', + 'description' => 'Concurrency 事件等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'UserIoWaitTime' => [ + 'title' => 'UserIO事件等待时间（毫秒）', + 'description' => 'UserIO 事件等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'ScheduleTime' => [ + 'title' => 'Schedule事件等待时间（毫秒）', + 'description' => 'Schedule 事件等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'RowCacheHit' => [ + 'title' => 'RowCache命中次数', + 'description' => 'RowCache 命中次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '498.0', + ], + 'BloomFilterCacheHit' => [ + 'title' => 'BloomFilterCache命中次数', + 'description' => 'BloomFilterCache 命中次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'BlockCacheHit' => [ + 'title' => 'BlockCache命中次数', + 'description' => 'BlockCache 命中次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '99279.0', + ], + 'BlockIndexCacheHit' => [ + 'title' => 'BlockIndexCache命中次数'."\n" + .'磁盘读次数', + 'description' => 'BlockIndexCache 命中次数'."\n" + .'磁盘读次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '142514.0', + ], + 'DiskReads' => [ + 'title' => '磁盘读次数', + 'description' => '磁盘读次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '96972.0', + ], + 'RetryCount' => [ + 'description' => '重试次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'TableScan' => [ + 'description' => '是否全表扫描。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ConsistencyLevel' => [ + 'title' => '一致性级别', + 'description' => '一致性级别。', + 'type' => 'string', + 'example' => '3', + ], + 'MemstoreReadRows' => [ + 'description' => 'Memstore 读行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ExpectedWorkerCount' => [ + 'description' => '并行度。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'UsedWorkerCount' => [ + 'description' => 'SQL 实际执行线程数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SsstoreReadRows' => [ + 'description' => 'Ssstore 读行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '986190', + ], + 'ObServerId' => [ + 'description' => 'server ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ObUserId' => [ + 'description' => '用户 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100010', + ], + 'ObDbId' => [ + 'description' => '数据库 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11006111****4828', + ], + 'Statement' => [ + 'title' => '参数化SQL文本', + 'description' => '参数化 SQL 文本。', + 'type' => 'string', + 'example' => 'select a from b', + ], + 'TransHash' => [ + 'title' => 'transaction hash', + 'description' => 'transaction hash。', + 'type' => 'string', + 'example' => '1219****927****73791', + ], + 'FullSqlText' => [ + 'description' => '完整的 SQL 文本。'."\n" + ."\n" + .'> 此参数暂时不可用。', + 'type' => 'string', + 'example' => 'select * from test where c1 > 1 and c2 > 3;', + ], + 'SqlText' => [ + 'description' => 'SQL 语句。', + 'type' => 'string', + 'example' => 'select ** from t', + ], + 'ParamsValue' => [ + 'title' => 'SQL参数值', + 'description' => 'SQL 参数值。', + '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' => '查询慢 SQL 执行明细的采样数据', + ], + 'DescribeOasSQLHistoryList' => [ + 'summary' => '查询 SQL 执行历史信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查看 SQL 执行历史参数的起始时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T04:38:38Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查看 SQL 执行历史参数的结束时间。'."\n" + ."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T05:38:38Z', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据库名称。', + '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' => '节点 IP。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp19y05uq6x*********', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => [ + 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否动态SQL', + 'description' => '是否动态SQL', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => 'SQL 执行历史信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'SQL 执行历史信息。', + 'type' => 'object', + 'properties' => [ + 'SQLId' => [ + 'title' => 'SQL ID', + 'description' => 'SQL ID', + 'type' => 'string', + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + 'DbName' => [ + 'title' => '数据库名', + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'test_db', + ], + 'AvgAffectedRows' => [ + 'description' => '期间内平均更新行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '9978.75', + ], + 'AvgBlockCacheHit' => [ + 'description' => '期间内的平均 BlockCache 命中次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgBlockIndexCacheHit' => [ + 'description' => '期间内的平均 BlockIndexCache 命中次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgBloomFilterCacheHit' => [ + 'description' => '期间内的平均 BloomFilterCache 命中次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'Executions' => [ + 'title' => '期间内的总执行次数', + 'description' => '期间内的总执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'FailCount' => [ + 'title' => '期间内的总错误次数', + 'description' => '期间内的总错误次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AvgRpcCount' => [ + 'description' => '期间内的平均发送 RPC 次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '8.0', + ], + 'RemotePlans' => [ + 'title' => '远程计划数', + 'description' => '远程计划数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'MissPlans' => [ + 'title' => '未命中计划次数', + 'description' => '未命中计划次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AvgReturnRows' => [ + 'description' => '期间内平均返回行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgLogicalReads' => [ + 'description' => '期间内平均逻辑读。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'RetryCount' => [ + 'title' => '期间内的总计重试次数', + 'description' => '期间内的总计重试次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AvgRowCacheHit' => [ + 'description' => '期间内的平均 RowCache 命中次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgDiskReads' => [ + 'description' => '期间内的平均物理读次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgMemstoreReadRows' => [ + 'description' => '期间内的平均 Memstore 读行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgSsstoreReadRows' => [ + 'description' => '期间内的平均SsStore读行数', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgApplicationWaitTime' => [ + 'title' => '客户端等待 期间内的平均Application事件等待时间（毫秒）', + 'description' => '客户端等待期间内的平均 Application 事件等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgElapsedTime' => [ + 'title' => '期间内的平均响应时间（毫秒）', + 'description' => '期间内的平均响应时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1876.78', + ], + 'AvgExecuteTime' => [ + 'title' => '期间内的平均计划执行时间（毫秒）', + 'description' => '期间内的平均计划执行时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1895.7', + ], + 'AvgQueueTime' => [ + 'title' => '期间内的平均排队时间（毫秒）', + 'description' => '期间内的平均排队时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.01', + ], + 'AvgConcurrencyWaitTime' => [ + 'title' => '期间内的平均Concurrency事件等待时间（毫秒）', + 'description' => '期间内的平均 Concurrency 事件等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgCpuTime' => [ + 'title' => '期间内的平均CPU时间（毫秒）', + 'description' => '期间内的平均 CPU 时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1875.34', + ], + 'AvgDecodeTime' => [ + 'title' => '期间内的平均语法解析时间（毫秒）', + 'description' => '期间内的平均语法解析时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgNetWaitTime' => [ + 'title' => '网络等待 期间内的平均网络入队时间（毫秒）', + 'description' => '网络等待期间内的平均网络入队时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgUserIoWaitTime' => [ + 'title' => '期间内的平均UserIO事件等待时间（毫秒）', + 'description' => '期间内的平均 UserIO 事件等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgGetPlanTime' => [ + 'title' => '期间内的平均计划生成时间（毫秒）', + 'description' => '期间内的平均计划生成时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxElapsedTime' => [ + 'title' => '最大响应时间', + 'description' => '最大响应时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '13643.3', + ], + 'SumWaitTime' => [ + 'title' => '内部等待 期间内的总等待时间（毫秒）', + 'description' => '内部等待期间内的总等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '9421.73', + ], + 'AvgScheduleTime' => [ + 'title' => '调度时间 期间内的平均Schedule事件等待时间（毫秒）', + 'description' => '调度时间期间内的平均 Schedule 事件等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxCpuTime' => [ + 'title' => '最大 CPU 时间', + 'description' => '最大 CPU 时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '13641.9', + ], + 'SumElapsedTime' => [ + 'description' => '期间内的总响应时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '11452126.36', + ], + 'Timestamp' => [ + 'title' => '采样时间点', + 'description' => '采样时间点。', + 'type' => 'string', + 'example' => '2023-04-12T04:46:38Z', + ], + 'Server' => [ + 'title' => 'SQL执行所在的Server（svr_ip:svr_port, 兼容tars', + 'description' => 'SQL 执行所在的 Server。', + 'type' => 'string', + 'example' => 'i-bp1db1****8uemejio', + ], + 'UserName' => [ + 'title' => 'userName, 兼容tars', + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'test_user', + ], + 'AvgPartitionCount' => [ + 'title' => '期间内平均访问分区数', + 'description' => '期间内平均访问分区数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'FailPercentage' => [ + 'title' => '期间内的错误百分比', + 'description' => '期间内的错误百分比。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RetCode4012Count' => [ + 'description' => '期间内结果码 4012 的发生次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode4013Count' => [ + 'description' => '期间内结果码 4013 的发生次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5001Count' => [ + 'description' => '期间内结果码 5001 的发生次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5024Count' => [ + 'description' => '期间内结果码 5024 的发生次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5167Count' => [ + 'description' => '期间内结果码 5167 的发生次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5217Count' => [ + 'description' => '期间内结果码 5217 的发生次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode6002Count' => [ + 'description' => '期间内结果码 6002 的发生次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AvgWaitTime' => [ + 'title' => '期间内的平均等待时间（毫秒）', + 'description' => '期间内的平均等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1442.49', + ], + 'AvgWaitCount' => [ + 'title' => '期间内的平均等待次数', + 'description' => '期间内的平均等待次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'LocalPlanPercentage' => [ + 'title' => '期间内的本地计划百分比', + 'description' => '期间内的本地计划百分比。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemotePlanPercentage' => [ + 'title' => '期间内的远程计划百分比', + 'description' => '期间内的远程计划百分比。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DistPlanPercentage' => [ + 'title' => '期间内的分布式计划百分比', + 'description' => '期间内的分布式计划百分比。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'AvgNetTime' => [ + 'title' => '期间内的平均网络传输时间（毫秒）', + 'description' => '期间内的平均网络传输时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '8', + ], + 'AvgExecutorRpcCount' => [ + 'title' => '期间内的平均执行RPC请求次数', + 'description' => '期间内的平均执行 RPC 请求次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MissPlanPercentage' => [ + 'title' => '期间内的计划命中率', + 'description' => '期间内的计划命中率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'TableScanPercentage' => [ + 'title' => '期间内的表扫描百分比', + 'description' => '期间内的表扫描百分比。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'StrongConsistencyPercentage' => [ + 'title' => '期间内的强一致性事务百分比', + 'description' => '期间内的强一致性事务百分比。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'WeakConsistencyPercentage' => [ + 'title' => '期间内的弱一致性事务百分比', + 'description' => '期间内的弱一致性事务百分比。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxAffectedRows' => [ + 'title' => '期间内最大更新行数', + 'description' => '期间内最大更新行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10000', + ], + 'MaxReturnRows' => [ + 'title' => '期间内最大返回行数', + 'description' => '期间内最大返回行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxWaitTime' => [ + 'title' => '期间内的最大等待时间（毫秒）', + 'description' => '期间内的最大等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3.4', + ], + 'MaxApplicationWaitTime' => [ + 'title' => '期间内的最大Application事件等待时间（毫秒）', + 'description' => '期间内的最大 Application 事件等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxConcurrencyWaitTime' => [ + 'title' => '期间内的最大Concurrency事件等待时间（毫秒）', + 'description' => '期间内的最大 Concurrency 事件等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxUserIoWaitTime' => [ + 'title' => '期间内的最大UserIO事件等待时间（毫秒）', + 'description' => '期间内的最大 UserIO 事件等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxDiskReads' => [ + 'title' => '期间内的最大物理读次数', + 'description' => '期间内的最大物理读次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgExpectedWorkerCount' => [ + 'title' => '期间内平均并行度', + 'description' => '期间内平均并行度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'AvgUsedWorkerCount' => [ + 'title' => '期间内sql平均使用线程数', + 'description' => '期间内 SQL 平均使用线程数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'SumLogicalReads' => [ + 'title' => '总逻辑读', + 'description' => '总逻辑读。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'ExecPs' => [ + 'description' => '期间的平均每秒执行次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.31', + ], + 'AvgDbTime' => [ + 'description' => '平均数据库时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SumDbTime' => [ + 'description' => '总数据库时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'WaitEvent' => [ + 'description' => '等待事件。', + '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' => '查询 SQL 执行历史', + ], + 'DescribeOasTopSQLList' => [ + 'summary' => '查询诊断系统采集到的 SQL 执行性能数据列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询 TOPSQL 参数的起始时间。'."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T04:38:38Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询 TOPSQL 参数的结束时间。'."\n" + ."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T05:38:38Z', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'SearchKeyWord', + 'in' => 'formData', + 'schema' => [ + 'description' => '关键字查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'update', + ], + ], + [ + 'name' => 'SearchParam', + 'in' => 'formData', + 'schema' => [ + 'description' => '参数查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'cputime', + ], + ], + [ + 'name' => 'SearchRule', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询规则。', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + ], + [ + 'name' => 'SearchValue', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询值。', + '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' => '节点 IP。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp18l4****str4uk03', + ], + ], + [ + 'name' => 'FilterCondition', + 'in' => 'formData', + 'schema' => [ + 'description' => '所有字段通过 @ 来引用。可选字段请参考 [查询 SQL 的性能统计](https://www.oceanbase.com/docs/community-ocp-cn-10000000001832433) 接口返回的所有列。', + 'type' => 'string', + 'required' => false, + 'example' => '@avgCpuTime > 20 and @executions > 100', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => [ + 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + [ + 'name' => 'SqlTextLength', + 'in' => 'formData', + 'schema' => [ + 'description' => '返回 SQL 文本的最大长度。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '65535', + ], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否动态SQL', + 'description' => '是否动态 SQL。'."\n" + .'> <br>表示传入的SQL ID 是否为动态 SQL 的 ID。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'MergeDynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '返回结果时，是否合并动态 SQL', + 'description' => '返回结果时，是否合并动态 SQL。'."\n" + .'> <br>表示输出结果时，是否聚合 in 查询的SQL 的结果。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'CustomColumns', + 'in' => 'formData', + 'schema' => [ + 'title' => '自定义字段规则', + 'description' => '自定义字段规则。所有字段通过 @ 来引用，运算符支持 `+、-、*、/` 等，首字母需要调整为小写。可选字段请参考 [查询 SQL 的性能统计](https://www.oceanbase.com/docs/community-ocp-cn-10000000001832433) 接口返回的所有列。', + 'type' => 'string', + 'required' => false, + 'example' => '@failCount/@executions', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => 'TopSQL 信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'TopSQL 信息。', + 'type' => 'object', + 'properties' => [ + 'Executions' => [ + 'description' => 'SQL 执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'RpcCount' => [ + 'title' => '期间的RPC次数', + 'description' => 'SQL 总 RPC 次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'RemotePlans' => [ + 'description' => 'SQL 远程执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'MissPlans' => [ + 'description' => 'SQL 未命中计划缓存次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'MaxElapsedTime' => [ + 'title' => '期间最大响应时间', + 'description' => 'SQL 最大响应时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10000', + ], + 'TotalWaitTime' => [ + 'title' => '期间总等待时间', + 'description' => 'SQL 执行时，总等待时间（单位：毫秒），对应v$sql_audit.total_wait_time_micro（单位：毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100000', + ], + 'ExecPs' => [ + 'title' => '期间的平均每秒执行次数', + 'description' => 'SQL 执行频率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.31', + ], + 'MaxCpuTime' => [ + 'title' => '最大CPU时间', + 'description' => '最大 CPU 时间，单位毫秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '13641.9', + ], + 'CpuPercentage' => [ + 'title' => 'CPU占比', + 'description' => 'CPU 占比。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.0', + ], + 'ClientIp' => [ + 'title' => '客户端 IP。', + 'description' => '客户端 IP。', + 'type' => 'string', + 'example' => 'i-bp1db****38uemejio', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'test_user', + ], + 'DbName' => [ + 'title' => '数据库名', + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'test_db', + ], + 'RetCode4012Count' => [ + 'description' => '期间内结果码 4012 的发生次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode4013Count' => [ + 'description' => '期间内结果码 4013 的发生次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5001Count' => [ + 'description' => '期间内结果码 5001 的发生次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5024Count' => [ + 'description' => '期间内结果码 5024 的发生次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5167Count' => [ + 'description' => '期间内结果码 5167 的发生次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5217Count' => [ + 'description' => '期间内结果码 5217 的发生次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode6002Count' => [ + 'description' => '期间内结果码 6002 的发生次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'FailPercentage' => [ + 'title' => '期间内的错误百分比', + 'description' => '期间内的错误百分比。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'SumWaitTime' => [ + 'title' => '期间内的总等待时间（毫秒）', + 'description' => '总等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '9421.73', + ], + 'AvgWaitCount' => [ + 'title' => '期间内的平均等待次数', + 'description' => '平均等待次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgRpcCount' => [ + 'title' => '期间内的平均发送RPC次数', + 'description' => 'SQL 平均 RPC 次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '8.0', + ], + 'LocalPlanPercentage' => [ + 'title' => '期间内的本地计划百分比', + 'description' => 'SQL Local 计划比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'RemotePlanPercentage' => [ + 'title' => '期间内的远程计划百分比', + 'description' => 'SQL Remote 计划比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'DistPlanPercentage' => [ + 'title' => '期间内的分布式计划百分比', + 'description' => 'SQLDistributed 计划比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.0', + ], + 'SumElapsedTime' => [ + 'title' => '期间内的总响应时间（毫秒）', + 'description' => 'SQL 总响应时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '11452126.36', + ], + 'AvgNetTime' => [ + 'title' => '期间内的平均网络传输时间（毫秒）', + 'description' => '期间内的平均网络传输时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgExecutorRpcCount' => [ + 'title' => '期间内的平均执行RPC请求次数', + 'description' => 'SQL 远程执行次数， 对应 v$sl_audit.executor_rpc。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MissPlanPercentage' => [ + 'title' => '期间内的计划命中率', + 'description' => 'SQL 未命中计划比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'TableScanPercentage' => [ + 'title' => '期间内的表扫描百分比', + 'description' => 'SQL 全表扫描比率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'StrongConsistencyPercentage' => [ + 'title' => '期间内的强一致性事务百分比', + 'description' => 'SQL 强读比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.0', + ], + 'WeakConsistencyPercentage' => [ + 'title' => '期间内的弱一致性事务百分比', + 'description' => 'SQL 弱读比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxAffectedRows' => [ + 'title' => '期间内的最大影响行数', + 'description' => 'SQL 最大影响行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10000.0', + ], + 'MaxReturnRows' => [ + 'title' => '期间内的最大返回行数', + 'description' => 'SQL 最大返回行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxWaitTime' => [ + 'title' => '期间内的最大等待时间（毫秒', + 'description' => 'SQL 最大等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3.4', + ], + 'MaxApplicationWaitTime' => [ + 'title' => '期间内的最大Application事件等待时间（毫秒）', + 'description' => 'SQL 最大应用等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxConcurrencyWaitTime' => [ + 'title' => '期间内的最大Concurrency事件等待时间（毫秒）', + 'description' => 'SQL 最大 IO 等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxUserIoWaitTime' => [ + 'title' => '期间内的最大UserIO事件等待时间（毫秒）', + 'description' => '期间内的最大 UserIO 事件等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxDiskReads' => [ + 'title' => '期间内的最大物理读次数', + 'description' => '最大磁盘读次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgExpectedWorkerCount' => [ + 'title' => '期间内平均并行度', + 'description' => '预期并发数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'AvgUsedWorkerCount' => [ + 'title' => '期间内sql平均使用线程数', + 'description' => '期间内 SQL 平均使用线程数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'SumLogicalReads' => [ + 'title' => '期间内 sql 总逻辑读', + 'description' => '总逻辑读。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'Server' => [ + 'title' => 'SQL执行所在的Server', + 'description' => 'OBServer。', + 'type' => 'string', + 'example' => 'i-bp1db1****8uemejio', + ], + 'ServerIp' => [ + 'title' => 'SQL执行所在的Server的IP', + 'description' => 'OBServerIp', + 'type' => 'string', + 'example' => 'i-bp1db1****8uemejio', + ], + 'ServerPort' => [ + 'title' => 'SQL执行所在的Server的Port', + 'description' => 'OBServer Port。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '389', + ], + 'SqlTextShort' => [ + 'title' => 'SQL的文本（前100字符）', + 'description' => 'SQL 文本（前 100 字符）。', + 'type' => 'string', + 'example' => 'delete /*+ XXX PARALLEL(4) */ fro', + ], + 'SqlType' => [ + 'title' => 'SQL类型', + 'description' => 'SQL 类型。', + 'type' => 'string', + 'example' => 'select ', + ], + 'SqlId' => [ + 'title' => 'SQL id', + 'description' => 'SQL ID。', + 'type' => 'string', + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + 'Inner' => [ + 'title' => '是否是内部SQL', + 'description' => '是否为内部 SQL。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'WaitEvent' => [ + 'title' => '期间内的最长等待事件', + 'description' => '最长等待事件。', + 'type' => 'string', + 'example' => 'none', + ], + 'AvgAffectedRows' => [ + 'title' => '期间内平均更新行数', + 'description' => '平均影响行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '9978.75', + ], + 'AvgReturnRows' => [ + 'title' => '期间内平均返回行数', + 'description' => '平均返回行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgPartitionCount' => [ + 'title' => '期间内平均访问分区数', + 'description' => '期间内平均访问分区数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.0', + ], + 'FailCount' => [ + 'description' => '执行出错次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AvgWaitTime' => [ + 'title' => '期间内的平均等待时间（毫秒）', + 'description' => '平均等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1442.49', + ], + 'AvgElapsedTime' => [ + 'title' => '期间内的平均响应时间（毫秒）', + 'description' => '期间内的平均响应时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '903.29', + ], + 'AvgCpuTime' => [ + 'title' => '期间内的平均CPU时间（毫秒）', + 'description' => '平均 CPU 时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1875.34', + ], + 'AvgNetWaitTime' => [ + 'title' => '期间内的平均网络入队时间（毫秒）', + 'description' => '平均网络时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgQueueTime' => [ + 'title' => '期间内的平均排队时间（毫秒）', + 'description' => '平均排队时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.01', + ], + 'AvgDecodeTime' => [ + 'title' => '期间内的平均语法解析时间（毫秒）', + 'description' => '平均解析时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgGetPlanTime' => [ + 'title' => '期间内的平均计划生成时间（毫秒）', + 'description' => '获取执行计划的平均时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgExecuteTime' => [ + 'title' => '期间内的平均计划执行时间（毫秒）', + 'description' => 'SQL 平均执行时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1895.7', + ], + 'AvgApplicationWaitTime' => [ + 'title' => '期间内的平均Application事件等待时间（毫秒）', + 'description' => '平均应用等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgConcurrencyWaitTime' => [ + 'title' => '期间内的平均Concurrency事件等待时间（毫秒）', + 'description' => '平均并发等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgUserIoWaitTime' => [ + 'title' => '期间内的平均UserIO事件等待时间（毫秒）', + 'description' => '平均用户 IO 时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgScheduleTime' => [ + 'title' => '期间内的平均Schedule事件等待时间（毫秒）', + 'description' => '平均调度时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgRowCacheHit' => [ + 'title' => '期间内的平均RowCache命中次数', + 'description' => '平均 Row Cache 命中数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgBloomFilterCacheHit' => [ + 'title' => '期间内的平均BloomFilterCache命中次数', + 'description' => '平均 Bloom Filter Cache 命中数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgBlockCacheHit' => [ + 'title' => '期间内的平均BlockCache命中次数', + 'description' => '平均 Block Cache 命中数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgBlockIndexCacheHit' => [ + 'title' => '期间内的平均BlockIndexCache命中次数', + 'description' => '平均 Block Index Cache 命中数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgDiskReads' => [ + 'title' => '期间内的平均物理读次数', + 'description' => '期间内的平均物理读次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'RetryCount' => [ + 'description' => '重试次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AvgMemstoreReadRows' => [ + 'title' => '期间内的强一致性事务百分比', + 'description' => '平均 Memstore 读行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgSsstoreReadRows' => [ + 'title' => '期间内的弱一致性事务百分比', + 'description' => '平均 SSTable读行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgLogicalReads' => [ + 'title' => '期间内 sql 平均逻辑读', + 'description' => '平均逻辑读。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'DynamicSql' => [ + 'title' => '是否动态SQL', + 'description' => '是否动态 SQL。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SqlList' => [ + 'title' => 'SQL列表', + 'description' => 'SQL 列表。'."\n" + .'> <br>入参 mergeDynamicSql = true 且有 in 查询时，会包含此参数。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Executions' => [ + 'description' => 'SQL 执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'RpcCount' => [ + 'title' => '期间的RPC次数', + 'description' => 'SQL 总 RPC 次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'RemotePlans' => [ + 'description' => 'SQL 远程执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'MissPlans' => [ + 'description' => 'SQL 未命中计划缓存次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'MaxElapsedTime' => [ + 'title' => '期间最大响应时间', + 'description' => 'SQL 最大响应时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10000', + ], + 'TotalWaitTime' => [ + 'title' => '期间总等待时间', + 'description' => 'SQL 执行时，总等待时间（单位：毫秒），对应v$sql_audit.total_wait_time_micro（单位：毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100000', + ], + 'ExecPs' => [ + 'title' => '期间的平均每秒执行次数', + 'description' => 'SQL 执行频率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.31', + ], + 'MaxCpuTime' => [ + 'title' => '最大CPU时间', + 'description' => '最大 CPU 时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '13641.9', + ], + 'CpuPercentage' => [ + 'title' => 'CPU占比', + 'description' => 'CPU 占比。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'ClientIp' => [ + 'title' => '客户端 IP。', + 'description' => '客户端 IP。', + 'type' => 'string', + 'example' => '127.*.*.*', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'test_user', + ], + 'DbName' => [ + 'title' => '数据库名', + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'test', + ], + 'RetCode4012Count' => [ + 'description' => '错误码 4012 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode4013Count' => [ + 'description' => '错误码 4013 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5001Count' => [ + 'description' => '错误码 5001 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5024Count' => [ + 'description' => '错误码 5024 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5167Count' => [ + 'description' => '错误码 5167 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5217Count' => [ + 'description' => '错误码 5217 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode6002Count' => [ + 'description' => '错误码 6002 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'FailPercentage' => [ + 'title' => '期间内的错误百分比', + 'description' => 'SQL 执行错误率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'SumWaitTime' => [ + 'title' => '期间内的总等待时间（毫秒）', + 'description' => '期间内的总等待时间（毫秒）。（waitTime, 对应 v$sql_audit.wait_time_micro）', + 'type' => 'number', + 'format' => 'double', + 'example' => '9421.73', + ], + 'AvgWaitCount' => [ + 'title' => '期间内的平均等待次数', + 'description' => '平均等待次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgRpcCount' => [ + 'title' => '期间内的平均发送RPC次数', + 'description' => 'SQL 平均 RPC 次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '8', + ], + 'LocalPlanPercentage' => [ + 'title' => '期间内的本地计划百分比', + 'description' => 'SQL Local 计划比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemotePlanPercentage' => [ + 'title' => '期间内的远程计划百分比', + 'description' => 'SQL Remote 计划比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DistPlanPercentage' => [ + 'title' => '期间内的分布式计划百分比', + 'description' => 'SQLDistributed 计划比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SumElapsedTime' => [ + 'title' => '期间内的总响应时间（毫秒）', + 'description' => 'SQL 总响应时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '11452126.36', + ], + 'AvgNetTime' => [ + 'title' => '期间内的平均网络传输时间（毫秒）', + 'description' => 'SQL 平均网络 IO 时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgExecutorRpcCount' => [ + 'title' => '期间内的平均执行RPC请求次数', + 'description' => 'SQL 远程执行次数， 对应 v$sl_audit.executor_rpc。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MissPlanPercentage' => [ + 'title' => '期间内的计划命中率', + 'description' => 'SQL 未命中计划比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'TableScanPercentage' => [ + 'title' => '期间内的表扫描百分比', + 'description' => 'SQL 全表扫描比率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'StrongConsistencyPercentage' => [ + 'title' => '期间内的强一致性事务百分比', + 'description' => 'SQL 强读比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'WeakConsistencyPercentage' => [ + 'title' => '期间内的弱一致性事务百分比', + 'description' => 'SQL 弱读比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxAffectedRows' => [ + 'title' => '期间内的最大影响行数', + 'description' => 'SQL 最大影响行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10000', + ], + 'MaxReturnRows' => [ + 'title' => '期间内的最大返回行数', + 'description' => 'SQL 最大返回行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxWaitTime' => [ + 'title' => '期间内的最大等待时间（毫秒', + 'description' => 'SQL 最大等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3.4', + ], + 'MaxApplicationWaitTime' => [ + 'title' => '期间内的最大Application事件等待时间（毫秒）', + 'description' => 'SQL 最大应用等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxConcurrencyWaitTime' => [ + 'title' => '期间内的最大Concurrency事件等待时间（毫秒）', + 'description' => 'SQL 最大并发等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxUserIoWaitTime' => [ + 'title' => '期间内的最大UserIO事件等待时间（毫秒）', + 'description' => 'SQL 最大 IO 等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxDiskReads' => [ + 'title' => '期间内的最大物理读次数', + 'description' => '最大磁盘读次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgExpectedWorkerCount' => [ + 'title' => '期间内平均并行度', + 'description' => '预期并发数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'AvgUsedWorkerCount' => [ + 'title' => '期间内sql平均使用线程数', + 'description' => '期间内 SQL 平均使用线程数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'SumLogicalReads' => [ + 'title' => '期间内 sql 总逻辑读', + 'description' => '总逻辑读。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'Server' => [ + 'title' => 'SQL执行所在的Server', + 'description' => 'OBServer', + 'type' => 'string', + 'example' => 'i-bp1db1****8uemejio', + ], + 'ServerIp' => [ + 'title' => 'SQL执行所在的Server的IP', + 'description' => 'OBServerIp', + 'type' => 'string', + 'example' => 'i-bp1db1****8uemejio', + ], + 'ServerPort' => [ + 'title' => 'SQL执行所在的Server的Port', + 'description' => 'OBServer Port。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '389', + ], + 'SqlTextShort' => [ + 'title' => 'SQL的文本（前100字符）', + 'description' => 'SQL 文本（前 100 字符）。', + 'type' => 'string', + 'example' => 'delete /*+ XXX PARALLEL(4) */ fro', + ], + 'SqlType' => [ + 'title' => 'SQL类型', + 'description' => 'SQL 类型。', + 'type' => 'string', + 'example' => 'select', + ], + 'SqlId' => [ + 'title' => 'SQL id', + 'description' => 'SQL ID。', + 'type' => 'string', + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + 'Inner' => [ + 'title' => '是否是内部SQL', + 'description' => '是否是内部 SQL。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'WaitEvent' => [ + 'title' => '期间内的最长等待事件', + 'description' => '最长等待事件。', + 'type' => 'string', + 'example' => 'none', + ], + 'AvgAffectedRows' => [ + 'title' => '期间内平均更新行数', + 'description' => '平均影响行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '9978.75', + ], + 'AvgReturnRows' => [ + 'title' => '期间内平均返回行数', + 'description' => '平均返回行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgPartitionCount' => [ + 'title' => '期间内平均访问分区数', + 'description' => '平均访问分区数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'FailCount' => [ + 'description' => '执行出错次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AvgWaitTime' => [ + 'title' => '期间内的平均等待时间（毫秒）', + 'description' => '平均等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1442.49', + ], + 'AvgElapsedTime' => [ + 'title' => '期间内的平均响应时间（毫秒）', + 'description' => '平均响应时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '903.29', + ], + 'AvgCpuTime' => [ + 'title' => '期间内的平均CPU时间（毫秒）', + 'description' => '平均 CPU 时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1875.34', + ], + 'AvgNetWaitTime' => [ + 'title' => '期间内的平均网络入队时间（毫秒）', + 'description' => '平均网络时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgQueueTime' => [ + 'title' => '期间内的平均排队时间（毫秒）', + 'description' => '平均排队时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.01', + ], + 'AvgDecodeTime' => [ + 'title' => '期间内的平均语法解析时间（毫秒）', + 'description' => '平均解析时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgGetPlanTime' => [ + 'title' => '期间内的平均计划生成时间（毫秒）', + 'description' => '获取执行计划的平均时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgExecuteTime' => [ + 'title' => '期间内的平均计划执行时间（毫秒）', + 'description' => 'SQL 平均执行时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1895.7', + ], + 'AvgApplicationWaitTime' => [ + 'title' => '期间内的平均Application事件等待时间（毫秒）', + 'description' => '平均应用等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgConcurrencyWaitTime' => [ + 'title' => '期间内的平均Concurrency事件等待时间（毫秒）', + 'description' => '平均并发等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgUserIoWaitTime' => [ + 'title' => '期间内的平均UserIO事件等待时间（毫秒）', + 'description' => '平均用户 IO 时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgScheduleTime' => [ + 'title' => '期间内的平均Schedule事件等待时间（毫秒）', + 'description' => '平均调度时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgRowCacheHit' => [ + 'title' => '期间内的平均RowCache命中次数', + 'description' => '平均 Row Cache 命中数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgBloomFilterCacheHit' => [ + 'title' => '期间内的平均BloomFilterCache命中次数', + 'description' => '平均 Bloom Filter Cache 命中数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgBlockCacheHit' => [ + 'title' => '期间内的平均BlockCache命中次数', + 'description' => '平均 Block Cache 命中数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgBlockIndexCacheHit' => [ + 'title' => '期间内的平均BlockIndexCache命中次数', + 'description' => '平均 Block Index Cache 命中数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgDiskReads' => [ + 'title' => '期间内的平均物理读次数', + 'description' => '平均磁盘读次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RetryCount' => [ + 'description' => '重试次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'AvgMemstoreReadRows' => [ + 'title' => '期间内的强一致性事务百分比', + 'description' => '平均 Memstore 读行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgSsstoreReadRows' => [ + 'title' => '期间内的弱一致性事务百分比', + 'description' => '平均 SSTable读行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgLogicalReads' => [ + 'title' => '期间内 sql 平均逻辑读', + 'description' => '平均逻辑读。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgDbTime' => [ + 'description' => '平均数据库时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SumDbTime' => [ + 'description' => '总数据库时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'FormatSqlId' => [ + 'title' => 'FormatSqlId', + 'description' => 'FormatSqlId', + 'type' => 'string', + ], + ], + ], + ], + 'LastFailCode' => [ + 'title' => '期间最后一次执行出错的错误码', + 'description' => '最后一次执行出错的错误码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-4012', + ], + 'AvgDbTime' => [ + 'description' => '平均数据库时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SumDbTime' => [ + 'description' => '总数据库时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'CustomColumns' => [ + 'title' => '自定义列', + 'description' => '自定义列。', + 'type' => 'object', + 'properties' => [ + 'Expression' => [ + 'title' => '自定义列的表达式', + 'description' => '自定义列的表达式。', + 'type' => 'string', + 'example' => '@failCount/@executions', + ], + 'Value' => [ + 'title' => '根据表达式计算的值', + 'description' => '根据表达式计算的值。', + 'type' => 'string', + 'example' => '0.0', + ], + ], + ], + 'ObDbId' => [ + 'description' => '数据库 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11006111****4828', + ], + 'FormatSqlId' => [ + 'title' => 'FormatSqlId', + 'description' => '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' => '查询 TopSQL 列表', + ], + 'DescribeOasSlowSQLList' => [ + 'summary' => '该接口用于查询慢 SQL 列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查看慢 SQL 历史参数的起始时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T04:38:38Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询慢 SQL 参数的结束时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T05:38:38Z', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'SearchKeyWord', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'update', + ], + ], + [ + 'name' => 'SearchParam', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'cputime', + ], + ], + [ + 'name' => 'SearchRule', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询规则。', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + ], + [ + 'name' => 'SearchValue', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询值。', + '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' => '数据库节点 IP。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp18qljorblo8es*****', + ], + ], + [ + 'name' => 'FilterCondition', + 'in' => 'formData', + 'schema' => [ + 'description' => '所有字段通过 @ 来引用。可选字段请参考[查询 SQL 的性能统计](https://www.oceanbase.com/docs/community-ocp-cn-10000000001832433)接口返回的所有列。', + 'type' => 'string', + 'required' => false, + 'example' => '@avgCpuTime > 20 and @executions > 100', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => [ + 'description' => '返回数据的语言。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + [ + 'name' => 'SqlTextLength', + 'in' => 'formData', + 'schema' => [ + 'description' => '返回 SQL 文本的最大长度。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '65535', + ], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否动态SQL', + 'description' => '是否动态 SQL。'."\n" + .'> <br>表示传入的 SQL ID 是否为动态 SQL 的 ID。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'MergeDynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '返回结果时，是否合并动态 SQL', + 'description' => '返回结果时，是否合并动态 SQL。'."\n" + .'> <br>表示输出结果时，是否聚合 in 查询的SQL 的结果。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => '慢 SQL 信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '慢 SQL 信息。', + 'type' => 'object', + 'properties' => [ + 'Executions' => [ + 'description' => 'SQL 执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'RpcCount' => [ + 'title' => '期间的RPC次数', + 'description' => '期间的 RPC 次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemotePlans' => [ + 'description' => '期间的远程执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'MissPlans' => [ + 'description' => '期间未命中执行计划的次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'MaxElapsedTime' => [ + 'title' => '期间最大响应时间', + 'description' => '期间最大响应时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '260.044', + ], + 'TotalWaitTime' => [ + 'title' => '期间总等待时间', + 'description' => '期间总等待时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10.966', + ], + 'ExecPs' => [ + 'title' => '期间的平均每秒执行次数', + 'description' => '期间的平均每秒执行次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.31', + ], + 'MaxCpuTime' => [ + 'title' => '最大CPU时间', + 'description' => '最大 CPU 时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '257.967', + ], + 'ClientIp' => [ + 'title' => '客户端 IP。', + 'description' => '客户端 IP。', + 'type' => 'string', + 'example' => '1*2.***.1*3.***', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'test_user', + ], + 'DbName' => [ + 'title' => '数据库名', + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'test_db', + ], + 'RetCode4012Count' => [ + 'description' => '错误码 4012 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode4013Count' => [ + 'description' => '错误码 4013 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5001Count' => [ + 'description' => '错误码 5001 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5024Count' => [ + 'description' => '错误码 5024 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5167Count' => [ + 'description' => '错误码 5167 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5217Count' => [ + 'description' => '错误码 5217 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode6002Count' => [ + 'description' => '错误码 6002 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'FailPercentage' => [ + 'title' => '期间内的错误百分比', + 'description' => 'SQL 执行错误率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'SumWaitTime' => [ + 'title' => '期间内的总等待时间（毫秒）', + 'description' => 'SQL 最大等待事件的等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '9421.73', + ], + 'AvgWaitCount' => [ + 'title' => '期间内的平均等待次数', + 'description' => 'SQL 平均等待次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgRpcCount' => [ + 'title' => '期间内的平均发送RPC次数', + 'description' => 'SQL 平均 RPC 次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '8.0', + ], + 'LocalPlanPercentage' => [ + 'title' => '期间内的本地计划百分比', + 'description' => 'SQL Local 计划比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'RemotePlanPercentage' => [ + 'title' => '期间内的远程计划百分比', + 'description' => 'SQL Remote 计划比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'DistPlanPercentage' => [ + 'title' => '期间内的分布式计划百分比', + 'description' => 'SQLDistributed 计划比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.0', + ], + 'SumElapsedTime' => [ + 'title' => '期间内的总响应时间（毫秒）', + 'description' => 'SQL 总响应时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '11452126.36', + ], + 'AvgNetTime' => [ + 'title' => '期间内的平均网络传输时间（毫秒）', + 'description' => 'SQL 平均网络 IO 时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgExecutorRpcCount' => [ + 'title' => '期间内的平均执行RPC请求次数', + 'description' => 'SQL 远程执行次数， 对应 v$sl_audit.executor_rpc。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MissPlanPercentage' => [ + 'title' => '期间内的计划命中率', + 'description' => 'SQL 未命中计划比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'TableScanPercentage' => [ + 'title' => '期间内的表扫描百分比', + 'description' => 'SQL 全表扫描比率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'StrongConsistencyPercentage' => [ + 'title' => '期间内的强一致性事务百分比', + 'description' => 'SQL 强读比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.0', + ], + 'WeakConsistencyPercentage' => [ + 'title' => '期间内的弱一致性事务百分比', + 'description' => 'SQL 弱读比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxAffectedRows' => [ + 'title' => '期间内的最大影响行数', + 'description' => 'SQL 最大影响行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10000.0', + ], + 'MaxReturnRows' => [ + 'title' => '期间内的最大返回行数', + 'description' => 'SQL 最大返回行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxWaitTime' => [ + 'title' => '期间内的最大等待时间（毫秒', + 'description' => 'SQL 最大等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3.4', + ], + 'MaxApplicationWaitTime' => [ + 'title' => '期间内的最大Application事件等待时间（毫秒）', + 'description' => 'SQL 最大应用等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxConcurrencyWaitTime' => [ + 'title' => '期间内的最大Concurrency事件等待时间（毫秒）', + 'description' => 'SQL 最大并发等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxUserIoWaitTime' => [ + 'title' => '期间内的最大UserIO事件等待时间（毫秒）', + 'description' => 'SQL 最大 IO 等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxDiskReads' => [ + 'title' => '期间内的最大物理读次数', + 'description' => '最大磁盘读次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgExpectedWorkerCount' => [ + 'title' => '期间内平均并行度', + 'description' => '预期并发数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'AvgUsedWorkerCount' => [ + 'title' => '期间内sql平均使用线程数', + 'description' => '平均使用线程数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'SumLogicalReads' => [ + 'title' => '期间内 sql 总逻辑读', + 'description' => '总逻辑读。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'Server' => [ + 'title' => 'SQL执行所在的Server', + 'description' => 'OBServer', + 'type' => 'string', + 'example' => 'i-bp1db1a**s038**mej**', + ], + 'ServerIp' => [ + 'title' => 'SQL执行所在的Server的IP', + 'description' => 'OBServerIp', + 'type' => 'string', + 'example' => 'i-bp1db1a**s038**mej**', + ], + 'ServerPort' => [ + 'title' => 'SQL执行所在的Server的Port', + 'description' => 'OBServer Port', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10110', + ], + 'SqlTextShort' => [ + 'title' => 'SQL的文本（前100字符）', + 'description' => 'SQL 文本（前 100 字符）。', + 'type' => 'string', + 'example' => 'select a from b where', + ], + 'SqlType' => [ + 'title' => 'SQL类型', + 'description' => 'SQL 类型。', + 'type' => 'string', + 'example' => 'select ', + ], + 'SqlId' => [ + 'title' => 'SQL id', + 'description' => 'SQL ID。', + 'type' => 'string', + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + 'Inner' => [ + 'title' => '是否是内部SQL', + 'description' => '是否为内部 SQL。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'WaitEvent' => [ + 'title' => '期间内的最长等待事件', + 'description' => '最长等待事件。', + 'type' => 'string', + 'example' => 'none', + ], + 'AvgAffectedRows' => [ + 'title' => '期间内平均更新行数', + 'description' => '平均影响行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '9978.75', + ], + 'AvgReturnRows' => [ + 'title' => '期间内平均返回行数', + 'description' => '平均返回行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgPartitionCount' => [ + 'title' => '期间内平均访问分区数', + 'description' => '平均访问分区数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.0', + ], + 'FailCount' => [ + 'description' => '执行出错次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AvgWaitTime' => [ + 'title' => '期间内的平均等待时间（毫秒）', + 'description' => '平均等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.42', + ], + 'AvgElapsedTime' => [ + 'title' => '期间内的平均响应时间（毫秒）', + 'description' => '平均响应时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1876.78', + ], + 'AvgCpuTime' => [ + 'title' => '期间内的平均CPU时间（毫秒）', + 'description' => '平均 CPU 时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1875.34', + ], + 'AvgNetWaitTime' => [ + 'title' => '期间内的平均网络入队时间（毫秒）', + 'description' => '平均网络时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgQueueTime' => [ + 'title' => '期间内的平均排队时间（毫秒）', + 'description' => '平均排队时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.01', + ], + 'AvgDecodeTime' => [ + 'title' => '期间内的平均语法解析时间（毫秒）', + 'description' => '平均解析时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgGetPlanTime' => [ + 'title' => '期间内的平均计划生成时间（毫秒）', + 'description' => '获取执行计划的平均时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgExecuteTime' => [ + 'title' => '期间内的平均计划执行时间（毫秒）', + 'description' => 'SQL 平均执行时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1895.7', + ], + 'AvgApplicationWaitTime' => [ + 'title' => '期间内的平均Application事件等待时间（毫秒）', + 'description' => '平均应用等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgConcurrencyWaitTime' => [ + 'title' => '期间内的平均Concurrency事件等待时间（毫秒）', + 'description' => '平均应用等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgUserIoWaitTime' => [ + 'title' => '期间内的平均UserIO事件等待时间（毫秒）', + 'description' => '平均用户 IO 时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgScheduleTime' => [ + 'title' => '期间内的平均Schedule事件等待时间（毫秒）', + 'description' => '平均调度时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgRowCacheHit' => [ + 'title' => '期间内的平均RowCache命中次数', + 'description' => '平均 Row Cache 命中数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgBloomFilterCacheHit' => [ + 'title' => '期间内的平均BloomFilterCache命中次数', + 'description' => '平均 Bloom Filter Cache 命中数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgBlockCacheHit' => [ + 'title' => '期间内的平均BlockCache命中次数', + 'description' => '平均 Block Cache 命中数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgBlockIndexCacheHit' => [ + 'title' => '期间内的平均BlockIndexCache命中次数', + 'description' => '平均 Block Index Cache 命中数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgDiskReads' => [ + 'title' => '期间内的平均物理读次数', + 'description' => '平均磁盘读次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'RetryCount' => [ + 'description' => '重试次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'AvgMemstoreReadRows' => [ + 'title' => '期间内的强一致性事务百分比', + 'description' => '平均 Memstore 读行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgSsstoreReadRows' => [ + 'title' => '期间内的弱一致性事务百分比', + 'description' => '平均 SSTable读行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'AvgLogicalReads' => [ + 'title' => '期间内 sql 平均逻辑读', + 'description' => '平均逻辑读。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'DynamicSql' => [ + 'title' => '是否动态SQL', + 'description' => '是否动态 SQL。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SqlList' => [ + 'description' => 'SQL 列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Executions' => [ + 'description' => '期间的总执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'RpcCount' => [ + 'title' => '期间的RPC次数', + 'description' => 'SQL 总 RPC 次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'RemotePlans' => [ + 'description' => 'SQL 远程执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'MissPlans' => [ + 'description' => 'SQL 未命中计划缓存次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'MaxElapsedTime' => [ + 'title' => '期间最大响应时间', + 'description' => 'SQL 最大响应时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10000', + ], + 'TotalWaitTime' => [ + 'title' => '期间总等待时间', + 'description' => 'SQL 执行时，总等待时间（单位：ms），对应 v$sql_audit.total_wait_time_micro（单位：us）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100000', + ], + 'ExecPs' => [ + 'title' => '期间的平均每秒执行次数', + 'description' => 'SQL 执行频率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.31', + ], + 'MaxCpuTime' => [ + 'title' => '最大CPU时间', + 'description' => 'SQL 最大 CPU 时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '257.967', + ], + 'ClientIp' => [ + 'title' => '客户端 IP。', + 'description' => '客户端 IP。', + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'admin', + ], + 'DbName' => [ + 'title' => '数据库名', + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'test', + ], + 'RetCode4012Count' => [ + 'title' => '期间内结果码4012的发生次数', + 'description' => '错误码 4012 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode4013Count' => [ + 'title' => '期间内结果码4013的发生次数', + 'description' => '错误码 4013 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5001Count' => [ + 'title' => '期间内结果码5001的发生次数', + 'description' => '错误码 5001 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5024Count' => [ + 'title' => '期间内结果码5024的发生次数', + 'description' => '错误码 5024 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5167Count' => [ + 'title' => '期间内结果码5167的发生次数', + 'description' => '错误码 5167 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode5217Count' => [ + 'title' => '期间内结果码5217的发生次数', + 'description' => '错误码 5217 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetCode6002Count' => [ + 'title' => '期间内结果码6002的发生次数', + 'description' => '错误码 6002 出现次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'FailPercentage' => [ + 'title' => '期间内的错误百分比', + 'description' => 'SQL 执行错误率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'SumWaitTime' => [ + 'title' => '期间内的总等待时间（毫秒）', + 'description' => 'SQL 最大等待事件的等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '9421.73', + ], + 'AvgWaitCount' => [ + 'title' => '期间内的平均等待次数', + 'description' => 'SQL 平均等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgRpcCount' => [ + 'title' => '期间内的平均发送RPC次数', + 'description' => 'SQL 平均 RPC 次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'LocalPlanPercentage' => [ + 'title' => '期间内的本地计划百分比', + 'description' => 'SQL Local 计划比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemotePlanPercentage' => [ + 'title' => '期间内的远程计划百分比', + 'description' => 'SQL Remote 计划比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DistPlanPercentage' => [ + 'title' => '期间内的分布式计划百分比', + 'description' => 'SQLDistributed 计划比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SumElapsedTime' => [ + 'title' => '期间内的总响应时间（毫秒）', + 'description' => 'SQL 总响应时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '11452126.36', + ], + 'AvgNetTime' => [ + 'title' => '期间内的平均网络传输时间（毫秒）', + 'description' => 'SQL 平均网络 IO 时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgExecutorRpcCount' => [ + 'title' => '期间内的平均执行RPC请求次数', + 'description' => 'SQL 远程执行次数， 对应 v$sl_audit.executor_rpc。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MissPlanPercentage' => [ + 'title' => '期间内的计划命中率', + 'description' => 'SQL 未命中计划比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'TableScanPercentage' => [ + 'title' => '期间内的表扫描百分比', + 'description' => 'SQL 全表扫描比率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'StrongConsistencyPercentage' => [ + 'title' => '期间内的强一致性事务百分比', + 'description' => 'SQL 强读比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'WeakConsistencyPercentage' => [ + 'title' => '期间内的弱一致性事务百分比', + 'description' => 'SQL 弱读比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxAffectedRows' => [ + 'title' => '期间内的最大影响行数', + 'description' => 'SQL 最大影响行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10000', + ], + 'MaxReturnRows' => [ + 'title' => '期间内的最大返回行数', + 'description' => 'SQL 最大返回行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxWaitTime' => [ + 'title' => '期间内的最大等待时间（毫秒', + 'description' => 'SQL 最大等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3.4', + ], + 'MaxApplicationWaitTime' => [ + 'title' => '期间内的最大Application事件等待时间（毫秒）', + 'description' => 'SQL 最大应用等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxConcurrencyWaitTime' => [ + 'title' => '期间内的最大Concurrency事件等待时间（毫秒）', + 'description' => 'SQL 最大并发等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxUserIoWaitTime' => [ + 'title' => '期间内的最大UserIO事件等待时间（毫秒）', + 'description' => 'SQL 最大 IO 等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MaxDiskReads' => [ + 'title' => '期间内的最大物理读次数', + 'description' => '最大磁盘读次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgExpectedWorkerCount' => [ + 'title' => '期间内平均并行度', + 'description' => '预期并发数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'AvgUsedWorkerCount' => [ + 'title' => '期间内sql平均使用线程数', + 'description' => '使用并发数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3', + ], + 'SumLogicalReads' => [ + 'title' => '期间内 sql 总逻辑读', + 'description' => '总逻辑读。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'Server' => [ + 'title' => 'SQL执行所在的Server', + 'description' => 'OBServer', + 'type' => 'string', + 'example' => '10.**.**.6', + ], + 'ServerIp' => [ + 'title' => 'SQL执行所在的Server的IP', + 'description' => 'OBServer IP', + 'type' => 'string', + 'example' => '11.***.**.69', + ], + 'ServerPort' => [ + 'title' => 'SQL执行所在的Server的Port', + 'description' => 'OBServer port', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '389', + ], + 'SqlTextShort' => [ + 'title' => 'SQL的文本（前100字符）', + 'description' => 'SQL 文本（前100字符）。', + 'type' => 'string', + 'example' => 'select * from test', + ], + 'SqlType' => [ + 'title' => 'SQL类型', + 'description' => 'SQL 类型。', + 'type' => 'string', + 'example' => 'SELECT', + ], + 'SqlId' => [ + 'title' => 'SQL id', + 'description' => 'SQL ID', + 'type' => 'string', + 'example' => '4CE89****8536A03374DD2****E76DE5', + ], + 'Inner' => [ + 'title' => '是否是内部SQL', + 'description' => '是否是内部 SQL。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'WaitEvent' => [ + 'title' => '期间内的最长等待事件', + 'description' => '最长等待事件。', + 'type' => 'string', + 'example' => 'none', + ], + 'AvgAffectedRows' => [ + 'title' => '期间内平均更新行数', + 'description' => '平均影响行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '9978.75', + ], + 'AvgReturnRows' => [ + 'title' => '期间内平均返回行数', + 'description' => '平均返回行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgPartitionCount' => [ + 'title' => '期间内平均访问分区数', + 'description' => '平均访问分区数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'FailCount' => [ + 'description' => '执行出错次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22', + ], + 'AvgWaitTime' => [ + 'title' => '期间内的平均等待时间（毫秒）', + 'description' => '平均等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.42', + ], + 'AvgElapsedTime' => [ + 'title' => '期间内的平均响应时间（毫秒）', + 'description' => '平均响应时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1876.78', + ], + 'AvgCpuTime' => [ + 'title' => '期间内的平均CPU时间（毫秒）', + 'description' => '平均 CPU 时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '@avgCpuTime > 20 and @executions > 100', + ], + 'AvgNetWaitTime' => [ + 'title' => '期间内的平均网络入队时间（毫秒）', + 'description' => '平均网络时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgQueueTime' => [ + 'title' => '期间内的平均排队时间（毫秒）', + 'description' => '平均排队时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.01', + ], + 'AvgDecodeTime' => [ + 'title' => '期间内的平均语法解析时间（毫秒）', + 'description' => '平均语法解析时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgGetPlanTime' => [ + 'title' => '期间内的平均计划生成时间（毫秒）', + 'description' => '平均计划生成时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgExecuteTime' => [ + 'title' => '期间内的平均计划执行时间（毫秒）', + 'description' => '平均计划执行时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1895.7', + ], + 'AvgApplicationWaitTime' => [ + 'title' => '期间内的平均Application事件等待时间（毫秒）', + 'description' => '平均应用等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgConcurrencyWaitTime' => [ + 'title' => '期间内的平均Concurrency事件等待时间（毫秒）', + 'description' => '平均并发等待时间（毫秒）', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgUserIoWaitTime' => [ + 'title' => '期间内的平均UserIO事件等待时间（毫秒）', + 'description' => '平均用户 IO 时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgScheduleTime' => [ + 'title' => '期间内的平均Schedule事件等待时间（毫秒）', + 'description' => '平均调度时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgRowCacheHit' => [ + 'title' => '期间内的平均RowCache命中次数', + 'description' => '平均 Row Cache 命中次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgBloomFilterCacheHit' => [ + 'title' => '期间内的平均BloomFilterCache命中次数', + 'description' => '平均 Bloom Filter Cache 命中次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgBlockCacheHit' => [ + 'title' => '期间内的平均BlockCache命中次数', + 'description' => '平均 Block Cache 命中次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgBlockIndexCacheHit' => [ + 'title' => '期间内的平均BlockIndexCache命中次数', + 'description' => '平均 Block Index Cache 命中次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgDiskReads' => [ + 'title' => '期间内的平均物理读次数', + 'description' => '平均磁盘读次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RetryCount' => [ + 'description' => '重试次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'AvgMemstoreReadRows' => [ + 'title' => '期间内的强一致性事务百分比', + 'description' => '平均 Memstore 读行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgSsstoreReadRows' => [ + 'title' => '期间内的弱一致性事务百分比', + 'description' => '平均 SSTable 读行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgLogicalReads' => [ + 'title' => '期间内 sql 平均逻辑读', + 'description' => '平均逻辑读。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AvgDbTime' => [ + 'description' => '平均数据库时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SumDbTime' => [ + 'description' => '总数据库时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'FormatSqlId' => [ + 'title' => 'FormatSqlId', + 'description' => 'FormatSqlId', + 'type' => 'string', + ], + ], + ], + ], + 'AvgDbTime' => [ + 'description' => '平均数据库时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SumDbTime' => [ + 'description' => '总数据库时间（毫秒）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'FormatSqlId' => [ + 'title' => 'FormatSqlId', + 'description' => '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' => '查询慢 SQL 列表', + ], + 'DescribeOutlineBinding' => [ + 'summary' => '根据 SQLID 查询一条 SQL 在数据库中被绑定的 Outline 信息或限流信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't2mr3oae0****', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => [ + 'title' => '表名称。', + 'description' => '租户名称。'."\n" + .'长度为 2~20 个字符，支持英文字母、数字和下划线，区分大小写，必须以字母或下划线开头，不可设置为 sys。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pay_online', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名称', + 'description' => '数据库名称。', + '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' => '- 当值为 True 时，查询 SQLID 在数据库中的限流信息。 '."\n" + .'- 当值为 False 时，查询 SQLID 在数据库中绑定索引或是绑定执行计划信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否模版sql', + 'description' => '是否模版sql', + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'FormatSqlId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'format sqlId', + 'description' => 'format sqlId', + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果', + 'type' => 'object', + 'properties' => [ + 'OutlineBinding' => [ + 'title' => '绑定信息', + 'description' => '绑定信息。', + 'type' => 'object', + 'properties' => [ + 'BindPlan' => [ + 'title' => '绑定计划', + 'description' => '绑定计划。', + 'type' => 'string', + 'example' => 'PHY_TABLE_SCAN | bmsql_order_line | 40 ******', + ], + 'OutlineId' => [ + 'title' => 'OutlineID', + 'description' => 'OutlineID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'BindIndex' => [ + 'title' => '绑定索引', + 'description' => '绑定索引。', + 'type' => 'string', + 'example' => 'PRIMARY', + ], + 'MaxConcurrent' => [ + 'title' => '最大并发', + 'description' => '最大并发。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TableName' => [ + 'title' => '表名称', + 'description' => '表名称', + 'type' => 'string', + 'example' => 'cluster_info', + ], + 'SqlText' => [ + 'title' => '限流的文本', + 'description' => '限流的文本', + 'type' => 'string', + ], + 'SqlTextConcurrentNum' => [ + 'title' => '限流的数值', + 'description' => '限流的数值', + 'type' => 'integer', + 'format' => 'int64', + ], + 'ByFormatSqlId' => [ + 'title' => '是否为模糊绑定', + 'description' => '是否为模糊绑定', + 'type' => 'boolean', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 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' => '查询 Outline 绑定信息', + ], + 'DescribeRecommendIndex' => [ + 'summary' => '根据 SQLID 查询诊断系统对 SQL 的索引推荐信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't2mr3oae0****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'SQLId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'SQLID', + 'description' => '可在 DescribeSlowSQLList/DescribeTopSQLList 接口的返回值中获取 SQLID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'RecommendIndex' => [ + 'title' => '推荐索引信息', + 'description' => '推荐索引信息。', + 'type' => 'object', + 'properties' => [ + 'SuggestIndex' => [ + 'title' => '建议索引，如果是主键，就是 PRIMARY，如果不是主键，以用户取名为准', + 'description' => '返回根据诊断系统计算后为 SQL 语句推荐的索引。 '."\n" + .'- 如推荐的索引为主键，则返回 PRIMARY； '."\n" + .'- 如推荐用户创建的索引，则返回索引名。 '."\n" + .'当前系统仅为 SQL 推荐一个索引，可通过 DescribeIndexes API 查看一个表的索引数据。', + 'type' => 'string', + 'example' => 'PRIMARY', + ], + 'TenantMode' => [ + 'title' => '租户模式', + 'description' => '返回租户模式。 当前支持： '."\n" + .'- Oracle：Oracle 模式。 '."\n" + .'- MySQL: MySQL 模式。', + 'type' => 'string', + 'example' => 'mysql', + ], + 'TableList' => [ + 'title' => '表信息', + 'description' => '表信息。 '."\n" + .'返回 SQLID 对应 SQL 语句涉及到的数据表，如单表查询，则返回访问的单张数据表，如关联查询，则返回 SQL 语句访问的所有数据表，以竖线分隔，如 "Table1|Table2"。', + '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' => '查询 SQL 索引推荐信息', + ], + 'DescribeSQLTuningAdvices' => [ + 'summary' => '查询 SQL 的优化建议包括两种：索引创建的建议、执行计划绑定的建议。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id', + 'description' => '集群id', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'obsdf43****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID', + 'description' => '租户ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'tsdc2s2****', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名称', + 'description' => '数据库名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testdb', + ], + ], + [ + 'name' => 'SqlId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'SqlId', + 'description' => 'SqlId', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '开始时间', + 'description' => '开始时间', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T04:38:38Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '结束时间', + 'description' => '结束时间', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-04-12T05:38:38Z', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => [ + 'description' => '支持的语言。取值：'."\n" + .'- 中文：zh-CN'."\n" + .'- 英文：en-US', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Data' => [ + 'description' => 'SQL 执行计划信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'SQL 执行计划信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '优化类型', + 'type' => 'string', + 'example' => 'PLAN_BINDING/INDEX_CREATION', + ], + 'ColumnNames' => [ + 'description' => '索引列顺序', + 'type' => 'string', + 'example' => 'c1;c2;c3', + ], + 'LocalityType' => [ + 'title' => '索引类型', + 'description' => '索引类型', + 'type' => 'string', + 'example' => 'Local/Global', + ], + 'Columns' => [ + 'title' => '索引列', + 'description' => '索引列列表', + 'type' => 'array', + 'items' => [ + 'description' => '索引列信息', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'title' => '列名', + 'description' => '列名', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'Ndv' => [ + 'title' => 'NDV', + 'description' => 'NDV', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'MinValue' => [ + 'title' => '最小值', + 'description' => '最小值', + 'type' => 'string', + 'example' => '1', + ], + 'MaxValue' => [ + 'title' => '最大值', + 'description' => '最大值', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + 'DbName' => [ + 'title' => '数据库名称', + 'description' => '数据库名称', + 'type' => 'string', + 'example' => 'test_db', + ], + 'Table' => [ + 'title' => '表名', + 'description' => '表名', + 'type' => 'string', + 'example' => 'test_table', + ], + 'Plan' => [ + 'description' => '执行计划', + 'type' => 'object', + 'properties' => [ + 'Executions' => [ + 'description' => '期间的总执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2062', + ], + 'AvgCpuTime' => [ + 'description' => '期间内的平均 CPU 时间（毫秒）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100.36', + ], + 'PlanHash' => [ + 'description' => 'SQL 执行计划在诊断系统内部的标识。', + 'type' => 'string', + 'example' => '-86290582****886880', + ], + 'TimeoutPercentage' => [ + 'description' => '超时百分比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'AvgConcurrencyWaitTime' => [ + 'description' => '期间内的平均 Concurrency 事件等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'FirstLoadTimeUs' => [ + 'description' => '首次加载时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1672367130576163', + ], + 'AvgDiskWrites' => [ + 'description' => '期间内的平均物理写入次数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'AvgUserIoWaitTime' => [ + 'description' => '期间内的平均 UserIo 事件等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'PlanSize' => [ + 'description' => '计划大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '49216', + ], + 'ServerSn' => [ + 'description' => '节点 ID。', + 'type' => 'string', + 'example' => 'i-bp1*****sw64dhb*****', + ], + 'OutlineData' => [ + 'description' => 'SQL 执行计划的 outline_data 字段。', + 'type' => 'string', + 'example' => 'xxxxx', + ], + 'PlanType' => [ + 'description' => 'Plan 类型：LOCAL、REMOTE、DIST。', + 'type' => 'string', + 'example' => 'LOCAL', + ], + 'ObDbId' => [ + 'description' => '数据库 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1108307720799259', + ], + 'HitPercentage' => [ + 'description' => '命中率。', + 'type' => 'number', + 'format' => 'float', + 'example' => '66.8', + ], + 'AvgBufferGets' => [ + 'description' => '计划在期间内的平均缓存读次数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ExecPs' => [ + 'description' => '期间的平均每秒执行次数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1.45', + ], + 'DelayedLargeQueryPercentage' => [ + 'description' => '长时间执行查询的延迟百分比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'TableScan' => [ + 'description' => '是否全表扫描。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'LargeQueryPercentage' => [ + 'description' => '长时间执行查询的完成百分比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'SchemaVersion' => [ + 'description' => 'Schema 版本。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1672367130529680', + ], + 'PlanId' => [ + 'description' => '计划 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '818', + ], + 'FirstLoadTime' => [ + 'description' => '首次加载时间。', + 'type' => 'string', + 'example' => '2022-12-30T02:25:30.576Z', + ], + 'AvgRowProcessed' => [ + 'description' => '期间内的平均行处理等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'MergedVersion' => [ + 'description' => '合并版本。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'HitDiagnosis' => [ + 'description' => '是否命中诊断。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Uid' => [ + 'description' => 'Plan 的唯一标识。', + 'type' => 'string', + 'example' => 'AAAAAAAAAAEAAAAAAAADMgAF8QJQwIUj', + ], + 'AvgApplicationWaitTime' => [ + 'description' => '期间内的平均 Application 事件等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'CollectTimeUs' => [ + 'description' => '收集时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1672358400000000', + ], + 'AvgElapsedTime' => [ + 'description' => '期间内的平均间隔等待时间（毫秒）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '713.62', + ], + 'ObServerId' => [ + 'description' => 'server ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'OutlineId' => [ + 'description' => 'Outline ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AvgDiskReads' => [ + 'description' => '期间内的平均物理读次数。', + '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' => '查询 SQL 的优化建议', + ], + 'DescribeSqlAuditStat' => [ + 'summary' => '按照客户端IP、用户、SQLID的维度统计SQL数据执行情况', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群实例Id', + 'description' => '集群实例 ID', + 'type' => 'string', + 'required' => false, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户Id', + 'description' => '租户 ID', + 'type' => 'string', + 'required' => false, + 'example' => 't33h8y08k****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '开始时间 yyyy-MM-dd\'T\'HH:mm:ss\'Z\'', + 'description' => '开始时间 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' => '结束时间 yyyy-MM-dd\'T\'HH:mm:ss\'Z\' （时间跨度不能超过6小时）', + 'type' => 'string', + 'required' => false, + 'example' => '2025-01-14T03:34:49Z', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页大小', + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页页码', + 'description' => '分页页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'OperatorType', + 'in' => 'formData', + 'schema' => [ + 'title' => '操作类型', + 'description' => '操作类型', + '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' => '请求返回的信息', + 'type' => 'array', + 'items' => [ + 'description' => '请求返回的信息', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => '集群实例Id', + 'description' => '集群实例 ID', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'TenantId' => [ + 'title' => '租户Id', + 'description' => '租户 ID', + 'type' => 'string', + 'example' => 't33h8y08k****', + ], + 'UserClientIp' => [ + 'title' => '客户端IP', + 'description' => '客户端 IP', + 'type' => 'string', + 'example' => 'xx.xx.xx.xx'."\n", + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => '用户名', + 'type' => 'string', + 'example' => 'test_mysql ', + ], + 'DatabaseName' => [ + 'title' => '数据库名', + 'description' => '数据库名', + 'type' => 'string', + 'example' => 'test_database_1', + ], + 'SqlId' => [ + 'title' => 'SqlID', + 'description' => 'Sql ID', + 'type' => 'string', + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + 'TotalSucceed' => [ + 'title' => '总成功条数', + 'description' => '总成功条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalFailed' => [ + 'title' => '总失败条数', + 'description' => '总失败条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'TotalAffectRows' => [ + 'title' => '总影响行数', + 'description' => '总影响行数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalScanRows' => [ + 'title' => '总扫描行数', + 'description' => '总扫描行数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalReturnRows' => [ + 'title' => '总返回行数', + 'description' => '总返回行数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AffectRows' => [ + 'title' => '平均影响行数（0的数据不计算在内）四舍五入', + 'description' => '平均影响行数（0的数据不计算在内）四舍五入', + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'ScanRows' => [ + 'title' => '平均扫描行数0的数据不计算在内）四舍五入', + 'description' => '平均扫描行数0的数据不计算在内）四舍五入', + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'ReturnRows' => [ + 'title' => '平均返回行数（0的数据不计算在内）四舍五入', + 'description' => '平均返回行数（0的数据不计算在内）四舍五入', + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'ExecuteTime' => [ + 'title' => '平均执行耗时 单位ms', + 'description' => '平均执行耗时 单位ms', + 'type' => 'number', + 'format' => 'double', + 'example' => '142', + ], + 'SqlStatement' => [ + 'title' => 'SQL模板', + 'description' => 'SQL模板', + 'type' => 'string', + 'example' => 'UPDATE `oceanbase_test_table` SET `name` = ? WHERE `key` = ?', + ], + 'OperatorType' => [ + 'title' => '操作类型', + 'description' => '操作类型', + 'type' => 'string', + 'example' => 'UPDATE', + ], + ], + ], + ], + 'TotalCount' => [ + 'title' => '总数', + 'description' => '总数', + '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' => '统计 SQL 执行情况', + ], + 'CreateOasOutlineTask' => [ + 'summary' => '发起 Outline 绑定任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '实例Id', + 'description' => '实例 ID', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户 ID', + 'type' => 'string', + 'required' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'SqlText', + 'in' => 'formData', + 'schema' => [ + 'title' => 'sql文本', + 'description' => 'SQL 文本', + 'type' => 'string', + 'required' => true, + 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名', + 'description' => '数据库名', + 'type' => 'string', + 'required' => true, + 'example' => 'test_data', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => [ + 'title' => '表名', + 'description' => '表名', + 'type' => 'string', + 'required' => false, + 'example' => 'test_1', + ], + ], + [ + 'name' => 'SqlId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'sqlId', + 'description' => 'SQL ID', + 'type' => 'string', + 'required' => false, + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + ], + [ + 'name' => 'IsConcurrentLimit', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否为限流', + 'description' => '是否为限流', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DynamicSql', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否为动态SQL', + 'description' => '是否为动态 SQL', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'UId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OceanBase 数据库用户标识符', + 'type' => 'string', + 'required' => false, + 'example' => '139*************', + ], + ], + [ + 'name' => 'PlanData', + 'in' => 'formData', + 'schema' => [ + 'title' => '执行计划', + 'description' => '执行计划', + 'type' => 'string', + 'required' => false, + 'example' => '********', + ], + ], + [ + 'name' => 'IndexName', + 'in' => 'formData', + 'schema' => [ + 'title' => '索引名', + 'description' => '索引名', + 'type' => 'string', + 'required' => false, + 'example' => 'idx_a', + ], + ], + [ + 'name' => 'MaxConcurrent', + 'in' => 'formData', + 'schema' => [ + 'title' => '限流数值', + 'description' => '限流数值', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '开始时间', + 'description' => '开始时间', + 'type' => 'string', + 'required' => false, + 'example' => '2025-05-13T15:40:43Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '结束时间', + 'description' => '结束时间', + 'type' => 'string', + 'required' => false, + 'example' => '2025-05-13T16:40:43Z', + ], + ], + [ + 'name' => 'StatementId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'sql模版id'."\n", + 'description' => 'SQL 模版 ID', + 'type' => 'string', + 'required' => false, + 'example' => '********', + ], + ], + [ + 'name' => 'BySqlId', + 'in' => 'formData', + 'schema' => [ + 'title' => '用来判断是通过sqlId/sqlText绑定，默认为true', + 'description' => '判断是通过 SQLID/SQLText 绑定，默认为 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' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Success' => [ + 'title' => '提交成功/失败', + 'description' => '是否调用成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '信息', + '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' => '发起 Outline 绑定任务', + 'description' => '任务绑定采用异步执行机制，您可通过 DescribeOutlineBinding 接口查询绑定结果。', + 'requestParamsDescription' => '* 发起限流：IsConcurrentLimit 和 MaxConcurrent 不能为空 '."\n" + .'* 绑定索引：TableName 和 IndexName 不能为空 '."\n" + .'* 绑定执行计划：PlanData 不能为空', + ], + 'ModifyInstanceSSL' => [ + 'summary' => '该接口用于修改实例的 SSL 配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'EnableSSL', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => '修改 SSL 状态，取值范围：'."\n" + .'- open：开启 SSL 加密。'."\n" + .'- update：更新 CA 证书。'."\n" + .'- close：关闭 SSL 加密。', + 'type' => 'string', + 'required' => true, + 'example' => 'open', + 'enum' => [], + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'InstanceSSL' => [ + 'title' => 'job', + 'description' => 'OceanBase 实例的 SSL 配置。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'EnableSSL' => [ + 'description' => '修改 SSL 状态，取值范围：'."\n" + .'- open：开启 SSL 加密。'."\n" + .'- update：更新 CA 证书。'."\n" + .'- close：关闭 SSL 加密。', + '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' => '修改 SSL 配置', + ], + 'DescribeInstanceSSL' => [ + 'summary' => '该接口用于查询 OceanBase 集群的 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' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'OceanBase租户ID', + 'description' => 'OceanBase租户ID', + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C', + ], + 'InstanceSSL' => [ + 'description' => '云监控实例详情。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'EnableSSL' => [ + 'description' => '是否开启 SSL 链路加密功能。', + 'type' => 'string', + 'example' => 'OPEN', + ], + 'ValidPeriod' => [ + 'description' => '有效期。', + 'type' => 'string', + 'example' => '2024-09-20 07:55:03.0', + ], + 'CaUrl' => [ + 'description' => 'ca 节点地址。', + 'type' => 'string', + 'example' => 'https://xxxx', + ], + 'Status' => [ + 'description' => '开启 SSL 状态。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'ForceSSLSupport' => [ + 'title' => '是否支持强制开启SSL', + 'description' => '是否支持强制开启 SSL。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ForceSSL' => [ + 'title' => '强制开启状态', + 'description' => '强制开启状态。', + 'type' => 'string', + 'example' => 'CLOSE', + 'enum' => [ + 'CLOSE', + 'OPEN', + ], + ], + 'AutoUpdate' => [ + 'description' => '是否开启 SSL 证书自动更新。', + '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' => '查询集群 SSL', + ], + 'CreateSecurityIpGroup' => [ + 'summary' => '创建一个 IP 白名单组。', + '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' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP安全白名单列表。 其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。最多可设置 40 个。', + 'description' => 'IP 白名单分组中的 IP 地址或地址段。 '."\n" + .'其为一个 JSON 格式的数组，数组中每个对象为一个 IP 字符串或者 IP 段，支持如下两种格式： '."\n" + .'- IP 地址形式，例如：["10.23.12.24"]。'."\n" + .'- CIDR 形式，例如：["10.23.12.24/24"]（无类域间路由，24 表示地址中前缀的长度，长度范围为 1~30）。 限制：单个白名单分组支持最多 40 个地址或地址段，所有白名单分组累计支持 200 个。', + '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' => '白名单分组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pay_online', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'SecurityIpGroup' => [ + 'title' => '白名单分组信息。', + 'description' => '白名单分组信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'SecurityIpGroupName' => [ + 'title' => '白名单分组名称。', + 'description' => '白名单分组名称。', + 'type' => 'string', + 'example' => 'pay_online', + ], + 'SecurityIps' => [ + 'title' => 'IP白名单分组中的IP地址或地址段。其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。', + 'description' => 'IP 白名单分组中的 IP 地址或地址段。 '."\n" + .'返回值 SecurityIps 是逗号分割的字符串。', + 'type' => 'string', + 'example' => '["192.***.1.1"]', + ], + ], + ], + ], + ], + ], + ], + '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' => '创建白名单组', + ], + 'DescribeSecurityIpGroups' => [ + 'summary' => '查看 IP 安全白名单分组列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'i-bp67acfmxazb4p****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'TotalCount' => [ + 'title' => '查询到的白名单分组个数。', + 'description' => '查询到的白名单分组个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SecurityIpGroups' => [ + 'title' => 'IP白名单分组信息。', + 'description' => 'IP 白名单分组列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'SecurityIps' => [ + 'title' => 'IP安全白名单列表。其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。', + 'description' => 'IP 安全白名单列表。'."\n" + .'其为一个 String 格式的数组，数组中每个对象为一个 IP 字符串或者 IP 段。', + 'type' => 'string', + 'example' => '127.*.*.1', + ], + 'SecurityIpGroupName' => [ + 'title' => '安全组名称。', + 'description' => '安全组名称。', + 'type' => 'string', + 'example' => 'default', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询 IP 安全白名单分组列表', + ], + 'DescribeTenantSecurityConfigs' => [ + 'summary' => '租户安全配置检测。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户Id', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'CheckId', + 'in' => 'formData', + 'schema' => [ + 'title' => '安全检测的唯一标识', + 'description' => '安全检测的唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => '****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '523E7183-1490-590D-BA03-12DFD316614B', + ], + 'Configs' => [ + 'description' => '配置列表。', + 'type' => 'object', + 'properties' => [ + 'TotalCheckCount' => [ + 'title' => '安全配置总体检测项目', + 'description' => '安全配置总体检测项目。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'TotalRiskCount' => [ + 'title' => '检测出来的总体风险项目', + 'description' => '检测出来的总体风险项目。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TenantSecurityConfigs' => [ + 'title' => '检测结果', + 'description' => '检测结果。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'TenantId' => [ + 'title' => '租户Id', + 'description' => '租户 ID。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'TenantName' => [ + 'title' => '租户名称', + 'description' => '租户名称。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'RiskCount' => [ + 'title' => '租户的风险条目', + 'description' => '租户的风险条目。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SecurityConfigs' => [ + 'title' => '风险列表', + 'description' => '风险列表。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'ConfigGroup' => [ + 'title' => '风险分组', + 'description' => '风险分组。', + 'type' => 'string', + 'example' => 'WHITELIST', + ], + 'ConfigName' => [ + 'title' => '风险项目名称', + 'description' => '风险项目名称。', + 'type' => 'string', + 'example' => 'WHITELIST_RANGE_LARGE', + ], + 'Risk' => [ + 'title' => '是否有风险', + 'description' => '是否有风险。', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'false', + ], + 'RiskDescription' => [ + 'title' => '风险描述', + 'description' => '风险描述。', + 'type' => 'string', + 'example' => '白名单开放过大，建议按需设置', + ], + 'ConfigDescription' => [ + 'title' => '检测项名称', + 'description' => '检测项名称。', + 'type' => 'string', + 'example' => '校验集群白名单范围是否过大', + ], + ], + ], + ], + ], + ], + ], + 'CheckId' => [ + 'title' => '检测的唯一标识', + 'description' => '检测的唯一标识。', + 'type' => 'string', + 'example' => ' xxx', + ], + 'InstanceId' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'CheckTime' => [ + 'title' => '检测时间', + 'description' => '检测时间。', + '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' => '租户安全配置检测', + ], + 'DescribeTenantEncryption' => [ + 'summary' => '该接口用于查询租户加密信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'TenantName', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户名称。 '."\n" + .'长度为 2~20 个字符，支持英文字母、数字和下划线，区分大小写，必须以字母或下划线开头。 不可设置为 sys。', + 'type' => 'string', + 'required' => false, + 'example' => 'forMySQLTenant', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询的页码。 '."\n" + .'- 起始值：1'."\n" + .'- 默认值：1', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示条数，默认为 10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'TotalCount' => [ + 'description' => '总数，分页查询时生效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'TenantEncryptions' => [ + 'description' => '允许加密的场景列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '允许加密的场景列表。', + 'type' => 'object', + 'properties' => [ + 'TenantId' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'example' => 't4louaeei****', + ], + 'TenantMode' => [ + 'description' => '租户模式。 '."\n" + .'当前支持：'."\n" + .'- Oracle：Oracle 模式。 '."\n" + .'- MySQL: MySQL 模式。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'TenantName' => [ + 'description' => '租户名称。', + 'type' => 'string', + 'example' => 'forMySQLTenant', + ], + 'EnableEncryption' => [ + 'description' => '是否启用加密。取值：'."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'false', + ], + 'TenantStatus' => [ + 'description' => '租户状态。', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'Status' => [ + 'description' => '租户是否开启加密的状态。', + 'type' => 'string', + 'example' => 'OPEN', + ], + 'EncryptionType' => [ + 'title' => '加密的类型', + 'description' => '加密的类型。', + 'type' => 'string', + 'example' => 'INTERNAL', + ], + 'EncryptionKeyId' => [ + 'title' => 'xxx', + 'description' => 'kms 加密的 keyId。', + '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' => '查询租户加密信息', + ], + 'DescribeInstanceSecurityConfigs' => [ + 'summary' => '集群安全配置检测。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'CheckId', + 'in' => 'formData', + 'schema' => [ + 'title' => '检测的唯一标识', + 'description' => '检测的唯一标识', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'InstanceSecurityConfigs' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCheckCount' => [ + 'title' => '集群安全项检测总数', + 'description' => '集群安全项检测总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TotalRiskCount' => [ + 'title' => '集群安全项风险总数', + 'description' => '集群安全项风险总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SecurityConfigs' => [ + 'title' => '检测项目列表', + 'description' => '检测项目列表。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'ConfigName' => [ + 'title' => '具体检测项名称', + 'description' => '具体检测项名称。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Risk' => [ + 'title' => '是否存在风险', + 'description' => '是否存在风险。', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'RiskDescription' => [ + 'title' => '安全建议', + 'description' => '安全建议。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'ConfigGroup' => [ + 'title' => '检测分组', + 'description' => '检测分组。', + 'type' => 'string', + 'example' => 'WHITELIST', + ], + 'ConfigDescription' => [ + 'title' => '检测项名称', + 'description' => '检测项名称。', + 'type' => 'string', + 'example' => '校验集群白名单范围是否过大', + ], + ], + ], + ], + 'CheckTime' => [ + 'title' => '2023-08-07 15:30:00', + 'description' => '检查时间。', + 'type' => 'string', + 'example' => '2023-08-07 15:30:00', + ], + 'InstanceId' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'Oceanbase集群ID。', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'CheckId' => [ + 'title' => '检测的唯一标识', + 'description' => '检测的唯一标识。', + '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' => '集群安全配置检测', + ], + 'ModifySecurityIps' => [ + 'summary' => '修改分组内的 IP 列表。', + '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' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP安全白名单列表。 其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。最多可设置 40 个。', + 'description' => 'IP 安全白名单列表。 '."\n" + .'其为一个 JSON 格式的数组，数组中每个对象为一个 IP 字符串或者 IP 段。最多可设置 40 个。', + 'type' => 'string', + 'required' => false, + 'example' => '["192.168.0.0/20", "192.169.1.1"]', + ], + ], + [ + 'name' => 'SecurityIpGroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP安全白名单组的组名。 由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', + 'description' => 'IP 安全白名单组的组名。 '."\n" + .'由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', + 'type' => 'string', + 'required' => false, + 'example' => 'paytest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'SecurityIpGroup' => [ + 'title' => 'IP白名单分组信息。', + 'description' => 'IP 白名单分组信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'SecurityIpGroupName' => [ + 'title' => '安全组名称。', + 'description' => '安全组名称。', + 'type' => 'string', + 'example' => 'online_paycore', + ], + 'SecurityIps' => [ + 'title' => 'IP安全白名单列表。其为一个Json格式的数组，数组中每个对象为一个IP字符串或者IP段。', + 'description' => 'IP 安全白名单列表。 '."\n" + ."\n" + .'其为一个 JSON 格式的数组。', + 'type' => 'string', + 'example' => '["192.***.1.2","192.***.1.1"]', + ], + ], + ], + ], + ], + ], + ], + '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' => '修改 IP 列表', + ], + 'ModifyTenantEncryption' => [ + 'summary' => '租户开启透明加密。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob2mr3oae0****', + ], + ], + [ + 'name' => 'EncryptionType', + 'in' => 'formData', + 'schema' => [ + 'description' => '加密类型：'."\n" + .'- INTERNAL：服务密钥（云服务自动生成）。'."\n" + .'- USER_KMS：自定义密钥（阿里云 KMS）。'."\n" + .'> <br>云盘加密开启后无法关闭。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'INTERNAL' => 'INTERNAL', + 'USER_KMS' => 'USER_KMS', + ], + 'example' => 'INTERNAL', + ], + ], + [ + 'name' => 'EncryptionKeyId', + 'in' => 'formData', + 'schema' => [ + 'title' => '加密使用的key', + 'description' => '密钥 ID。'."\n" + .'> <br>加密类型为服务密钥（INTERNAL）时无需填写，加密类型为自定义密钥 （USER_KMS）时必填。', + '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' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'TenantId' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'example' => 'ob2mr3oae0****', + ], + 'EncryptionType' => [ + 'description' => '加密类型：'."\n" + .'- INTERNAL：服务密钥（云服务自动生成）。'."\n" + .'- USER_KMS：自定义密钥（阿里云 KMS）。'."\n" + .'> <br>云盘加密开启后无法关闭。', + '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' => '租户开启透明加密', + ], + 'DeleteSecurityIpGroup' => [ + 'summary' => '删除 Oceanbase 集群的某个 IP 白名单分组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'SecurityIpGroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP安全白名单组的组名。 由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', + 'description' => 'IP 安全白名单组的组名。'."\n" + .'由小写英文字符开头，由小写英文字符或者数字结尾，只能包含小写英文字符，数字和下划线，长度在 2-32 个字符之间。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'paytest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果。', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'SecurityIpGroup' => [ + 'title' => '删除的IP白名单分组信息。', + 'description' => '删除的 IP 白名单分组信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => 'Oceanbase集群ID。', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'SecurityIpGroupName' => [ + 'title' => '删除的IP安全白名单组的组名。', + 'description' => '删除的 IP 安全白名单组的组名。', + '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' => '删除白名单分组', + ], + 'DescribeBackupEncryptedString' => [ + 'summary' => '获取 OceanBase 整体加密的备份信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id', + 'description' => '集群id', + 'type' => 'string', + 'required' => true, + 'example' => 'ob4wibn0abo9uo', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户id', + 'description' => '租户id', + 'type' => 'string', + 'required' => true, + 'example' => 'txxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'BackupInfoJson' => [ + 'description' => '整体加密后的备份信息。', + 'type' => 'string', + 'example' => 'xxxxxxxx（加密串）', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"BackupInfoJson\\": \\"xxxxxxxx（加密串）\\"\\n }\\n}","type":"json"}]', + 'title' => '获取整体加密的备份信息', + ], + 'DescribeMetricsDataV2' => [ + 'summary' => '返回用户监控数据', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群实例Id', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'Metrics', + 'in' => 'formData', + 'schema' => [ + 'title' => '监控指标名称', + 'description' => '监控指标。<br>多个指标之间用逗号分隔。例如："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' => '开始时间 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' => '结束时间 YYYY-MM-DDThh:mm:ssZ', + 'type' => 'string', + 'required' => true, + 'example' => '2023-04-12T05:38:38Z', + ], + ], + [ + 'name' => 'Labels', + 'in' => 'formData', + 'schema' => [ + 'title' => '监控数据查询条件标签', + 'description' => '一组 kv 组成的字符串，key、value 之间用冒号分隔，kv 对之间用逗号分隔，同一 key 不同 value 间用分号分隔。例如："clusterId:ob*****,tenantId:t******;t*******,serverId:*****,zoneId:cn-hangzhou-j"。<br>'."\n" + .'key 为固定字段：'."\n" + .'- clusterId：表示 OceanBase 集群 ID。'."\n" + .'- tenantId：表示 OceanBase 租户 ID。'."\n" + .'- zoneId：表示 OB zone ID。'."\n" + .'- serverId：表示 OBServer 节点 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'clusterId:ob***', + ], + ], + [ + 'name' => 'GroupByLabels', + 'in' => 'formData', + 'schema' => [ + 'title' => '监控数据分组标签', + 'description' => '用于分组的字段。多个字段之间用逗号分隔。例如："clusterId,tenantId" 。', + 'type' => 'string', + 'required' => true, + 'example' => 'clusterId', + ], + ], + [ + 'name' => 'SortMetricKey', + 'in' => 'formData', + 'schema' => [ + 'title' => 'SortMetricKey', + 'description' => '排序列。', + 'type' => 'string', + 'required' => false, + 'example' => 'tps', + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序顺序', + 'description' => '排序规则。'."\n" + .'- 升序：ASC。'."\n" + .'- 降序：DESC。', + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序后返回的 Data 数组长度', + 'description' => '排序后返回的 Data 数组长度。', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ReplicaType', + 'in' => 'formData', + 'schema' => [ + 'title' => '副本类型', + 'description' => '副本类型。<br>'."\n" + .'OceanBase 集群监控根据副本类型设置节点过滤条件。'."\n" + .'- 默认不传, 可用于 OceanBase 监控或查询访问代理监控，查询 OceanBase 监控时，表示查询所有副本类型节点的监控数据。'."\n" + .'- FULL，仅对 OceanBase 监控生效，表示只查询全功能副本节点上的监控数据。 '."\n" + .'- READONLY，仅对 OceanBase 监控生效，表示只查询只读副本节点上的监控数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'FULL', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'title' => '数据集合', + 'description' => '请求返回的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Labels' => [ + 'title' => '数据标签', + 'description' => '数据标签。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'clusterId:ob********', + 'description' => '标签详情。', + ], + ], + 'Data' => [ + 'description' => '请求返回的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'MetricValue' => [ + 'title' => '监控指标数据', + 'description' => '监控指标数据', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '\'load1\': 1.29', + 'description' => '指标数据。', + ], + ], + 'Timestamp' => [ + 'title' => '时间戳', + 'description' => '时间戳', + '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' => '查询监控指标数据', + ], + 'DescribeMetricsData' => [ + 'summary' => '该接口用于查询 OceanBase 集群的单维度或者多维度监控指标数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '集群 id', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询监控指标数据的起始时间。 该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'description' => '查询监控指标数据的起始时间。 该时间只支持 UTC 时间，格式为：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' => '查询监控指标数据的结束时间。 该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2021-06-13T15:40:43Z', + ], + ], + [ + 'name' => 'Metrics', + 'in' => 'query', + 'schema' => [ + 'title' => '监控指标', + 'description' => '监控指标。<br>多个指标之间用逗号分隔。例如："sql_all_count,sql_all_rt..."。', + 'type' => 'string', + 'required' => true, + 'example' => 'sql_all_count', + ], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => [ + 'description' => '一组 kv 组成的字符串，key、value 之间用逗号分隔，kv 对之间用逗号分隔。例如："app:OB,clusterId:ob*****,tenantId:t******,serverId:*****,zoneId:cn-hangzhou-j"。<br>'."\n" + .'k 为固定字段：'."\n" + .'- app：表示应用类型，目前仅支持 OceanBase。'."\n" + .'- clusterId：表示 OceanBase 集群 ID。'."\n" + .'- tenantId：表示 OceanBase 租户 ID。'."\n" + .'- zoneId：表示 ob zone id'."\n" + .'- serverId：表示 OBServer 节点 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app:OB,clusterId:ob***', + ], + ], + [ + 'name' => 'GroupByLabels', + 'in' => 'query', + 'schema' => [ + 'description' => '用于分组的字段。多个字段之间用逗号分隔。例如："app,clusterId,tenantId" 。', + 'type' => 'string', + 'required' => true, + 'example' => 'app,clusterId', + ], + ], + [ + 'name' => 'SortMetricKey', + 'in' => 'query', + 'schema' => [ + 'title' => '排序列', + 'description' => '排序列。', + 'type' => 'string', + 'required' => false, + 'example' => 'tps', + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'query', + 'schema' => [ + 'title' => '排序规则', + 'description' => '排序规则。'."\n" + .'- 升序：ASC。'."\n" + .'- 降序：DESC。', + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'title' => '排序后返回的Data 数组长度', + 'description' => '排序后返回的 Data 数组长度。', + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'ReplicaType', + 'in' => 'formData', + 'schema' => [ + 'description' => '副本类型。<br>'."\n" + .'OceanBase 集群监控根据副本类型设置节点过滤条件。'."\n" + .'- 默认不传, 可用于 OceanBase 监控或查询访问代理监控，查询 OceanBase 监控时，表示查询所有副本类型节点的监控数据。'."\n" + .'- FULL，仅对 OceanBase 监控生效，表示只查询全功能副本节点上的监控数据。 '."\n" + .'- READONLY，仅对 OceanBase 监控生效，表示只查询只读副本节点上的监控数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'FULL', + 'enum' => [ + 'FULL', + 'READONLY', + ], + ], + ], + [ + 'name' => 'MetricScope', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => '返回数据。', + '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' => '查询监控指标数据', + ], + 'DescribeNodeMetrics' => [ + 'summary' => '查询一个 OceanBase 节点指标信息。', + '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' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'description' => '分页查询时设置的每页行数。 '."\n" + .'- 最大值：100。 '."\n" + .'- 默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => '分页查询的页码。 '."\n" + .'- 起始值：1。 '."\n" + .'- 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'tfafd34fs****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '监控数据的起始时间。该时间只支持UTC时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'description' => '监控数据的起始时间。'."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + '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' => '监控数据的结束时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + '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' => '监控指标项。'."\n" + .'<props="china">当前可支持的指标及说明请参考 [节点监控数据详情](~~212099~~)。</props>'."\n" + .'<props="intl">当前可支持的指标及说明请参考 [节点监控数据详情](https://www.alibabacloud.com/help/zh/apsaradb-for-oceanbase/latest/node-statistics)。</props>', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'tps', + ], + ], + [ + 'name' => 'NodeName', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点名称', + 'description' => '节点名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp16niirq4zdmgvm****', + ], + ], + [ + 'name' => 'NodeIdList', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点列表', + 'description' => '节点列表。', + 'type' => 'string', + 'required' => false, + 'example' => '[i-bp16niirq4zdmgvm****,i-bp16n56hq4z4fgvm****]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数量', + 'description' => '总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-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' => '查询节点指标信息', + ], + 'DescribeTenantMetrics' => [ + 'summary' => '查询指定 OceanBase 租户指标信息。', + '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' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'description' => '分页查询时设置的每页行数。 '."\n" + .'- 最大值：100。 '."\n" + .'- 默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => '分页查询的页码。'."\n" + .'- 起始值：1。'."\n" + .'- 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TenantName', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户名称。 长度为2~20 个字符，支持英文字母、数字和下划线，区分大小写，必须以字母或下划线开头。 不可设置为 sys。TenantName、TenantId、TenantList至少填一项', + 'description' => '租户名称。'."\n" + .'长度为 2~20 个字符，支持英文字母、数字和下划线，区分大小写，必须以字母或下划线开头。 不可设置为 sys。 '."\n" + .'> <br>该参数后期会废弃，建议使用 TenantIdList。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'pay_online', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '监控数据的起始时间。该时间只支持UTC时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'description' => '监控数据的起始时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + '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' => '监控数据的结束时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + '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' => '监控指标项。 '."\n" + .'<props="china">当前可支持的指标及说明请参考 [租户监控数据详情](~~212125~~)。</props>'."\n" + ."\n" + .'<props="intl">当前可支持的指标及说明请参考 [租户监控数据详情](https://www.alibabacloud.com/help/zh/apsaradb-for-oceanbase/latest/view-tenant-statistics)。</props>', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'tps', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID。TenantName、TenantId、TenantList至少填一项', + 'description' => '租户 ID。 '."\n" + .'> <br>该参数后期会废弃，建议使用 TenantIdList。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'tfafd34fs****', + ], + ], + [ + 'name' => 'TenantIdList', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户 ID 列表，入参为JSONArray格式，需要使用双引号和方括号。'."\n" + .'TenantName、TenantId、TenantList至少填一项，', + 'description' => '租户 ID 列表。', + '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' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-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' => '查询租户指标信息', + ], + 'CreateProject' => [ + 'summary' => '本接口用于创建数据迁移或数据同步任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'UseOss', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否使用OSS方式创建', + 'description' => '是否使用 OSS 方式创建。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'OssKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '通过 GetUploadOssUrl 获取的 Osskey', + 'description' => '通过 GetUploadOssUrl 获取的 Osskey。', + 'type' => 'string', + 'required' => false, + 'example' => 'open_api_create_project/oacp_xxx', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目 ID', + 'description' => '数据迁移或数据同步任务的 ID。您需要调用 ListProjects 接口获取待配置任务的 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'np_fe****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '任务名称', + 'description' => '数据迁移或数据同步任务的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'title' => '任务类型（MIGRATION 迁移任务、SYNC 同步任务）', + 'description' => '任务的类型，包括 `MIGRATION`（表示数据迁移任务）和 `SYNC`（表示数据同步任务）。', + 'type' => 'string', + 'required' => true, + 'example' => 'MIGRATION', + 'enum' => [ + 'MIGRATION', + 'SYNC', + ], + ], + ], + [ + 'name' => 'LabelIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '标签ID。最多支持5个', + 'description' => '标签 ID 的集合，最多支持 5 个。', + 'type' => 'array', + 'items' => [ + 'description' => '标签 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'I_dfe****', + ], + 'required' => false, + 'example' => 'MIGRATION', + ], + ], + [ + 'name' => 'WorkerGradeId', + 'in' => 'formData', + 'schema' => [ + 'title' => '传输实例ID', + 'description' => '传输实例的 ID。您需要调用 ListProjects 接口获取待配置任务的 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'g_abcdefj***', + ], + ], + [ + 'name' => 'SourceEndpointId', + 'in' => 'formData', + 'schema' => [ + 'title' => '源端数据源ID', + 'description' => '源端数据源的 ID。您需要调用 `ListDataSource` 接口获取 ID，格式为 e_****。', + 'type' => 'string', + 'required' => true, + 'example' => 'e_4j0c12z****', + ], + ], + [ + 'name' => 'SinkEndpointId', + 'in' => 'formData', + 'schema' => [ + 'title' => '目标端数据源ID', + 'description' => '目标端数据源的 ID。您需要调用 `ListDataSource` 接口获取 ID，格式为 e_****。', + 'type' => 'string', + 'required' => true, + 'example' => 'e_4j0cz****', + ], + ], + [ + 'name' => 'TransferMapping', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '传输对象映射信息', + 'description' => '传输对象的映射信息。', + 'type' => 'object', + 'properties' => [ + 'Mode' => [ + 'title' => '传输对象映射模式（SPECIFIC 指定对象、WILDCARD 匹配规则）', + 'description' => '传输对象映射模式，包括 `SPECIFIC`（表示指定对象）和 `WILDCARD`（表示匹配规则）。', + 'type' => 'string', + 'required' => false, + 'example' => 'SPCEIFIC', + 'enum' => [ + 'SPECIFIC', + 'WILDCARD', + ], + ], + 'Databases' => [ + 'title' => '数据库信息', + 'description' => '数据库的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '库ID', + 'description' => '数据库的 ID。', + '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' => '映射对象所在的集群，源端为 OceanBase 数据源时生效。'."\n" + .'><notice>该参数已废弃。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'cluster_name', + ], + 'TenantName' => [ + 'title' => '映射对象租户（已废弃）', + 'description' => '映射对象所在的租户，源端为 OceanBase 数据源时生效。><notice>该参数已废弃。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'tenant_name', + ], + 'Tables' => [ + 'title' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', + 'description' => '当前数据库中传输表对象的配置。`Mode` 为 `WILDCARD` 时，该参数表示具体黑名单或白名单的配置，表和视图共用。', + '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' => '表的 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e_4l085bu7***', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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场景下使用', + 'description' => 'HBase 模式分区配置，仅迁移到 OBKV 场景下使用。', + 'type' => 'object', + 'properties' => [ + 'PartitionType' => [ + 'description' => '分区类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'RANGE', + 'enum' => [ + 'KEY', + 'RANGE', + 'NONE', + ], + ], + 'VirtualColumn' => [ + 'description' => '虚拟列，目前仅支持使用 substring 构建虚拟列。', + 'type' => 'string', + 'required' => false, + 'example' => 'substring(K, 1, 4)', + ], + 'PartitionSize' => [ + 'description' => '分区范围，取值范围为 [1,1024]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1024', + 'minimum' => '1', + 'example' => '3', + ], + ], + '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' => [ + 'description' => '视图的 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e_4himpq4z***', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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' => '具体表对象的配置集合。`mode` 为 `WILDCARD` 时，该参数表示具体表对象的重命名、行过滤配置。', + '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' => '表的 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e_4azdil4lu7***', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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' => '具体视图对象的配置。`mode` 为 `WILDCARD` 时，该参数表示具体视图对象的重命名配置。', + 'type' => 'array', + 'items' => [ + 'description' => '具体视图对象的配置。mode 为 WILDCARD 时，该参数表示具体视图对象的重命名配置。', + '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' => '视图的 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e_3wsmjv49a***', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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' => '数据库的 ID。', + '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' => '映射对象所在的集群，源端为 OceanBase 数据源时生效。><notice>该参数已废弃。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'cluster_name', + ], + 'TenantName' => [ + 'title' => '映射对象租户（已废弃）', + 'description' => '映射对象所在的租户，源端为 OceanBase 数据源时生效。><notice>该参数已废弃。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'tenant_name', + ], + 'Tables' => [ + 'title' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', + 'description' => '当前数据库中传输表对象的配置。`Mode` 为 `WILDCARD` 时，该参数表示具体黑名单或白名单的配置，表和视图共用。', + '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' => '表的 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e_474hmh5iqo***', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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' => '视图的 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e_4azdil4lu7mo', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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' => '具体表对象的配置集合。`mode` 为 `WILDCARD` 时，该参数表示具体表对象的重命名、行过滤配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'description' => '表的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'table_name', + ], + 'Id' => [ + 'title' => '表ID', + 'description' => '表的 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e_4himpq4zf***', + ], + 'MappedName' => [ + 'title' => '表映射名', + 'description' => '表的映射名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'mapped_table', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '标准的 SQL 语句中的 WHERE 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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' => '具体视图对象的配置集合。`mode` 为 `WILDCARD` 时，该参数表示具体视图对象的重命名配置。', + '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' => '视图的 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e_474hmh5iqo***', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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' => '支持的表类型。包括 ALL（所有表）、WITH_UNIQUE_ROW_ID（有唯一行标识的表）和 WITHOUT_UNIQUE_ROW_ID（无唯一行标识的表），默认值为 ALL。', + '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' => '投递至消息队列时，数据 JSON 序列化类型。包括 DEFAULT、CANAL、DATAWORKS_V2、SHAREPLEX、DEFAULT_WITH_SCHEMA、DEBEZIUM、DEBEZIUMFlatten 和 DEBEZIUMSMT。', + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT', + ], + 'MqPartitionMode' => [ + 'title' => '投递到消息队列时，分区路由方式', + 'description' => '投递至消息队列时，分区路由方式。包括 ONE（指定分区投递）、HASH（根据主键/分片列值进行 HASH 分区投递、TABLE（根据库表名进行 HASH 分区投递）。', + 'type' => 'string', + 'required' => false, + 'example' => 'ONE', + ], + 'MqPartition' => [ + 'title' => '当 partitionMode 为 ONE 时，此参数表示投递分区的在当前 topic 下的位置', + 'description' => '当 `MqPartitionMode` 为 `ONE` 时，该参数表示投递的分区在当前 Topic 下的位置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'DatahubTopicType' => [ + 'title' => '投递到消息队列（DATAHUB）时，指定 topic 的类型', + 'description' => '投递至消息队列 DataHub 时，指定 Topic 的类型。枚举值包括 `BLOB` 和 `TUPLE`。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'TUPLE', + ], + 'RocketMqProducerGroup' => [ + 'title' => '指定生产组名(目标端为 ROCKETMQ 时生效),默认 OMS', + 'description' => '指定生产组名（目标端为 ROCKETMQ 时生效），默认值为 OMS。', + 'type' => 'string', + 'required' => false, + 'example' => 'OMS', + ], + 'RocketMqMsgTags' => [ + 'title' => '设置消息 tag(目标端为 ROCKETMQ 时生效)，默认 default -> default_tag', + 'description' => '设置消息 tag（目标端为 ROCKETMQ 时生效），默认 default->default_tag。', + 'type' => 'string', + 'required' => false, + 'example' => 'default_tag', + ], + 'RocketMqEnableMsgTrace' => [ + 'title' => '是否开启消息追踪(目标端为 ROCKETMQ 时生效)', + 'description' => '是否开启消息追踪（目标端为 ROCKETMQ 时生效）。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'RocketMqSendMsgTimeout' => [ + 'title' => '设置消息投递超时时间(目标端为 ROCKETMQ 时生效)', + 'description' => '设置消息投递超时时间（目标端为 ROCKETMQ 时生效）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => 'null', + ], + 'DataWorksBusinessName' => [ + 'title' => '业务系统标识', + 'description' => '业务系统标识。用于标识数据的业务系统来源，以便您后续进行自定义处理。仅选择序列化方式为 DataWorks 时支持设置该参数，长度限制为 1~20 个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + 'SyncSchema' => [ + 'title' => '是否同步源端数据所在的 schema 到目标端（预期目标端表上会创建一个附加字段，用来接收 schema 名称，该字段见 syncSchemaColumnName 参数）', + 'description' => '是否同步源端数据所在的 Schema 到目标端（预期目标端表上会创建一个附加列，用于接收 Schema 名称，该字段见 `syncSchemaColumnName` 参数）。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'SyncSchemaColumnName' => [ + 'title' => '若开启同步 schema 到目标端的功能，可以指定同步到目标端的字段名', + 'description' => '如果开启同步 Schema 到目标端的功能，您可以指定同步到目标端的列名（需要在目标端预先创建该列）。', + 'type' => 'string', + 'required' => false, + 'example' => 'source_schema_name', + ], + 'CustomColumns' => [ + 'description' => '自定义列数组（目标端需要预先创建对应的列）。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'title' => '列名称', + 'description' => '列的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_column', + ], + 'Expression' => [ + 'title' => '列值表达式', + 'description' => '列值表达式。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'SinkStoreFormat' => [ + 'title' => '若开启同步 schema 到目标端的功能，可以指定同步到目标端的字段名', + 'description' => '目标端表对象存储类型。当目标端 OceanBase 数据库为 V4.3.0 及之后版本，并且在 **选择迁移类型** 页面选中 **结构迁移** 或 **增量同步** > **DDL 同步**，该参数生效。'."\n" + ."\n" + .'目标端表对象存储类型包括 **默认**（DEFAULT）、**行存**（ROW）、**列存**（COLUMN） 和 **行列混存**（COMPOUND），该参数用于确定结构迁移或增量同步时目标端表对象的存储类型，详情请参见 [default_table_store_format](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000002015561)。'."\n" + ."\n" + .'> **默认** 选项是根据目标端参数配置自适应其他选项，是结构迁移的表对象或增量 DDL 的新增表对象根据设置的存储类型写入对应的结构。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'DEFAULT', + ], + 'SourceStoreFormat' => [ + 'title' => '若开启同步 schema 到目标端的功能，可以指定同步到目标端的字段名', + 'description' => '源端表对象存储类型。当源端 OceanBase 数据库为 V4.3.0 及之后版本，并且在 **选择迁移类型** 页面选中 **反向增量** > **DDL 同步**，该参数生效。'."\n" + ."\n" + .'源端表对象存储类型包括 **默认**（DEFAULT）、**行存**（ROW）、**列存**（COLUMN） 和 **行列混存**（COMPOUND），该参数用于确定反向增量同步时源端表对象的存储类型，详情请参见 [default_table_store_format](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000002015561)。'."\n" + ."\n" + .'> **默认** 选项是根据目标端参数配置自适应其他选项，是反向增量时增量 DDL 的新增表对象根据设置的存储类型写入对应的结构。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'DEFAULT', + ], + ], + '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' => 'byte/char 转换方案，枚举值包括 `IGNORE_BYTE_IF_BYTE_USED`、`FORCE_CHAR_IF_BYTE_USED`、`EXPAND_LEN_IF_BYTE_USED` 和 `DO_NOTHING_IF_BYTE_USED`（默认值）。', + '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' => '处理源端无唯一索引表的全量迁移时，是否清空目标表。'."\n" + .'场景：PolarDB-X 1.0 数据库多链路无主键表汇聚至同一目标端表，避免前面若干条链路有部分数据后，另一条链路刚启动便清空了历史的迁移数据。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'AllowDestTableNotEmpty' => [ + 'title' => '允许目标端表非空，在源端多个分表向目标端一张表聚合迁移时，需要打开。'."\n" + .'注意：只有在没有选中"全量校验"的情况下，才允许打开此开关。', + 'description' => '目标端表对象存在记录时处理策略，包括 **忽略** 和 **停止迁移**。'."\n" + .'- 设置为 true，表示选择忽略：当目标端表对象存在数据时，如果原数据与写入数据冲突，数据传输采用将冲突数据记录日志，保留原数据不变的策略进行数据写入。'."\n" + .'><notice>选择忽略，全量校验将使用 IN 模式拉取数据，无法校验目标端多数据的场景，并且校验性能存在一定程度降级。></notice>'."\n" + .'- 设置为 false，表示选择停止迁移：当目标端表对象存在数据时，全量迁移会报错不允许迁移，请处理好目标端数据后再继续迁移。'."\n" + .'><notice>如果出错后单击恢复，数据传输将忽略该配置选项，继续迁移表数据，请谨慎操作。></notice>', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'FullTransferSpeedMode' => [ + 'title' => '全量传输速度', + 'description' => '全量迁移并发速度，包括 STEADY、NORMAL 和 FAST。'."\n" + .'><notice>如果有全量迁移步骤，则 FullTransferSpeedMode 必传，可以传 NORMAL。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'NORMAL', + 'default' => 'NORMAL', + 'enum' => [ + 'STEADY', + 'NORMAL', + 'FAST', + ], + ], + 'FullVerifySpeedMode' => [ + 'title' => '全量校验速度', + 'description' => '全量校验并发速度，包括 STEADY、NORMAL 和 FAST。'."\n" + .'><notice>如果有全量校验步骤，则 FullVerifySpeedMode 必传，可以传 NORMAL。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'NORMAL', + 'default' => 'NORMAL', + 'enum' => [ + 'STEADY', + 'NORMAL', + 'FAST', + ], + ], + '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' => '全量传输阶段限制能达到的最大传输速率，单位为记录数/秒。输入 null 时，表示不限制 RPS。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'null', + ], + 'ThrottleIOPS' => [ + 'title' => '限制流量，单位字节 null 不限速', + 'description' => '全量传输阶段限制能达到的最大传输流量，单位为字节/秒。输入 null 时，表示不限制 IOPS。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'null', + ], + 'HbaseObjCheckMode' => [ + 'title' => 'hbase 对象校验模式: NEWEST, ALL', + 'description' => 'HBase 对象的校验模式，包括 NEWEST 和 ALL。', + 'type' => 'string', + 'required' => false, + 'example' => 'NEWEST', + 'enum' => [ + 'ALL', + 'NEWEST', + ], + ], + 'HbaseObjMigMode' => [ + 'title' => 'hbase 对象迁移模式: NEWEST, ALL', + 'description' => 'HBase 对象的迁移模式，包括 NEWEST 和 ALL。', + 'type' => 'string', + 'required' => false, + 'example' => 'NEWEST', + 'enum' => [ + 'ALL', + 'NEWEST', + ], + ], + 'IndexDDLConcurrencyLimit' => [ + 'description' => '单条索引 DDL 并发度配置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'MaxConcurrentIndexDDLs' => [ + 'description' => '最大并发索引 DDL 数量配置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8', + ], + ], + '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', + 'PUT', + ], + ], + 'required' => false, + ], + 'StoreLogKeptHour' => [ + 'title' => '有增量同步阶段，且增量日志拉取组件为 Store 时，日志保存时间, 单位小时，默认7天，最长365天', + 'description' => '有增量同步阶段且增量日志拉取组件为 Store 时，日志的保存时间。单位为小时，默认 7 天，最长支持 365 天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '24', + ], + 'EnableSequencingWithinTxn' => [ + 'title' => '有增量同步阶段时，且增量日志拉取组件为 Store 时，是否开启事务内序号编排', + 'description' => '有增量同步阶段且增量日志拉取组件为 Store 时，是否开启事务内序号编排。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'IncrSyncConcurrency' => [ + 'title' => '增量同步线程数，默认64', + 'description' => '增量同步的线程数，默认值为 64。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1024', + 'minimum' => '1', + 'example' => '64', + 'default' => '64', + ], + 'EnableIncrSyncStatistics' => [ + 'title' => '是否开启增量记录(dml、ddl)统计', + 'description' => '是否开启增量记录（DML、DDL）统计。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'ThrottleRps' => [ + 'title' => '限制RPS null 不限速', + 'description' => '增量传输阶段限制能达到的最大传输速率，单位为记录数/秒。输入 null 时，表示不限制 RPS。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'null', + ], + 'ThrottleIOPS' => [ + 'title' => '限制流量，单位字节 null 不限速', + 'description' => '增量传输阶段限制能达到的最大传输流量，单位为字节/秒。输入 null 时，表示不限制 IOPS。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'null', + ], + 'SupportDDLTypes' => [ + 'title' => '支持DDL类型', + 'description' => '支持的 DDL 类型。', + 'type' => 'array', + 'items' => [ + 'description' => '支持的 DDL 类型。', + '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' => [ + 'StartTimestamp' => [ + 'title' => '反向增量同步位点', + 'description' => '反向增量同步起始位点。', + 'type' => 'string', + 'required' => false, + 'example' => '1684771200', + ], + 'RecordTypeWhiteList' => [ + 'title' => '有反向增量同步阶段时，同步的增量数据类型', + 'description' => '有反向增量同步阶段时，同步的增量数据类型。', + 'type' => 'array', + 'items' => [ + 'description' => '有反向增量同步阶段时，同步的增量数据类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'INSERT', + 'enum' => [ + 'HEARTBEAT', + 'INSERT', + 'UPDATE', + 'DELETE', + 'BEGIN', + 'COMMIT', + 'ROLLBACK', + 'DDL', + 'ROW', + 'PUT', + ], + ], + 'required' => false, + ], + 'StoreLogKeptHour' => [ + 'title' => '有反向增量同步阶段，且增量日志拉取组件为 Store 时，日志保存时间, 单位小时，默认7天，最长365天', + 'description' => '有反向增量同步阶段，且增量日志拉取组件为 Store 时的日志保存时间，单位为小时。默认 7 天，最长 365 天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '24', + ], + 'EnableSequencingWithinTxn' => [ + 'title' => '有反向增量同步阶段时，且增量日志拉取组件为 Store 时，是否开启事务内序号编排', + 'description' => '有反向增量同步阶段，且增量日志拉取组件为 Store 时，是否开启事务内序号编排。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'IncrSyncConcurrency' => [ + 'title' => '反向增量同步线程数，默认64', + 'description' => '反向增量同步线程数，默认值为 64。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1024', + 'minimum' => '1', + 'enumValueTitles' => [], + 'example' => '64', + 'default' => '64', + ], + 'EnableIncrSyncStatistics' => [ + 'title' => '是否开启反向增量记录(dml、ddl)统计', + 'description' => '是否开启反向增量记录（DML、DDL）统计。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'ThrottleRps' => [ + 'title' => '限制RPS null 不限速', + 'description' => '反向增量同步阶段限制能达到的最大传输速率，单位为记录数/秒。输入 null 时，表示不限制 RPS。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'null', + ], + 'ThrottleIOPS' => [ + 'title' => '限制流量，单位字节 null 不限速', + 'description' => '反向增量同步阶段限制能达到的最大传输流量，单位为字节/秒。输入 null 时，表示不限制 IOPS。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'null', + ], + 'SupportDDLTypes' => [ + 'title' => '支持DDL类型', + 'description' => '支持的 DDL 类型。', + 'type' => 'array', + 'items' => [ + 'description' => '支持的 DDL 类型。', + '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', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => '数据迁移或数据同步任务的 ID。', + '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"}]', + 'title' => '创建任务', + ], + 'StartProject' => [ + 'summary' => '本接口用于启动数据迁移或数据同步任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据迁移或数据同步任务的 ID。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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"}]', + 'title' => '启动任务', + ], + 'StopProject' => [ + 'summary' => '本接口用于暂停数据迁移或数据同步任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据迁移或数据同步任务的 ID。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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"}]', + 'title' => '暂停任务', + ], + 'ResumeProject' => [ + 'summary' => '本接口用于恢复数据迁移或数据同步任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据迁移或数据同步任务的 ID。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'Contact the administrator.', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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"}]', + 'title' => '恢复任务', + ], + 'ReleaseProject' => [ + 'summary' => '本接口用于释放数据迁移或数据同步任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据迁移或数据同步任务的 ID。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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"}]', + 'title' => '释放任务', + ], + 'DeleteProject' => [ + 'summary' => '本接口用于删除数据迁移或数据同步任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据迁移或数据同步任务的 ID。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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"}]', + 'title' => '删除任务', + 'description' => '><notice>包年包月类型的项目不支持通过调用 API 的方式删除，请使用阿里云工单退订的方式删除此项目。</notice>', + ], + 'ListProjects' => [ + 'summary' => '本接口用于数据迁移或数据同步任务列表页面的分页查询。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'SearchKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目名称或项目ID', + 'description' => '数据迁移或数据同步任务的名称/ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'np_4w****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目类型（MIGRATION,SYNC）', + 'description' => '任务的类型，包括 `MIGRATION`（表示数据迁移任务）和 `SYNC`（表示数据同步任务）。'."\n" + .'><notice> Type 参数为必填项。></notice>', + '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' => '数据迁移或数据同步任务的状态集合，包括 INIT（未启动）, RUNNING（运行中）、SUSPEND（已暂停）、FAILED（失败）、FINISHED（已完成）、RELEASING（释放中）、RELEASED（已释放）、DELETED（已删除）、RUNNING_MODIFYING（修改中）、RUNNING_MERGING（合并中）、RUNNING_ALARMING（告警中）和 UNCONFIGURED（待配置）。', + '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', + 'UNCONFIGURED', + ], + ], + 'required' => false, + 'enumValueTitles' => [], + ], + ], + [ + 'name' => 'LabelIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '标签ID集合', + 'description' => '标签 ID 的集合，最多支持 5 个。', + 'type' => 'array', + 'items' => [ + 'description' => '标签 ID。', + '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' => '排序字段，包括 `gmtCreate` 和 `gmtModified`，默认值为 `gmtCreate`。', + 'type' => 'string', + 'required' => false, + 'example' => 'gmtCreate', + ], + ], + [ + 'name' => 'Order', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序顺序（asc：升序 descend:降序），默认降序', + 'description' => '排列顺序，包括 `asc`（升序）和 `descend`（降序）。默认值为 `descend`。', + 'type' => 'string', + 'required' => false, + 'example' => 'descend', + 'default' => 'descend', + 'enum' => [ + 'asc', + 'descend', + ], + ], + ], + [ + 'name' => 'NeedRelatedInfo', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否需要查询项目关联信息，默认true（数据源连接信息、传输实例信息、项目步骤信息等）', + 'description' => '是否需要查询任务关联信息（数据源连接信息、传输实例信息、任务步骤信息等），默认值为 true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => '传输实例的 ID。', + 'type' => 'string', + 'example' => 'g_i4wa7***', + ], + 'WorkerGradeInfo' => [ + 'description' => '传输实例的详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'ID', + 'description' => '传输实例的 ID。', + 'type' => 'string', + 'example' => 'g_i4wa7***', + ], + 'Name' => [ + 'title' => '别名', + 'description' => '传输实例的别名。', + 'type' => 'string', + 'example' => 'i5fu***', + ], + 'Grade' => [ + 'title' => '规格', + 'description' => '传输实例的规格。', + 'type' => 'string', + 'example' => 'OMS_G2_MIGRATION_LARGE', + ], + 'Spec' => [ + 'title' => '规格大小', + 'description' => '传输实例的规格大小。', + 'type' => 'string', + 'example' => 'LARGE', + ], + 'SpecName' => [ + 'title' => '规格大小名称', + 'description' => '传输实例规格大小的名称。', + 'type' => 'string', + 'example' => 'LARGE', + ], + 'SourceType' => [ + 'title' => '源端数据源类型', + 'description' => '源端数据源的类型。', + 'type' => 'string', + 'example' => 'OB_MYSQL', + ], + 'SourceRegion' => [ + 'title' => '源端数据源地域', + 'description' => '源端数据源所在的地域。', + 'type' => 'string', + 'example' => 'ap-southeast-1', + ], + 'DestType' => [ + 'title' => '目标端数据源类型', + 'description' => '目标端数据源的类型。', + 'type' => 'string', + 'example' => 'OB_MYSQL', + ], + 'DestRegion' => [ + 'title' => '目标端数据源地域', + 'description' => '目标端数据源所在的地域。', + 'type' => 'string', + 'example' => 'ap-southeast-1', + ], + 'ChargeType' => [ + 'title' => '计费类型', + 'description' => '数据迁移或数据同步任务的计费类型。', + 'type' => 'string', + 'example' => 'POSTPAY', + ], + 'AutoRenewal' => [ + 'description' => '是否开启自动续费。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Expired' => [ + 'description' => '是否已到期。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'EndTime' => [ + 'title' => '到期时间，UTC时间', + 'description' => '到期时间。支持 UTC 时间，格式为 YYYY-MM-DDThh:mm:ss。', + 'type' => 'string', + 'example' => '2024-01-28T15:07:44', + ], + 'GmtCreate' => [ + 'title' => '创建时间，UTC时间', + 'description' => '创建时间。支持 UTC 时间，格式为 YYYY-MM-DDThh:mm:ss。', + 'type' => 'string', + 'example' => '2024-01-28T14:07:44', + ], + ], + ], + 'Id' => [ + 'title' => '项目 id', + 'description' => '数据迁移或数据同步任务的 ID。', + 'type' => 'string', + 'example' => 'np_4w****'."\n", + ], + 'Type' => [ + 'title' => '类型 (MIGRATION: 数据迁移任务, SYNC: 数据同步任务)', + 'description' => '任务的类型，包括 `MIGRATION`（表示数据迁移任务）和 `SYNC`（表示数据同步任务）。', + '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' => '标签 ID。', + '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' => '标签的类型。1 表示用户标签，0 表示运维标签。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Count' => [ + 'title' => '使用此标签的项目数量', + 'description' => '使用该标签的任务数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + 'Owner' => [ + 'title' => '项目owner', + 'description' => '任务 Owner。', + 'type' => 'string', + 'example' => 'admin', + ], + 'Importance' => [ + 'title' => '项目告警等级 (HIGH: 高保护状态, MEDIUM: 中保护状态, LOW: 低保护状态, IGNORE: 无保护状态)', + 'description' => '任务的告警等级，包括 `HIGH`（高保护状态）、`MEDIUM`（中保护状态）、`LOW`（低保护状态）和 `IGNORE`（无保护状态）。', + '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' => '数据迁移或数据同步任务的状态，包括 INIT（未启动）、RUNNING（运行中）、SUSPEND（已暂停）、FAILED（失败）、FINISHED（已完成）、RELEASING（释放中）、RELEASED（已释放）、DELETED（已删除）、RUNNING_MODIFYING（修改中）和 RUNNING_MERGING（合并中）。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'GmtCreate' => [ + 'title' => '项目创建时间 UTC时间', + 'description' => '任务的创建时间，以 UTC + 0 时区的时间格式展示。', + 'type' => 'string', + 'example' => '2023-07-13T06:26:15', + ], + 'GmtModified' => [ + 'title' => '项目更新时间 UTC时间', + 'description' => '任务的更新时间，以 UTC + 0 时区的时间格式展示。', + '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' => '任务的目标端连接信息 ID。', + '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' => '该参数已废弃，建议您调用 `DescribeProject` 接口。', + 'type' => 'object', + 'properties' => [ + 'Mode' => [ + 'title' => '传输对象映射模式 (SPECIFIC, WILDCARD)', + 'description' => '传输对象映射模式，包括 `SPECIFIC`（表示指定对象）和 `WILDCARD`（表示匹配规则）。', + 'type' => 'string', + 'example' => 'SPECIFIC', + ], + ], + ], + 'CommonTransferConfig' => [ + 'title' => '公共传输配置（所有步骤）', + 'description' => '该参数已废弃，建议您调用 `DescribeProject` 接口。', + 'type' => 'object', + 'properties' => [ + 'TableCategory' => [ + 'title' => '传输的表类型', + 'description' => '支持的表类型。包括 ALL（所有表）、WITH_UNIQUE_ROW_ID（有唯一行标识的表）和 WITHOUT_UNIQUE_ROW_ID（无唯一行标识的表），默认值为 ALL。', + 'type' => 'string', + 'example' => 'ALL', + ], + 'ActiveActive' => [ + 'title' => '是否双活场景', + 'description' => '是否为容灾双活场景。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MqSerializerType' => [ + 'title' => '投递到消息队列时，数据 json 序列化类型', + 'description' => '投递至消息队列时，数据 JSON 序列化类型。包括 DEFAULT、CANAL、DATAWORKS_V2、SHAREPLEX、DEFAULT_WITH_SCHEMA、DEBEZIUM、DEBEZIUMFLATTEN 和 DEBEZIUMSMT。', + 'type' => 'string', + 'example' => 'DEFAULT', + ], + 'MqPartitionMode' => [ + 'title' => '投递到消息队列时，分区路由方式', + 'description' => '投递至消息队列时，分区路由方式。包括 ONE（指定分区投递）、HASH（根据主键/分片列值进行 HASH 分区投递、TABLE（根据库表名进行 HASH 分区投递）。', + 'type' => 'string', + 'example' => 'ONE', + ], + 'MqPartition' => [ + 'title' => '当 partitionMode 为 ONE 时，此参数表示投递分区的在当前 topic 下的位置', + 'description' => '当 partitionMode 为 ONE 时，该参数表示投递的分区在当前 Topic 下的位置。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DatahubTopicType' => [ + 'title' => '投递到消息队列时，指定 topic 的类型', + 'description' => '投递至消息队列 DataHub 时，指定 Topic 的类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'BLOB' => 'BLOB', + 'TUPLE' => 'TUPLE', + ], + 'example' => 'TUPLE', + ], + 'RocketMqProducerGroup' => [ + 'title' => '指定生产组名(目标端为 ROCKETMQ 时生效),默认 OMS', + 'description' => '指定生产组名（目标端为 ROCKETMQ 时生效），默认值为 OMS。', + 'type' => 'string', + 'example' => 'OMS', + ], + 'RocketMqMsgTags' => [ + 'title' => '设置消息 tag(目标端为 ROCKETMQ 时生效)，默认 default -> default_tag', + 'description' => '设置消息 tag（目标端为 ROCKETMQ 时生效），默认 default->default_tag。', + 'type' => 'string', + 'example' => 'default_tag', + ], + 'RocketMqEnableMsgTrace' => [ + 'title' => '是否开启消息追踪(目标端为 ROCKETMQ 时生效)', + 'description' => '是否开启消息追踪（目标端为 ROCKETMQ 时生效）。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'RocketMqSendMsgTimeout' => [ + 'title' => '设置消息投递超时时间(目标端为 ROCKETMQ 时生效)', + 'description' => '设置消息投递超时时间（目标端为 ROCKETMQ 时生效）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'null', + ], + 'DataWorksBusinessName' => [ + 'title' => '业务系统标识(可选)', + 'description' => '业务系统标识（可选）。', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + 'EnableStructTransfer' => [ + 'title' => '是否启用结构传输', + 'description' => '是否开启结构传输。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'StructTransferConfig' => [ + 'title' => '结构传输配置', + 'description' => '该参数已废弃，建议您调用 `DescribeProject` 接口。', + 'type' => 'object', + 'properties' => [ + 'ByteCharConvertStrategy' => [ + 'title' => 'byte/char 转换方案', + 'description' => 'byte/char 转换方案，默认值为 `DO_NOTHING_IF_BYTE_USED`。', + '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' => '该参数已废弃，建议您调用 `DescribeProject` 接口。', + 'type' => 'object', + 'properties' => [ + 'NonePkUkTruncateDstTable' => [ + 'title' => '在处理源端无唯一索引表德的全量迁移时，是否 truncate 目标表（清空目标表数据）,组件层面默认为 true', + 'description' => '处理源端无唯一索引表的全量迁移时，是否清空目标表。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'AllowDestTableNotEmpty' => [ + 'title' => '允许目标端表非空，在源端多个分表向目标端一张表聚合迁移时，需要打开', + 'description' => '目标端表对象存在记录时处理策略，包括 **忽略** 和 **停止迁移**。'."\n" + .'- 设置为 true，表示选择忽略：当目标端表对象存在数据时，如果原数据与写入数据冲突，数据传输采用将冲突数据记录日志，保留原数据不变的策略进行数据写入。'."\n" + .'><notice>选择忽略，全量校验将使用 IN 模式拉取数据，无法校验目标端多数据的场景，并且校验性能存在一定程度降级。></notice>'."\n" + .'- 设置为 false，表示选择停止迁移：当目标端表对象存在数据时，全量迁移会报错不允许迁移，请处理好目标端数据后再继续迁移。'."\n" + .'><notice>如果出错后单击恢复，数据传输将忽略该配置选项，继续迁移表数据，请谨慎操作。></notice>', + 'type' => 'boolean', + 'example' => 'false', + ], + 'FullTransferSpeedMode' => [ + 'title' => '全量迁移 配置(STEADY：平稳，NORMAL：正常，FAST：快速)。', + 'description' => '全量迁移并发速度，包括 STEADY、NORMAL 和 FAST。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'FullVerifySpeedMode' => [ + 'title' => '全量校验 配置(STEADY：平稳，NORMAL：正常，FAST：快速)。', + 'description' => '全量校验并发速度，包括 STEADY、NORMAL 和 FAST。', + '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' => '该参数已废弃，建议您调用 `DescribeProject` 接口。', + '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' => '有增量同步阶段且增量日志拉取组件为 Store 时，日志的保存时间。单位为小时，默认 7 天，最长支持 365 天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '24', + ], + 'EnableSequencingWithinTxn' => [ + 'title' => '有增量同步阶段时，且增量日志拉取组件为 Store 时，是否开启事务内序号编排', + 'description' => '有增量同步阶段且增量日志拉取组件为 Store 时，是否开启事务内序号编排。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IncrSyncConcurrency' => [ + 'title' => '增量同步线程数，默认64', + 'description' => '增量同步的线程数，默认值为 64。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '64', + ], + 'EnableIncrSyncStatistics' => [ + 'title' => '是否开启增量记录(dml\\ddl)统计', + 'description' => '是否开启增量记录（DML、DDL）统计。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'SourceConnectInfo' => [ + 'title' => '源端节点连接信息', + 'description' => '源端节点的连接信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '连接信息ID', + 'description' => '连接信息的 ID。', + 'type' => 'string', + 'example' => 'c_4w3aq****', + ], + 'EndpointName' => [ + 'title' => '终端节点名', + 'description' => '终端节点的名称。', + 'type' => 'string', + 'example' => 'ration12****0obmysql4116892***', + ], + 'EndpointId' => [ + 'title' => '终端节点id', + 'description' => '终端节点的 ID。', + 'type' => 'string', + 'example' => 'e_4w3al***', + ], + 'EndpointSide' => [ + 'title' => '终端节点类型（source 源端，dest 目的端） （后续set进去，库中不存储） (SOURCE, DEST)', + 'description' => '终端节点的类型，包括 `source`（源端）和 `dest`（目标端）。', + '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' => 'nlsLengthSemantics 属性，仅针对 Oracle 和 OceanBase 数据库 Oracle 租户数据源。', + 'type' => 'string', + 'example' => 'null', + ], + 'OperatingSystem' => [ + 'title' => '操作系统(OB 没有)。', + 'description' => '操作系统（OceanBase 数据库无该参数）。', + 'type' => 'string', + 'example' => 'Linux', + ], + 'Region' => [ + 'title' => '地域属性', + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'OcpName' => [ + 'title' => 'ocp name 属性，记录 ocp。', + 'description' => 'OCP 的名称。', + 'type' => 'string', + 'example' => 'null', + ], + 'ConnExtraAttributes' => [ + 'description' => '连接额外属性。具体返回字段请参见《附录》模块的内容。', + 'type' => 'any', + 'example' => 'null', + ], + 'Owner' => [ + 'title' => 'owner', + 'description' => 'Owner。', + 'type' => 'string', + 'example' => 'admin', + ], + 'ResourceOwner' => [ + 'title' => '资源所有者uid', + 'description' => '资源所有者的 UID。', + 'type' => 'string', + 'example' => '1325847***', + ], + 'Host' => [ + 'description' => 'IP 地址。', + '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' => '连接信息的 ID。', + 'type' => 'string', + 'example' => 'c_4w3akx***', + ], + 'EndpointName' => [ + 'title' => '终端节点名', + 'description' => '终端节点的名称。', + 'type' => 'string', + 'example' => 'ation129***9apimysql5616****', + ], + 'EndpointId' => [ + 'title' => '终端节点id', + 'description' => '终端节点的 ID。', + 'type' => 'string', + 'example' => 'e_4w3aic***', + ], + 'EndpointSide' => [ + 'title' => '终端节点类型（source 源端，dest 目的端） （后续set进去，库中不存储） (SOURCE, DEST)', + 'description' => '终端节点的类型，包括 `source`（源端）和 `dest`（目标端）。', + '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' => 'nlsLengthSemantics 属性，仅针对 Oracle 和 OceanBase 数据库 Oracle 租户数据源。', + 'type' => 'string', + 'example' => 'null', + ], + 'OperatingSystem' => [ + 'title' => '操作系统(OB 没有)。', + 'description' => '操作系统（OceanBase 数据库无该参数）。', + 'type' => 'string', + 'example' => 'Linux', + ], + 'Region' => [ + 'title' => '地域属性', + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'OcpName' => [ + 'title' => 'ocp name 属性，记录 ocp。', + 'description' => 'OCP 名称。', + 'type' => 'string', + 'example' => 'null', + ], + 'ConnExtraAttributes' => [ + 'description' => '连接额外属性。具体返回字段请参见《附录》模块的内容。', + 'type' => 'any', + 'example' => 'null', + ], + 'Owner' => [ + 'title' => 'owner', + 'description' => 'Owner。', + 'type' => 'string', + 'example' => 'admin', + ], + 'ResourceOwner' => [ + 'title' => '资源所有者uid', + 'description' => '资源所有者的 UID。', + 'type' => 'string', + 'example' => '1325847***', + ], + 'Host' => [ + 'description' => 'IP 地址。', + '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' => '步骤的运行状态，包括 INIT（初始化）、RUNNING（运行中）、FAILED（失败）、 FINISHED（已完成）、 SUSPEND（已暂停）、MONITORING（持续监控状态，用于增量同步和增量校验的持续监控态）。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'ExtraInfo' => [ + 'title' => '补充信息（json）', + 'description' => '补充信息（JSON）。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '错误原因的上下文。', + 'example' => 'null', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '开始时间，以 UTC + 0 时区的时间格式展示。', + 'type' => 'string', + 'example' => '2020-05-22T17:04:18', + ], + 'FinishTime' => [ + 'title' => '结束时间，UTC 格式："2020-05-22T17:04:18"', + 'description' => '结束时间，以 UTC + 0 时区的时间格式展示。', + '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' => '该参数已废弃，建议您调用 `DescribeProject` 接口。', + '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' => '处于 RUNNING 状态的步骤。', + 'type' => 'string', + 'example' => 'TRANSFER_PRECHECK', + ], + 'RunningProgress' => [ + 'title' => 'running step 进度', + 'description' => '处于 RUNNING 状态的步骤的运行进度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'MonitoringIncr' => [ + 'title' => '是否开始监控增量', + 'description' => '是否开始监控增量。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Subtopics' => [ + 'title' => '任务关联 store 的 subtopics', + 'description' => '任务关联 Store 的 Subtopics 列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务关联 Store 的 Subtopic。', + 'type' => 'string', + 'example' => 'null', + ], + ], + 'ReverseSubtopics' => [ + 'title' => '任务关联反向 store 的 subtopics', + 'description' => '任务关联反向 Store 的 Subtopics 列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务关联反向 Store 的 Subtopic。', + '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' => '是否能够直连源端 OceanBase 数据库。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OverwriteConfig' => [ + 'title' => '是否允许完全覆盖更新配置', + 'description' => '是否允许完全覆盖更新配置。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IgnoreUnsupportDdl' => [ + 'title' => '对于connector，是否忽略不支持的ddl', + 'description' => '是否忽略不支持的 DDL。', + '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' => '数据库的 ID。目前仅逻辑库才会具有 ID，可能存在在一个 Endpoint 中库名相同，但是 ID 不同。表示的是不同的 ID 情况。', + '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' => '用于标识处理该 DatabaseName 的 Source Client。', + 'example' => 'null', + ], + 'Tables' => [ + 'title' => '表名称', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableId' => [ + 'title' => '目前只有逻辑表才会存在 tableId，在逻辑表中可能存库表名完全相同，但是只能根据 id 才能区分的场景', + 'type' => 'string', + 'description' => '逻辑表的 ID。', + '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' => '传输实例的 ID。', + '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' => '同步 DataWorks 场景，记录不同下游消费方的表配置，用于同步任务复用时的配置合并。', + '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' => '标准的 SQL 语句中的 `WHERE `子句，用于配置行过滤。', + ], + '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' => '针对逻辑表下，逻辑表的 ID。', + ], + 'SourceEndpointId' => [ + 'title' => '针对物理表下传递 endpointId', + 'type' => 'string', + 'example' => 'null', + 'description' => '针对物理表下传递 endpointId。', + ], + 'SourceClientId' => [ + 'title' => 'connector client id', + 'type' => 'string', + 'example' => 'null', + 'description' => 'Connector Client 的 ID。', + ], + ], + ], + 'description' => '同步 DataWorks 场景，记录不同下游消费方的表配置，用于同步任务复用时的配置合并。', + ], + ], + 'SubIds' => [ + 'title' => '取代', + 'description' => '配置对象的 ID 列表。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '配置对象的 ID。', + 'example' => 'null', + ], + ], + 'MaxConnectorCount' => [ + 'title' => 'connector 最大数量，-1 表示不限制', + 'description' => 'Connector 的最大数量，-1 表示不限制。', + '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"}]', + 'title' => '分页查询任务列表', + 'responseParamsDescription' => '## 附录'."\n" + ."\n" + .'### Kafka'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "endpoint":"xxx.xxx.xxx.1:2883",'."\n" + .' "username":null,'."\n" + .' "enableSSL":null,'."\n" + .' "enableSASL":null,'."\n" + .' "saslMechanism":null,'."\n" + .' "disableIdentificationAlgorithm":false'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| 参数 | 类型 | 描述 |'."\n" + .'|--------------------------|-------------|------------------|'."\n" + .'| endpoint | string | 服务地址。 |'."\n" + .'| username | string | 用户名。当您选择认证方式为 PLAIN、SCRAM-SHA-256 和 SCRAM-SHA-512 时，该参数必填。 |'."\n" + .'| enableSSL | boolean | 是否开启 SSL 认证。如果开启，则需要上传授信证书。 |'."\n" + .'| enableSASL | boolean | 是否开启 SASL 认证。 |'."\n" + .'| saslMechanism |KafkaSaslMechanisnEnum | 加密方式，包括 PLAIN、SCRAM-SHA-256、SCRAM-SHA-512 和 KERBEROS。 |'."\n" + .'|disableIdentificationAlgorithm | boolean |SSL 加密时，是否开启主机名验证。 |'."\n" + ."\n" + .'### DataHub'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "endpoint":"xxx.xxx.xxx.1:2883",'."\n" + .' "project":"detx***"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| 参数 | 类型 | 描述 |'."\n" + .'|--------------------------|-------------|------------------|'."\n" + .'| endpoint | string | 服务地址。 |'."\n" + .'| project | string | 任务的名称。 |'."\n" + ."\n" + .'### RocketMQ'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "endpoint":"xxx.xxx.xxx.1:2883",'."\n" + .' "endpointType":null,'."\n" + .' "version":null'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| 参数 | 类型 | 描述 |'."\n" + .'|--------------------------|-------------|------------------|'."\n" + .'| endpoint | string | 服务地址。 |'."\n" + .'| endpointType | CloudRocketMQEndpoint.Type | 服务地址的类型。 |'."\n" + .'| version | CloudRocketMQInst.Version | RocketMQ 的版本。|'."\n" + ."\n" + .'### OceanBase'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "cluster":"xgez***",'."\n" + .' "tenant":"gexr**",'."\n" + .' "isLogicSource":false,'."\n" + .' "useLogProxy":true,'."\n" + .' "drcUser":"tes***",'."\n" + .' "configUrl":"http://xxx.xxx.xxx.1:2883/service****",'."\n" + .' "logProxyIp":"xxx.xxx.xxx.2",'."\n" + .' "logProxyPort":2883,'."\n" + .' "noUserAuth":false'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| 参数 | 类型 | 描述 |'."\n" + .'|--------------------------|-------------|------------------|'."\n" + .'| cluster | string | 集群的名称。 |'."\n" + .'| tenant | string | 租户的名称。 |'."\n" + .'| isLogicSource | boolean | 是否为逻辑数据源。|'."\n" + .'| useLogProxy | boolean | 是否使用 LogProxy。|'."\n" + .'| drcUser | string | drc_user 的配置。 |'."\n" + .'| configUrl | string | 用于获取 OceanBase 数据库底层服务器的真实地址。 |'."\n" + .'| logProxyIp | string | LogProxy 服务的 IP 地址。 |'."\n" + .'| logProxyPort | integer | LogProxy 服务的端口。 |'."\n" + .'| noUserAuth | boolean | 对于同步 DataWorks 的接口，数据源是 OMS 自动生成的。如果没有用户账号和密码，则不能连接用户的 OceanBase 数据库。 |'."\n" + ."\n" + .'### TiDB'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "kafkaId":"e_edz****",'."\n" + .' "kafkaTopic":"test**",'."\n" + .' "kafkaName":"denz***"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| 参数 | 类型 | 描述 |'."\n" + .'|--------------------------|-------------|------------------|'."\n" + .'| kafkaId | string | 绑定的 Kafka 数据源的 ID。 |'."\n" + .'| kafkaTopic | string | 绑定的 Kafka Topic 的名称。 |'."\n" + .'| kafkaName | string | 绑定的 Kafka 数据源的名称。|', + ], + 'DescribeProject' => [ + 'summary' => '本接口用于查询数据迁移或数据同步任务的任务详情。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目ID', + 'description' => '数据迁移或数据同步任务的 ID。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => '传输实例的 ID。', + 'type' => 'string', + 'example' => 'g_i4wa7***'."\n", + ], + 'WorkerGradeInfo' => [ + 'description' => '传输实例的详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'ID', + 'description' => '传输实例的 ID。', + 'type' => 'string', + 'example' => 'g_i4wa7***'."\n", + ], + 'Name' => [ + 'title' => '别名', + 'description' => '传输实例的别名。', + 'type' => 'string', + 'example' => 'i5fuij***', + ], + 'Grade' => [ + 'title' => '规格', + 'description' => '传输实例的规格。', + 'type' => 'string', + 'example' => 'OMS_G2_MIGRATION_LARGE', + ], + 'Spec' => [ + 'title' => '规格大小', + 'description' => '传输实例的规格大小。', + 'type' => 'string', + 'example' => 'LARGE', + ], + 'SpecName' => [ + 'title' => '规格大小名称', + 'description' => '传输实例规格大小的名称。', + 'type' => 'string', + 'example' => 'LARGE', + ], + 'SourceType' => [ + 'title' => '源端数据源类型', + 'description' => '源端数据源的类型。', + 'type' => 'string', + 'example' => 'OB_MYSQL', + ], + 'SourceRegion' => [ + 'title' => '源端数据源地域', + 'description' => '源端数据源所在的地域。', + 'type' => 'string', + 'example' => 'ap-southeast-1', + ], + 'DestType' => [ + 'title' => '目标端数据源类型', + 'description' => '目标端数据源的类型。', + 'type' => 'string', + 'example' => 'OB_MYSQL', + ], + 'DestRegion' => [ + 'title' => '目标端数据源地域', + 'description' => '目标端数据源所在的地域。', + 'type' => 'string', + 'example' => 'ap-southeast-1', + ], + 'ChargeType' => [ + 'title' => '计费方式', + 'description' => '数据迁移或数据同步任务的计费类型。', + 'type' => 'string', + 'example' => 'POSTPAY', + ], + 'AutoRenewal' => [ + 'description' => '是否开启自动续费。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Expired' => [ + 'description' => '是否已到期。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'EndTime' => [ + 'title' => '到期时间，UTC时间', + 'description' => '到期时间。支持 UTC 时间，格式为 YYYY-MM-DDThh:mm:ss。', + 'type' => 'string', + 'example' => '2024-02-02T16:00:00', + ], + 'GmtCreate' => [ + 'title' => '创建时间，UTC时间', + 'description' => '创建时间。支持 UTC 时间，格式为 YYYY-MM-DDThh:mm:ss。', + 'type' => 'string', + 'example' => '2024-01-28T14:07:44', + ], + ], + ], + 'Id' => [ + 'title' => '项目 id', + 'description' => '任务的 ID。', + 'type' => 'string', + 'example' => 'np_fe****', + ], + 'Type' => [ + 'title' => '类型 (MIGRATION: 数据迁移任务, SYNC: 数据同步任务)', + 'description' => '任务的类型，包括 `MIGRATION`（表示数据迁移任务）和 `SYNC`（表示数据同步任务）。', + 'type' => 'string', + 'example' => 'SYNC', + ], + 'Name' => [ + 'title' => '项目名称', + 'description' => '任务的名称，不能包含空格。', + 'type' => 'string', + 'example' => 'test', + ], + 'Labels' => [ + 'title' => '标签id集合', + 'description' => '标签的集合，最多支持 5 个。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '标签id', + 'description' => '标签 ID。', + 'type' => 'string', + 'example' => 'l_dr****', + ], + 'Name' => [ + 'title' => '标签名称', + 'description' => '标签的名称。', + 'type' => 'string', + 'example' => 'test_tag', + ], + ], + ], + ], + 'Owner' => [ + 'title' => '项目owner', + 'description' => '任务的 Owner。', + 'type' => 'string', + 'example' => 'omsefry***', + ], + 'Importance' => [ + 'title' => '项目告警等级 (HIGH: 高保护状态, MEDIUM: 中保护状态, LOW: 低保护状态, IGNORE: 无保护状态)', + 'description' => '任务的告警等级，包括 HIGH（高保护状态）、MEDIUM（中保护状态）、LOW（低保护状态）和 IGNORE（无保护状态）。', + 'type' => 'string', + 'example' => 'HIGH', + ], + 'Status' => [ + 'title' => '项目状态 (INIT: 未启动, RUNNING: 运行中, SUSPEND: 暂停中, FAILED: 已失败, FINISHED: 已完成, RELEASING: 释放中, RELEASED: 已释放, DELETED: 已删除, RUNNING_MODIFYING: 修改中, RUNNING_MERGING: 合并中)', + 'description' => '数据迁移或数据同步任务的状态，包括 INIT（未启动）、RUNNING（运行中）、SUSPEND（已暂停）、FAILED（失败）、FINISHED（已完成）、RELEASING（释放中）、RELEASED（已释放）、DELETED（已删除）、RUNNING_MODIFYING（修改中）和 RUNNING_MERGING（合并中）。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'GmtCreate' => [ + 'title' => '项目创建时间 UTC时间', + 'description' => '任务的创建时间，以 UTC + 0 时区的时间格式展示。', + 'type' => 'string', + 'example' => '2023-07-13T06:26:15', + ], + 'GmtModified' => [ + 'title' => '项目更新时间 UTC时间', + 'description' => '任务的更新时间，以 UTC + 0 时区的时间格式展示。', + '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' => '目标端连接信息的 ID。', + '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' => '传输对象映射模式，包括 `SPECIFIC`（表示指定对象）和 `WILDCARD`（表示匹配规则）。', + 'type' => 'string', + 'example' => 'SPECIFIC', + ], + 'Databases' => [ + 'description' => '数据库对象列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '数据库的类型。', + 'type' => 'string', + 'example' => 'MYSQL', + ], + 'Id' => [ + 'description' => '数据库的 ID。', + 'type' => 'string', + 'example' => 'db_id', + ], + 'Name' => [ + 'description' => '数据库的名称。', + 'type' => 'string', + 'example' => 'db_name', + ], + 'MappedName' => [ + 'description' => '数据库的映射名称。', + 'type' => 'string', + 'example' => 'mapped_db', + ], + 'TenantName' => [ + 'description' => '映射对象租户，源端为 OceanBase 数据源时生效。', + 'type' => 'string', + 'example' => 'tenant_name', + ], + 'Tables' => [ + 'description' => '当前数据库中传输表对象的配置。`Mode` 为 `WILDCARD` 时，该参数表示具体黑名单或白名单的配置，表和视图共用。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'example' => 'table_name', + ], + 'MappedName' => [ + 'description' => '表的映射名称。', + 'type' => 'string', + 'example' => 'mapped_table', + ], + 'Id' => [ + 'description' => '表的 ID。', + 'type' => 'string', + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'description' => '通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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' => '视图的 ID。', + 'type' => 'string', + 'example' => 'fexdg***', + ], + 'WhereClause' => [ + 'description' => '通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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' => '具体表对象的配置集合。`mode` 为 `WILDCARD` 时，该参数表示具体表对象的重命名、行过滤配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'example' => 'table_name', + ], + 'MappedName' => [ + 'description' => '表的映射名称。', + 'type' => 'string', + 'example' => 'mapped_table', + ], + 'Id' => [ + 'description' => '表的 ID。', + 'type' => 'string', + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'description' => '通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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' => '具体视图对象的配置列表。`mode` 为 `WILDCARD` 时，该参数表示具体视图对象的重命名配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '视图的名称。', + 'type' => 'string', + 'example' => 'view_name', + ], + 'MappedName' => [ + 'description' => '视图的映射名称。', + 'type' => 'string', + 'example' => 'mapped_name', + ], + 'Id' => [ + 'description' => '视图的 ID。', + 'type' => 'string', + 'example' => 'view_id', + ], + 'WhereClause' => [ + 'description' => '通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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' => '包括 DATABASE 和 TABLE。', + 'type' => 'string', + 'example' => 'DATABASE', + ], + 'Id' => [ + 'description' => '数据库对象的 ID。', + 'type' => 'string', + 'example' => 'db_id', + ], + 'Name' => [ + 'description' => '数据库对象的名称。', + 'type' => 'string', + 'example' => 'db_name', + ], + 'MappedName' => [ + 'description' => '数据库的映射名称。', + 'type' => 'string', + 'example' => 'mapped_db', + ], + 'TenantName' => [ + 'description' => '映射对象租户，源端为 OceanBase 时生效。', + 'type' => 'string', + 'example' => 'mapped_tenant', + ], + 'Tables' => [ + 'description' => '当前数据库中传输表对象的配置。`Mode` 为 `WILDCARD` 时，该参数表示具体黑名单或白名单的配置，表和视图共用。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'example' => 'table_name', + ], + 'MappedName' => [ + 'description' => '表的映射名称。', + 'type' => 'string', + 'example' => 'mapped_table', + ], + 'Id' => [ + 'description' => '表的 ID。', + 'type' => 'string', + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'description' => '通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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' => '视图的 ID。', + 'type' => 'string', + 'example' => 'view_id', + ], + 'WhereClause' => [ + 'description' => '通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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' => '具体表对象的配置集合。`mode` 为 `WILDCARD` 时，该参数表示具体表对象的重命名、行过滤配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'example' => 'table_name', + ], + 'MappedName' => [ + 'description' => '表的映射名称。', + 'type' => 'string', + 'example' => 'mapped_table', + ], + 'Id' => [ + 'description' => '表的 ID。', + 'type' => 'string', + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'description' => '标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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' => '体视图对象的配置列表。`mode` 为 `WILDCARD` 时，该参数表示具体视图对象的重命名配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '视图的名称。', + 'type' => 'string', + 'example' => 'view_name', + ], + 'MappedName' => [ + 'description' => '视图的映射名称。', + 'type' => 'string', + 'example' => 'mapped_view', + ], + 'Id' => [ + 'description' => '视图的 ID。', + 'type' => 'string', + 'example' => 'view_id', + ], + 'WhereClause' => [ + 'description' => '通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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' => '支持的表类型。包括 ALL（所有表）、WITH_UNIQUE_ROW_ID（有唯一行标识的表）和 WITHOUT_UNIQUE_ROW_ID（无唯一行标识的表），默认值为 ALL。', + 'type' => 'string', + 'example' => 'ALL', + ], + 'ActiveActive' => [ + 'title' => '是否双活场景', + 'description' => '是否为容灾双活场景。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MqSerializerType' => [ + 'title' => '投递到消息队列时，数据 json 序列化类型', + 'description' => '投递至消息队列时，数据 JSON 序列化类型。包括 DEFAULT、CANAL、DATAWORKS_V2、SHAREPLEX、DEFAULT_WITH_SCHEMA、 DEBEZIUM、DEBEZIUMFLATTEN 和 DEBEZIUMSMT。', + 'type' => 'string', + 'example' => 'DEFAULT', + ], + 'MqPartitionMode' => [ + 'title' => '投递到消息队列时，分区路由方式', + 'description' => '投递至消息队列时，分区路由方式。包括 ONE（指定分区投递）、HASH（根据主键/分片列值进行 HASH 分区投递、TABLE（根据库表名进行 HASH 分区投递）。', + 'type' => 'string', + 'example' => 'ONE', + ], + 'MqPartition' => [ + 'title' => '当 partitionMode 为 ONE 时，此参数表示投递分区的在当前 topic 下的位置', + 'description' => '当 `partitionMode` 为 `ONE` 时，该参数表示投递的分区在当前 Topic 下的位置。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DatahubTopicType' => [ + 'title' => '投递到消息队列时，指定 topic 的类型', + 'description' => '投递至消息队列 DataHub 时，指定 Topic 的类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'BLOB' => 'BLOB', + 'TUPLE' => 'TUPLE', + ], + 'example' => 'TUPLE', + ], + 'RocketMqProducerGroup' => [ + 'title' => '指定生产组名(目标端为 ROCKETMQ 时生效),默认 OMS', + 'description' => '指定生产组名（目标端为 ROCKETMQ 时生效），默认 OMS。', + 'type' => 'string', + 'example' => 'OMS', + ], + 'RocketMqMsgTags' => [ + 'title' => '设置消息 tag(目标端为 ROCKETMQ 时生效)，默认 default -> default_tag', + 'description' => '设置消息 tag（目标端为 ROCKETMQ 时生效），默认 default -> default_tag。', + 'type' => 'string', + 'example' => 'default_tag', + ], + 'RocketMqEnableMsgTrace' => [ + 'title' => '是否开启消息追踪(目标端为 ROCKETMQ 时生效)', + 'description' => '是否开启消息追踪（目标端为 ROCKETMQ 时生效）。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RocketMqSendMsgTimeout' => [ + 'title' => '设置消息投递超时时间(目标端为 ROCKETMQ 时生效)', + 'description' => '设置消息投递超时时间（目标端为 ROCKETMQ 时生效）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'null', + ], + 'DataWorksBusinessName' => [ + 'title' => '业务系统标识(可选)', + 'description' => '业务系统标识（可选）。', + 'type' => 'string', + 'example' => 'null', + ], + 'SinkStoreFormat' => [ + 'title' => '业务系统标识(可选)', + 'description' => '业务系统标识（可选）。', + 'type' => 'string', + 'example' => 'null', + ], + 'SourceStoreFormat' => [ + 'title' => '业务系统标识(可选)', + 'description' => '业务系统标识（可选）。', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + 'EnableStructTransfer' => [ + 'title' => '是否启用结构传输', + 'description' => '是否启用结构传输。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'StructTransferConfig' => [ + 'title' => '结构传输配置', + 'description' => '结构传输配置。', + 'type' => 'object', + 'properties' => [ + 'ByteCharConvertStrategy' => [ + 'title' => 'byte/char 转换方案', + 'description' => 'byte/char 转换方案，包括 `IGNORE_BYTE_IF_BYTE_USED`、`FORCE_CHAR_IF_BYTE_USED`、`EXPAND_LEN_IF_BYTE_USED` 和 `DO_NOTHING_IF_BYTE_USED`（默认值）。', + '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' => '目标端表对象存在记录时处理策略，包括 **忽略** 和 **停止迁移**。'."\n" + .'- 设置为 true，表示选择忽略：当目标端表对象存在数据时，如果原数据与写入数据冲突，数据传输采用将冲突数据记录日志，保留原数据不变的策略进行数据写入。'."\n" + .'><notice>选择 忽略，全量校验将使用 IN 模式拉取数据，无法校验目标端多数据的场景，并且校验性能存在一定程度降级。></notice>'."\n" + .'- 设置为 false，表示选择停止迁移：当目标端表对象存在数据时，全量迁移会报错不允许迁移，请处理好目标端数据后再继续迁移。'."\n" + .'><notice>如果出错后单击恢复，数据传输将忽略该配置选项，继续迁移表数据，请谨慎操作。></notice>', + 'type' => 'boolean', + 'example' => 'true', + ], + 'FullTransferSpeedMode' => [ + 'title' => '全量迁移 配置(STEADY：平稳，NORMAL：正常，FAST：快速)。', + 'description' => '全量迁移并发速度，包括 STEADY、NORMAL 和 FAST。', + 'type' => 'string', + 'example' => 'FAST', + ], + 'FullVerifySpeedMode' => [ + 'title' => '全量校验 配置(STEADY：平稳，NORMAL：正常，FAST：快速)。', + 'description' => '全量校验并发速度，包括 STEADY、NORMAL 和 FAST。', + 'type' => 'string', + 'example' => 'FAST', + ], + 'WriteWorkerNum' => [ + 'title' => '写入并发数', + 'description' => '写入并发数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '64', + ], + 'ReadWorkerNum' => [ + 'title' => '读取并发数', + 'description' => '读取并发数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '64', + ], + 'ThrottleRps' => [ + 'title' => '限制RPS', + 'description' => '全量传输阶段限制能达到的最大传输速率，单位为记录数/秒。返回 null 时，表示没有限制 RPS。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'ThrottleIOPS' => [ + 'title' => '限制流量，单位字节', + 'description' => '全量传输阶段限制能达到的最大传输流量，单位为字节/秒。返回 null 时，表示没有限制 IOPS。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + ], + ], + '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' => '有增量同步阶段且增量日志拉取组件为 Store 时，日志的保存时间。单位为小时，默认 7 天，最长支持 365 天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '24', + ], + 'EnableSequencingWithinTxn' => [ + 'title' => '有增量同步阶段时，且增量日志拉取组件为 Store 时，是否开启事务内序号编排', + 'description' => '有增量同步阶段且增量日志拉取组件为 Store 时，是否开启事务内序号编排。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IncrSyncConcurrency' => [ + 'title' => '增量同步线程数，默认64', + 'description' => '增量同步的线程数，默认值为 64。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '64', + ], + 'EnableIncrSyncStatistics' => [ + 'title' => '是否开启增量记录(dml\\ddl)统计', + 'description' => '是否开启增量记录（DML、DDL）统计。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ThrottleRps' => [ + 'title' => '限制RPS', + 'description' => '增量传输阶段限制能达到的最大传输速率，单位为记录数/秒。返回 null 时，表示没有限制 RPS。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'ThrottleIOPS' => [ + 'title' => '限制流量，单位字节', + 'description' => '增量传输阶段限制能达到的最大传输流量，单位为字节/秒。返回 null 时，表示没有限制 IOPS。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'SupportDDLTypes' => [ + 'description' => '增量传输阶段支持的 DDL 类型。', + 'type' => 'array', + 'items' => [ + 'description' => '增量传输阶段支持的 DDL 类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'DROP_INDEX' => 'DROP_INDEX', + 'RENAME_TABLE' => 'RENAME_TABLE', + 'DROP_TABLE' => 'DROP_TABLE', + 'TRUNCATE_TABLE' => 'TRUNCATE_TABLE', + 'ALTER_TABLE' => 'ALTER_TABLE', + 'CREATE_TABLE' => 'CREATE_TABLE', + 'CREATE_INDEX' => 'CREATE_INDEX', + ], + 'example' => 'CREATE_TABLE', + ], + ], + ], + ], + 'ReverseIncrTransferConfig' => [ + 'title' => '反向增量配置', + 'description' => '反向增量配置。', + 'type' => 'object', + 'properties' => [ + 'StartTimestamp' => [ + 'title' => '勾选了增量且没勾选全量时，允许设置增量起始位点，秒级时间戳', + 'description' => '勾选了增量且没勾选全量时，允许设置增量起始位点，秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1687363200', + ], + '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' => '有增量同步阶段且增量日志拉取组件为 Store 时的日志的保存时间。单位为小时，默认 7 天，最长支持 365 天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '24', + ], + 'EnableSequencingWithinTxn' => [ + 'title' => '有增量同步阶段时，且增量日志拉取组件为 Store 时，是否开启事务内序号编排', + 'description' => '有增量同步阶段且增量日志拉取组件为 Store 时，是否开启事务内序号编排。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IncrSyncConcurrency' => [ + 'title' => '增量同步线程数，默认64', + 'description' => '增量同步线程数，默认值为 64。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '64', + ], + 'EnableIncrSyncStatistics' => [ + 'title' => '是否开启增量记录(dml\\ddl)统计', + 'description' => '是否开启增量记录（DML、DDL）统计。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ThrottleRps' => [ + 'title' => '限制RPS', + 'description' => '反向增量传输阶段限制能达到的最大传输速率，单位为记录数/秒。返回 null 时，表示没有限制 RPS。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'ThrottleIOPS' => [ + 'title' => '限制流量，单位字节', + 'description' => '反向增量传输阶段限制能达到的最大传输流量，单位为字节/秒。返回 null 时，表示没有限制 IOPS。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'SupportDDLTypes' => [ + 'description' => '反向增量传输阶段支持的 DDL 类型。', + 'type' => 'array', + 'items' => [ + 'description' => '反向增量传输阶段支持的 DDL 类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'DROP_INDEX' => 'DROP_INDEX', + 'RENAME_TABLE' => 'RENAME_TABLE', + 'DROP_TABLE' => 'DROP_TABLE', + 'TRUNCATE_TABLE' => 'TRUNCATE_TABLE', + 'ALTER_TABLE' => 'ALTER_TABLE', + 'CREATE_TABLE' => 'CREATE_TABLE', + 'CREATE_INDEX' => 'CREATE_INDEX', + ], + 'example' => 'CREATE_TABLE', + ], + ], + ], + ], + 'SourceConnectInfo' => [ + 'title' => '源端节点连接信息', + 'description' => '源端节点的连接信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '连接信息ID', + 'description' => '连接信息的 ID。', + 'type' => 'string', + 'example' => 'c_feg****', + ], + 'EndpointName' => [ + 'title' => '终端节点名', + 'description' => '终端节点的名称。', + 'type' => 'string', + 'example' => 'migon****', + ], + 'EndpointId' => [ + 'title' => '终端节点id', + 'description' => '终端节点的 ID。', + 'type' => 'string', + 'example' => 'e_3kx5i***1s', + ], + 'EndpointSide' => [ + 'title' => '终端节点类型（source 源端，dest 目的端） （后续set进去，库中不存储） (SOURCE, DEST)', + 'description' => '终端节点的类型，包括 `source`（源端）和 `dest`（目标端）。', + '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' => 'nlsLengthSemantics 属性，仅针对 Oracle 和 OceanBase 数据库 Oracle 租户数据源。', + 'type' => 'string', + 'example' => 'null'."\n", + ], + 'OperatingSystem' => [ + 'title' => '操作系统(OB 没有)。', + 'description' => '操作系统（OceanBase 数据库无该参数）。', + 'type' => 'string', + 'example' => 'Linux', + ], + 'Region' => [ + 'title' => '地域属性', + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'OcpName' => [ + 'title' => 'ocp name 属性，记录 ocp。', + 'description' => 'OCP 的名称。', + 'type' => 'string', + 'example' => 'null', + ], + 'ConnExtraAttributes' => [ + 'description' => '连接额外属性。具体返回字段请参见《附录》模块的内容。', + 'type' => 'any', + 'example' => 'null', + ], + 'Owner' => [ + 'title' => 'owner', + 'description' => 'Owner。', + 'type' => 'string', + 'example' => 'oms_test', + ], + 'ResourceOwner' => [ + 'title' => '资源所有者uid', + 'description' => '资源所有者的 UID。', + 'type' => 'string', + 'example' => '1325847***'."\n", + ], + 'Host' => [ + 'description' => 'IP 地址。', + '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' => '连接信息的 ID。', + 'type' => 'string', + 'example' => 'e_4lgzuzi9znr4', + ], + 'EndpointName' => [ + 'title' => '终端节点名', + 'description' => '终端节点的名称。', + 'type' => 'string', + 'example' => 'RATION12948*****', + ], + 'EndpointId' => [ + 'title' => '终端节点id', + 'description' => '终端节点的 ID。', + 'type' => 'string', + 'example' => 'e_4w1q****', + ], + 'EndpointSide' => [ + 'title' => '终端节点类型（source 源端，dest 目的端） （后续set进去，库中不存储） (SOURCE, DEST)', + 'description' => '终端节点的类型，包括 `source`（源端）和 `dest`（目标端）。', + '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' => 'nlsLengthSemantics 属性，仅针对 Oracle 和 OceanBase 数据库 Oracle 租户数据源。', + 'type' => 'string', + 'example' => 'null', + ], + 'OperatingSystem' => [ + 'title' => '操作系统(OB 没有)。', + 'description' => '操作系统（OceanBase 数据库无该参数）。', + 'type' => 'string', + 'example' => 'Linux', + ], + 'Region' => [ + 'title' => '地域属性', + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'OcpName' => [ + 'title' => 'ocp name 属性，记录 ocp。', + 'description' => 'OCP 的名称。', + 'type' => 'string', + 'example' => 'null', + ], + 'ConnExtraAttributes' => [ + 'description' => '连接额外属性。具体返回字段请参见《附录》模块的内容。', + 'type' => 'any', + 'example' => 'null', + ], + 'Owner' => [ + 'title' => 'owner', + 'description' => 'Owner。', + 'type' => 'string', + 'example' => 'oms_test', + ], + 'ResourceOwner' => [ + 'title' => '资源所有者uid', + 'description' => '资源所有者的 UID。', + 'type' => 'string', + 'example' => '1325847***'."\n", + ], + 'Host' => [ + 'description' => 'IP 地址。', + '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' => '步骤的运行状态，包括 INIT（初始化）、RUNNING（运行中）、FAILED（失败）、 FINISHED（已完成）、 SUSPEND（已暂停）、MONITORING（持续监控状态，用于增量同步和增量校验的持续监控态）。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'ExtraInfo' => [ + 'title' => '补充信息（json）', + 'description' => '补充信息（json）', + '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' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '用于填充 Message 中的占位符。', + 'example' => 'null', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + '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' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '建议内容的上下文。', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '开始时间，以 UTC + 0 时区的时间格式展示。', + 'type' => 'string', + 'example' => '2020-05-22T17:04:18', + ], + 'FinishTime' => [ + 'title' => '结束时间，UTC 格式："2020-05-22T17:04:18"', + 'description' => '结束时间，以 UTC + 0 时区的时间格式展示。', + 'type' => 'string', + 'example' => '2020-05-22T17:04:18', + ], + 'Progress' => [ + 'title' => '步骤进度', + 'description' => '步骤的运行进度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'StepInfo' => [ + 'title' => '步骤详情,全量传输/增量传输/正向切换', + 'description' => '各步骤的运行详情。具体包含的信息请参见《StepInfo 数据结构》。', + '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' => '处于 RUNNING 状态的步骤。', + 'type' => 'string', + 'example' => 'PRE-CHECK', + ], + 'RunningProgress' => [ + 'title' => 'running step 进度', + 'description' => '处于 RUNNING 状态的步骤的运行进度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'MonitoringIncr' => [ + 'title' => '是否开始监控增量', + 'description' => '是否开始监控增量。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Subtopics' => [ + 'title' => '任务关联 store 的 subtopics', + 'description' => '任务关联 Store 的 Subtopics 列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务关联 Store 的 Subtopic。', + 'type' => 'string', + 'example' => 'null', + ], + ], + 'ReverseSubtopics' => [ + 'title' => '任务关联反向 store 的 subtopics', + 'description' => '任务关联反向 Store 的 Subtopics 列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务关联反向 Store 的 Subtopic。', + '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' => '是否能够直连源端 OceanBase 数据库。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OverwriteConfig' => [ + 'title' => '是否允许完全覆盖更新配置', + 'description' => '是否允许完全覆盖更新配置。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IgnoreUnsupportDdl' => [ + 'title' => '对于connector，是否忽略不支持的ddl', + 'description' => '是否忽略不支持的 DDL。', + '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' => '数据库的 ID。目前仅逻辑库才会具有 ID，可能存在在一个 Endpoint 中库名相同，但是 ID 不同。表示的是不同的 ID 情况。', + ], + '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' => 'Connector Client 的 ID。', + ], + 'Tables' => [ + 'title' => '表名称', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableId' => [ + 'title' => '目前只有逻辑表才会存在 tableId，在逻辑表中可能存库表名完全相同，但是只能根据 id 才能区分的场景', + 'type' => 'string', + 'description' => '表的 ID。', + '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' => '传输实例的 ID。', + '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' => '同步 DataWorks 场景，记录不同下游消费方的表配置，用于同步任务复用时的配置合并。', + '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' => '通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + ], + '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' => '针对逻辑表下，逻辑表的 ID。', + ], + 'SourceEndpointId' => [ + 'title' => '针对物理表下传递 endpointId', + 'type' => 'string', + 'description' => '针对物理表下传递 endpointId。', + 'example' => 'null', + ], + 'SourceClientId' => [ + 'title' => 'connector client id', + 'type' => 'string', + 'example' => 'null', + 'description' => '用于标识处理该 DatabaseName 的 Source Client。', + ], + ], + ], + 'description' => '同步 DataWorks 场景，记录不同下游消费方的表配置，用于同步任务复用时的配置合并。', + ], + ], + 'SubIds' => [ + 'title' => '取代', + 'description' => '配置对象的 ID 列表。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '配置对象的 ID。', + ], + ], + 'MaxConnectorCount' => [ + 'title' => 'connector 最大数量，-1 表示不限制', + 'description' => 'Connector 的最大数量，-1 表示不限制。', + '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"}]', + 'title' => '查询任务的详情', + 'responseParamsDescription' => '## StepInfo 数据结构'."\n" + ."\n" + .'不同步骤的 `StepInfo` 参数返回不同的字段。 '."\n" + ."\n" + .'* TRANSFER_APP_SWITCH（正向切换）'."\n" + ."\n" + .' | 参数 | 类型 | 描述 |'."\n" + .' |----------|----------------|---------------|'."\n" + .' | checkpointSampleTimestamp | long | 位点采集时间。格式为 Unix timestamp，单位为秒。 |'."\n" + ."\n" + .'* INCR_TRANSFER（增量同步）'."\n" + ."\n" + .' | 参数 | 类型 | 描述 |'."\n" + .' |----------|----------------|---------------|'."\n" + .' | incrTimestampCheckpoint | long | 位点时间。格式为 Unix timestamp，单位为秒。 |'."\n" + .' | checkpointSampleTimestamp | long | 位点采集时间。格式为 Unix timestamp，单位为秒。 | '."\n" + .' | enableIncrStatistics | boolean | 是否开启 DML/DDL 统计。 |'."\n" + ."\n" + .'* FULL_VERIFIER（全量校验）和 FULL_TRANSFER（全量迁移）'."\n" + ."\n" + .' | 参数 | 类型 | 描述 |'."\n" + .' |------------|------------------|------------------------|'."\n" + .' | processedRecords | long | 已完成迁移行数/实际行数。 |'."\n" + .' | capacity | long | 预估总行数。|'."\n" + .' | srcRps | long | 源端读取 RPS，单位为记录数/秒。 |'."\n" + .' | srcRt | string | 源端读取 RT，单位为毫秒/条。 |'."\n" + .' | srcIops | long | 源端读取流量，单位为字节数/秒。 |'."\n" + .' | dstRps | long | 目标端读取/写入 RPS，单位为记录数/秒。 |'."\n" + .' | dstRt | long | 目标端读取/写入 RT，单位为毫秒/条。 |'."\n" + .' | dstIops | long | 目标端读取/写入流量，单位为字节数/秒。 |'."\n" + .' | srcRpsRef | long | 源端读取 RPS 的基准值。 |'."\n" + .' | dstRpsRef | long | 目标端读取/写入 RPS 的基准值。 |'."\n" + .' | dstRtRef | long | 目标端读取/写入 RT 基准值。 |'."\n" + ."\n" + .'## 附录'."\n" + ."\n" + .'### Kafka'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "endpoint":"xxx.xxx.xxx.1:2883",'."\n" + .' "username":null,'."\n" + .' "enableSSL":null,'."\n" + .' "enableSASL":null,'."\n" + .' "saslMechanism":null,'."\n" + .' "disableIdentificationAlgorithm":false'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| 参数 | 类型 | 描述 |'."\n" + .'|--------------------------|-------------|------------------|'."\n" + .'| endpoint | string | 服务地址。 |'."\n" + .'| username | string | 用户名。当您选择认证方式为 PLAIN、SCRAM-SHA-256 和 SCRAM-SHA-512 时，该参数必填。 |'."\n" + .'| enableSSL | boolean | 是否开启 SSL 认证。如果开启，则需要上传授信证书。 |'."\n" + .'| enableSASL | boolean | 是否开启 SASL 认证。 |'."\n" + .'| saslMechanism |KafkaSaslMechanisnEnum | 加密方式，包括 PLAIN、SCRAM-SHA-256、SCRAM-SHA-512 和 KERBEROS。 |'."\n" + .'|disableIdentificationAlgorithm | boolean |SSL 加密时，是否开启主机名验证。 |'."\n" + ."\n" + .'### DataHub'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "endpoint":"xxx.xxx.xxx.1:2883",'."\n" + .' "project":"detx***"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| 参数 | 类型 | 描述 |'."\n" + .'|--------------------------|-------------|------------------|'."\n" + .'| endpoint | string | 服务地址。 |'."\n" + .'| project | string | 任务的名称。 |'."\n" + ."\n" + .'### RocketMQ'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "endpoint":"xxx.xxx.xxx.1:2883",'."\n" + .' "endpointType":null,'."\n" + .' "version":null'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| 参数 | 类型 | 描述 |'."\n" + .'|--------------------------|-------------|------------------|'."\n" + .'| endpoint | string | 服务地址。 |'."\n" + .'| endpointType | CloudRocketMQEndpoint.Type | 服务地址的类型。 |'."\n" + .'| version | CloudRocketMQInst.Version | RocketMQ 的版本。|'."\n" + ."\n" + .'### OceanBase'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "cluster":"xgez***",'."\n" + .' "tenant":"gexr**",'."\n" + .' "isLogicSource":false,'."\n" + .' "useLogProxy":true,'."\n" + .' "drcUser":"tes***",'."\n" + .' "configUrl":"http://xxx.xxx.xxx.1:2883/service****",'."\n" + .' "logProxyIp":"xxx.xxx.xxx.2",'."\n" + .' "logProxyPort":2883,'."\n" + .' "noUserAuth":false'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| 参数 | 类型 | 描述 |'."\n" + .'|--------------------------|-------------|------------------|'."\n" + .'| cluster | string | 集群的名称。 |'."\n" + .'| tenant | string | 租户的名称。 |'."\n" + .'| isLogicSource | boolean | 是否为逻辑数据源。|'."\n" + .'| useLogProxy | boolean | 是否使用 LogProxy。|'."\n" + .'| drcUser | string | drc_user 的配置。 |'."\n" + .'| configUrl | string | 用于获取 OceanBase 数据库底层服务器的真实地址。 |'."\n" + .'| logProxyIp | string | LogProxy 服务的 IP 地址。 |'."\n" + .'| logProxyPort | integer | LogProxy 服务的端口。 |'."\n" + .'| noUserAuth | boolean | 对于同步 DataWorks 的接口，数据源是 OMS 自动生成的。如果没有用户账号和密码，则不能连接用户的 OceanBase 数据库。 |'."\n" + ."\n" + .'### TiDB'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "kafkaId":"e_edz****",'."\n" + .' "kafkaTopic":"test**",'."\n" + .' "kafkaName":"denz***"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| 参数 | 类型 | 描述 |'."\n" + .'|--------------------------|-------------|------------------|'."\n" + .'| kafkaId | string | 绑定的 Kafka 数据源的 ID。 |'."\n" + .'| kafkaTopic | string | 绑定的 Kafka Topic 的名称。 |'."\n" + .'| kafkaName | string | 绑定的 Kafka 数据源的名称。|', + ], + 'DescribeProjectSteps' => [ + 'summary' => '本接口用于查询数据迁移或数据同步任务运行步骤的详情。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目ID', + 'description' => '数据迁移或数据同步任务的 ID。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => '步骤的运行状态，包括 INIT（初始化）、RUNNING（运行中）、FAILED（失败）、 FINISHED（已完成）、SUSPEND（已暂停）、MONITORING（持续监控状态，用于增量同步和增量校验的持续监控态）。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '错误原因的上下文。', + 'example' => 'null', + ], + ], + 'Proposal' => [ + 'description' => '建议。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '建议内容的上下文。', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '开始时间，以 UTC + 0 时区的时间格式展示。', + 'type' => 'string', + 'example' => '2020-05-22T17:04:18', + ], + 'FinishTime' => [ + 'title' => '结束时间，UTC 格式："2020-05-22T17:04:18"', + 'description' => '结束时间，以 UTC + 0 时区的时间格式展示。', + 'type' => 'string', + 'example' => '2020-05-22T17:04:18', + ], + 'Progress' => [ + 'title' => '步骤进度', + 'description' => '步骤的运行进度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'StepInfo' => [ + 'title' => '步骤详情,全量传输/增量传输/正向切换', + 'description' => '各步骤的运行详情。具体包含的信息请参见《StepInfo 数据结构》。', + '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"}]', + 'title' => '查询任务步骤的详情', + 'responseParamsDescription' => '## StepInfo 数据结构'."\n" + ."\n" + .'不同步骤的 `stepInfo` 参数返回不同的字段。 '."\n" + ."\n" + .'* TRANSFER_APP_SWITCH（正向切换）'."\n" + ."\n" + .' | 参数 | 类型 | 描述 |'."\n" + .' |----------|----------------|---------------|'."\n" + .' | checkpointSampleTimestamp | long | 位点采集时间。格式为 Unix timestamp，单位为秒。 |'."\n" + ."\n" + .'* INCR_TRANSFER（增量同步）'."\n" + ."\n" + .' | 参数 | 类型 | 描述 |'."\n" + .' |----------|----------------|---------------|'."\n" + .' | incrTimestampCheckpoint | long | 位点时间。格式为 Unix timestamp，单位为秒。 |'."\n" + .' | checkpointSampleTimestamp | long | 位点采集时间。格式为 Unix timestamp，单位为秒。 | '."\n" + .' | enableIncrStatistics | boolean | 是否开启 DML/DDL 统计。 |'."\n" + ."\n" + .'* FULL_VERIFIER（全量校验）和 FULL_TRANSFER（全量迁移）'."\n" + ."\n" + .' | 参数 | 类型 | 描述 |'."\n" + .' |------------|------------------|------------------------|'."\n" + .' | processedRecords | long | 已完成迁移行数/实际行数。 |'."\n" + .' | capacity | long | 预估总行数。|'."\n" + .' | srcRps | long | 源端读取 RPS，单位为记录数/秒。 |'."\n" + .' | srcRt | string | 源端读取 RT，单位为毫秒/条。 |'."\n" + .' | srcIops | long | 源端读取流量，单位为字节数/秒。 |'."\n" + .' | dstRps | long | 目标端读取/写入 RPS，单位为记录数/秒。 |'."\n" + .' | dstRt | long | 目标端读取/写入 RT，单位为毫秒/条。 |'."\n" + .' | dstIops | long | 目标端读取/写入流量，单位为字节数/秒。 |'."\n" + .' | srcRpsRef | long | 源端读取 RPS 的基准值。 |'."\n" + .' | dstRpsRef | long | 目标端读取/写入 RPS 的基准值。 |'."\n" + .' | dstRtRef | long | 目标端读取/写入 RT 基准值。 |', + ], + 'DescribeProjectStepMetric' => [ + 'summary' => '本接口用于查询数据迁移或数据同步任务的运行步骤的指标。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目ID', + 'description' => '数据迁移或数据同步任务的 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'np_dr****', + ], + ], + [ + 'name' => 'StepName', + 'in' => 'formData', + 'schema' => [ + 'title' => '步骤名称', + 'description' => '任务运行步骤的名称，包括 `FULL_TRANSFER`、`INCR_TRANSFER`、`FULL_VERIFIER` 和 `REVERSE_INCR_TRANSFER`。', + 'type' => 'string', + 'required' => true, + 'example' => 'FULL_TRANSFER', + ], + ], + [ + 'name' => 'MetricType', + 'in' => 'formData', + 'schema' => [ + 'title' => '指标类型', + 'description' => '任务运行步骤对应的指标。<ul><li>`FULL_TRANSFER` 对应的指标包括 RPS、IOPS、SOURCE_READ_TIME、SOURCE_SLICE_TIME 和 SINK_EXECUTE_TIME。 </li><li>`INCR_TRANSFER` 对应的指标包括 DELAY、IOPS、RPS、SINK_COMMIT_TIME 和 SINK_EXECUTE_TIME。 </li><li>`FULL_VERIFIER` 对应的指标包括 FULL_VERIFY_SOURCE_RPS、FULL_VERIFY_SOURCE_READ_IOPS、FULL_VERIFY_DEST_RPS 和 FULL_VERIFY_DEST_READ_IOPS。</li> <li>`REVERSE_INCR_TRANSFER` 对应的指标包括 RPS、IOPS、DELAY、SINK_EXECUTE_TIME 和 SINK_COMMIT_TIME。 </li> </ul>', + 'type' => 'string', + 'required' => true, + 'example' => 'RPS', + ], + ], + [ + 'name' => 'Aggregator', + 'in' => 'formData', + 'schema' => [ + 'title' => '聚合算子 AVG-取平均值（平均数据折线图），NONE-取中位（瞬时数据折线图），默认 NONE', + 'description' => '聚合算子，包括 `AVG`（平均数据折线图）和 `NONE`（瞬时数据折线图）。默认值为 `NONE`。', + 'type' => 'string', + 'required' => true, + 'example' => 'AVG', + 'enum' => [ + 'AVG', + 'NONE', + ], + ], + ], + [ + 'name' => 'BeginTimestamp', + 'in' => 'formData', + 'schema' => [ + 'title' => '开始时间（秒级时间戳）', + 'description' => '开始时间，单位为秒级时间戳。开始时间和结束时间的间隔不低于 1 小时。', + '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' => '最大查询点数。取值范围： 5~7*24*60，建议值：时间段（单位分钟）/maxPointNum > 5。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => '聚合算子，包括 `AVG`（平均数据折线图）和 `NONE`（瞬时数据折线图）。', + '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"}]', + 'title' => '查询任务步骤的指标', + ], + 'DescribeProjectProgress' => [ + 'summary' => '本接口用于查询数据迁移或数据同步任务的进度信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目ID', + 'description' => '数据迁移或数据同步任务的 ID。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => '任务的 ID。', + 'type' => 'string', + 'example' => 'np_fe****', + ], + 'Status' => [ + 'title' => '通用的项目状态枚举 (INIT: 未启动, RUNNING: 运行中, SUSPEND: 暂停中, FAILED: 已失败, FINISHED: 已完成, RELEASING: 释放中, RELEASED: 已释放, DELETED: 已删除, RUNNING_MODIFYING: 修改中, RUNNING_MERGING: 合并中)', + 'description' => '任务的状态，包括 INIT（未启动）、RUNNING（运行中）、SUSPEND（已暂停）、FAILED（已失败）、FINISHED（已完成）、RELEASING（释放中）、RELEASED（已释放）、DELETED（已删除）、RUNNING_MODIFYING（修改中）和 RUNNING_MERGING。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'AlarmLevel' => [ + 'title' => '告警保障等级 (HIGH: 高保护状态, MEDIUM: 中保护状态, LOW: 低保护状态, IGNORE: 无保护状态)', + 'description' => '告警保障等级，包括 HIGH（高保护状态）、MEDIUM（中保护状态）、LOW（低保护状态）和 IGNORE（无保护状态）。', + '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' => '当前任务运行所处的步骤（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）。', + 'type' => 'string', + 'example' => 'PRE_CHECK', + ], + 'IncrSyncCheckpoint' => [ + 'description' => '正向增量同步位点。当源端为 DB2 LUW、OceanBase、MySQL 或 Oracle 数据库时，格式均为 Unix timestamp，单位为秒。', + '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' => '结构传输进度的百分比，取值范围为 0~100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'FullTransferProgress' => [ + 'title' => '全量传输进度百分比，0~100', + 'description' => '全量传输进度的百分比，取值范围为 0~100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'EnableReverseIncrTransfer' => [ + 'title' => '是否有反向增量同步', + 'description' => '是否有反向增量同步。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ReverseIncrTransferCheckpoint' => [ + 'title' => '反向增量同步位点，unix timestamp，单位秒', + 'description' => '反向增量同步位点。格式为 Unix timestamp，单位为秒。', + '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"}]', + 'title' => '查询任务的进度', + ], + 'DescribeProjectComponents' => [ + 'summary' => '本接口用于查询数据迁移或数据同步任务的组件信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目ID', + 'description' => '数据迁移或数据同步任务的 ID。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => '增量拉取组件 Store 列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '名称', + 'description' => 'Store 组件的名称。', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1-7145:OB_ORACLE_np_4w3r***_4w:0000***97', + ], + 'Ip' => [ + 'title' => 'IP', + 'description' => 'Store 组件所在的 IP 地址。', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1', + ], + 'Region' => [ + 'title' => '所在地域', + 'description' => 'Store 组件所在的地域。', + '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' => '每秒处理的事务数（Transactions Per Second，TPS）。', + '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' => '状态，包括 EXCEPTION（Store 运行异常）、ACTIVE（Store 正常运行中）、STOP（Store 人为操作停止）、UNEXPECTED_EXIT（Store reader 非预期退出）和 CHANGE_SOURCE。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '用于填充 Message 中的占位符。', + 'example' => 'null', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '错误原因的上下文。', + 'example' => 'null', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + 'ToSwitch' => [ + 'title' => '是否需要主备切换，供 HA 判断', + 'description' => '是否需要主备切换，供 HA 判断。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Port' => [ + 'title' => '对外服务端口', + 'description' => '对外服务端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2883', + ], + 'StorePort' => [ + 'title' => 'store 端口', + 'description' => 'Store 组件的端口。', + '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' => '创建时间，以 UTC + 0 时区的时间格式展示。', + 'type' => 'string', + 'example' => '2023-07-13T17:29:54', + ], + 'GmtModified' => [ + 'title' => '更新时间（UTC 格式时间）', + 'description' => '更新时间，以 UTC + 0 时区的时间格式展示。', + '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' => '反向增量组件所在的 IP 地址。', + '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' => '每秒处理的事务数（Transactions Per Second，TPS）。', + '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' => '状态，包括 EXCEPTION（Store 运行异常）、ACTIVE（Store 正常运行中）、STOP（Store 人为操作停止）、UNEXPECTED_EXIT（Store reader 非预期退出）和 CHANGE_SOURCE。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '用于填充 Message 中的占位符。', + 'example' => 'null', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '错误原因的上下文。', + 'example' => 'null', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + 'ToSwitch' => [ + 'title' => '是否需要主备切换，供 HA 判断', + 'description' => '是否需要主备切换，供 HA 判断。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Port' => [ + 'title' => '对外服务端口', + 'description' => '对外服务端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2883', + ], + 'StorePort' => [ + 'title' => 'store 端口', + 'description' => 'Store 组件的端口。', + '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' => '创建时间，以 UTC + 0 时区的时间格式展示。', + 'type' => 'string', + 'example' => '2023-07-13T18:04:36', + ], + 'GmtModified' => [ + 'title' => '更新时间', + 'description' => '更新时间，以 UTC + 0 时区的时间格式展示。', + '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' => '全量校验组件的状态，包括 INIT、RUNNING、DONE、FAILED、SHUTDOWNED 和 DELETED。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '用于填充 Message 中的占位符。', + 'example' => 'null', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '错误原因的上下文。', + 'example' => 'null', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '建议内容的上下文。', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + 'Ip' => [ + 'title' => 'ip', + 'description' => '全量校验组件所在的 IP 地址。', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1', + ], + 'TaskId' => [ + 'title' => 'taskId', + 'description' => '全量校验组件的 ID。', + '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' => '全量导入组件所在的 IP 地址。', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1', + ], + 'Identity' => [ + 'title' => '正向：项目id', + 'description' => '任务 ID。', + 'type' => 'string', + 'example' => 'p_4w8v****', + ], + 'Progress' => [ + 'title' => '进度', + 'description' => '全量导入组件的进度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'Status' => [ + 'title' => '状态 (RUNNING, STOPPED, EXCEPTION, FINISHED)', + 'description' => '全量导入组件的状态，包括 RUNNING、STOPPED、EXCEPTION 和 FINISHED。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'GmtCreate' => [ + 'title' => '创建时间', + 'description' => '创建时间，以 UTC + 0 时区的时间格式展示。', + 'type' => 'string', + 'example' => '2023-07-13T18:04:36', + ], + 'GmtModify' => [ + 'title' => '修改时间', + 'description' => '更新时间，以 UTC + 0 时区的时间格式展示。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '用于填充 Message 中的占位符。', + 'example' => 'null', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '增量同步组件所在的 IP 地址。', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1', + ], + 'Identity' => [ + 'title' => '正向：项目id', + 'description' => '任务 ID。', + 'type' => 'string', + 'example' => 'np_4w***', + ], + 'Subtopics' => [ + 'title' => 'subtopic', + 'description' => 'SubTpoics 集合。', + 'type' => 'array', + 'items' => [ + 'description' => 'SubTopic。', + 'type' => 'string', + 'example' => 'null', + ], + ], + 'Status' => [ + 'title' => '状态 (RUNNING, STOPPED, EXCEPTION, FINISHED)', + 'description' => '状态，包括 RUNNING、STOPPED、EXCEPTION 和 FINISHED。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'Checkpoint' => [ + 'title' => '当前位点 UTC 时间', + 'description' => '当前位点，以 UTC + 0 时区的时间格式展示。', + 'type' => 'string', + 'example' => '2023-07-13T09:19:53', + ], + 'Tps' => [ + 'title' => '每秒处理事务数', + 'description' => '每秒处理的事务数（Transactions Per Second，TPS）。', + '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' => '创建时间，以 UTC + 0 时区的时间格式展示。', + 'type' => 'string', + 'example' => '2023-07-13T18:04:36', + ], + 'GmtModify' => [ + 'title' => '修改时间 UTC时间', + 'description' => '修改时间，以 UTC + 0 时区的时间格式展示。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '用于填充 Message 中的占位符。', + 'example' => 'null', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '反向增量同步组件所在的 IP 地址。', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1', + ], + 'Identity' => [ + 'title' => '正向：项目id', + 'description' => '任务 ID。', + 'type' => 'string', + 'example' => 'np_4w8****', + ], + 'Subtopics' => [ + 'title' => 'subtopic', + 'description' => 'Subtopics 集合。', + 'type' => 'array', + 'items' => [ + 'description' => 'Subtopic。', + 'type' => 'string', + 'example' => 'null', + ], + ], + 'Status' => [ + 'title' => '状态 (RUNNING, STOPPED, EXCEPTION, FINISHED)', + 'description' => '状态，包括 RUNNING、STOPPED、EXCEPTION 和 FINISHED。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'Checkpoint' => [ + 'title' => '当前位点 UTC 时间', + 'description' => '当前位点，以 UTC + 0 时区的时间格式展示。', + 'type' => 'string', + 'example' => '2023-07-13T09:19:53', + ], + 'Tps' => [ + 'title' => '每秒处理事务数', + 'description' => '每秒处理的事务数（Transactions Per Second，TPS）。', + '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' => '创建时间，以 UTC + 0 时区的时间格式展示。', + 'type' => 'string', + 'example' => '2023-07-13T18:04:36', + ], + 'GmtModify' => [ + 'title' => '修改时间 UTC时间', + 'description' => '修改时间，以 UTC + 0 时区的时间格式展示。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '建议内容的上下文。', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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"}]', + 'title' => '查询任务的组件信息', + ], + 'ListProjectFullVerifyResult' => [ + 'summary' => '本接口用于查询数据迁移任务的全量校验结果。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目ID', + 'description' => '数据迁移任务的 ID。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => '迁移的状态，包括 `RUNNING`、`ERROR`、`FINISHED` 和 `SUSPEND`。', + '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' => '全量校验结果的类型，包括 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。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '用于填充 Message 中的占位符。', + 'example' => 'null', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '建议内容的上下文。', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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"}]', + 'title' => '查询任务的全量校验结果', + ], + 'StartProjectsByLabel' => [ + 'summary' => '本接口用于启动指定标签下，所有处于未启动状态的数据迁移或数据同步任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '标签ID', + 'description' => '标签 ID。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => '执行成功的任务 ID 集合。', + 'type' => 'array', + 'items' => [ + 'description' => '执行成功的任务 ID。', + 'type' => 'string', + 'example' => 'np_4w****'."\n", + ], + ], + 'FailedProjectIds' => [ + 'title' => '执行失败的项目id', + 'description' => '执行失败的任务 ID 集合。', + 'type' => 'array', + 'items' => [ + 'description' => '执行失败的任务 ID。', + '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"}]', + 'title' => '启动指定标签下所有未启动的任务', + ], + 'StopProjectsByLabel' => [ + 'summary' => '本接口用于暂停指定标签下，所有处于运行中状态的数据迁移或数据同步任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '标签ID', + 'description' => '标签 ID。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => '执行成功的任务 ID 集合。', + 'type' => 'array', + 'items' => [ + 'description' => '执行成功的任务 ID。', + 'type' => 'string', + 'example' => 'np_4w****', + ], + ], + 'FailedProjectIds' => [ + 'title' => '执行失败的项目id', + 'description' => '执行失败的任务 ID 集合。', + 'type' => 'array', + 'items' => [ + 'description' => '执行失败的任务 ID。', + '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"}]', + 'title' => '暂停指定标签下所有运行中的任务', + ], + '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' => '作用类型（CREATE_PROJECT）。', + 'type' => 'string', + 'required' => true, + 'example' => 'CREATE_PROJECT', + ], + ], + [ + 'name' => 'EffectiveTimeMinutes', + 'in' => 'formData', + 'schema' => [ + 'description' => '有效时长。默认 10 分钟内有效，设置范围为 1~30 分钟。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => '获取上传 OSS URL 的信息。', + 'type' => 'object', + 'properties' => [ + 'OssUrl' => [ + 'title' => '上传文件的临时url', + 'description' => '上传请求内容到 OSS 的临时 URL。', + 'type' => 'string', + 'example' => 'https://cn-hangzhou-pre-omsstore.oss-cn-hangzhou.aliyuncs.com/open_api_create_project/oacp******?Expires=169031&OSSAccessKeyId=LTAI****************&Signature=XdDF****************', + ], + 'OssKey' => [ + 'title' => 'ossKey', + 'description' => '用于调用接口传的 OssKey。', + 'type' => 'string', + 'example' => 'open_api_create_project/oacp_4xd****', + ], + 'ExpectedExpirationTime' => [ + 'title' => 'ossUrl 的预计失效时间 UTC 时间', + 'description' => 'OssUrl 的预计失效时间，以 UTC + 0 时区的时间格式展示。', + '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"}]', + 'title' => '获取上传 OSS URL', + ], + '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' => '源端的类型，包括 OCEANBASE、KAFKA、ROCKETMQ、POLARDB_X_1、TIDB 和 POLARDB_X_2。', + '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' => '目标端的类型，包括 OCEANBASE、KAFKA、ROCKETMQ、POLARDB_X_1、POLARDB_X_2 和 TIDB。', + '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' => '是否仅查询可以绑定的实例，默认为 true。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'FATAL', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'successful'."\n", + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'null'."\n", + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => '传输实例的 ID。', + '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' => '任务的 ID。', + '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' => '创建时间，以 UTC + 0 时区的时间格式展示。', + '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"}]', + 'title' => '查询传输实例列表', + ], + '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' => '类型，包括 INTERNET、VPC、RDS、PolarDB 和 DG。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'RDS' => 'RDS', + 'PolarDB' => 'PolarDB', + 'DG' => 'DG', + 'INTERNET' => 'INTERNET', + 'VPC' => 'VPC', + ], + 'example' => 'VPC', + 'enum' => [ + 'INTERNET', + 'VPC', + 'RDS', + 'DG', + 'POLARDB', + ], + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户申请公有云 VPC 的唯一 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1d2q3mhg9i23ofi****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据库实例 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-t4****', + ], + ], + [ + 'name' => 'DgInstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DG 网关 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dg-x****', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据库宿主机的 IP。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx.xxx.xxx.1', + ], + ], + [ + 'name' => 'Port', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据库宿主机 IP 的端口号。', + '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' => '数据库用户的密码，需要使用 Base64 编码。', + 'type' => 'string', + 'required' => true, + 'example' => 'cGFzc193b3JK', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据源的备注信息，不能超过 128 个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'UseSsl', + 'in' => 'formData', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + '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' => '包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'Contact the administrator.', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => 'MySQL 数据源的 ID。', + '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"}]', + 'title' => '创建 MySQL 数据源', + ], + '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' => 'OceanBase 数据库租户的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'tenant_name', + ], + ], + [ + 'name' => 'Cluster', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群', + 'description' => 'OceanBase 数据库租户所在集群的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cluster_name', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'vpc ID', + 'description' => '用户申请公有云 VPC 的唯一 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1d2q3mhg9i23ofi****', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP', + 'description' => '数据库宿主机的 IP。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx.xxx.xxx.1', + ], + ], + [ + 'name' => 'Port', + 'in' => 'formData', + 'schema' => [ + 'title' => '端口', + 'description' => '数据库宿主机 IP 的端口号。', + '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' => 'LogProxy 端口。', + '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' => '数据库用户的密码，需要使用 Base64 编码。', + 'type' => 'string', + 'required' => true, + 'example' => 'cGFzc193b3JK', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源描述信息', + 'description' => '数据源的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ConfigUrl', + 'in' => 'formData', + 'schema' => [ + 'title' => 'OB Server 地址', + 'description' => '用于获取 OceanBase 数据库底层服务器的真实地址。', + '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' => '该用户主要用于读取 OceanBase 数据库增量日志和数据库对象结构信息，请在业务集群 sys 租户下创建该用户。', + 'type' => 'string', + 'required' => false, + 'example' => 'user_na***', + ], + ], + [ + 'name' => 'DrcPassword', + 'in' => 'formData', + 'schema' => [ + 'title' => 'sys 租户下用户名密码（Base64编码）', + 'description' => 'sys 租户下用户名的密码，需要使用 Base64 编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'pas***', + ], + ], + [ + 'name' => 'InnerDrcPassword', + 'in' => 'formData', + 'schema' => [ + 'title' => '__oceanbase_inner_drc_user 的密码,使用base64编码', + 'description' => '__oceanbase_inner_drc_user 的密码，需要使用 Base64 编码。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => 'OceanBase 数据源的 ID。', + '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"}]', + 'title' => '创建 OceanBase 数据源', + ], + 'ListDataSource' => [ + 'summary' => '本接口用于查询已创建数据源的列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'SearchKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源ID或名称', + 'description' => '数据源的名称或 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'sourcename', + ], + ], + [ + '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' => '数据源排序的字段，包括 gmtCreate（默认值）和 gmtModified。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'gmtModified' => 'gmtModified', + 'gmtCreate' => 'gmtCreate', + ], + 'example' => 'gmtCreate', + ], + ], + [ + 'name' => 'Order', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序（降序 descend ， 升序：asc），默认 descend', + 'description' => '数据源排序的顺序，包括 `asc`（升序）和 `descend`（降序）。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => '数据源的角色，包括 `MASTER` 和 `SLAVE`。', + 'type' => 'string', + 'example' => 'MASTER', + 'enum' => [ + 'MASTER', + 'SLAVE', + ], + ], + 'Owner' => [ + 'title' => '数据源Owner', + 'description' => '数据源的 Owner。', + 'type' => 'string', + 'example' => 'admin', + ], + 'Tenant' => [ + 'title' => '租户名称或ID （专有云、VPC 对应名称）', + 'description' => '数据库租户的名称或 ID。', + 'type' => 'string', + 'example' => 'tenant_name', + ], + 'Cluster' => [ + 'title' => '集群名称或ID (专有云、VPC 对应名称)', + 'description' => '数据库租户所在集群的名称或 ID。', + 'type' => 'string', + 'example' => 'cluster_name', + ], + 'Schema' => [ + 'title' => '数据库名，若填写，后续迁移或者同步操作，只会针对该数据库操作； (专有云参数)', + 'description' => '数据库的名称。填写后，仅对该数据库进行数据迁移或数据同步。', + 'type' => 'string', + 'example' => 'schema_name', + ], + 'VpcId' => [ + 'title' => 'vpc id （公有云参数）', + 'description' => '用户申请公有云 VPC 的唯一 ID。', + 'type' => 'string', + 'example' => 'vpc_t4***', + ], + 'Ip' => [ + 'title' => 'ip（专有云、VPC）', + 'description' => '数据库宿主机的 IP 地址。', + 'type' => 'string', + 'example' => 'xxx.xxx.xxx.1', + ], + 'Port' => [ + 'title' => '端口（专有云、VPC）', + 'description' => '数据库宿主机 IP 的端口号。', + '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' => '数据源的备注信息，不能超过 128 个字符。', + 'type' => 'string', + 'example' => 'test', + ], + 'OracleSid' => [ + 'title' => 'ORACLE的sid', + 'description' => 'Oracle 数据库的 SID。', + 'type' => 'string', + 'example' => 'null', + ], + 'OracleNlsLengthSemantics' => [ + 'title' => 'nls_length_semantics 属性，只针对 oracle、ob-oracle', + 'description' => '`nls_length_semantics` 属性，仅针对 Oracle 和 OceanBase 数据库 Oracle 租户数据源。', + 'type' => 'string', + 'example' => 'null', + ], + 'OperatingSystem' => [ + 'title' => '操作系统，ob 没有。', + 'description' => '操作系统。OceanBase 数据源没有该参数。', + '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' => '数据源的创建时间，以 UTC + 0 时区的时间格式展示。', + 'type' => 'string', + 'example' => '2023-07-13T20:27:28.000+00:00', + ], + 'GmtModified' => [ + 'title' => '修改时间 UTC', + 'description' => '数据源的修改时间，以 UTC + 0 时区的时间格式展示。', + 'type' => 'string', + 'example' => '2023-07-13T20:37:28.000+00:00', + ], + 'PartnerId' => [ + 'title' => '对应主备库ID', + 'description' => '对应主备库的 ID。', + '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"}]', + 'title' => '查询数据源列表', + 'responseParamsDescription' => '## 附录'."\n" + .'### Kafka'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "endpoint":"xxx.xxx.xxx.1:2883",'."\n" + .' "username":null,'."\n" + .' "enableSSL":null,'."\n" + .' "enableSASL":null,'."\n" + .' "saslMechanism":null,'."\n" + .' "disableIdentificationAlgorithm":false'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| 参数 | 类型 | 描述 |'."\n" + .'|--------------------------|-------------|------------------|'."\n" + .'| endpoint | string | 服务地址。 |'."\n" + .'| username | string | 用户名。当您选择认证方式为 PLAIN、SCRAM-SHA-256 和 SCRAM-SHA-512 时，该参数必填。 |'."\n" + .'| enableSSL | boolean | 是否开启 SSL 认证。如果开启，则需要上传授信证书。 |'."\n" + .'| enableSASL | boolean | 是否开启 SASL 认证。 |'."\n" + .'| saslMechanism |KafkaSaslMechanisnEnum | 加密方式，包括 PLAIN、SCRAM-SHA-256、SCRAM-SHA-512 和 KERBEROS。 |'."\n" + .'|disableIdentificationAlgorithm | boolean |SSL 加密时，是否开启主机名验证。 |'."\n" + ."\n" + .'### DataHub'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "endpoint":"xxx.xxx.xxx.1:2883",'."\n" + .' "project":"detx***"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| 参数 | 类型 | 描述 |'."\n" + .'|--------------------------|-------------|------------------|'."\n" + .'| endpoint | string | 服务地址。 |'."\n" + .'| project | string | 任务的名称。 |'."\n" + ."\n" + .'### RocketMQ'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "endpoint":"xxx.xxx.xxx.1:2883",'."\n" + .' "endpointType":null,'."\n" + .' "version":null'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| 参数 | 类型 | 描述 |'."\n" + .'|--------------------------|-------------|------------------|'."\n" + .'| endpoint | string | 服务地址。 |'."\n" + .'| endpointType | CloudRocketMQEndpoint.Type | 服务地址的类型。 |'."\n" + .'| version | CloudRocketMQInst.Version | RocketMQ 的版本。|'."\n" + ."\n" + .'### OceanBase'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "cluster":"xgez***",'."\n" + .' "tenant":"gexr**",'."\n" + .' "isLogicSource":false,'."\n" + .' "useLogProxy":true,'."\n" + .' "drcUser":"tes***",'."\n" + .' "configUrl":"http://xxx.xxx.xxx.1:2883/service****",'."\n" + .' "logProxyIp":"xxx.xxx.xxx.2",'."\n" + .' "logProxyPort":2883,'."\n" + .' "noUserAuth":false'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| 参数 | 类型 | 描述 |'."\n" + .'|--------------------------|-------------|------------------|'."\n" + .'| cluster | string | 集群的名称。 |'."\n" + .'| tenant | string | 租户的名称。 |'."\n" + .'| isLogicSource | boolean | 是否为逻辑数据源。|'."\n" + .'| useLogProxy | boolean | 是否使用 LogProxy。|'."\n" + .'| drcUser | string | drc_user 的配置。 |'."\n" + .'| configUrl | string | 用于获取 OceanBase 数据库底层服务器的真实地址。 |'."\n" + .'| logProxyIp | string | LogProxy 服务的 IP 地址。 |'."\n" + .'| logProxyPort | integer | LogProxy 服务的端口。 |'."\n" + .'| noUserAuth | boolean | 对于同步 DataWorks 的接口，数据源是 OMS 自动生成的。如果没有用户账号和密码，则不能连接用户的 OceanBase 数据库。 |'."\n" + ."\n" + .'### TiDB'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "connExtraAttributes":{'."\n" + .' "kafkaId":"e_edz****",'."\n" + .' "kafkaTopic":"test**",'."\n" + .' "kafkaName":"denz***"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'| 参数 | 类型 | 描述 |'."\n" + .'|--------------------------|-------------|------------------|'."\n" + .'| kafkaId | string | 绑定的 Kafka 数据源的 ID。 |'."\n" + .'| kafkaTopic | string | 绑定的 Kafka Topic 的名称。 |'."\n" + .'| kafkaName | string | 绑定的 Kafka 数据源的名称。|', + ], + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => '标签的 ID。', + '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"}]', + 'title' => '创建标签', + ], + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null ', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => '标签的 ID。', + '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"}]', + 'title' => '查询标签列表', + ], + 'CreateOmsMysqlDataSource' => [ + 'summary' => '新建 MySQL 数据源。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源名称。长度为2~128个英文或中文字符。可以包含数字、下划线（_）、半角句号（.）或者短划线（-）。不能包含“/”等非法字符', + 'description' => '数据源名称。 '."\n" + .'长度为 2~128 个英文或中文字符，可包含数字、下划线（_）、半角句号（.）或者短划线（-）。 '."\n" + ."\n" + .'> <br>不可包含 “/” 等非法字符', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oms-mysql', + 'enum' => [], + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'title' => '所有 mysql 的类型 枚举：'."\n" + .'INTERNET、VPC、RDS、POLARDB、DG', + 'description' => 'MySQL 类型。 '."\n" + .'包括 INTERNET、VPC、RDS、PolarDB 和 DG。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'INTERNET', + 'enum' => [], + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源所属VPC ID。若Type为VPC则该字段必填。', + 'description' => '数据源所属 VPC ID。 '."\n" + ."\n" + .'> <br>如 Type 为 VPC，则该字段必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-12345abcde*******', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源云实例ID。若Type为RDS、POLARDB、DG该字段必填。', + 'description' => '数据源云实例 ID。 '."\n" + ."\n" + .'> <br>如 Type 为 RDS、PolarDB、DG，则该字段必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-12ab34cd56******', + 'enum' => [], + ], + ], + [ + 'name' => 'DgDatabaseId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'database gateway，数据库网关实例 id。若Type为 DG，该字段必填。', + 'description' => 'database gateway，数据库网关实例 ID。 '."\n" + ."\n" + .'> <br>如 Type 为 DG，则该字段必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'dg-yhss6sdlaff****', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源 ip 地址。若Type为INTERNET、VPC该字段必填。', + 'description' => '数据源 IP 地址。 '."\n" + ."\n" + .'> <br>如 Type 为 INTERNET、VPC，则该字段必填。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.****', + ], + ], + [ + 'name' => 'Port', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源端口。若Type为INTERNET、VPC该字段必填。', + 'description' => '数据源端口。 '."\n" + ."\n" + .'> <br>如 Type 为 INTERNET、VPC，则该字段必填。', + 'type' => 'string', + 'required' => false, + 'example' => '3306', + ], + ], + [ + 'name' => 'Schema', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名。若填写，后续迁移或者同步操作，只会针对该数据库操作；', + 'description' => '数据库名。 '."\n" + ."\n" + .'> <br>如填写，后续迁移或同步操作，只会针对该数据库操作。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Username', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库连接用户名。', + 'description' => '数据库连接用户名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'omsTestUser', + ], + ], + [ + 'name' => 'Password', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库连接密码，待加密明文（必须经过Base64编码）。', + 'description' => '数据库连接密码（需经过 Base64 编码后传入）。 '."\n" + .'例如，密码 abcd123@! 经过 Base64 转换后的值为 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" + .'It must be 2 to 256 characters in length. The default value is null.', + 'type' => 'string', + 'required' => false, + 'example' => 'OMS 测试 MySQL 数据源', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Data' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'EndpointId' => [ + 'description' => '数据源记录 ID。', + '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' => '新建 MySQL 数据源', + 'description' => '><notice><br>使用该接口需将 OceanBase 数据传输服务器的 IP 地址（请至 OMS 数据源添加页面查询） 加入到您的阿里云数据库实例的白名单、ECS 的安全规则或自建数据库对应的安全设置（通常为您自建数据库的防火墙）中以确保 OceanBase 数据传输服务可成功访问到您的数据库实例。></notice>', + ], + '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' => '传输实例的 ID。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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"}]', + 'title' => '释放传输实例', + ], + 'CancelProjectModifyRecord' => [ + 'summary' => '该接口用于根据修改记录的 ID 取消修改操作。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '修改记录 ID', + 'description' => '修改记录的 ID。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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"}]', + 'title' => '取消修改操作', + 'description' => '仅支持取消处于 PENDING 状态的修改记录。', + ], + 'RetryProjectModifyRecords' => [ + 'summary' => '该接口用于根据修改记录的 ID 重试修改操作。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '修改记录 ID', + 'description' => '修改记录的 ID。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（新）。', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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"}]', + 'title' => '重试修改操作', + 'description' => '仅支持重试处于 FAILED 状态的修改记录。', + ], + 'StopProjectModifyRecords' => [ + 'summary' => '该接口用于根据修改记录的 ID 终止修改操作。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '修改记录 ID', + 'description' => '修改记录的 ID。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（旧）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'Contact the administrator.', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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"}]', + 'title' => '终止修改操作', + 'description' => '仅支持停止处于 RUNNING 和 FAILED 状态的修改记录，且不可恢复。', + ], + 'ListProjectModifyRecords' => [ + 'summary' => '该接口用于根据数据迁移或数据同步任务的 ID 查询任务的修改记录。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目 ID', + 'description' => '数据迁移或数据同步任务的 ID。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（旧）。', + 'type' => 'string', + 'example' => 'A system error occurred.'."\n", + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => '修改记录的 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '344000005', + ], + 'SubProjectId' => [ + 'title' => '子项目 id（增表时产生）', + 'description' => '子任务的 ID（增加表时产生）。', + 'type' => 'string', + 'example' => 'np_598qm***', + ], + 'MergeRequestId' => [ + 'title' => '合并父子项目的工单 id，用于加表场景', + 'description' => '合并父子任务的工单 ID，用于增加表的场景。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'id', + ], + 'UpdateRequestId' => [ + 'title' => '更新父项目工单 id，用于减表或已有表对象更新场景', + 'description' => '更新父任务工单 ID，用于减表或已有表对象更新的场景。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'id', + ], + 'Type' => [ + 'title' => '修改记录任务类型 (INCREASE_OBJECT: 增加对象, DECREASE_OBJECT: 减少对象)', + 'description' => '修改记录任务类型，包括 INCREASE_OBJECT（增加对象）和 DECREASE_OBJECT（减少对象）。', + 'type' => 'string', + 'example' => 'INCREASE_OBJECT', + ], + 'Status' => [ + 'title' => '修改记录状态 (PENDING: 待执行, MODIFYING: 修改中（减表修改父项目工单的执行，加表创建子项目）, RUNNING: 运行中（子项目运行中）, MERGING: 合并中（父子项目符合合并条件）, TERMINATED: 已终止, SUCCESS: 成功, FAILED: 失败, CANCEL: 已取消)', + 'description' => '修改记录的状态，包括：'."\n" + .'- PENDING：待执行'."\n" + .'- MODIFYING：修改中（减表修改父任务工单的执行，加表创建子任务）'."\n" + .'- RUNNING：运行中（子任务运行中）'."\n" + .'- MERGING：合并中（父子任务符合合并条件）'."\n" + .'- TERMINATED：已终止'."\n" + .'- SUCCESS：成功'."\n" + .'- FAILED：失败'."\n" + .'- CANCEL：已取消', + 'type' => 'string', + 'example' => 'PENDING', + ], + 'ErrorDetail' => [ + 'title' => '错误详情，修改记录状态处于', + 'description' => '错误详情。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码（旧）。', + 'type' => 'string', + 'example' => 'INNER_ERROR', + ], + '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' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '用于填充 Message 中的占位符。', + 'example' => 'null', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '错误原因的上下文。', + 'example' => 'null', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '数据库的 ID。', + 'type' => 'string', + 'example' => 'db_id', + ], + 'Tables' => [ + 'title' => '当前库下的传输表对象配置', + 'description' => '当前数据库中传输表对象的配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MappedName' => [ + 'title' => '映射对象 table/topic', + 'description' => '表或 Topic 的映射名称。', + 'type' => 'string', + 'example' => 'mapped_name', + ], + 'Name' => [ + 'title' => '表名', + 'description' => '表的名称。', + 'type' => 'string', + 'example' => 'table_name', + ], + 'Id' => [ + 'title' => '表 ID', + 'description' => '表的 ID。', + 'type' => 'string', + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'title' => '行过滤表', + 'description' => '通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => '列类型的引申（包括 INT8, INT16, INT24, INT32, INT64, BIGINT, BOOLEAN, FLOAT, DOUBLE, DECIMAL, NUMBER, SMALL_MONEY, MONEY, DEC_FLOAT, REAL, UCHAR_STRING, GRAPHIC_STRING, CHAR_STRING, NCHAR_STRING, VAR_GRAPHIC_STRING, VAR_UCHAR_STRING, VAR_STRING, VAR_CHAR_STRING, VAR_NCHAR_STRING, ROW_ID, UROWID, TEXT, NTEXT, UTEXT, TINY_TEXT, MEDIUM_TEXT, LONG_TEXT, BINARY_BYTES, VAR_BINARY_BYTES, RAW, LONG_RAW, BIT, VAR_BIT, BLOB, TINY_BLOB, MEDIUM_BLOB, LONG_BLOB, BFILE, IMAGE, JSONB, UUID, ENUM, SET, INTERVAL_DAY_TO_SECOND, INTERVAL_YEAR_TO_MONTH, INTERVAL_DATE_TIME, CLOB, NCLOB, XML, JSON, LONG_VAR_CHAR, LONG_VAR_GRAPHIC, GEOGRAPHY, GEOMETRY, POINT, LSEG, BOX, PATH, CIRCLE, LINESTRING, POLYGON, MULTIPOINT, MULTILINESTRING, MULTIPOLYGON, GEOMETRYCOLLECTION, CIDR, INET, MACADDR, MACADDR8, TSVERCTOR, TSQUERY, YEAR, DATE, MYSQL_NEW_DATE, TIME, TIME_WITH_NANOS, TIME_WITH_TIMEZONE, SMALL_DATETIME, DATETIME, DATETIME_WITH_NONAS, TIMESTAMP_IN_LONG, TIMESTAMP_IN_LONG_WITH_NANOS, TIMESTAMP, TIMESTAMP_WITH_NANOS, TIMESTAMP_WITH_TIMEZONE, TIMESTAMP_WITH_LOCAL_TIMEZONE, ZONED_DATETIME, OID, REGCLASS, REGCOLLATION, REGCONFIG, REGDICTIONARY, REGNAMESPACE, REGOPER, REGOPERATOR, REGROLE, REGTYPE, INT4RANGE, INT8RANGE, NUMRANGE, TSRANGE, TSTZRANGE, DATERANGE, STRUCT, LIST, NULL, CUSTOM_TYPE, UNIQUEIDENTIFIER, UNSUPPORTED_TYPE）。', + 'type' => 'string', + 'example' => 'INT8', + ], + 'RawColumnType' => [ + 'title' => '数据库记录的列类型原始字符串', + 'description' => '数据库记录的列类型的原始字符串。', + 'type' => 'string', + 'example' => 'null', + ], + 'ColumnKey' => [ + 'title' => '索引类型 (PRI, UNI, MUL)', + 'description' => '索引的类型，包括 PRI、UNI 和 MUL。', + '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' => '包括 DATABASE 和 TABLE。', + 'type' => 'string', + 'example' => 'DATABASE', + ], + ], + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB table schema', + 'description' => 'ADB 数据源的映射信息。', + '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' => '表的 ID。', + 'type' => 'string', + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'title' => '行过滤表', + 'description' => '通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => '索引的类型，包括 PRI、UNI 和 MUL。', + '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' => '包括 DATABASE 和 TABLE。', + 'type' => 'string', + 'example' => 'DATABASE', + ], + ], + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB table schema', + 'description' => 'ADB 数据源的映射信息。', + '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' => '表或 Topic 的映射名称。', + 'type' => 'string', + 'example' => 'mapped_name', + ], + 'Name' => [ + 'title' => '表名', + 'description' => '表的名称。', + 'type' => 'string', + 'example' => 'table_name', + ], + 'Id' => [ + 'title' => '表 ID', + 'description' => '表的 ID。', + 'type' => 'string', + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'title' => '行过滤表', + 'description' => '通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => '索引的类型，包括 PRI、UNI 和 MUL。', + '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' => '包括 DATABASE 和 TABLE。', + 'type' => 'string', + 'example' => 'DATABASE', + ], + ], + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB table schema', + 'description' => 'ADB 数据源的映射信息。', + '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' => '表或 Topic 的映射名称。', + 'type' => 'string', + 'example' => 'mapped_name', + ], + 'Name' => [ + 'title' => '表名', + 'description' => '表的名称。', + 'type' => 'string', + 'example' => 'table_name', + ], + 'Id' => [ + 'title' => '表 ID', + 'description' => '表的 ID。', + 'type' => 'string', + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'title' => '行过滤表', + 'description' => '通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => '索引的类型，包括 PRI、UNI 和 MUL。', + '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' => '包括 DATABASE 和 TABLE。', + 'type' => 'string', + 'example' => 'DATABASE', + ], + ], + ], + ], + 'AdbTableSchema' => [ + 'title' => 'ADB table schema', + 'description' => 'ADB 数据源的映射信息。', + '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' => 'Schema 映射信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceName' => [ + 'title' => '源schema名', + 'description' => '源端 Schema 的名称。', + 'type' => 'string', + 'example' => 'source_name', + ], + 'DestName' => [ + 'title' => '映射schema名', + 'description' => 'Schema 的映射名称。', + 'type' => 'string', + 'example' => 'mapped_schema', + ], + ], + ], + ], + 'TableMappings' => [ + 'title' => '表映射信息列表', + 'description' => '表映射信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceSchema' => [ + 'title' => '源schema名', + 'description' => '源端 Schema 的名称。', + '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' => '源端 Schema 的名称。', + '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' => '源端 Schema 的名称。', + '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' => '减少对象的 ETL 信息（迁移）。', + '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' => '目标端表或 Topic 的名称。', + 'type' => 'string', + 'example' => 'dest_name', + ], + 'WhereClause' => [ + 'title' => 'sql 语法', + 'description' => '通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => '针对逻辑表下，逻辑表的 ID。', + 'type' => 'string', + 'example' => 'null', + ], + 'SourceEndpointId' => [ + 'title' => '针对物理表下传递 endpointId', + 'description' => '针对物理表下传递 endpointId。', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + 'GmtModified' => [ + 'title' => '修改时间', + 'description' => '任务的更新时间，以 UTC + 0 时区的时间格式展示。', + '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"}]', + 'title' => '查询任务的修改记录', + ], + 'CreateProjectModifyRecords' => [ + 'summary' => '本接口用于修改处于运行中、失败或已暂停状态的数据迁移或数据同步任务的迁移/同步对象。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目 ID', + 'description' => '数据迁移或数据同步任务的 ID。', + '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' => '数据库的 ID。', + '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' => '当前数据库中传输表对象的配置。Mode 为 WILDCARD 时，该参数表示具体黑名单或白名单的配置，表和视图共用。', + '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' => '表的 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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场景下使用', + 'description' => 'Hbase 模式分区配置，仅迁移到OBKV场景下使用', + 'type' => 'object', + 'properties' => [ + 'PartitionType' => [ + 'type' => 'string', + 'required' => false, + 'enum' => [ + 'KEY', + 'RANGE', + 'NONE', + ], + ], + 'VirtualColumn' => [ + 'type' => 'string', + 'required' => false, + ], + 'PartitionSize' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1024', + 'minimum' => '1', + ], + ], + 'required' => false, + ], + ], + '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' => '视图的 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'view_id', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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' => '具体表对象的配置集合。`mode` 为 `WILDCARD` 时，该参数表示具体表对象的重命名、行过滤配置。', + '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' => '表的 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'table_id', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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' => '具体视图对象的配置列表。`mode` 为 `WILDCARD` 时，该参数表示具体视图对象的重命名配置。', + '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' => '视图的 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'view_id', + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。', + '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' => 'ADB 数据源的映射信息。', + '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' => '传输对象列表（修改匹配规则时必填）', + 'description' => '传输对象列表（修改匹配规则时必填）', + 'type' => 'object', + 'properties' => [ + 'Mode' => [ + 'title' => '传输对象映射模式（SPECIFIC 指定对象、WILDCARD 匹配规则、COMPLEX 混合规则）', + 'description' => '传输对象映射模式（SPECIFIC 指定对象、WILDCARD 匹配规则、COMPLEX 混合规则）', + 'type' => 'string', + 'required' => false, + 'example' => 'SPCEIFIC', + 'enum' => [ + 'SPECIFIC', + 'WILDCARD', + 'COMPLEX', + ], + ], + 'Databases' => [ + 'title' => '数据库信息', + 'description' => '数据库信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '库ID', + 'description' => '库ID', + 'type' => 'string', + 'required' => false, + ], + 'Name' => [ + 'title' => '数据库名', + 'description' => '数据库名', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '数据库映射名', + 'description' => '数据库映射名', + 'type' => 'string', + 'required' => false, + ], + 'ClusterName' => [ + 'title' => '映射对象集群（已废弃）', + 'description' => '映射对象集群（已废弃）', + 'type' => 'string', + 'required' => false, + ], + 'TenantName' => [ + 'title' => '映射对象租户（已废弃）', + 'description' => '映射对象租户（已废弃）', + 'type' => 'string', + 'required' => false, + ], + 'Tables' => [ + 'title' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', + 'description' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'description' => '表名', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '表映射名', + 'description' => '表映射名', + 'type' => 'string', + 'required' => false, + ], + 'Id' => [ + 'title' => '表ID', + 'description' => '表ID', + 'type' => 'string', + 'required' => false, + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '行过滤，ETL语法', + 'type' => 'string', + 'required' => false, + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'type' => 'string', + 'required' => false, + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'ObkvPartitionConfig' => [ + 'title' => 'Hbase 模式分区配置，仅迁移到OBKV场景下使用', + 'description' => 'Hbase 模式分区配置，仅迁移到OBKV场景下使用', + 'type' => 'object', + 'properties' => [ + 'PartitionType' => [ + 'type' => 'string', + 'required' => false, + 'enum' => [ + 'KEY', + 'RANGE', + 'NONE', + ], + ], + 'VirtualColumn' => [ + 'type' => 'string', + 'required' => false, + ], + 'PartitionSize' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1024', + 'minimum' => '1', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Views' => [ + 'title' => '当前库下的传输视图对象配置', + 'description' => '当前库下的传输视图对象配置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '视图名', + 'description' => '视图名', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '视图映射名', + 'description' => '视图映射名', + 'type' => 'string', + 'required' => false, + ], + 'Id' => [ + 'type' => 'string', + 'required' => false, + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '行过滤，ETL语法', + 'type' => 'string', + 'required' => false, + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'type' => 'string', + 'required' => false, + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'SpecificTables' => [ + 'title' => '具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）', + 'description' => '具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'description' => '表名', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '表映射名', + 'description' => '表映射名', + 'type' => 'string', + 'required' => false, + ], + 'Id' => [ + 'type' => 'string', + 'required' => false, + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '行过滤，ETL语法', + 'type' => 'string', + 'required' => false, + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'type' => 'string', + 'required' => false, + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'SpecificViews' => [ + 'title' => '具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）', + 'description' => '具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '视图名', + 'description' => '视图名', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '视图映射名', + 'description' => '视图映射名', + 'type' => 'string', + 'required' => false, + ], + 'Id' => [ + 'type' => 'string', + 'required' => false, + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '行过滤，ETL语法', + 'type' => 'string', + 'required' => false, + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'type' => 'string', + 'required' => false, + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'DatabasesBlack' => [ + 'title' => '匹配规则模式：数据库对象黑名单', + 'description' => '匹配规则模式：数据库对象黑名单', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'type' => 'string', + 'required' => false, + ], + 'Name' => [ + 'title' => '库名', + 'description' => '库名', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '映射库名', + 'description' => '映射库名', + 'type' => 'string', + 'required' => false, + ], + 'ClusterName' => [ + 'title' => '映射对象集群（已废弃）', + 'description' => '映射对象集群（已废弃）', + 'type' => 'string', + 'required' => false, + ], + 'TenantName' => [ + 'title' => '映射对象租户（已废弃）', + 'description' => '映射对象租户（已废弃）', + 'type' => 'string', + 'required' => false, + ], + 'Tables' => [ + 'title' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', + 'description' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'description' => '表名', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '表映射名', + 'description' => '表映射名', + 'type' => 'string', + 'required' => false, + ], + 'Id' => [ + 'title' => '表ID', + 'description' => '表ID', + 'type' => 'string', + 'required' => false, + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '行过滤，ETL语法', + 'type' => 'string', + 'required' => false, + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'type' => 'string', + 'required' => false, + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Views' => [ + 'title' => '当前库下的传输视图对象配置', + 'description' => '当前库下的传输视图对象配置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '视图名', + 'description' => '视图名', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '视图映射名', + 'description' => '视图映射名', + 'type' => 'string', + 'required' => false, + ], + 'Id' => [ + 'title' => '视图ID', + 'description' => '视图ID', + 'type' => 'string', + 'required' => false, + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '行过滤，ETL语法', + 'type' => 'string', + 'required' => false, + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'type' => 'string', + 'required' => false, + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'SpecificTables' => [ + 'title' => '具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）', + 'description' => '具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'description' => '表名', + 'type' => 'string', + 'required' => false, + ], + 'Id' => [ + 'title' => '表ID', + 'description' => '表ID', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '表映射名', + 'description' => '表映射名', + 'type' => 'string', + 'required' => false, + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '行过滤，ETL语法', + 'type' => 'string', + 'required' => false, + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'type' => 'string', + 'required' => false, + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'SpecificViews' => [ + 'title' => '具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）', + 'description' => '具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'description' => '表名', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '表映射名', + 'description' => '表映射名', + 'type' => 'string', + 'required' => false, + ], + 'Id' => [ + 'title' => '视图ID', + 'description' => '视图ID', + 'type' => 'string', + 'required' => false, + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '行过滤，ETL语法', + 'type' => 'string', + 'required' => false, + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'type' => 'string', + 'required' => false, + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'TableAndViewWhiteList' => [ + 'title' => '匹配规则模式：表、视图的通配白名单', + 'description' => '匹配规则模式：表、视图的通配白名单', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'TableAndViewBlackList' => [ + 'title' => '匹配规则模式：表、视图的通配黑名单', + 'description' => '匹配规则模式：表、视图的通配黑名单', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'WhiteTableRules' => [ + 'title' => '表白名单规则', + 'description' => '表白名单规则', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaMapping' => [ + 'title' => 'schema 映射', + 'description' => 'schema 映射', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '对象名称', + 'description' => '对象名称', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '映射对象名称', + 'description' => '映射对象名称', + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'ObjectMapping' => [ + 'title' => 'schema 下的对象映射', + 'description' => 'schema 下的对象映射', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '对象名称', + 'description' => '对象名称', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '映射对象名称', + 'description' => '映射对象名称', + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'WhiteViewRules' => [ + 'title' => '视图白名单规则', + 'description' => '视图白名单规则', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaMapping' => [ + 'title' => 'schema 映射', + 'description' => 'schema 映射', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '对象名称', + 'description' => '对象名称', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '映射对象名称', + 'description' => '映射对象名称', + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'ObjectMapping' => [ + 'title' => 'schema 下的对象映射', + 'description' => 'schema 下的对象映射', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '对象名称', + 'description' => '对象名称', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '映射对象名称', + 'description' => '映射对象名称', + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'BlackTableRules' => [ + 'title' => '表黑名单规则', + 'description' => '表黑名单规则', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaMapping' => [ + 'title' => 'schema 映射', + 'description' => 'schema 映射', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '对象名称', + 'description' => '对象名称', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '映射对象名称', + 'description' => '映射对象名称', + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'ObjectMapping' => [ + 'title' => 'schema 下的对象映射', + 'description' => 'schema 下的对象映射', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '对象名称', + 'description' => '对象名称', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '映射对象名称', + 'description' => '映射对象名称', + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'BlackViewRules' => [ + 'title' => '视图黑名单规则', + 'description' => '视图黑名单规则', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaMapping' => [ + 'title' => 'schema 映射', + 'description' => 'schema 映射', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '对象名称', + 'description' => '对象名称', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '映射对象名称', + 'description' => '映射对象名称', + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'ObjectMapping' => [ + 'title' => 'schema 下的对象映射', + 'description' => 'schema 下的对象映射', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '对象名称', + 'description' => '对象名称', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '映射对象名称', + 'description' => '映射对象名称', + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Schemas' => [ + 'title' => '精确库表对象设置', + 'description' => '精确库表对象设置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '库ID', + 'description' => '库ID', + 'type' => 'string', + 'required' => false, + ], + 'Name' => [ + 'title' => '数据库名', + 'description' => '数据库名', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '数据库映射名', + 'description' => '数据库映射名', + 'type' => 'string', + 'required' => false, + ], + 'ClusterName' => [ + 'title' => '映射对象集群（已废弃）', + 'description' => '映射对象集群（已废弃）', + 'type' => 'string', + 'required' => false, + ], + 'TenantName' => [ + 'title' => '映射对象租户（已废弃）', + 'description' => '映射对象租户（已废弃）', + 'type' => 'string', + 'required' => false, + ], + 'Tables' => [ + 'title' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', + 'description' => '当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'description' => '表名', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '表映射名', + 'description' => '表映射名', + 'type' => 'string', + 'required' => false, + ], + 'Id' => [ + 'title' => '表ID', + 'description' => '表ID', + 'type' => 'string', + 'required' => false, + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '行过滤，ETL语法', + 'type' => 'string', + 'required' => false, + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'type' => 'string', + 'required' => false, + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'ObkvPartitionConfig' => [ + 'title' => 'Hbase 模式分区配置，仅迁移到OBKV场景下使用', + 'description' => 'Hbase 模式分区配置，仅迁移到OBKV场景下使用', + 'type' => 'object', + 'properties' => [ + 'PartitionType' => [ + 'type' => 'string', + 'required' => false, + 'enum' => [ + 'KEY', + 'RANGE', + 'NONE', + ], + ], + 'VirtualColumn' => [ + 'type' => 'string', + 'required' => false, + ], + 'PartitionSize' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1024', + 'minimum' => '1', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Views' => [ + 'title' => '当前库下的传输视图对象配置', + 'description' => '当前库下的传输视图对象配置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '视图名', + 'description' => '视图名', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '视图映射名', + 'description' => '视图映射名', + 'type' => 'string', + 'required' => false, + ], + 'Id' => [ + 'type' => 'string', + 'required' => false, + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '行过滤，ETL语法', + 'type' => 'string', + 'required' => false, + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'type' => 'string', + 'required' => false, + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'SpecificTables' => [ + 'title' => '具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）', + 'description' => '具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '表名', + 'description' => '表名', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '表映射名', + 'description' => '表映射名', + 'type' => 'string', + 'required' => false, + ], + 'Id' => [ + 'type' => 'string', + 'required' => false, + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '行过滤，ETL语法', + 'type' => 'string', + 'required' => false, + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'type' => 'string', + 'required' => false, + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'SpecificViews' => [ + 'title' => '具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）', + 'description' => '具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '视图名', + 'description' => '视图名', + 'type' => 'string', + 'required' => false, + ], + 'MappedName' => [ + 'title' => '视图映射名', + 'description' => '视图映射名', + 'type' => 'string', + 'required' => false, + ], + 'Id' => [ + 'type' => 'string', + 'required' => false, + ], + 'WhereClause' => [ + 'title' => '行过滤，ETL语法', + 'description' => '行过滤，ETL语法', + 'type' => 'string', + 'required' => false, + ], + 'FilterColumns' => [ + 'title' => '过滤列', + 'description' => '过滤列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'ShardColumns' => [ + 'title' => '分片列', + 'description' => '分片列', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'AdbTableSchema' => [ + 'title' => 'ADB 数据源的映射信息', + 'description' => 'ADB 数据源的映射信息', + 'type' => 'object', + 'properties' => [ + 'PrimaryKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'DistributedKeys' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'PartitionStatement' => [ + 'type' => 'string', + 'required' => false, + ], + 'PartitionLifeCycle' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + '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', + ], + 'Level' => [ + 'title' => 'FATAL, ERROR, WARNING, CRITICAL', + 'description' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述（旧）。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'example' => 'null', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => 'Contact the administrator. ', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => '请求返回的修改记录 ID。', + '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"}]', + 'title' => '修改传输对象', + ], + 'UpdateProjectConfig' => [ + 'summary' => '本接口用于更新数据迁移或数据同步任务的配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目ID', + 'description' => '数据迁移或数据同步项目的 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'np_fe****', + ], + ], + [ + 'name' => 'CommonTransferConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '高级配置', + 'description' => '高级配置', + 'type' => 'object', + 'properties' => [ + 'SinkStoreFormat' => [ + 'type' => 'string', + 'required' => false, + ], + 'SourceStoreFormat' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + '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' => '全量传输阶段限制能达到的最大传输速率，单位为记录数/秒。输入 null 时，表示不限制 RPS。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'null', + ], + 'ThrottleIOPS' => [ + 'title' => '限制流量，单位字节 null 不限速', + 'description' => '全量传输阶段限制能达到的最大传输流量，单位为字节/秒。输入 null 时，表示不限制 IOPS。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'null', + ], + 'MaxConcurrentIndexDDLs' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + 'IndexDDLConcurrencyLimit' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + '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' => '增量传输阶段限制能达到的最大传输速率，单位为记录数/秒。输入 null 时，表示不限制 RPS。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'null', + ], + 'ThrottleIOPS' => [ + 'title' => '限制流量，单位字节 null 不限速', + 'description' => '增量传输阶段限制能达到的最大传输流量，单位为字节/秒。输入 null 时，表示不限制 IOPS。', + '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' => '支持的 DDL 类型。', + 'type' => 'array', + 'items' => [ + 'description' => '增量传输阶段支持的 DDL 类型。', + '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' => '反向增量传输阶段限制能达到的最大传输速率，单位为记录数/秒。输入 null 时，表示不限制 RPS。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'null', + ], + 'ThrottleIOPS' => [ + 'title' => '限制流量，单位字节 null 不限速', + 'description' => '反向增量传输阶段限制能达到的最大传输流量，单位为字节/秒。输入 null 时，表示不限制 IOPS。', + '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' => '反向增量传输阶段支持的 DDL 类型。', + 'type' => 'array', + 'items' => [ + 'description' => '反向增量传输阶段支持的 DDL 类型。', + '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' => '包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'WARN', + ], + 'Message' => [ + 'description' => '错误描述。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议（新）。', + 'type' => 'string', + 'example' => '请联系管理员', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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"}]', + 'title' => '更新任务配置', + 'description' => '本接口使用全量替换式更新：'."\n" + .'- 全部覆盖：当您调用本接口时，需要传入一整套完整的配置信息。 '."\n" + .'- 未传即删：在新的配置集中未包含的任何旧配置项，都将被删除。'."\n" + .'- 差异更新：只有与系统当前记录不一致的配置项会被更新至您传入的新值。', + ], + 'DeleteDataSource' => [ + 'summary' => '该接口用于删除数据源。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据源 ID', + 'description' => '数据源的 ID。', + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议。', + 'type' => 'string', + 'example' => 'Contact the administrator.', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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"}]', + 'title' => '删除数据源', + ], + 'CreateRdsPostgreSQLDataSource' => [ + 'summary' => '该接口用于创建 RDS PostgreSQL 数据源。', + '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' => '数据库实例的 ID。', + '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' => '数据库用户的密码，需要使用 Base64 编码。', + 'type' => 'string', + 'required' => true, + 'example' => 'cGFzc193b3JK', + ], + ], + [ + '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' => '错误等级，包括 FATAL、ERROR、WARNING 和 CRITICAL。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'Message' => [ + 'description' => '错误描述。', + 'type' => 'string', + 'example' => 'A system error occurred.', + ], + 'ExtraContext' => [ + 'description' => '用于填充 Message 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'null', + 'description' => '用于填充 Message 中的占位符。', + ], + ], + 'MessageMcmsKey' => [ + 'description' => '错误信息的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'MessageMcmsContext' => [ + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '用于填充 MessageMcmsKey 中的占位符。', + ], + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsKey' => [ + 'description' => '错误原因的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ReasonMcmsContext' => [ + 'description' => '错误原因的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'null', + 'description' => '错误原因的上下文。', + ], + ], + 'Proposal' => [ + 'description' => '建议。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsKey' => [ + 'description' => '建议内容的 Key。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProposalMcmsContext' => [ + 'description' => '建议内容的上下文。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '建议内容的上下文。', + 'example' => 'null', + ], + ], + 'UpstreamErrorDetail' => [ + 'description' => '上游错误详情，用于处理 HTTP 请求。', + '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' => '请求 ID。', + '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' => '数据源的 ID。', + '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"}]', + 'title' => '创建 RDS PostgreSQL 数据源', + ], + 'DescribeBackupSetDownloadLink' => [ + 'summary' => '该接口用于查询 OceanBase 备份设置下载链接。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'DownloadTaskId', + 'in' => 'formData', + 'schema' => [ + 'description' => '目标备份集所对应的下载任务 ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1000002', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'DownloadTaskId' => [ + 'description' => '目标备份集所对应的下载任务 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000002', + ], + 'DownloadTaskStatus' => [ + 'description' => '目标备份集所对应的下载任务状态。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'DownloadTaskCreateTime' => [ + 'description' => '目标备份集所对应的下载任务创建时间。', + 'type' => 'string', + 'example' => '2020-05-22T17:04:18', + ], + 'BackupRestorableTime' => [ + 'description' => '备份集的可恢复时间点。', + 'type' => 'string', + 'example' => 'yyyy-MM-dd HH:mm:ss', + ], + 'BackupSetId' => [ + 'description' => '目标备份集 ID。', + 'type' => 'string', + 'example' => 'bak-4n****gacpa8', + ], + 'InternalUrl' => [ + 'description' => '内部网址。', + 'type' => 'string', + 'example' => 'http://bucket.oss-region-internal.aliyuncs.com/xxxxx', + ], + 'UrlExpiredTime' => [ + 'description' => '网址过期时间。', + 'type' => 'string', + 'example' => '2024-01-04 17:39:49', + ], + 'UrlAliveTime' => [ + 'description' => '网址有效时长。单位：秒。', + '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' => '获取备份设置的下载链接', + ], + 'DescribeDataBackupSet' => [ + 'summary' => '查询 OceanBase 备份集信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群ID', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'title' => '按照备份集状态查询', + 'description' => '按照备份集状态查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'DONE', + 'enum' => [ + 'BEGINNING', + 'DOING', + 'DONE', + 'FAILED', + 'OVERDUE', + 'UNKNOWN', + ], + ], + ], + [ + 'name' => 'BackupObjectType', + 'in' => 'formData', + 'schema' => [ + 'title' => '按照备份对象类型查询', + 'description' => '按照备份对象类型查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'tenant', + 'enum' => [ + 'cluster', + 'tenant', + 'table', + 'database', + ], + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '开始时间，'."\n" + ."\n" + .'格式：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-12-27T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '备份集结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-01-06T15:59:59Z', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页数量。 '."\n" + .'默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => '备份集详情。', + 'type' => 'array', + 'items' => [ + 'description' => '备份集详情。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '备份结束时间。', + 'type' => 'string', + 'example' => '2023-04-13T03:38:10Z', + ], + 'Status' => [ + 'description' => '备份集状态。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'Type' => [ + 'description' => '备份类型。', + 'type' => 'string', + 'example' => 'manual', + ], + 'StartTime' => [ + 'description' => '备份开始时间。', + 'type' => 'string', + 'example' => '2020-05-22T17:04:18', + ], + 'DataSize' => [ + 'description' => '备份集数据大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '31457280', + ], + 'Policy' => [ + 'description' => '备份策略。', + 'type' => 'string', + 'example' => 'automated', + ], + 'SetId' => [ + 'description' => '备份集 ID。', + 'type' => 'string', + 'example' => 'imm-test-set-cb****ee-b7d7-11ed-956f-****3e10bd70', + ], + 'Method' => [ + 'description' => '备份方法。', + 'type' => 'string', + 'example' => 'logical', + ], + 'Checkpoint' => [ + 'description' => '位点时间。', + 'type' => 'string', + 'example' => '2023-05-15T07:11:08Z', + ], + 'DataVersion' => [ + 'description' => '数据版本号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1678847020352', + ], + 'BackupObjectType' => [ + 'title' => '备份对象类型', + 'description' => '备份对象类型。', + 'type' => 'string', + 'example' => 'cluster', + ], + 'BackupObjects' => [ + 'title' => '备份对象列表', + 'description' => '备份对象列表。', + 'type' => 'array', + 'items' => [ + 'description' => '备份集详情。', + 'type' => 'object', + 'properties' => [ + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'test-****way', + ], + 'TenantName' => [ + 'description' => '租户名称。', + 'type' => 'string', + 'example' => 'ob2mr3oae0****', + ], + 'DatabaseTablesList' => [ + 'description' => '备份集列表。', + 'type' => 'array', + 'items' => [ + 'description' => '备份集列表。', + 'type' => 'object', + 'properties' => [ + 'Database' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'sms_pre', + ], + 'Tables' => [ + 'description' => '表列表。', + 'type' => 'array', + 'items' => [ + 'description' => '表列表。', + 'type' => 'string', + 'example' => '{\'Tables\': []}', + ], + ], + ], + ], + ], + ], + ], + ], + 'BackupResults' => [ + 'title' => '备份结果', + 'description' => '备份结果。', + 'type' => 'array', + 'items' => [ + 'description' => '备份结果详情。', + 'type' => 'object', + 'properties' => [ + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'container-opa-****-02', + ], + 'TenantName' => [ + 'description' => '租户名称。', + 'type' => 'string', + 'example' => 'ob2mr3oae0****'."\n", + ], + 'TableBackupResults' => [ + 'description' => '表恢复结果。', + 'type' => 'array', + 'items' => [ + 'description' => '表恢复结果。', + 'type' => 'object', + 'properties' => [ + 'Database' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'order_ce****_online', + ], + 'Table' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'tr_sale_order_****', + ], + 'Status' => [ + 'description' => '备份状态。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'Message' => [ + 'description' => '错误描述。', + 'type' => 'string', + 'example' => 'Create tag success', + ], + ], + ], + ], + ], + ], + ], + 'DownloadTaskStatus' => [ + 'title' => '目标备份集所对应的备份任务状态', + 'description' => '目标备份集所对应的备份任务状态。', + 'type' => 'string', + 'example' => 'not_exist', + ], + 'DownloadTaskId' => [ + 'title' => '目标备份集所对应的备份任务ID', + 'description' => '目标备份集所对应的备份任务 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100***012', + ], + 'Validity' => [ + 'title' => '有效性，可空；', + 'description' => '有效性，可空。', + 'type' => 'string', + 'example' => 'VALID', + 'enum' => [ + 'VALID', + 'INVALID', + ], + ], + 'Progress' => [ + 'title' => '备份进度', + 'description' => '备份进度。', + 'type' => 'string', + 'example' => '52', + ], + 'StorageClass' => [ + 'title' => '备份集类型，standard：一级备份、'."\n" + .'archive：归档（二级）备份', + 'description' => '备份集类型。'."\n" + .'- standard：一级备份。'."\n" + .'- archive：归档（二级）备份。', + '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' => '查询备份集信息', + ], + 'CreateBackupSetDownloadLink' => [ + 'summary' => '创建 OceanBase 备份任务下载链接。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '目标备份集所属Oceanbase集群ID', + 'description' => '目标备份集所属 OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'i-bp67acfmxazb4p****', + ], + ], + [ + 'name' => 'BackupSetId', + 'in' => 'formData', + 'schema' => [ + 'title' => '目标备份集ID', + 'description' => '目标备份集 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'bak-6f****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'DownloadTaskId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE205C00-30E4-****-****-87E3A8A2AA0C\\",\\n \\"Data\\": {\\n \\"DownloadTaskId\\": 0\\n }\\n}","type":"json"}]', + 'title' => '创建备份任务下载链接', + ], + 'DescribeRestorableTenants' => [ + 'summary' => '查询可恢复 OceanBase 租户。', + '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' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + [ + 'name' => 'IsRemote', + 'in' => 'formData', + 'schema' => [ + 'title' => '为兼容老版本，可以为空', + 'description' => '为兼容老版本，可以为空。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SetId', + 'in' => 'formData', + 'schema' => [ + 'title' => '备份集ID', + 'description' => '备份集 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'bak-xxxxx', + ], + ], + [ + 'name' => 'RestoreMode', + 'in' => 'formData', + 'schema' => [ + 'title' => '恢复方式', + 'description' => '恢复方式。非必填，在 IsRemote=true 时，必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'from_time_point', + 'enum' => [ + 'from_backup_set', + 'from_time_point', + ], + ], + ], + [ + 'name' => 'Method', + 'in' => 'formData', + 'schema' => [ + 'title' => '备份类型', + 'description' => '备份类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'native_logical', + 'enum' => [ + 'logical', + 'physical', + 'native_logical', + ], + ], + ], + [ + 'name' => 'IsOnline', + 'in' => 'formData', + 'schema' => [ + 'title' => '目标解析集群是否在线。为兼容旧版本可以不填，不填时值为对isRemote取反', + 'description' => '目标解析集群是否在线。'."\n" + .'> 为兼容旧版本时可以不填，不填时值为对 isRemote 取反。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RestoreObjectType', + 'in' => 'formData', + 'schema' => [ + 'title' => '恢复对象类型', + 'description' => '恢复对象类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'tenant', + 'enum' => [ + 'cluster', + 'tenant', + 'database', + 'table', + 'serverless', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-****-****-87E3A8A2AA0C', + ], + 'Tenants' => [ + 'description' => '租户信息。', + 'type' => 'array', + 'items' => [ + 'description' => '租户的列表信息。', + 'type' => 'object', + 'properties' => [ + 'TenantName' => [ + 'description' => '租户名称。', + 'type' => 'string', + 'example' => 'sbtest1', + ], + 'Method' => [ + 'description' => '备份方式。', + 'type' => 'string', + 'enumValueTitles' => [ + 'native_logical：库表逻辑备份' => 'native_logical：库表逻辑备份', + 'physical：物理备份' => 'physical：物理备份', + 'logical：逻辑备份（OB2276及以下）' => 'logical：逻辑备份（OB2276及以下）', + ], + 'example' => 'logical', + ], + 'TenantId' => [ + 'description' => '租户 ID。', + 'type' => 'string', + 'example' => 'ob317v4uif****', + ], + 'TimeIntervalList' => [ + 'description' => '租户可恢复时间区间信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '租户可恢复时间区间信息。', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '可恢复的起始时间。', + 'type' => 'string', + 'example' => '2023-01-20T16:00:00Z', + ], + 'EndTime' => [ + 'description' => '可恢复的结束时间。', + 'type' => 'string', + 'example' => '2023-03-13T02:43:03Z', + ], + 'FromArchive' => [ + 'title' => '是否属于归档恢复', + 'description' => '是否属于归档恢复。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'StorageType' => [ + 'description' => '备份存储类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'standard：标准存储' => 'standard：标准存储', + 'archive：归档存储' => 'archive：归档存储', + ], + 'example' => 'standard', + ], + ], + ], + ], + 'ClusterId' => [ + 'title' => '集群ID', + 'description' => '集群 ID。', + 'type' => 'string', + 'example' => 'objnf3b2****', + ], + 'ObRpmVersion' => [ + 'title' => 'OB RPM版本号', + 'description' => 'OceanBase RPM 版本号。', + 'type' => 'string', + 'example' => '3.2.3.1-2022080510****', + ], + 'ObVersion' => [ + 'title' => 'OB 大版本号', + 'description' => 'OceanBase 大版本号。', + 'type' => 'string', + 'example' => '3.2.3.1', + ], + 'SourceRegion' => [ + 'title' => '集群所属地域', + 'description' => '集群所属地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'TenantAlias' => [ + 'title' => '租户别名', + 'description' => '租户别名。', + 'type' => 'string', + 'example' => 'aaa', + ], + 'CpuNum' => [ + 'title' => '租户cpu规格', + 'description' => '租户 CPU 规格。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'MemoryNum' => [ + 'title' => '租户memory规格', + 'description' => '租户存储规格。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'BackupBucketName' => [ + 'title' => '备份目录名', + 'description' => '备份目录名。', + 'type' => 'string', + 'example' => 'backup', + ], + 'ObTenantId' => [ + 'title' => '租户ID', + 'description' => '租户 ID。', + 'type' => 'string', + 'example' => 'tvd43v****', + ], + 'ClusterName' => [ + 'title' => '集群名', + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'testCluster', + ], + 'BackupSets' => [ + 'description' => '备份集列表。', + 'type' => 'array', + 'items' => [ + 'description' => '备份集信息。', + 'type' => 'object', + 'properties' => [ + 'Checkpoint' => [ + 'title' => '备份集的快照点', + 'description' => '备份集的快照点。', + 'type' => 'string', + 'example' => '2024-01-01\'T\'12:10:10.000\'Z\'', + ], + 'SetId' => [ + 'title' => '备份集ID', + 'description' => '备份集 ID。', + 'type' => 'string', + 'example' => 'bak-xxxxx', + ], + 'BackupSetId' => [ + 'description' => '恢复所使用的全量备份集 ID。', + 'type' => 'string', + 'example' => 'bak-4n****gacpa8', + ], + 'TenantId' => [ + 'title' => '租户ID', + 'description' => '租户ID', + 'type' => 'string', + 'example' => 't5********', + ], + ], + ], + ], + 'UsedDisk' => [ + 'title' => '租户磁盘大小', + 'description' => '租户磁盘大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'UnitNum' => [ + 'title' => '租户节点数', + 'description' => '租户节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TenantMode' => [ + 'title' => '租户模式', + 'description' => '租户模式。', + 'type' => 'string', + 'example' => 'Oracle', + ], + 'TenantDataBackupRemainDays' => [ + 'title' => '租户备份数据剩余有效天数', + 'description' => '租户备份数据剩余有效天数', + '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' => '查询可恢复租户', + ], + 'DescribeAnomalySQLList' => [ + 'summary' => '查询诊断系统判定认为可能存在性能问题的 SQL 列表。', + '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' => 'OceanBase集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'obsd23j4f****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't4louaeei****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '起始时间', + 'description' => '查询可疑 SQL 参数的起始时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-06-13T15:40:43Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '结束时间', + 'description' => '查询可疑 SQL 参数的结束时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-09-13T15:40:43Z', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名称', + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testdb', + ], + ], + [ + 'name' => 'SearchKeyWord', + 'in' => 'formData', + 'schema' => [ + 'title' => '关键字查询', + 'description' => '关键字查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'update', + ], + ], + [ + 'name' => 'SearchParameter', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数查询', + 'description' => '参数查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'cputime', + ], + ], + [ + 'name' => 'SearchRule', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询规则', + 'description' => '查询规则。 '."\n" + .'该参数取值包括："="，">"， “>=”， “<”，“<="', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + ], + [ + 'name' => 'SearchValue', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询值', + 'description' => '查询值。', + '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' => '节点 IP。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp19y05****pacyqnlrc', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'description' => '分页查询时设置的每页行数。'."\n" + .'- 最大值：100。'."\n" + .'- 默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => '分页查询的页码。'."\n" + .'- 起始值：1。'."\n" + .'- 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FilterCondition', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '过滤条件', + 'description' => '过滤条件。 '."\n" + .'> <br> - OceanBase 的所有字段均支持过滤。<br> - 将参数的键值以 JSON 的格式写在 JSON 字符串中，以对该参数进行过滤。', + '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' => '排序列。', + 'type' => 'string', + 'required' => false, + 'example' => 'cputime', + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序规则', + 'description' => '排序规则。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '{ "dbname":test, "SQLType":null }' => '{ "dbname":test, "SQLType":null }', + ], + 'example' => 'desc', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => [ + 'description' => '支持的语言。取值：'."\n" + .'- 中文：zh-CN'."\n" + .'- 英文：en-US', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数量', + 'description' => '总数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'AnomalySQLList' => [ + 'title' => '可疑SQL列表', + 'description' => '可疑 SQL 列表。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '返回数据序号', + 'description' => '返回数据序号', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'DiagnosisRule' => [ + 'title' => '诊断规则', + 'description' => '诊断规则', + 'type' => 'string', + 'example' => '全表扫描有索引未用', + ], + 'SQLText' => [ + 'title' => 'sql文本', + 'description' => 'SQL 文本。', + 'type' => 'string', + 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC', + ], + 'Suggestion' => [ + 'title' => '建议', + 'description' => '建议。', + 'type' => 'string', + 'example' => '请确认业务场景、数据分布变化、请求量突涨、执行计划变化等情况', + ], + 'DbName' => [ + 'title' => '数据库名', + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'database1', + ], + 'RequestTimeUTCString' => [ + 'title' => '请求时间（零时区）', + 'description' => '请求时间（零时区）。', + 'type' => 'string', + 'example' => '2022-01-11T07:08:00Z', + ], + 'CpuTime' => [ + 'title' => '平均CPU时间（ms）', + 'description' => '平均 CPU 时间。单位：毫秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '50.13', + ], + 'SQLId' => [ + 'title' => 'SQLID', + 'description' => 'SQLID。', + 'type' => 'string', + 'example' => '99E9D3BF****B486239E6C7BC79B****', + ], + 'Diagnosis' => [ + 'title' => '诊断信息', + 'description' => '诊断信息。', + 'type' => 'string', + 'example' => '全表扫描有索引未用', + ], + 'RequestTime' => [ + 'title' => '请求时间', + 'description' => '请求时间。单位：毫秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '50.00', + ], + 'Executions' => [ + 'title' => '执行次数', + 'description' => '执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '89043', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => '用户名。', + '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' => '查询可疑 SQL 列表', + 'description' => '为优化用户体验，云数据库对 SQL 诊断功能进行了升级，本接口已下线并由新的接口替代，详情请参见 <props="china">[【通知】云数据库诊断管理 API 接口下线](https://help.aliyun.com/document_detail/2352272.html?spm=a2c4g.292641.0.0.8d3622f8LtqWiM)</props><props="intl">[【通知】云数据库诊断管理 API 接口下线](https://www.alibabacloud.com/help/zh/apsaradb-for-oceanbase/latest/notice-cloud-database-diagnosis-management-api-interface-downline)</props>。', + ], + 'DescribeSQLDetails' => [ + 'summary' => '根据 SQLID 查询一条 SQL 的 SQL 文本信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID', + 'description' => '租户 ID。', + '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' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'SQLDetails' => [ + 'title' => 'SQL详情', + 'description' => 'SQL 列表详情。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'SQLText' => [ + 'title' => 'SQL文本', + 'description' => 'SQL 文本。', + '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' => '查询 SQL 文本信息', + 'description' => '为优化用户体验，云数据库对 SQL 诊断功能进行了升级，本接口已下线并由新的接口替代，详情请参见 <props="china">[【通知】云数据库诊断管理 API 接口下线](https://help.aliyun.com/document_detail/2352272.html?spm=a2c4g.292641.0.0.8d3622f8LtqWiM)</props><props="intl">[【通知】云数据库诊断管理 API 接口下线](https://www.alibabacloud.com/help/zh/apsaradb-for-oceanbase/latest/notice-cloud-database-diagnosis-management-api-interface-downline)</props>。', + ], + 'DescribeSQLPlans' => [ + 'summary' => '根据 SQLID 查询诊断系统存储的 SQL 执行计划信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID', + 'description' => '租户 ID。', + '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' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'SQLPlans' => [ + 'title' => '执行计划信息', + 'description' => '执行计划列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '执行计划列表信息。', + 'type' => 'object', + 'properties' => [ + 'HitCount' => [ + 'title' => '命中次数', + 'description' => '命中次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'OutlineData' => [ + 'title' => 'Outline数据', + 'description' => 'Outline 数据。', + 'type' => 'string', + 'example' => '/*+ BEGIN_OUTLINE_DATA FULL(@\\"SEL$1\\" \\"testdb1.bmsql_order_line\\"@\\"SEL$1\\") END_OUTLINE_DATA*/', + ], + 'AvgExecutionMS' => [ + 'title' => '平均执行时间 (ms)', + 'description' => '平均执行时间 (ms)。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'PlanUnionHash' => [ + 'title' => 'SQL执行计划在诊断系统内部的唯一标识', + 'description' => 'SQL 执行计划在诊断系统内部的唯一标识。', + 'type' => 'string', + 'example' => '859ef7ee****b23ac98cdeb2476f****', + ], + 'OutlineId' => [ + 'title' => 'OutlineID', + 'description' => 'OutlineID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'AvgExecutionTimeMS' => [ + 'title' => '平均执行时间', + 'description' => '数据库使用此执行计划的平均执行时间，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '288', + ], + 'PlanId' => [ + 'title' => 'SQL执行计划在数据库内部的ID', + 'description' => 'SQL 执行计划在数据库内部的 ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9114', + ], + 'OutlineTime' => [ + 'title' => '绑定时间', + 'description' => '绑定时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1641492303000', + ], + 'OutlineTimeUTCString' => [ + 'title' => '绑定时间(零时区)', + 'description' => '绑定时间（零时区）。', + 'type' => 'string', + 'example' => '2022-01-06T18:05:03Z', + ], + 'PlanFull' => [ + 'title' => 'SQL的完整执行计划', + 'description' => 'SQL 的完整执行计划。', + 'type' => 'string', + 'example' => 'PHY_TABLE_SCAN | bmsql_order_line | 40 ******', + ], + 'NodeIp' => [ + 'title' => '节点ip', + 'description' => '节点 IP。', + 'type' => 'string', + 'example' => 'i-bp16niirq4zdmgvm****', + ], + 'MergedVersion' => [ + 'title' => '合并版本', + 'description' => '合并版本。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '132', + ], + 'QuerySQL' => [ + 'title' => '查询sql', + 'description' => '查询 sql。', + 'type' => 'string', + 'example' => 'SELECT ol_i_id, ***, *** FROM aaa', + ], + 'FirstLoadTimeUTCString' => [ + 'title' => '首次加载时间(零时区)', + 'description' => '首次加载时间（零时区）。', + 'type' => 'string', + 'example' => '2022-01-06T18:05:03Z', + ], + 'FirstLoadTime' => [ + 'title' => '首次加载时间', + 'description' => '首次加载时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1641492303000', + ], + 'PlanInfo' => [ + 'title' => '计划信息', + 'description' => '计划信息。', + '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' => '查询 SQL 执行计划', + 'description' => '为优化用户体验，云数据库对 SQL 诊断功能进行了升级，本接口已下线并由新的接口替代，详情请参见 <props="china">[【通知】云数据库诊断管理 API 接口下线](https://help.aliyun.com/document_detail/2352272.html?spm=a2c4g.292641.0.0.8d3622f8LtqWiM)</props><props="intl">[【通知】云数据库诊断管理 API 接口下线](https://www.alibabacloud.com/help/zh/apsaradb-for-oceanbase/latest/notice-cloud-database-diagnosis-management-api-interface-downline)</props>。', + ], + 'DescribeSQLHistoryList' => [ + 'summary' => '根据 SQLID 查询一条 SQL 在时间段内的执行历史。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't2mr3oae0****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数历史查看的起始时间。', + 'description' => '查看 SQL 执行历史参数的起始时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-06-13T15:40:43Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数历史查看的结束时间。', + 'description' => '查看 SQL 执行历史参数的结束时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：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' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '每页数量', + 'description' => '每页数量。 '."\n" + .'默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'SQLHistoryList' => [ + 'title' => 'SQL历史信息', + 'description' => 'SQL 历史信息。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'title' => '列表', + 'description' => 'SQL 历史信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'SQL 历史列表信息。', + 'type' => 'object', + 'properties' => [ + 'ExecPerSecond' => [ + 'title' => '每秒次数', + 'description' => '每秒次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '163.0', + ], + 'MaxCpuTime' => [ + 'title' => '最大CPU时间', + 'description' => '最大 CPU 时间。', + 'type' => 'number', + 'format' => 'float', + 'example' => '257.967', + ], + 'BlockCacheHit' => [ + 'title' => 'BlockCache命中次数', + 'description' => 'BlockCache 命中次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + 'DecodeTime' => [ + 'title' => '解码等待', + 'description' => '解码等待。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'RemotePlans' => [ + 'title' => '远程计划数', + 'description' => '远程计划数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RPCCount' => [ + 'title' => 'RPC次数', + 'description' => 'RPC 次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NetWaitTime' => [ + 'title' => '网络等待', + 'description' => '网络等待。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'DiskRead' => [ + 'title' => '物理读', + 'description' => '物理读。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NodeIp' => [ + 'title' => '节点IP', + 'description' => '节点 IP。', + 'type' => 'string', + 'example' => 'i-bp18qljorblo8es*****', + ], + 'ConcurrencyWaitTime' => [ + 'title' => '并发等待', + 'description' => '并发等待。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'DbName' => [ + 'title' => '数据库名', + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'testdb', + ], + 'MemstoreReadRowCount' => [ + 'title' => '读内存行数', + 'description' => '读内存行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '527', + ], + 'AppWaitTime' => [ + 'title' => '客户端等待', + 'description' => '客户端等待。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'ElapsedTime' => [ + 'title' => '平均响应时间', + 'description' => '平均响应时间。', + 'type' => 'number', + 'format' => 'float', + 'example' => '76.382', + ], + 'MissPlans' => [ + 'title' => '未命中计划次数', + 'description' => '未命中计划次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AffectedRows' => [ + 'title' => '影响行数', + 'description' => '影响行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ScheduleTime' => [ + 'title' => '调度时间', + 'description' => '调度时间。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'Event' => [ + 'title' => '等待事件', + 'description' => '等待事件。', + 'type' => 'string', + 'example' => 'mysql response wait client', + ], + 'TotalWaitTime' => [ + 'title' => '内部等待', + 'description' => '内部等待。', + 'type' => 'number', + 'format' => 'float', + 'example' => '10.966', + ], + 'ReturnRows' => [ + 'title' => '返回行数', + 'description' => '返回行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExecuteTime' => [ + 'title' => '内部执行时间', + 'description' => '内部执行时间。', + 'type' => 'number', + 'format' => 'float', + 'example' => '61.044', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'tester', + ], + 'Executions' => [ + 'title' => '执行次数', + 'description' => '执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '89403', + ], + 'GetPlanTime' => [ + 'title' => '硬解析时间', + 'description' => '硬解析时间。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.052', + ], + 'CpuTime' => [ + 'title' => '平均CPU时间', + 'description' => '平均 CPU 时间。', + 'type' => 'number', + 'format' => 'float', + 'example' => '50.13', + ], + 'MaxElapsedTime' => [ + 'title' => '最大响应时间', + 'description' => '最大响应时间。', + 'type' => 'number', + 'format' => 'float', + 'example' => '260.44', + ], + 'BlockIndexCacheHit' => [ + 'title' => 'BlockIndexCache命中次数', + 'description' => 'BlockIndexCache 命中次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'EndTimeUTCString' => [ + 'title' => '结束时间（零时区）', + 'description' => '结束时间（零时区）。', + 'type' => 'string', + 'example' => '2021-12-28T02:08:18Z', + ], + 'EndTime' => [ + 'title' => '结束时间', + 'description' => '结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2021-12-28T02:08:18Z', + ], + 'RetryCount' => [ + 'title' => '重试次数', + 'description' => '重试次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ClientIp' => [ + 'title' => '客户端IP', + 'description' => '客户端 IP。', + 'type' => 'string', + 'example' => '1*2.***.1*3.***', + ], + 'BloomFilterCacheHit' => [ + 'title' => 'BloomFilterCache命中次数', + 'description' => 'BloomFilterCache 命中次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'IOWaitTime' => [ + 'title' => 'IO等待', + 'description' => 'IO 等待。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'FailTimes' => [ + 'title' => '失败次数', + 'description' => '失败次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'QueueTime' => [ + 'title' => '队列等待', + 'description' => '队列等待。', + 'type' => 'number', + 'format' => 'float', + 'example' => '15.275', + ], + 'RowCacheHit' => [ + 'title' => 'RowCache命中次数', + 'description' => 'RowCache 命中次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'LogicalRead' => [ + 'title' => '逻辑读', + 'description' => '逻辑读。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19', + ], + 'SsstoreReadRowCount' => [ + 'title' => '读磁盘行数', + 'description' => '读磁盘行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '43086', + ], + ], + ], + ], + 'Count' => [ + 'title' => '数量', + 'description' => '数量。', + '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' => '查询 SQL 执行历史', + 'description' => '为优化用户体验，云数据库对 SQL 诊断功能进行了升级，本接口已下线并由新的接口替代，详情请参见 <props="china">[【通知】云数据库诊断管理 API 接口下线](https://help.aliyun.com/document_detail/2352272.html?spm=a2c4g.292641.0.0.8d3622f8LtqWiM)</props><props="intl">[【通知】云数据库诊断管理 API 接口下线](https://www.alibabacloud.com/help/zh/apsaradb-for-oceanbase/latest/notice-cloud-database-diagnosis-management-api-interface-downline)</props>。', + ], + 'DescribeTopSQLList' => [ + 'summary' => '查询诊断系统采集到的 SQL 执行性能数据列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't2mr3oae0****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '起始时间。', + 'description' => '查询 TOPSQL 参数的起始时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-06-13T15:40:43Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '结束时间。', + 'description' => '查询 TOPSQL 参数的结束时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-09-13T15:40:43Z', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名称', + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'testdb', + ], + ], + [ + 'name' => 'SearchKeyWord', + 'in' => 'formData', + 'schema' => [ + 'title' => '关键字查询', + 'description' => '关键字查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'update', + ], + ], + [ + 'name' => 'SearchParameter', + 'in' => 'formData', + 'schema' => [ + 'title' => '参数查询', + 'description' => '参数查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'cputime', + ], + ], + [ + 'name' => 'SearchRule', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询规则', + 'description' => '查询规则。', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + ], + [ + 'name' => 'SearchValue', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询值', + 'description' => '查询值。', + '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' => '节点 IP。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp19y05uq6xpacyqnlrc', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询的页码。 起始值：1 默认值：1', + 'description' => '分页查询的页码。'."\n" + .'- 起始值：1。'."\n" + .'- 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时设置的每页行数。 最大值：100 默认值：10', + 'description' => '分页查询时设置的每页行数。 '."\n" + .'- 最大值：100。 '."\n" + .'- 默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'FilterCondition', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '过滤条件', + 'description' => '过滤条件。', + 'type' => 'object', + 'required' => false, + 'example' => '[dbName:sys]', + ], + ], + [ + 'name' => 'SortColumn', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序列', + 'description' => '排序列。', + 'type' => 'string', + 'required' => false, + 'example' => 'cputime', + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序规则', + 'description' => '排序规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数量', + 'description' => '总数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'TopSQLList' => [ + 'title' => 'TOPSQL列表', + 'description' => 'TOPSQL 列表。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '返回数据序号', + 'description' => '返回数据序号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExecPerSecond' => [ + 'title' => '每秒次数', + 'description' => '每秒次数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '163.0', + ], + 'SQLText' => [ + 'title' => 'sql文本', + 'description' => 'SQL 文本。', + 'type' => 'string', + 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC', + ], + 'MaxCpuTime' => [ + 'title' => '最大CPU时间', + 'description' => '最大 CPU 时间，单位 ms。', + 'type' => 'number', + 'format' => 'float', + 'example' => '257.967', + ], + 'BlockCacheHit' => [ + 'title' => 'BlockCache命中次数', + 'description' => 'BlockCache 命中次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + 'DecodeTime' => [ + 'title' => '解码等待', + 'description' => '解码等待时间，单位 ms。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'RemotePlans' => [ + 'title' => '远程计划数', + 'description' => '远程计划数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RPCCount' => [ + 'title' => 'RPC次数', + 'description' => 'RPC 次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NetWaitTime' => [ + 'title' => '网络等待', + 'description' => '网络等待时间，单位 ms。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'DiskRead' => [ + 'title' => '物理读', + 'description' => '物理读。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NodeIp' => [ + 'title' => '节点IP', + 'description' => '节点 IP。', + 'type' => 'string', + 'example' => 'i-bp18qljorblo8es*****', + ], + 'ConcurrencyWaitTime' => [ + 'title' => '并发等待', + 'description' => '并发等待时间，单位 ms。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'MemstoreReadRowCount' => [ + 'title' => '读内存行数', + 'description' => '读内存行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '527', + ], + 'DbName' => [ + 'title' => '数据库名', + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'testdb', + ], + 'AppWaitTime' => [ + 'title' => '客户端等待', + 'description' => '客户端等待时间，单位 ms。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'ElapsedTime' => [ + 'title' => '平均响应时间', + 'description' => '平均响应时间，单位 ms。', + 'type' => 'number', + 'format' => 'float', + 'example' => '76.382', + ], + 'MissPlans' => [ + 'title' => '未命中计划次数', + 'description' => '未命中计划次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AffectedRows' => [ + 'title' => '影响行数', + 'description' => '影响行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ScheduleTime' => [ + 'title' => '调度时间', + 'description' => '调度时间，单位 ms。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'Event' => [ + 'title' => '等待事件', + 'description' => '等待事件。', + 'type' => 'string', + 'example' => 'mysql response wait client', + ], + 'TotalWaitTime' => [ + 'title' => '内部等待', + 'description' => '内部等待时间，单位 ms。', + 'type' => 'number', + 'format' => 'float', + 'example' => '10.966', + ], + 'ReturnRows' => [ + 'title' => '返回行数', + 'description' => '返回行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExecuteTime' => [ + 'title' => '内部执行时间', + 'description' => '内部执行时间，单位 ms。', + 'type' => 'number', + 'format' => 'float', + 'example' => '61.044', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'tester', + ], + 'Executions' => [ + 'title' => '执行次数', + 'description' => '执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '89403', + ], + 'GetPlanTime' => [ + 'title' => '硬解析时间', + 'description' => '硬解析时间，单位 ms。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.052', + ], + 'CpuTime' => [ + 'title' => '平均CPU时间', + 'description' => '平均 CPU 时间，单位 ms。', + 'type' => 'number', + 'format' => 'float', + 'example' => '50.13', + ], + 'MaxElapsedTime' => [ + 'title' => '最大响应时间', + 'description' => '最大响应时间，单位 ms。', + 'type' => 'number', + 'format' => 'float', + 'example' => '260.044', + ], + 'SQLType' => [ + 'title' => 'sql类型', + 'description' => 'SQL 类型。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'BlockIndexCacheHit' => [ + 'title' => 'BlockIndexCache命中次数', + 'description' => 'BlockIndexCache 命中次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'RetryCount' => [ + 'title' => '重试次数', + 'description' => '重试次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SQLId' => [ + 'title' => 'SQLID', + 'description' => 'SQLID。', + 'type' => 'string', + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + 'ClientIp' => [ + 'title' => '客户端IP', + 'description' => '客户端 IP。', + 'type' => 'string', + 'example' => '1*2.***.1*3.***', + ], + 'BloomFilterCacheHit' => [ + 'title' => 'BloomFilterCache命中次数', + 'description' => 'BloomFilterCache 命中次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'IOWaitTime' => [ + 'title' => 'IO等待', + 'description' => 'IO 等待时间，单位 ms。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'FailTimes' => [ + 'title' => '失败次数', + 'description' => '失败次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'QueueTime' => [ + 'title' => '队列等待', + 'description' => '队列等待时间，单位 ms。', + 'type' => 'number', + 'format' => 'float', + 'example' => '15.275', + ], + 'RowCacheHit' => [ + 'title' => 'RowCache命中次数', + 'description' => 'RowCache 命中次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'LogicalRead' => [ + 'title' => '逻辑读', + 'description' => 'SQL 在所选时间段内平均逻辑读次数。 '."\n" + .'包含读各个 cache 模块次数、磁盘 IO 次数，为衡量 SQL 过滤性的重要指标。 '."\n" + ."\n" + .'> <br> “逻辑读/返回行数”比例越大，说明过滤性越差。通常是由 SQL 写入内容、表索引创建和 SQL 执行计划不标准等原因引起。', + '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' => '查询 TopSQL 列表', + 'description' => '为优化用户体验，云数据库对 SQL 诊断功能进行了升级，本接口已下线并由新的接口替代，详情请参见 <props="china">[【通知】云数据库诊断管理 API 接口下线](https://help.aliyun.com/document_detail/2352272.html?spm=a2c4g.292641.0.0.8d3622f8LtqWiM)</props><props="intl">[【通知】云数据库诊断管理 API 接口下线](https://www.alibabacloud.com/help/zh/apsaradb-for-oceanbase/latest/notice-cloud-database-diagnosis-management-api-interface-downline)</props>。', + ], + 'DescribeSlowSQLList' => [ + 'summary' => '查询慢 SQL 列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户ID', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't2mr3oae0****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '开始时间', + 'description' => '查询慢 SQL 参数的起始时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-06-13T15:40:43Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '结束时间', + 'description' => '查询慢 SQL 参数的结束时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-09-13T15:40:43Z', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据库名称', + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testdb', + ], + ], + [ + 'name' => 'SearchKeyWord', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询关键字', + 'description' => '查询关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'update', + ], + ], + [ + 'name' => 'SearchParameter', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询参数', + 'description' => '查询参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'cputime', + ], + ], + [ + 'name' => 'SearchRule', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询规则', + 'description' => '查询规则。', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + ], + [ + 'name' => 'SearchValue', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询值', + 'description' => '查询值。', + 'type' => 'string', + 'required' => false, + 'example' => '0.01', + ], + ], + [ + 'name' => 'SQLId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'SQL唯一标识', + 'description' => 'SQLID，SQL 唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + ], + [ + 'name' => 'NodeIp', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点ip', + 'description' => '数据库节点 IP。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp18qljorblo8es*****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '页码', + 'description' => '分页查询时设置的每页行数。'."\n" + .'- 最大值：100。'."\n" + .'- 默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '页大小', + 'description' => '分页查询的页码。'."\n" + .'- 起始值：1。'."\n" + .'- 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FilterCondition', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '过滤条件', + 'description' => '过滤条件。', + 'type' => 'object', + 'required' => false, + 'example' => '[dbName:sys]', + ], + ], + [ + 'name' => 'SortColumn', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序列', + 'description' => '排序列。', + 'type' => 'string', + 'required' => false, + 'example' => 'cputime', + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序顺序', + 'description' => '排序规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数量', + 'description' => '总数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'SlowSQLList' => [ + 'title' => '慢SQL列表信息', + 'description' => '慢 SQL 列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '返回数据序号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExecPerSecond' => [ + 'description' => '每秒次数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '163.0', + ], + 'SQLText' => [ + 'description' => 'SQL 文本。', + 'type' => 'string', + 'example' => 'SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC', + ], + 'MaxCpuTime' => [ + 'description' => '最大 CPU 时间。', + 'type' => 'number', + 'format' => 'float', + 'example' => '257.967', + ], + 'BlockCacheHit' => [ + 'description' => 'BlockCache 命中次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + 'DecodeTime' => [ + 'description' => '解码等待。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'RemotePlans' => [ + 'description' => '远程计划数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RPCCount' => [ + 'description' => 'RPC 次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NetWaitTime' => [ + 'description' => '网络等待。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'DiskRead' => [ + 'description' => '物理读。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NodeIp' => [ + 'description' => '节点 IP。', + 'type' => 'string', + 'example' => 'i-bp18qljorblo8es*****', + ], + 'ConcurrencyWaitTime' => [ + 'description' => '并发等待。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'MemstoreReadRowCount' => [ + 'description' => '读内存行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '527', + ], + 'DbName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'testdb', + ], + 'AppWaitTime' => [ + 'description' => '客户端等待。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'ElapsedTime' => [ + 'description' => '平均响应时间。', + 'type' => 'number', + 'format' => 'float', + 'example' => '76.382', + ], + 'MissPlans' => [ + 'description' => '未命中计划次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AffectedRows' => [ + 'description' => '影响行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ScheduleTime' => [ + 'description' => '调度时间。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'Event' => [ + 'description' => '等待事件。', + 'type' => 'string', + 'example' => 'mysql response wait client', + ], + 'TotalWaitTime' => [ + 'description' => '内部等待。', + 'type' => 'number', + 'format' => 'float', + 'example' => '10.966', + ], + 'ReturnRows' => [ + 'description' => '返回行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExecuteTime' => [ + 'description' => '内部执行时间。', + 'type' => 'number', + 'format' => 'float', + 'example' => '61.044', + ], + 'UserName' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'tester', + ], + 'Executions' => [ + 'description' => '执行次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '89403', + ], + 'GetPlanTime' => [ + 'description' => '硬解析时间。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.052', + ], + 'CpuTime' => [ + 'description' => '平均 CPU 时间。', + 'type' => 'number', + 'format' => 'float', + 'example' => '50.13', + ], + 'MaxElapsedTime' => [ + 'description' => '最大响应时间。', + 'type' => 'number', + 'format' => 'float', + 'example' => '260.044', + ], + 'SQLType' => [ + 'description' => 'SQL 类型。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'BlockIndexCacheHit' => [ + 'description' => 'BlockIndexCache 命中次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'RetryCount' => [ + 'description' => '重试次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SQLId' => [ + 'description' => 'SQLID。', + 'type' => 'string', + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + 'ClientIp' => [ + 'description' => '客户端 IP。', + 'type' => 'string', + 'example' => '1*2.***.1*3.***', + ], + 'BloomFilterCacheHit' => [ + 'description' => 'BloomFilterCache 命中次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'IOWaitTime' => [ + 'description' => 'IO 等待。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'FailTimes' => [ + 'description' => '失败次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'QueueTime' => [ + 'description' => '队列等待。', + 'type' => 'number', + 'format' => 'float', + 'example' => '15.275', + ], + 'RowCacheHit' => [ + 'description' => 'RowCache 命中次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'LogicalRead' => [ + 'description' => '逻辑读。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19', + ], + 'SsstoreReadRowCount' => [ + 'description' => '读磁盘行数。', + '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' => '查询慢 SQL 列表', + 'description' => '为优化用户体验，云数据库对 SQL 诊断功能进行了升级，本接口已下线并由新的接口替代，详情请参见<props="china"> [【通知】云数据库诊断管理 API 接口下线](https://help.aliyun.com/document_detail/2352272.html?spm=a2c4g.292641.0.0.8d3622f8LtqWiM)</props><props="intl"> [【通知】云数据库诊断管理 API 接口下线](https://www.alibabacloud.com/help/zh/apsaradb-for-oceanbase/latest/notice-cloud-database-diagnosis-management-api-interface-downline?spm=a2c63.p38356.0.0.cc7e1ffeUU8HNb)</props>。', + ], + 'DescribeSlowSQLHistoryList' => [ + 'summary' => '根据 SQLID 查询一条 SQL 在时间段内的被判定为 Slow SQL 时的执行历史。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'title' => '租户名', + 'description' => '租户 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't384tolsj****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '开始时间', + 'description' => '查看慢 SQL 历史参数的起始时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-12-14T02:34:49Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '结束时间', + 'description' => '查看慢 SQL 历史参数的结束时间。 '."\n" + .'该时间只支持 UTC 时间，格式为：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' => 'SQLID，SQL 唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8D6E84735C0****1823D199E2CA1****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询的页码。'."\n" + .'- 起始值：1。 '."\n" + .'- 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询时设置的每页行数。'."\n" + .'- 最大值：100。 '."\n" + .'- 默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'SlowSQLHistoryList' => [ + 'title' => '慢SQL历史列表', + 'description' => '慢 SQL 历史列表信息。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '请求的返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'SqlId' => [ + 'description' => 'SQLID。', + 'type' => 'string', + 'example' => '8D6E84****0B8FB1823D199E2CA1****', + ], + 'SqlType' => [ + 'description' => 'SQL 类型。', + 'type' => 'string', + 'example' => '1', + ], + 'TenantName' => [ + 'description' => '租户名称。', + 'type' => 'string', + 'example' => 'pay_online', + ], + 'UserName' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'tester', + ], + 'ClientIp' => [ + 'description' => '客户端 IP。', + 'type' => 'string', + 'example' => '1*2.***.1*3.***', + ], + 'DbName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'testdb', + ], + 'Event' => [ + 'description' => '等待事件。', + 'type' => 'string', + 'example' => 'mysql response wait client', + ], + 'NodeIp' => [ + 'description' => '节点 IP。', + 'type' => 'string', + 'example' => 'i-bp18qljorblo8es*****', + ], + 'AffectedRows' => [ + 'description' => '影响行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'BlockCacheHit' => [ + 'description' => 'BlockCache 命中次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '14', + ], + 'BlockIndexCacheHit' => [ + 'description' => 'BlockIndexCache 命中次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '4', + ], + 'BloomFilterCacheHit' => [ + 'description' => 'BloomFilterCache 命中次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'Executions' => [ + 'description' => '执行次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '89403', + ], + 'FailTimes' => [ + 'description' => '失败次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RPCCount' => [ + 'description' => 'RPC 次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemotePlans' => [ + 'description' => '远程计划数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MissPlans' => [ + 'description' => '未命中计划次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'ReturnRows' => [ + 'description' => '返回行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'LogicalRead' => [ + 'description' => '逻辑读。', + 'type' => 'number', + 'format' => 'double', + 'example' => '19', + ], + 'RetryCount' => [ + 'description' => '重试次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RowCacheHit' => [ + 'description' => 'RowCache 命中次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DiskRead' => [ + 'description' => '物理读。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MemstoreReadRowCount' => [ + 'description' => '读内存行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '527', + ], + 'SsstoreReadRowCount' => [ + 'description' => '读磁盘行数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '43086', + ], + 'ExecPerSecond' => [ + 'description' => '每秒次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '163.0', + ], + 'AppWaitTime' => [ + 'description' => '客户端等待。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'ElapsedTime' => [ + 'description' => '平均响应时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '76.382', + ], + 'ExecuteTime' => [ + 'description' => '内部执行时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '61.044', + ], + 'QueueTime' => [ + 'description' => '队列等待。', + 'type' => 'number', + 'format' => 'double', + 'example' => '15.275', + ], + 'ConcurrencyWaitTime' => [ + 'description' => '并发等待。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'CpuTime' => [ + 'description' => '平均 CPU 时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '50.13', + ], + 'DecodeTime' => [ + 'description' => '解码等待。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'NetWaitTime' => [ + 'description' => '网络等待时间，单位 ms。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'IOWaitTime' => [ + 'description' => 'IO 等待。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'GetPlanTime' => [ + 'description' => '硬解析时间，单位 ms。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.052', + ], + 'MaxElapsedTime' => [ + 'description' => '最大响应时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '260.044', + ], + 'TotalWaitTime' => [ + 'description' => '内部等待。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10.966', + ], + 'ScheduleTime' => [ + 'description' => '调度时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'MaxCpuTime' => [ + 'description' => '最大 CPU 时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '257.967', + ], + 'EndTimeUTCString' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2021-12-28T02:08:18Z', + ], + ], + ], + ], + 'Count' => [ + 'description' => '数量。', + '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' => '查询慢 SQL 历史列表', + 'description' => '为优化用户体验，云数据库对 SQL 诊断功能进行了升级，本接口已下线并由新的接口替代，详情请参见 <props="china">[【通知】云数据库诊断管理 API 接口下线](https://help.aliyun.com/document_detail/2352272.html?spm=a2c4g.292641.0.0.8d3622f8LtqWiM)</props><props="intl">[【通知】云数据库诊断管理 API 接口下线](https://www.alibabacloud.com/help/zh/apsaradb-for-oceanbase/latest/notice-cloud-database-diagnosis-management-api-interface-downline)</props>。', + ], + 'DescribeProxyService' => [ + 'summary' => '查询 OceanBase 代理服务信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id', + 'description' => 'OceanBase 集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ob317v4uif****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求的返回结果', + 'description' => '请求的返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C', + ], + 'Data' => [ + 'description' => '数据列表。', + 'type' => 'object', + 'properties' => [ + 'ProxyClusterId' => [ + 'title' => '代理集群id', + 'description' => '代理集群 ID。', + 'type' => 'string', + 'example' => 'proxy-3t****zrieasg', + ], + 'ProxyMode' => [ + 'title' => '代理模式', + 'description' => '代理模式。', + 'type' => 'string', + 'example' => 'shared', + ], + 'Zone' => [ + 'title' => '可用区', + 'description' => '可用区。', + 'type' => 'string', + 'example' => 'cn-shanghai-e,cn-shanghai-f', + ], + 'UnitSpec' => [ + 'title' => '单元规格', + 'description' => '单元规格。', + 'type' => 'string', + 'example' => '4C8GB', + ], + 'UnitNum' => [ + 'title' => '单元数量', + 'description' => '单元数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'CurrentEndpointNum' => [ + 'title' => '当前地址数', + 'description' => '当前地址数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'EndpointNumQuota' => [ + 'title' => '地址数量配额', + 'description' => '地址数量配额。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-07-05T08:23:10Z', + ], + 'Status' => [ + 'title' => '代理状态', + 'description' => '代理状态。', + 'type' => 'string', + 'example' => 'ONLINE', + 'enum' => [ + 'ONLINE：运行中', + 'CREATING：创建中', + 'DELETING：关闭中', + 'DELETED：已关闭', + ], + ], + 'ProxyServiceVersion' => [ + 'title' => '代理服务版本', + 'description' => '代理服务版本。', + 'type' => 'string', + 'example' => '1.0', + ], + 'ExpireTime' => [ + 'title' => '到期时间', + 'description' => '到期时间。', + 'type' => 'string', + 'example' => '2123-07-05T16:00:00', + ], + 'UnitNumLimit' => [ + 'title' => '单元数量上限', + 'description' => '单元数量上限。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'ProxyVersion' => [ + 'description' => '数据库代理的版本。', + 'type' => 'string', + 'example' => '4.3.1.0-xxxxxxxxx', + ], + 'DeployMode' => [ + 'type' => 'string', + ], + 'ServerNumLimit' => [ + 'title' => '节点数量上限值', + 'description' => '节点数量上限值', + 'type' => 'integer', + 'format' => 'int64', + ], + 'AllowModifyServerNum' => [ + 'title' => 'true：允许修改，且显示当前节点数量'."\n" + .'false：不允许修改，且不显示当前节点数量', + 'description' => 'true：允许修改，且显示当前节点数量'."\n" + .'false：不允许修改，且不显示当前节点数量', + 'type' => 'boolean', + ], + 'SharedUnitNumLimit' => [ + 'title' => 'K8S 共享模式代理服务的单元数量上限', + 'description' => 'K8S 共享模式代理服务的单元数量上限', + 'type' => 'integer', + 'format' => 'int64', + ], + 'ExclusiveUnitNumLimit' => [ + 'title' => 'K8S 独占模式代理服务的单元数量上限', + 'description' => 'K8S 独占模式代理服务的单元数量上限', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + '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' => '查询代理服务信息', + ], + ], + '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', + ], + ], +]; |