'1.0', 'info' => ['style' => 'RPC', 'product' => 'polardbx', 'version' => '2020-02-02'], 'directories' => [ [ 'children' => [ 'DescribeDBInstanceConfig', 'DescribeDBInstanceTopology', 'DescribeDBInstanceViaEndpoint', 'ModifyDBInstanceClass', 'DescribeDBInstanceHA', 'UpdatePolarDBXInstanceNode', 'DescribeTransformStatus', 'DescribePolarxDataNodes', 'ModifyDBInstanceVip', 'DescribeRdsVswitches', 'DescribeShowStorageInfo', 'DescribeStoragePoolInfo', 'CreateStoragePool', 'CreateCustomEndpoint', 'DescribeCustomEndpointList', 'ModifyCustomEndpointNet', 'DeleteCustomEndpoint', 'ModifyCustomEndpoint', 'AllocateColdDataVolume', 'ReleaseColdDataVolume', 'DescribeColdDataBasicInfo', ], 'type' => 'directory', 'title' => '实例管理', 'id' => 329231, ], [ 'children' => ['DescribeSqlAuditInfo', 'EnableSqlAudit', 'DisableSqlAudit', 'CheckSqlAuditSlsStatus'], 'type' => 'directory', 'title' => '监控与日志', 'id' => 329274, ], [ 'children' => ['DescribeScaleOutMigrateTaskList', 'CreateTransformOperation', 'DescribeRplInspectionTask', 'SkipCurrentStep', 'CreateRplInspectionTask'], 'type' => 'directory', 'title' => '任务管理', 'id' => 329172, ], [ 'children' => ['UpdateDBInstanceSSL'], 'type' => 'directory', 'title' => 'SSL加密', 'id' => 329181, ], [ 'children' => ['DescribeBackupSetList', 'DescribeBinaryLogList', 'UpdateBackupPolicy', 'DescribeOpenBackupSet', 'DescribeBackupSet'], 'type' => 'directory', 'title' => '备份管理', 'id' => 329188, ], [ 'children' => ['UpdateDBInstanceTDE', 'EnableRightsSeparation', 'DisableRightsSeparation'], 'type' => 'directory', 'title' => '数据安全', 'id' => 329196, ], [ 'children' => ['CreateSuperAccount', 'DescribeAccountList', 'ResetAccountPasswordRestrict', 'ModifyAccountPrivilege'], 'type' => 'directory', 'title' => '账号管理', 'id' => 329204, ], [ 'children' => ['DescribeEnabledCrossRegions', 'AlignStoragePrimaryAzone'], 'type' => 'directory', 'title' => '地域', 'id' => 329213, ], [ 'children' => ['CreateDB', 'DeleteDB', 'DescribeCharacterSet', 'DescribeDbList', 'DescribeDistributeTableList', 'ModifyDatabaseDescription', 'StartSwitchDatabase', 'DescribeComponentPropeties', 'ModifyEngineMigration', 'DescribeArchiveTableList'], 'type' => 'directory', 'title' => '数据库管理', 'id' => 329220, ], [ 'children' => ['UpgradeCDCVersion', 'DescribeCdcInfo', 'DescribeCdcVersionList', 'DescribeCdcClassList', 'ModifyCdcClass'], 'type' => 'directory', 'title' => 'CDC管理', 'id' => 329300, ], [ 'children' => ['AttachColumnarInstance', 'UpgradeColumnarVersion', 'ModifyColumnarClass', 'DescribeColumnarVersionList', 'DescribeColumnarInfo', 'DescribeColumnarClassList'], 'type' => 'directory', 'title' => '列存管理', 'id' => 329308, ], [ 'children' => ['DescribeEvaluateAndImportTask', 'DescribeEvaluateAndImportTasks', 'DeleteEvaluateAndImportTask', 'CreateSQLEvaluateTask', 'CreateStructureImportTask', 'DescribeDataImportTaskInfo', 'CloseEngineMigration', 'ConfirmNoConnection', 'RestartDataImportTask', 'StopDataImportTask', 'CreateDataImportTask', 'DescribeStructureImportTaskInfo', 'RefreshImportMeta'], 'type' => 'directory', 'title' => '数据迁移与同步', 'id' => 329286, ], [ 'children' => ['DeleteGdnInstance', 'DescribeGdnInstances', 'SwitchGdnMemberRole', 'CreateGdnInstance'], 'type' => 'directory', 'title' => 'GDN管理', 'id' => 329315, ], [ 'children' => ['SubmitSqlFlashbackTask', 'PreCheckSqlFlashbackTask', 'DescribeSqlFlashbackTaskList'], 'type' => 'directory', 'title' => 'SQL闪回', 'id' => 329320, ], [ 'children' => [ 'AllocateInstancePublicConnection', 'AllocateMem0PublicConnection', 'CancelActiveOperationTasks', 'ChangeResourceGroup', 'CheckCloudResourceAuthorized', 'CheckHealth', 'CreateAccount', 'CreateBackup', 'CreateDBInstance', 'CreateGatewayConsumerForPolarDBX', 'CreateGdnStandbyMember', 'CreateMem0', 'CreatePolardbxSupabaseInstance', 'CreateSubCNInstance', 'CreateSupabaseNetType', 'DeleteAccount', 'DeleteDBInstance', 'DeleteMem0', 'DeletePolardbxSupabaseInstance', 'DeleteSubCNInstance', 'DeleteSupabaseNetType', 'DescribeActiveOperationMaintainConf', 'DescribeActiveOperationTaskCount', 'DescribeActiveOperationTasks', 'DescribeAvailableCrossRegions', 'DescribeBackupPolicy', 'DescribeDBInstanceAttribute', 'DescribeDBInstanceEndpoint', 'DescribeDBInstanceSSL', 'DescribeDBInstanceTDE', 'DescribeDBInstances', 'DescribeDBNodePerformance', 'DescribeEvents', 'DescribeMem0Info', 'DescribeMem0SecurityIps', 'DescribeParameterGroups', 'DescribeParameterTemplates', 'DescribeParameters', 'DescribeRdsVpcs', 'DescribeRegions', 'DescribeSecurityIps', 'DescribeSlowLogRecords', 'DescribeSupabaseApiKey', 'DescribeSupabaseInstanceAttribute', 'DescribeSupabaseInstances', 'DescribeSupabaseIpWhitelist', 'DescribeTags', 'DescribeTasks', 'DescribeUserEncryptionKeyList', 'ListTagResources', 'MigrateDBInstance', 'ModifyAccountDescription', 'ModifyActiveOperationMaintainConf', 'ModifyActiveOperationTasks', 'ModifyDBInstanceConfig', 'ModifyDBInstanceConnectionString', 'ModifyDBInstanceDescription', 'ModifyDBInstanceMaintainTime', 'ModifyMem0SecurityIps', 'ModifyParameter', 'ModifySecurityIps', 'ModifySupabaseDashboardPassword', 'ModifySupabaseSecurityIPList', 'ReleaseInstancePublicConnection', 'ReleaseMem0PublicConnection', 'ResetAccountPassword', 'ResetMem0AccountPassword', 'RestartDBInstance', 'RestartSupabaseInstance', 'RestoreDBInstance', 'SwitchDBInstanceHA', 'TagResources', 'UntagResources', 'UpdateCustinsParam', 'UpgradeDBInstanceKernelVersion', ], 'title' => '其他', 'type' => 'directory', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'AlignStoragePrimaryAzone' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '132459', 'abilityTreeNodes' => ['FEATUREdrds7CT80F'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => ''], ], [ 'name' => 'StorageInstanceName', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => ''], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => ''], ], [ 'name' => 'SwitchTimeMode', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['type' => 'string', 'description' => ''], 'RequestId' => ['type' => 'string', 'description' => ''], 'Success' => ['type' => 'boolean', 'description' => ''], ], 'description' => '', ], ], ], 'changeSet' => [ ['createdAt' => '2022-05-11T12:44:50.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AlignStoragePrimaryAzone'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'AllocateColdDataVolume' => [ 'summary' => '调用AllocateColdDataVolume接口', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '137133', 'abilityTreeNodes' => ['FEATUREdrdsONAWER'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzravgpt8q****'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D6A4256F-7B83-5BD7-9AC0-72E1FAC05330'], ], 'description' => '', ], ], ], 'title' => 'AllocateColdDataVolume', 'changeSet' => [ ['createdAt' => '2022-07-28T08:28:31.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AllocateColdDataVolume'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6A4256F-7B83-5BD7-9AC0-72E1FAC05330\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D6A4256F-7B83-5BD7-9AC0-72E1FAC05330\\n","errorExample":""}]', ], 'AllocateInstancePublicConnection' => [ 'summary' => '调用AllocateInstancePublicConnection接口创建公网IP。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-**************'], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => ['description' => '公网地址前缀。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-**************'], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => ['description' => '公网地址端口。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3306'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'InstanceClusterName', 'in' => 'query', 'schema' => ['title' => '实例CN集群名称，例如default', 'type' => 'string', 'example' => 'default'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], ], 'description' => '', ], ], ], 'title' => '申请外网连接地址', 'changeSet' => [ ['createdAt' => '2024-01-04T11:29:46.000Z', 'description' => '错误码发生变更'], ['createdAt' => '2024-01-04T11:29:46.000Z', 'description' => '错误码发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AllocateInstancePublicConnection'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'polardbx:AllocateInstancePublicConnection', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n","errorExample":""}]', ], 'AllocateMem0PublicConnection' => [ 'summary' => '为 Mem0 实例开通公网域名', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-spsil01pww4hfz'], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => ['title' => '公网连接串前缀', 'description' => '公网连接串前缀', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-**************'], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => ['title' => '端口', 'description' => '端口', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3306'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => 'A501A191-BD70-5E50-98A9-C2A486A82****'], 'AccessDeniedDetail' => [ 'description' => '访问被拒绝的详细原因。', 'type' => 'object', 'properties' => [ 'AuthAction' => ['description' => '说明如上。', 'type' => 'string', 'example' => 'xxx'], 'AuthPrincipalType' => ['description' => '说明如上。', 'type' => 'string', 'example' => '222'], 'AuthPrincipalOwnerId' => ['description' => '说明如上。', 'type' => 'string', 'example' => '111'], 'AuthPrincipalDisplayName' => ['description' => '请求中用于鉴权的身份标识。', 'type' => 'string', 'example' => 'xxx'], 'PolicyType' => ['description' => 'PolicyType', 'type' => 'string', 'example' => 'PRIORITY'], 'NoPermissionType' => ['description' => 'NoPermissionType', 'type' => 'string', 'example' => 'ImplicitDeny'], 'EncodedDiagnosticMessage' => ['description' => '编码诊断信息。', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], ], ], ], 'description' => '', ], ], ], 'title' => '开通记忆引擎公网地址', 'description' => '该接口用于在回滚任务前，确认无任何活跃连接以保障操作安全。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A501A191-BD70-5E50-98A9-C2A486A82****\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\"\\n }\\n}","type":"json"}]', ], 'AttachColumnarInstance' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-xxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBInstanceName' => ['description' => '创建的实例名称。', 'type' => 'string', 'example' => 'pxc-xxx'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], 'TaskId' => ['description' => '后端任务ID。', 'type' => 'string', 'example' => '422922413'], ], 'description' => '', ], ], ], 'title' => '挂载列存', 'summary' => '该接口用于将一个列存实例（Columnar Instance）挂载到指定的主数据库实例上。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachColumnarInstance'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceName\\": \\"pxc-xxx\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"TaskId\\": \\"422922413\\"\\n}","type":"json"}]', ], 'CancelActiveOperationTasks' => [ 'summary' => '调用CancelActiveOperationTasks接口取消运维事件任务。', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '102580', 'abilityTreeNodes' => ['FEATUREdrdsZVW4NQ'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'Ids', 'in' => 'query', 'schema' => ['description' => '事件ID集合，以英文逗号隔开。', 'type' => 'string', 'required' => true, 'example' => '111'], ], ], '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' => 'AE4F6C34-065F-45AA-B5DC-4B8D816F6305'], 'Ids' => ['description' => '事件ID集合， 以英文逗号隔开。', 'type' => 'string', 'example' => '111,1223'], ], ], ], ], 'title' => '取消运维事件任务', 'changeSet' => [ ['createdAt' => '2021-11-17T06:21:51.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelActiveOperationTasks'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AE4F6C34-065F-45AA-B5DC-4B8D816F6305\\",\\n \\"Ids\\": \\"111,1223\\"\\n}","errorExample":""},{"type":"xml","example":"\\n AE4F6C34-065F-45AA-B5DC-4B8D816F6305\\n 111,1223\\n","errorExample":""}]', ], 'ChangeResourceGroup' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '116109', 'abilityTreeNodes' => ['FEATUREdrdsJGJ3OD'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '地域', 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['title' => '资源类型', 'description' => '资源类型，目前仅支持PolarDB-X 2.0实例一种类型的资源。', 'type' => 'string', 'required' => true, 'example' => 'polardbxinstance'], ], [ 'name' => 'ResourceId', 'in' => 'query', 'schema' => ['title' => '资源ID', 'description' => '资源ID。', 'type' => 'string', 'required' => true, 'example' => 'pxc-szrwrbp693****', 'maxItems' => 51], ], [ 'name' => 'NewResourceGroupId', 'in' => 'query', 'schema' => ['title' => '新资源组ID', 'description' => '新资源组ID。', 'type' => 'string', 'required' => true, 'example' => 'rg-acfmwolx3j4****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34'], ], 'description' => '', ], ], ], 'title' => '修改实例资源组', 'summary' => '修改实例资源组。', 'description' => '注意： '."\n" .'- **endpoint**和其他接口有区别，国内和新加坡需使用**polardbx.aliyuncs.com**， 其他地域使用**polardbx.{region id}.aliyunc.com**。'."\n" .'- 调试此API接口的时候，如果报服务不可用的错，请确认下**endpoint**是否正确，可通过切换**服务地址**到**迪拜**或者**印度**，将**endpoint**切换到**polardbx.aliyuncs.com**。', 'changeSet' => [ ['createdAt' => '2021-12-28T11:48:03.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34\\n","errorExample":""}]', ], 'CheckCloudResourceAuthorized' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86218', 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域的ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********'], ], [ 'name' => 'RoleArn', 'in' => 'query', 'schema' => ['description' => '指定已授权角色的全局资源描述符ARN（Alibaba Cloud Resource Name）信息，完成该角色的授权后即可使用相关密钥管理服务，格式：acs:ram::$accountID:role/$roleName 。'."\n" ."\n" .'- $accountID：云账号ID。您可以登录阿里云控制台，将鼠标悬停在右上角头像的位置，单击安全设置进行查看。'."\n" .'- $roleName：RAM角色名称，取值固定为：AliyunRdsInstanceEncryptionDefaultRole。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。'."\n" ."\n", 'type' => 'string', 'example' => 'A501A191-BD70-5E50-98A9-C2A486A82****'], 'Data' => [ 'description' => '返回体。', 'type' => 'object', 'properties' => [ 'AuthorizationState' => ['description' => '授权状态，包括如下返回值：'."\n" ."\n" .'- **0**：未授权；'."\n" .'- **1**：已授权；'."\n" .'- **2**：未开通密钥管理服务。', 'type' => 'string', 'example' => '0'], 'RoleArn' => ['description' => '指定已授权角色的全局资源描述符ARN（Alibaba Cloud Resource Name）信息，完成该角色的授权后即可使用相关密钥管理服务，格式：acs:ram::$accountID:role/$roleName 。', 'type' => 'string', 'example' => 'acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole'], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'The current engine version does not support the operation.', 'description' => '当前引擎版本不支持操作。'], ], ], 'title' => 'KMS秘钥授权校验', 'summary' => '调用CheckCloudResourceAuthorized接口查询PolarDB-X实例是否已被授权使用KMS密钥服务。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckCloudResourceAuthorized'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A501A191-BD70-5E50-98A9-C2A486A82****\\",\\n \\"Data\\": {\\n \\"AuthorizationState\\": \\"0\\",\\n \\"RoleArn\\": \\"acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A501A191-BD70-5E50-98A9-C2A486A82****\\n \\n 0\\n acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole\\n \\n","errorExample":""}]', ], 'CheckHealth' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86219', 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Status' => ['description' => '组件是否健康。返回值UP代表健康，其他值或为空则代表异常。', 'type' => 'string', 'example' => 'UP'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9'], ], 'description' => '', ], ], ], 'title' => 'CheckHealth', 'summary' => '进行服务健康度检测。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"UP\\",\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\"\\n}","errorExample":""},{"type":"xml","example":"\\n UP\\n 173CA69A-3513-591D-8A09-C1EA37CBE2D9\\n","errorExample":""}]', ], 'CheckSqlAuditSlsStatus' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86221', 'abilityTreeNodes' => ['FEATUREdrdsB0CUNV'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。>您可以调用[describeregions](~~196841~~)接口查看polardb-x支持的地域详情，包括地域id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'sql审计功能开启状态，取值范围如下：*enabled：已开启*disabled：未开启', 'type' => 'string', 'example' => 'enabled'], 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9'], ], 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => '数据库实例不存在'], ], ], 'title' => '校验审计状态', 'summary' => '该接口用于检查指定数据库实例的 SQL 审计日志是否已成功接入 SLS（阿里云日志服务，Log Service）。'."\n" .'调用后，系统返回当前实例的 SQL 审计功能与 SLS 的连接状态、项目（Project）和日志库（Logstore）配置信息、同步是否正常等。', 'description' => '> * PolarDB-X 2.0 SQL审计与分析功能本身免费使用，但日志服务会对存储空间、读取流量、请求数量、数据加工、数据投递等进行收费，更多关于SQL审计功能的详情，请参见[开启SQL审计与分析](~~184619~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckSqlAuditSlsStatus'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"enabled\\",\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\"\\n}","type":"json"}]', ], 'CloseEngineMigration' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '201206', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名。', 'type' => 'string', 'required' => true, 'example' => 'pxc-htri0****r4k9p'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ContinueEnableBinlog', 'in' => 'query', 'schema' => ['description' => '是否继续打开Binlog，取值范围如下： '."\n" .'* **true**：继续打开Binlog'."\n" .'* **false**：关闭Binlog'."\n" ."\n" .'默认取值为**true**。 '."\n" ."\n" .'> 关闭Binlog将会重启您的PolarDB集群。'."\n", 'type' => 'string', '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 of the request', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], 'Code' => ['description' => '接口返回Code', 'type' => 'string', 'example' => '200'], 'Message' => ['description' => '成功为空，失败返回错误信息。', 'type' => 'string', 'example' => '*****'], 'HttpStatusCode' => ['description' => '请求状态码', 'type' => 'string', 'example' => '200'], 'SuccessResponse' => [ 'description' => '请求是否成功。'."\n" ."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'true', ], 'Data' => [ 'description' => '新的地址链接串信息', 'type' => 'object', 'properties' => [ 'DBInstanceName' => ['description' => '实例Id', 'type' => 'string', 'example' => 'pxc-hzjasd****'], 'TaskId' => ['description' => '后端任务ID。', 'type' => 'string', 'example' => '2209883'], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => '该请求使用与先前相同但不相同的请求相同的客户端令牌。 除非请求相同，否则请勿将客户端令牌与其他请求重用。'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '关闭引擎迁移', 'summary' => '此接口用于关闭指定实例的数据库引擎迁移流程。当用户启动从其他数据库（如自建 MySQL、RDS 等）向 PolarDB-X 的数据迁移任务后，若需中途终止或清理迁移状态，可通过此接口安全停止迁移过程。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloseEngineMigration'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"*****\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"SuccessResponse\\": \\"true\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-hzjasd****\\",\\n \\"TaskId\\": \\"2209883\\"\\n }\\n}","type":"json"}]', ], 'ConfirmNoConnection' => [ 'summary' => '回滚切换时确认无连接。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '201845', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pxc-hzravgpt8q****'], ], [ 'name' => 'SlinkTaskId', 'in' => 'query', 'schema' => ['description' => '短链任务的唯一标识 ID，用于定位需要回滚的任务', 'type' => 'string', 'required' => true, 'example' => 'etx-szr2rr6i*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '接口额外返回信息，成功返回success，错误返回对应错误码。', 'type' => 'string', 'example' => 'Success'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6BA32080EEA'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'SlinkTaskId' => ['description' => '原始任务 ID，用于响应与请求匹配。', 'type' => 'string', 'example' => 'etx-szr2rr6i*****'], ], ], ], 'description' => '', ], ], ], 'title' => '回滚切换时确认无连接', 'description' => '该接口用于在回滚任务前，确认无任何活跃连接以保障操作安全。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConfirmNoConnection'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"6BA32080EEA\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', ], 'CreateAccount' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-**************'], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => '待创建的账号名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testAccount'], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => ['description' => '待创建账号的账号密码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test@1111'], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['description' => '授权数据库名。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testdb'], ], [ 'name' => 'AccountPrivilege', 'in' => 'query', 'schema' => ['description' => '给新创建的账号授权某数据库的权限，包括：'."\n" ."\n" .'- ReadWrite'."\n" .'- ReadOnly'."\n" .'- DMLOnly'."\n" .'- DDLOnly', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ReadWrite'], ], [ 'name' => 'AccountDescription', 'in' => 'query', 'schema' => ['description' => '账号描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ 'name' => 'SecurityAccountName', 'in' => 'query', 'schema' => ['description' => '安全管理员账号名称。'."\n" ."\n" .'> 若已开启三权分立模式，该参数必填，未开启三权分立可以不填。', 'type' => 'string', 'required' => false, 'example' => 'securityAccount'], ], [ 'name' => 'SecurityAccountPassword', 'in' => 'query', 'schema' => ['description' => '安全管理员账号密码。'."\n" ."\n" .'> 若已开启三权分立模式，该参数必填，未开启三权分立可以不填。', 'type' => 'string', 'required' => false, 'example' => 'securityPassword'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '成功为空，失败为报错信息。', 'type' => 'string', 'example' => '****'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => '创建普通账号', 'summary' => '调用CreateAccount接口创建账号。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccount'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n ****\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n","errorExample":""}]', ], 'CreateBackup' => [ 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86225', 'abilityTreeNodes' => ['FEATUREdrdsE1M93A'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-**************'], ], [ 'name' => 'BackupType', 'in' => 'query', 'schema' => ['description' => '备份种类，目前只支持“0”，表示快速备份。', 'type' => 'string', 'required' => false, 'example' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '成功为空，失败为报错信息。', 'type' => 'string', 'example' => '*****'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'BackupSetId' => ['type' => 'string', 'description' => ''], ], ], ], 'description' => '', ], ], ], 'title' => '创建备份', 'summary' => '调用CreateBackup接口创建备份。', 'changeSet' => [ ['createdAt' => '2024-06-19T01:48:19.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2024-06-19T01:48:19.000Z', 'description' => '响应参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBackup'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"BackupSetId\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n *****\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n \\n 627833\\n \\n","errorExample":""}]', ], 'CreateCustomEndpoint' => [ 'summary' => '该接口，用于为数据库实例创建自定义的连接地址（Endpoint）。', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '236560', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例Id', 'type' => 'string', 'required' => true, 'example' => 'pxc-hzjasd****'], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => '访问控制实例名称。名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、下划线（_）和短划线（-）。', 'type' => 'string', 'required' => true, 'example' => 'ext-win-live-17'], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => '访问端点所在的专有网络ID。', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp1ndoug37dtwoedlmru0'], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'required' => true, 'example' => 'vsw-*********'], ], [ 'name' => 'NodeIds', 'in' => 'query', 'schema' => ['description' => 'RemindUnit（对象类型）为NODE（任务节点）时，监控的任务节点ID。多个ID之间使用英文逗号（,）分隔，一个规则最多监控50个节点。', 'type' => 'string', 'required' => true, 'example' => 'r-bp1l5kfgw8****c3iv'], ], [ 'name' => 'NodeAutoEnter', 'in' => 'query', 'schema' => ['description' => '节点在被添加或恢复后，是否自动加入集群并开始提供服务', 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], [ 'name' => 'NodeRole', 'in' => 'query', 'schema' => ['description' => '若希望查询云原生版读写分离架构实例中只读节点的指标，您在传入具体**NodeId**的同时，还需要在本参数传入**READONLY**。'."\n" .'> 其余情况请无需传入（或传入**MASTER**）。', 'type' => 'string', 'required' => false, 'example' => 'READONLY'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], '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' => '2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9'], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'CustomEndpointId' => ['description' => '终端ID', 'type' => 'string', 'example' => 'pxe-c4gkgqg****7sgyg'], 'DBInstanceName' => ['description' => '实例Id', 'type' => 'string', 'example' => 'pxc-*********'], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'CustomEndpoint.ExceedLimit', 'errorMessage' => 'the count of custom endpoints can not exceed limiting value.', 'description' => '自定义连接的数量超过限制'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => '创建自定义终端', 'description' => '更多关于实例账号的信息，请参见[账号管理](https://help.aliyun.com/document_detail/172163.html)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomEndpoint'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9\\",\\n \\"Data\\": {\\n \\"CustomEndpointId\\": \\"pxe-c4gkgqg****7sgyg\\",\\n \\"DBInstanceName\\": \\"pxc-*********\\"\\n }\\n}","type":"json"}]', ], 'CreateDB' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-**************'], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => '创建的数据库授权的指定账号名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testaccount'], ], [ 'name' => 'Charset', 'in' => 'query', 'schema' => ['description' => '字符集，支持如下字符集：'."\n" ."\n" .'- **utf8**'."\n" .'- **gbk**'."\n" .'- **latin1**'."\n" .'- **utf8mb4**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'utf8mb4'], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => ['description' => '创建的数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testdb'], ], [ 'name' => 'AccountPrivilege', 'in' => 'query', 'schema' => ['description' => '给新创建的账号授权某数据库的权限，包括：'."\n" ."\n" .'- **ReadWrite**'."\n" .'- **ReadOnly**'."\n" .'- **DMLOnly**'."\n" .'- **DDLOnly**', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ReadWrite'], ], [ 'name' => 'DbDescription', 'in' => 'query', 'schema' => ['description' => '数据库描述信息。', 'type' => 'string', 'required' => false, 'example' => 'db for test'], ], [ 'name' => 'SecurityAccountName', 'in' => 'query', 'schema' => ['description' => '安全管理员账号名称。'."\n" ."\n" .'> 若已开启三权分立模式，该参数必填，未开启三权分立可以不填。', 'type' => 'string', 'required' => false, 'example' => 'securityAccount'], ], [ 'name' => 'SecurityAccountPassword', 'in' => 'query', 'schema' => ['description' => '安全管理员账号密码。'."\n" ."\n" .'> 若已开启三权分立模式，该参数必填，未开启三权分立可以不填。', 'type' => 'string', 'required' => false, 'example' => 'securityPassword'], ], [ 'name' => 'Mode', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'title' => 'drds/auto 用来区分所建库为自动拆分模式，还是手动拆分模式', 'description' => '创建数据库时选择的模式，取值如下：'."\n" ."\n" .'- **auto**：该模式的数据库支持自动分区，即创建表时无需指定分区键；'."\n" .'- **drds**：该模式的数据库不支持自动分区，创建表时需使用专用的分库分表语法，指定分库分表键。', 'type' => 'string', 'required' => false, 'example' => 'auto', 'enum' => ['drds', 'auto'], ], ], [ 'name' => 'StoragePoolName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '成功为空，失败返回错误信息。', 'type' => 'string', 'example' => '*****'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => '创建数据库', 'summary' => '调用CreateDB接口创建数据库。', 'changeSet' => [ ['createdAt' => '2023-12-21T09:07:21.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2021-11-17T02:57:12.000Z', 'description' => '请求参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDB'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n *****\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n","errorExample":""}]', ], 'CreateDBInstance' => [ 'summary' => '调用CreateDBInstance接口创建PolarDB-X实例。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '86227', 'abilityTreeNodes' => ['FEATUREdrdsIT76F2'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => ['description' => '实例付费类型。'."\n" ."\n" .'- **PREPAY**：包年包月'."\n" .'- **POSTPAY**：按量付费', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PREPAY'], ], [ 'name' => 'DBNodeCount', 'in' => 'query', 'schema' => ['description' => '实例节点数量:'."\n" .'* 标准版：1'."\n" .'* 企业版：>=2', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '99', 'minimum' => '0', 'example' => '3'], ], [ 'name' => 'DBNodeClass', 'in' => 'query', 'schema' => ['description' => '创建标准时需要传, 企业版无需传。'."\n" ."\n" .'标准版本地盘规格：'."\n" .'- **mysql.n8.small.25**: 1核 8 GB（通用）'."\n" .'- **mysql.n2.medium.25**: 2核 4 GB（通用）'."\n" .'- **mysql.n4.medium.25**: 2核 8 GB（通用）'."\n" .'- **mysql.n8.medium.25**: 2核 16 GB（通用）'."\n" .'- **mysql.n2.large.25**: 4核 8 GB（通用）'."\n" .'- **mysql.n4.large.25**: 4核 16 GB（通用）'."\n" .'- **mysql.n8.large.25**: 4核 32 GB（通用）'."\n" .'- **mysql.n2.xlarge.25**: 8核 16 GB（通用）'."\n" .'- **mysql.n4.xlarge.25**: 8核 32 GB（通用）'."\n" .'- **mysql.n8.xlarge.25**: 8核 64 GB（通用）'."\n" .'- **mysql.n2.2xlarge.25**: 16核 32 GB（通用）'."\n" .'- **mysql.n4.2xlarge.25**: 16核 64 GB（通用）'."\n" .'- **mysql.n8.2xlarge.25**: 16核 128 GB（通用）'."\n" .'- **mysql.x2.medium.25**: 2核 4 GB（独享）'."\n" .'- **mysql.x4.medium.25**: 2核 8 GB（独享）'."\n" .'- **mysql.x8.medium.25**: 2核 16 GB（独享）'."\n" .'- **mysql.x2.large.25**: 4核 8 GB（独享）'."\n" .'- **mysql.x4.large.25**: 4核 16 GB（独享）'."\n" .'- **mysql.x8.large.25**: 4核 32 GB（独享）'."\n" .'- **mysql.x2.xlarge.25**: 8核 16 GB（独享）'."\n" .'- **mysql.x4.xlarge.25**: 8核 32 GB（独享）'."\n" .'- **mysql.x8.xlarge.25**: 8核 64 GB（独享）'."\n" .'- **mysql.x2.2xlarge.25**: 16核 32 GB（独享）'."\n" .'- **mysql.x4.2xlarge.25**: 16核 64 GB（独享）'."\n" .'- **mysql.x8.2xlarge.25**: 16核 128 GB（独享）'."\n" .'- **mysql.x4.4xlarge.25**: 32核 128 GB（独享）'."\n" .'- **mysql.x8.4xlarge.25**: 32核 256 GB（独享）'."\n" .'- **mysql.x4.8xlarge.25**: 64核 256 GB（独享）'."\n" .'- **mysql.x8.8xlarge.25**: 64核 512 GB（独享）'."\n" .'- **mysql.st.12xlarge.25**: 90核 720 GB（独享）'."\n" ."\n" .'标准版云盘规格：'."\n" .'- **polarx.mysql.n2.medium.c25**: 2核4G(通用)'."\n" .'- **polarx.mysql.n4.medium.c25**: 2核8G(通用)'."\n" .'- **polarx.mysql.n8.medium.c25**: 2核16G(通用)'."\n" .'- **polarx.mysql.n2.large.c25**: 4核8G(通用)'."\n" .'- **polarx.mysql.n4.large.c25**: 4核16G(通用)'."\n" .'- **polarx.mysql.n8.large.c25**: 4核32G(通用)'."\n" .'- **polarx.mysql.n2.xlarge.c25**: 8核16G(通用)'."\n" .'- **polarx.mysql.n4.xlarge.c25**: 8核32G(通用)'."\n" .'- **polarx.mysql.n8.xlarge.c25**: 8核64G(通用)'."\n" .'- **polarx.mysql.x2.medium.c25**: 2核4G(独享)'."\n" .'- **polarx.mysql.x4.medium.c25**: 2核8G(独享)'."\n" .'- **polarx.mysql.x8.medium.c25**: 2核16G(独享)'."\n" .'- **polarx.mysql.x2.large.c25**: 4核8G(独享)'."\n" .'- **polarx.mysql.x4.large.c25**: 4核16G(独享)'."\n" .'- **polarx.mysql.x8.large.c25**: 4核32G(独享)'."\n" .'- **polarx.mysql.x2.xlarge.c25**: 8核16G(独享)'."\n" .'- **polarx.mysql.x4.xlarge.c25**: 8核32G(独享)'."\n" .'- **polarx.mysql.x8.xlarge.c25**: 8核64G(独享)'."\n" .'- **polarx.mysql.x2.2xlarge.c25**: 16核32G(独享)'."\n" .'- **polarx.mysql.x4.2xlarge.c25**: 16核64G(独享)'."\n" .'- **polarx.mysql.x8.2xlarge.c25**: 16核128G(独享)'."\n" .'- **polarx.mysql.x2.4xlarge.c25**: 32核64G(独享)'."\n" .'- **polarx.mysql.x4.4xlarge.c25**: 32核128G(独享)'."\n" .'- **polarx.mysql.x8.4xlarge.c25**: 32核256G(独享)'."\n" .'- **polarx.mysql.x2.8xlarge.c25**: 64核128G(独享)'."\n" .'- **polarx.mysql.x4.8xlarge.c25**: 64核256G(独享)'."\n" .'- **polarx.mysql.x8.8xlarge.c25**: 64核512G(独享)', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'polarx.x4.2xlarge.2d'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => '幂等请求串，保持每次创建不同即可。', 'type' => 'string', 'required' => false, 'example' => 'xxxxxx-xxx'], ], [ 'name' => 'NetworkType', 'in' => 'query', 'schema' => ['description' => '网络类型，仅支持VPC网络。', 'type' => 'string', 'required' => false, 'example' => 'vpc'], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => ['description' => 'VPC ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-*****'], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-*********'], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => ['description' => '预付费时，可以选择买几个月或者几年。'."\n" ."\n" .'> Period设置为Year时，该参数支持的取值为1、2、3。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['description' => '收费周期，包年包月只能选Year、Month， 按量付费默认选择Hour。', 'type' => 'string', 'required' => false, 'example' => 'Month'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => '可以为空，资源组ID，暂时不支持。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => ['description' => '是否自动续费，默认为true。'."\n" ."\n" .'- **true**：是'."\n" .'- **false**：否', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => ['description' => 'mysql引擎版本，5.7或者8.0。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5.7'], ], [ 'name' => 'IsReadDBInstance', 'in' => 'query', 'schema' => ['description' => '是否为只读实例。'."\n" ."\n" .'- **true**：是'."\n" .'- **false**：否', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'PrimaryDBInstanceName', 'in' => 'query', 'schema' => ['description' => '如果为只读实例，需要指定主实例。', 'type' => 'string', 'required' => false, 'example' => 'pxc-*********'], ], [ 'name' => 'TopologyType', 'in' => 'query', 'schema' => ['description' => '拓扑类型：'."\n" ."\n" .'- **3azones**：三可用区；'."\n" .'- **1azone**：单可用区。', 'type' => 'string', 'required' => true, 'example' => '3azones'], ], [ 'name' => 'PrimaryZone', 'in' => 'query', 'schema' => ['description' => '主可用区。', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen-e'], ], [ 'name' => 'SecondaryZone', 'in' => 'query', 'schema' => ['description' => '次可用区。', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen-a'], ], [ 'name' => 'TertiaryZone', 'in' => 'query', 'schema' => ['description' => '第三可用区。', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen-e'], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => '实例可用区。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-a'], ], [ 'name' => 'CnClass', 'in' => 'query', 'schema' => ['description' => '计算节点规格，创建企业版需要传，创建标准版无需传。'."\n" ."\n" .'企业版本地盘：'."\n" ."\n" .'- **polarx.x4.medium.2e**: 2核 8 GB（通用）'."\n" .'- **polarx.x4.large.2e**: 4核 16 GB（通用）'."\n" .'- **polarx.x4.xlarge.2e**: 8核 32 GB（通用）'."\n" .'- **polarx.x4.2xlarge.2e**: 16核 64 GB（通用）'."\n" .'- **polarx.x8.large.2e**: 4核 32 GB（独享）'."\n" .'- **polarx.x2.large.2x**: 8核 16 GB（独享）'."\n" .'- **polarx.x4.xlarge.2x**: 8核 32 GB（独享）'."\n" .'- **polarx.x8.xlarge.2e**: 8核 64 GB（独享）'."\n" .'- **polarx.x8.2xlarge.2e**: 16核 128 GB（独享）'."\n" .'- **polarx.x4.4xlarge.2e**: 32核 128 GB（独享）'."\n" .'- **polarx.x8.4xlarge.2e**: 32核 256 GB（独享）'."\n" .'- **polarx.st.8xlarge.2e**: 60核 470 GB（独享）'."\n" .'- **polarx.st.12xlarge.2e**: 90核 720 GB（独享）'."\n" ."\n\n" .'企业版云盘：'."\n" .'- **polarx.x4.medium.c2e**: 2核 8 GB（通用）'."\n" .'- **polarx.x4.large.c2e**: 4核 16 GB（通用）'."\n" .'- **polarx.x4.xlarge.c2e**: 8核 32 GB（通用）'."\n" .'- **polarx.x4.2xlarge.c2e**: 16核 64 GB（通用）'."\n" .'- **polarx.x8.large.c2e**: 4核 32 GB（独享）'."\n" .'- **polarx.x2.large.c2x**: 8核 16 GB（独享）'."\n" .'- **polarx.x4.xlarge.c2x**: 8核 32 GB（独享）'."\n" .'- **polarx.x8.xlarge.c2e**: 8核 64 GB（独享）'."\n" .'- **polarx.x8.2xlarge.c2e**: 16核 128 GB（独享）'."\n" .'- **polarx.x4.4xlarge.c2e**: 32核 128 GB（独享）'."\n" .'- **polarx.x8.4xlarge.c2e**: 32核 256 GB（独享）'."\n" .'- **polarx.st.8xlarge.c2e**: 60核 470 GB（独享）'."\n" .'- **polarx.st.12xlarge.c2e**: 90核 720 GB（独享）', 'type' => 'string', 'required' => false, 'example' => 'polarx.x4.medium.2e'], ], [ 'name' => 'DnClass', 'in' => 'query', 'schema' => ['description' => '存储节点规格，创建企业版需要传，创建标准版无需传。'."\n" ."\n" .'企业版本地盘：'."\n" ."\n" .'- **mysql.n2.medium.25**: 2核 4 GB（通用）'."\n" .'- **mysql.n4.medium.25**: 2核 8 GB（通用）'."\n" .'- **mysql.n2.large.25**: 4核 8 GB（通用）'."\n" .'- **mysql.n4.large.25**: 4核 16 GB（通用）'."\n" .'- **mysql.n4.xlarge.25**: 8核 32 GB（通用）'."\n" .'- **mysql.n4.2xlarge.25**: 16核 64 GB（通用）'."\n" .'- **mysql.x4.large.25**: 4核 16 GB（独享）'."\n" .'- **mysql.x8.large.25**: 4核 32 GB（独享）'."\n" .'- **mysql.x2.xlarge.25**: 8核 16 GB（独享）'."\n" .'- **mysql.x8.xlarge.25**: 8核 64 GB（独享）'."\n" .'- **mysql.x8.2xlarge.25**: 16核 128 GB（独享）'."\n" .'- **mysql.x4.4xlarge.25**: 32核 128 GB（独享）'."\n" .'- **mysql.x8.4xlarge.25**: 32核 256 GB（独享）'."\n" .'- **mysql.st.8xlarge.25**: 60核 470 GB（独享）'."\n" .'- **mysql.st.12xlarge.25**: 90核 720 GB（独享）'."\n" .'- **mysql.x8.45xlarge.25**: 180核 1440 GB（独享）'."\n" .'- **mysql.x8.60xlarge.25**: 240核 1920 GB（独享）'."\n" ."\n\n" .'企业版云盘：'."\n" ."\n" .'- **polarx.mysql.n2.medium.c25**: 2核 4 GB（通用）'."\n" .'- **polarx.mysql.n4.medium.c25**: 2核 8 GB（通用）'."\n" .'- **polarx.mysql.n2.large.c25**: 4核 8 GB（通用）'."\n" .'- **polarx.mysql.n4.large.c25**: 4核 16 GB（通用）'."\n" .'- **polarx.mysql.n4.xlarge.c25**: 8核 32 GB（通用）'."\n" .'- **polarx.mysql.n4.2xlarge.c25**: 16核 64 GB（通用）'."\n" .'- **polarx.mysql.x4.large.c25**: 4核 16 GB（独享）'."\n" .'- **polarx.mysql.x8.large.c25**: 4核 32 GB（独享）'."\n" .'- **polarx.mysql.x2.xlarge.c25**: 8核 16 GB（独享）'."\n" .'- **polarx.mysql.x8.xlarge.c25**: 8核 64 GB（独享）'."\n" .'- **polarx.mysql.x8.2xlarge.c25**: 16核 128 GB（独享）'."\n" .'- **polarx.mysql.x4.4xlarge.c25**: 32核 128 GB（独享）'."\n" .'- **polarx.mysql.x8.4xlarge.c25**: 32核 256 GB（独享）'."\n" .'- **polarx.mysql.st.8xlarge.c25**: 60核 470 GB（独享）'."\n" .'- **polarx.mysql.st.12xlarge.c25**: 90核 720 GB（独享）'."\n" .'- **polarx.mysql.x8.45xlarge.c25**: 180核 1440 GB（独享）'."\n" .'- **polarx.mysql.x8.60xlarge.c25**: 240核 1920 GB（独享）', 'type' => 'string', 'required' => false, 'example' => 'mysql.n4.medium.25'], ], [ 'name' => 'CNNodeCount', 'in' => 'query', 'schema' => ['description' => '计算节点个数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '99', 'minimum' => '0', 'example' => '2'], ], [ 'name' => 'DNNodeCount', 'in' => 'query', 'schema' => ['description' => '存储节点个数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '99', 'minimum' => '0', 'example' => '2'], ], [ 'name' => 'IsColumnarReadDBInstance', 'in' => 'query', 'schema' => ['description' => '创建的实例是否为列存只读实例。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'Series', 'in' => 'query', 'schema' => [ 'title' => '企业版: enterprise'."\n" .'标准版: standard', 'description' => '企业版：enterprise'."\n" .'标准版：standard', 'type' => 'string', 'required' => false, 'example' => 'enterprise', 'default' => 'enterprise', 'enum' => ['enterprise', 'standard'], ], ], [ 'name' => 'DnStorageSpace', 'in' => 'query', 'schema' => ['description' => '存储节点磁盘空间大小', 'type' => 'string', 'required' => false, 'example' => '1500'], ], [ 'name' => 'ExtraParams', 'in' => 'query', 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ 'description' => '其他参数', 'type' => 'object', 'required' => false, 'additionalProperties' => ['type' => 'string', 'description' => '其他参数', 'example' => 'xxxx'], ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => '数据库描述。', 'type' => 'string', 'required' => false, 'example' => 'ods_api_apidata_mobilegame_pay_api_di'], ], [ 'name' => 'OriginMinorVersion', 'in' => 'query', 'schema' => ['description' => '小版本号，通常不需要传', 'type' => 'string', 'required' => false, 'example' => 'polardb-2.4.0_standard_xcluster8.4.20-20260331'], ], [ 'name' => 'StorageType', 'in' => 'query', 'schema' => ['description' => '存储类型'."\n" .'* 本地盘：custom_local_ssd'."\n" .'* 云盘：cloud_auto', 'type' => 'string', 'required' => false, 'example' => 'cloud_auto'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBInstanceName' => ['description' => '创建的实例名称。', 'type' => 'string', 'example' => 'pxc-*********'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], 'OrderId' => ['description' => '订单号。', 'type' => 'string', 'example' => '12345'], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceName\\": \\"pxc-*********\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"OrderId\\": \\"12345\\"\\n}","errorExample":""},{"type":"xml","example":"\\n pxc-*********\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n 12345\\n","errorExample":""}]', 'title' => '创建实例', 'description' => '****', 'changeSet' => [ ['createdAt' => '2025-12-18T14:58:28.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2025-03-12T14:38:16.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2025-03-12T14:38:16.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2025-03-12T14:38:16.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2024-12-03T15:33:24.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2024-06-13T13:55:10.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2024-04-24T07:43:16.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2023-12-14T09:09:49.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2023-09-08T09:40:07.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2023-09-01T08:57:24.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2022-12-07T03:41:44.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2021-12-09T01:46:12.000Z', 'description' => '请求参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBInstance'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardbx:CreateDBInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], ], 'CreateDataImportTask' => [ 'summary' => '用于创建一个数据导入任务，将外部数据文件（如 SQL 脚本、CSV 文件等）导入到目标数据库实例中。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '103607', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。>您可以调用[describeregions](~~196841~~)接口查看polardb-x支持的地域详情，包括地域id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例id。>您可以调用[describedbinstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例id。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pxc-********'], ], [ 'name' => 'SrcResId', 'in' => 'query', 'schema' => ['description' => '源rds实例id。>您可以调用[describedrivingaccess](~~196830~~)接口查看目标地域下所有源rds实例的详情，包括实例id。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pxc-shrnv****kh87z'], ], [ 'name' => 'SrcDb', 'in' => 'query', 'schema' => ['description' => '源数据库为rdsmysql时，迁移源的数据库信息。>源数据库必须与目标数据库保持一致。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'transfer_for_st'], ], [ 'name' => 'SrcUserName', 'in' => 'query', 'schema' => ['description' => '源端用户名', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'drds_test'], ], [ 'name' => 'SrcPassword', 'in' => 'query', 'schema' => ['description' => '源端执行导入任务的读写模式，取值范围如下：***rw**：读写***ro**：只读', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '******'], ], [ 'name' => 'DstResId', 'in' => 'query', 'schema' => ['description' => '迁移任务id。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pxc-shr8****k36vrn'], ], [ 'name' => 'DstDb', 'in' => 'query', 'schema' => ['description' => '导入目标sql的执行环境，取值范围如下：***importing**：导入中。***success**：导入成功。***fail**：导入失败。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'transfer_test3'], ], [ 'name' => 'DstUserName', 'in' => 'query', 'schema' => ['description' => '目标端用户名', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'bbt_cms_prod'], ], [ 'name' => 'DstPassword', 'in' => 'query', 'schema' => ['description' => '目标rds实例高权限账号的密码。>*您可以调用[describedbinstances](~~196830~~)接口查看目标实例的高权限账号信息，包括密码。*仅当[unk]dstpassword=true[unk]时，该参数生效。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '******'], ], [ 'name' => 'SlinkTaskId', 'in' => 'query', 'schema' => ['description' => '导入任务id。', 'type' => 'string', 'required' => true, 'example' => 'etx-szr2rr6i*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '请求返回消息', 'type' => 'string', 'example' => '*****'], 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'SlinkTaskId' => ['description' => '导入任务id。', 'type' => 'string', 'example' => 'etx-szr2rr6i*****'], ], ], ], 'description' => '', ], ], ], 'title' => '创建数据导入任务', 'description' => 'CreateDataImportTask 接口用于创建数据导入任务，支持将存储在OSS、ECS或直接传入的SQL/CSV文件导入到目标数据库实例中。通过指定实例ID、数据库名、引擎类型、数据来源（如OSS路径）及导入类型，系统将异步或同步执行数据写入操作，适用于数据迁移、初始化和补录等场景，返回任务ID以便后续状态查询与管理。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataImportTask'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', ], 'CreateGatewayConsumerForPolarDBX' => [ 'summary' => '为PolarDB-X实例创建AI网关Consumer', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '86227', 'abilityTreeNodes' => ['FEATUREdrdsIT76F2'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例id。>您可以调用[describedbinstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => '后端任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '422922413'], 'DBInstanceName' => ['description' => '实例名。', 'type' => 'string', 'example' => 'pxc-**************'], 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => 'A501A191-BD70-5E50-98A9-C2A486A82****'], ], 'description' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '开启实例AI能力', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": 422922413,\\n \\"DBInstanceName\\": \\"pxc-**************\\",\\n \\"RequestId\\": \\"A501A191-BD70-5E50-98A9-C2A486A82****\\"\\n}","type":"json"}]', ], 'CreateGdnInstance' => [ 'summary' => '创建GDN实例', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '219398', 'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '主实例名', 'type' => 'string', 'required' => true, 'example' => 'pxc-********', 'title' => 'polarx实例名'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => '地域'], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => '描述信息。', 'type' => 'string', 'required' => false, 'example' => 'FASTJSON 2.0.x has been released, faster and more secure, recommend you upgrade.', 'title' => '实例备注'], ], [ 'name' => 'GdnMode', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'title' => 'gdn模式', 'example' => 'gdn_mode_master_slave, gdn_mode_bidirectional', 'description' => 'gdn模式'], ], [ 'name' => 'RplSyncDdl', 'in' => 'query', 'schema' => ['type' => 'boolean', 'required' => false, 'title' => '同步ddl', 'description' => '同步ddl'], ], [ 'name' => 'RplDmlStrategy', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'title' => 'DMS复制策略', 'example' => 'MERGE, SERIAL, TRANSACTION, SPLIT', 'description' => 'DMS复制策略'], ], [ 'name' => 'RplConflictStrategy', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'title' => '冲突策略', 'example' => 'DIRECT_OVERWRITE, OVERWRITE, IGNORE, INTERRUPT', 'description' => '冲突策略'], ], ], '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' => '0DBA1657-7607-56D6-BB6D-641BF17CCFDB'], 'Message' => ['description' => '请求返回消息。'."\n" .'> 请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => '****'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'], 'Data' => [ 'description' => '实例详情列表。', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '2209883'], ], ], ], ], ], ], 'title' => '创建GDN实例', 'changeSet' => [ ['createdAt' => '2025-10-14T13:06:12.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2025-10-14T13:06:12.000Z', 'description' => '请求参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGdnInstance'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardbx:CreateGdnInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0DBA1657-7607-56D6-BB6D-641BF17CCFDB\\",\\n \\"Message\\": \\"****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]', ], 'CreateGdnStandbyMember' => [ 'summary' => '添加gdn从实例', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '206549', 'abilityTreeNodes' => ['FEATUREdrds6M21XK'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => ['description' => '实例付费类型。'."\n" ."\n" .'- **PREPAY**：包年包月'."\n" .'- **POSTPAY**：按量付费', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PREPAY'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => '幂等请求串，保持每次创建不同即可。', 'type' => 'string', 'required' => false, 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], ], [ 'name' => 'NetworkType', 'in' => 'query', 'schema' => ['description' => '网络类型，仅支持VPC网络。', 'type' => 'string', 'required' => false, 'example' => 'vpc'], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => ['description' => 'VPC ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-*****'], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-*********'], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => ['description' => '预付费时，可以选择买几个月或者几年。'."\n" ."\n" .'> Period设置为Year时，该参数支持的取值为1、2、3。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['description' => '收费周期，包年包月只能选Year、Month， 按量付费默认选择Hour。', 'type' => 'string', 'required' => false, 'example' => 'Month'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => '可以为空，资源组ID，暂时不支持。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => ['description' => '是否自动续费，默认为true。'."\n" ."\n" .'- **true**：是'."\n" .'- **false**：否', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => ['description' => 'mysql引擎版本，5.7或者8.0。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5.7'], ], [ 'name' => 'TopologyType', 'in' => 'query', 'schema' => ['description' => '拓扑类型：'."\n" ."\n" .'- **3azones**：三可用区；'."\n" .'- **1azone**：单可用区。', 'type' => 'string', 'required' => true, 'example' => '3azones'], ], [ 'name' => 'PrimaryZone', 'in' => 'query', 'schema' => ['description' => '主可用区。', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen-e'], ], [ 'name' => 'SecondaryZone', 'in' => 'query', 'schema' => ['description' => '次可用区。', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen-a'], ], [ 'name' => 'TertiaryZone', 'in' => 'query', 'schema' => ['description' => '第三可用区。', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen-e'], ], [ 'name' => 'CnClass', 'in' => 'query', 'schema' => ['description' => '计算节点规格，创建企业版需要传，创建标准版无需传。'."\n" ."\n" .'企业版本地盘：'."\n" ."\n" .'- **polarx.x4.medium.2e**: 2核 8 GB（通用）'."\n" .'- **polarx.x4.large.2e**: 4核 16 GB（通用）'."\n" .'- **polarx.x4.xlarge.2e**: 8核 32 GB（通用）'."\n" .'- **polarx.x4.2xlarge.2e**: 16核 64 GB（通用）'."\n" .'- **polarx.x8.large.2e**: 4核 32 GB（独享）'."\n" .'- **polarx.x2.large.2x**: 8核 16 GB（独享）'."\n" .'- **polarx.x4.xlarge.2x**: 8核 32 GB（独享）'."\n" .'- **polarx.x8.xlarge.2e**: 8核 64 GB（独享）'."\n" .'- **polarx.x8.2xlarge.2e**: 16核 128 GB（独享）'."\n" .'- **polarx.x4.4xlarge.2e**: 32核 128 GB（独享）'."\n" .'- **polarx.x8.4xlarge.2e**: 32核 256 GB（独享）'."\n" .'- **polarx.st.8xlarge.2e**: 60核 470 GB（独享）'."\n" .'- **polarx.st.12xlarge.2e**: 90核 720 GB（独享）'."\n" ."\n\n" .'企业版云盘：'."\n" .'- **polarx.x4.medium.c2e**: 2核 8 GB（通用）'."\n" .'- **polarx.x4.large.c2e**: 4核 16 GB（通用）'."\n" .'- **polarx.x4.xlarge.c2e**: 8核 32 GB（通用）'."\n" .'- **polarx.x4.2xlarge.c2e**: 16核 64 GB（通用）'."\n" .'- **polarx.x8.large.c2e**: 4核 32 GB（独享）'."\n" .'- **polarx.x2.large.c2x**: 8核 16 GB（独享）'."\n" .'- **polarx.x4.xlarge.c2x**: 8核 32 GB（独享）'."\n" .'- **polarx.x8.xlarge.c2e**: 8核 64 GB（独享）'."\n" .'- **polarx.x8.2xlarge.c2e**: 16核 128 GB（独享）'."\n" .'- **polarx.x4.4xlarge.c2e**: 32核 128 GB（独享）'."\n" .'- **polarx.x8.4xlarge.c2e**: 32核 256 GB（独享）'."\n" .'- **polarx.st.8xlarge.c2e**: 60核 470 GB（独享）'."\n" .'- **polarx.st.12xlarge.c2e**: 90核 720 GB（独享）', 'type' => 'string', 'required' => false, 'example' => '4核32G'], ], [ 'name' => 'DnClass', 'in' => 'query', 'schema' => ['description' => '存储节点规格，创建企业版需要传，创建标准版无需传。'."\n" ."\n" .'企业版本地盘：'."\n" ."\n" .'- **mysql.n2.medium.25**: 2核 4 GB（通用）'."\n" .'- **mysql.n4.medium.25**: 2核 8 GB（通用）'."\n" .'- **mysql.n2.large.25**: 4核 8 GB（通用）'."\n" .'- **mysql.n4.large.25**: 4核 16 GB（通用）'."\n" .'- **mysql.n4.xlarge.25**: 8核 32 GB（通用）'."\n" .'- **mysql.n4.2xlarge.25**: 16核 64 GB（通用）'."\n" .'- **mysql.x4.large.25**: 4核 16 GB（独享）'."\n" .'- **mysql.x8.large.25**: 4核 32 GB（独享）'."\n" .'- **mysql.x2.xlarge.25**: 8核 16 GB（独享）'."\n" .'- **mysql.x8.xlarge.25**: 8核 64 GB（独享）'."\n" .'- **mysql.x8.2xlarge.25**: 16核 128 GB（独享）'."\n" .'- **mysql.x4.4xlarge.25**: 32核 128 GB（独享）'."\n" .'- **mysql.x8.4xlarge.25**: 32核 256 GB（独享）'."\n" .'- **mysql.st.8xlarge.25**: 60核 470 GB（独享）'."\n" .'- **mysql.st.12xlarge.25**: 90核 720 GB（独享）'."\n" .'- **mysql.x8.45xlarge.25**: 180核 1440 GB（独享）'."\n" .'- **mysql.x8.60xlarge.25**: 240核 1920 GB（独享）'."\n" ."\n\n" .'企业版云盘：'."\n" ."\n" .'- **polarx.mysql.n2.medium.c25**: 2核 4 GB（通用）'."\n" .'- **polarx.mysql.n4.medium.c25**: 2核 8 GB（通用）'."\n" .'- **polarx.mysql.n2.large.c25**: 4核 8 GB（通用）'."\n" .'- **polarx.mysql.n4.large.c25**: 4核 16 GB（通用）'."\n" .'- **polarx.mysql.n4.xlarge.c25**: 8核 32 GB（通用）'."\n" .'- **polarx.mysql.n4.2xlarge.c25**: 16核 64 GB（通用）'."\n" .'- **polarx.mysql.x4.large.c25**: 4核 16 GB（独享）'."\n" .'- **polarx.mysql.x8.large.c25**: 4核 32 GB（独享）'."\n" .'- **polarx.mysql.x2.xlarge.c25**: 8核 16 GB（独享）'."\n" .'- **polarx.mysql.x8.xlarge.c25**: 8核 64 GB（独享）'."\n" .'- **polarx.mysql.x8.2xlarge.c25**: 16核 128 GB（独享）'."\n" .'- **polarx.mysql.x4.4xlarge.c25**: 32核 128 GB（独享）'."\n" .'- **polarx.mysql.x8.4xlarge.c25**: 32核 256 GB（独享）'."\n" .'- **polarx.mysql.st.8xlarge.c25**: 60核 470 GB（独享）'."\n" .'- **polarx.mysql.st.12xlarge.c25**: 90核 720 GB（独享）'."\n" .'- **polarx.mysql.x8.45xlarge.c25**: 180核 1440 GB（独享）'."\n" .'- **polarx.mysql.x8.60xlarge.c25**: 240核 1920 GB（独享）', 'type' => 'string', 'required' => false, 'example' => '4核32G'], ], [ 'name' => 'CNNodeCount', 'in' => 'query', 'schema' => ['description' => '计算节点个数。', 'type' => 'string', 'required' => false, 'example' => '2'], ], [ 'name' => 'DNNodeCount', 'in' => 'query', 'schema' => ['description' => '存储节点个数。', 'type' => 'string', 'required' => false, 'example' => '2'], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => '描述信息。', 'type' => 'string', 'required' => false, 'example' => 'go-to-the-docks-for-french-fries'], ], [ 'name' => 'CloneInstanceName', 'in' => 'query', 'schema' => ['description' => '源实例名', 'type' => 'string', 'required' => true, 'example' => 'pxc-***'], ], [ 'name' => 'SourceInstanceRegion', 'in' => 'query', 'schema' => ['description' => '源实例所在地域', 'type' => 'string', 'required' => true, 'example' => 'cn-chengdu'], ], [ 'name' => 'Series', 'in' => 'query', 'schema' => ['description' => '企业版：enterprise'."\n" .'标准版：standard', 'type' => 'string', 'required' => false, 'example' => 'enterprise'], ], [ 'name' => 'StorageType', 'in' => 'query', 'schema' => ['description' => '存储类型', 'type' => 'string', 'required' => false, 'example' => 'cloud_auto'], ], ], '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' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9'], 'DBInstanceName' => ['description' => '创建的实例名称。', 'type' => 'string', 'example' => 'pxc-hzravgpt8q****'], 'OrderId' => ['description' => '订单号。', 'type' => 'string', 'example' => '12345'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '添加gdn从实例', 'description' => '更多关于实例账号的信息，请参见[账号管理](https://help.aliyun.com/document_detail/172163.html)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\",\\n \\"DBInstanceName\\": \\"pxc-hzravgpt8q****\\",\\n \\"OrderId\\": \\"12345\\"\\n}","type":"json"}]', ], 'CreateMem0' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-xxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '2209883'], ], ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string'], 'AuthPrincipalType' => ['type' => 'string'], 'AuthPrincipalOwnerId' => ['type' => 'string'], 'AuthPrincipalDisplayName' => ['type' => 'string'], 'PolicyType' => ['type' => 'string'], 'NoPermissionType' => ['type' => 'string'], 'EncodedDiagnosticMessage' => ['type' => 'string'], ], ], ], 'description' => '', ], ], ], 'title' => '开通记忆引擎', 'summary' => '开通记忆引擎', 'description' => '更多关于实例账号的信息，请参见[账号管理](https://help.aliyun.com/document_detail/172163.html)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardbx:CreateMem0', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"PolicyType\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\"\\n }\\n}","type":"json"}]', ], 'CreatePolardbxSupabaseInstance' => [ 'summary' => '创建Supabase实例', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '地域ID', 'description' => '地域ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['title' => '可用区ID', 'description' => '可用区ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing-h'], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['title' => 'VPC ID', 'description' => 'VPC ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-bp1ndoug37dtwoedlmru0'], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['title' => '交换机ID', 'description' => '交换机ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vsw-*********'], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => ['title' => '付费类型 (PREPAY/POSTPAY)', 'description' => '付费类型 (PREPAY/POSTPAY)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PREPAY'], ], [ 'name' => 'DbPassword', 'in' => 'query', 'schema' => ['title' => '数据库密码', 'description' => '数据库密码', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dTyMQem0o3HOAFh!'], ], [ 'name' => 'DashboardPassword', 'in' => 'query', 'schema' => ['title' => 'Dashboard 密码', 'description' => 'Dashboard 密码', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dTyMQem0o3HOAFh!'], ], [ 'name' => 'TenantMode', 'in' => 'query', 'schema' => ['title' => '是否多租户模式', 'description' => '是否多租户模式', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'false', 'default' => 'false'], ], [ 'name' => 'NodeSpec', 'in' => 'query', 'schema' => ['title' => '节点规格', 'description' => '节点规格', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'polarx.supabase.x2.small'], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => ['title' => '购买时长', 'description' => '购买时长', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1'], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['title' => '计费周期 (Year/Month/Hour)', 'description' => '计费周期 (Year/Month/Hour)', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Month'], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => ['title' => '是否自动续费', 'description' => '是否自动续费', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'default' => 'true'], ], [ 'name' => 'DbInstanceDescription', 'in' => 'query', 'schema' => ['title' => '实例描述', 'description' => '实例描述', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Supabase实例'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['title' => '资源组ID', 'description' => '资源组ID', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'null'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['title' => '幂等Token', 'description' => '幂等Token', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], 'Data' => [ 'title' => '创建结果', 'description' => '创建结果', 'type' => 'object', 'properties' => [ 'DBInstanceId' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 'pxsp-xxxxxxxxxx'], 'OrderId' => ['title' => '订单ID', 'description' => '订单ID', 'type' => 'integer', 'format' => 'int64', 'example' => '265325896860727'], 'ConnectionString' => ['title' => '连接地址', 'description' => '连接地址', 'type' => 'string', 'example' => 'test2.polarx.huhehaote.rds.aliyuncs.com'], 'Port' => ['title' => '端口', 'description' => '端口', 'type' => 'integer', 'format' => 'int32', 'example' => '3300'], ], ], 'AccessDeniedDetail' => [ 'title' => '无权限访问详情', 'description' => '无权限访问详情', 'type' => 'object', 'properties' => [ 'AuthAction' => ['title' => '鉴权动作', 'description' => '鉴权动作', 'type' => 'string', 'example' => 'xxx'], 'AuthPrincipalType' => ['title' => '鉴权主体类型', 'description' => '鉴权主体类型', 'type' => 'string', 'example' => '222'], 'NoPermissionType' => ['title' => '无权限类型', 'description' => '无权限类型', 'type' => 'string', 'example' => 'ImplicitDeny'], 'PolicyType' => ['title' => '策略类型', 'description' => '策略类型', 'type' => 'string', 'example' => 'PRIORITY'], 'EncodedDiagnosticMessage' => ['title' => '诊断信息', 'description' => '诊断信息', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], 'AuthPrincipalOwnerId' => ['title' => '鉴权主体OwnerId', 'description' => '鉴权主体OwnerId', 'type' => 'string', 'example' => '111'], 'AuthPrincipalDisplayName' => ['title' => '鉴权主体名称', 'description' => '鉴权主体名称', 'type' => 'string', 'example' => 'xxx'], ], ], ], 'description' => '', ], ], ], 'title' => '创建Supabase实例', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"pxsp-xxxxxxxxxx\\",\\n \\"OrderId\\": 265325896860727,\\n \\"ConnectionString\\": \\"test2.polarx.huhehaote.rds.aliyuncs.com\\",\\n \\"Port\\": 3300\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n }\\n}","type":"json"}]', ], 'CreateRplInspectionTask' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '104276', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'SlinkTaskId', 'in' => 'query', 'schema' => ['description' => '切换任务id。', 'type' => 'string', 'required' => true, 'example' => 'etx-szr2rr6i*****'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域id。>您可以调用[describeregions](~~196841~~)接口查看polardb-x支持的地域详情，包括地域id。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'SrcUserName', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '源实例（源数据库）的连接用户名', 'type' => 'string', 'required' => false, 'example' => 'bbt_ump'], ], [ 'name' => 'SrcPassword', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '源rds实例的用户密码。>您可以调用[describedbinstances](~~196830~~)接口查看目标地域下所有实例的详情，包括用户密码。', 'type' => 'string', 'required' => false, 'example' => '******'], ], [ 'name' => 'DstResId', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '目标任务id。', 'type' => 'string', 'required' => false, 'example' => 'pxc-zkrc1****l54rc'], ], [ 'name' => 'DstDb', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '目标实例中迁移对象所属的rds实例id。>您可以调用[describedbinstances](~~196830~~)接口查看目标地域下所有rds实例的详情，包括实例id。', 'type' => 'string', 'required' => false, 'example' => 'transfer_test3'], ], [ 'name' => 'DstUserName', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '目标实例的连接用户名', 'type' => 'string', 'required' => false, 'example' => 'bbt_item'], ], [ 'name' => 'DstPassword', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '目标rds实例高权限账号的密码。>*长度为8~32个字符。*由大写字母、小写字母、数字、特殊字符中的任意三种组成。*特殊字符为!@#$&%^*()_+-=', 'type' => 'string', 'required' => false, 'example' => '******'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '任务错误信息。>仅当任务状态为**stop**时返回该参数。', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '任务详情。', 'type' => 'object', 'properties' => [ 'SlinkTaskId' => ['description' => 'slink任务id。', 'type' => 'string', 'example' => 'etx-szr2rr6i*****'], ], ], ], 'description' => '', ], ], ], 'title' => '复制链路健康检查', 'summary' => '在数据迁移过程中，用于复制链路健康检查。', 'description' => '数据同步阶段，主动发起对复制链路的诊断任务，检查是否存在延迟、中断、数据不一致等异常问题', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRplInspectionTask'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', ], 'CreateSQLEvaluateTask' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '103587', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域id。>您可以调用[describeregions](~~196841~~)接口查看polardb-x支持的地域详情，包括地域id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例id。>您可以调用[describedbinstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-shr4idrgogti89'], ], [ 'name' => 'SlinkTaskDesc', 'in' => 'query', 'schema' => ['description' => '目标sql的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test-drds->auto'], ], [ 'name' => 'SrcResId', 'in' => 'query', 'schema' => ['description' => '源rds实例id。>您可以调用[describedropsystemeventmetalist](~~196836~~)接口查看目标地域下所有的源rds实例详情，包括实例id。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pxc-shr****rgkh87z'], ], [ 'name' => 'SrcDb', 'in' => 'query', 'schema' => ['description' => '源rds实例是否开启源rds，取值范围如下：***enable**：开启源rds***disabled**：关闭源rds', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'transfer_test3'], ], [ 'name' => 'SrcUserName', 'in' => 'query', 'schema' => ['description' => '源端用户名', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'drds_test'], ], [ 'name' => 'SrcPassword', 'in' => 'query', 'schema' => ['description' => '源端口号，取值范围为3200~3999。>当**dbendpointinstancetype**取值为**polardb-o**时，本参数才可用且必须传入。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '******'], ], [ 'name' => 'DstResId', 'in' => 'query', 'schema' => ['description' => '目标sql的id。>您可以调用[describedbinstances](~~196830~~)接口查看目标sql的详情，包括id。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pxc-zkrc1****l54rc'], ], [ 'name' => 'DstDb', 'in' => 'query', 'schema' => ['description' => '执行目标sql的实例id。>您可以调用[describedbinstances](~~196830~~)接口查看目标sql的详情，包括实例id。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'transfer_for_st'], ], [ 'name' => 'DstUserName', 'in' => 'query', 'schema' => ['description' => '目标端用户名', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'drds_test'], ], [ 'name' => 'DstPassword', 'in' => 'query', 'schema' => ['description' => '目标sql的密码。>您可以调用[describedbinstances](~~196830~~)接口查看目标sql的详情，包括密码。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '******'], ], [ 'name' => 'SlinkTaskId', 'in' => 'query', 'schema' => ['description' => '执行目标sql的任务id。>您可以通过[describecloudcenterinstances](~~196830~~)接口查看polardb-x支持的目标sql的id。', 'type' => 'string', 'required' => false, 'example' => 'etx-szr2rr6i*****'], ], [ 'name' => 'SrcResType', 'in' => 'query', 'schema' => ['title' => '源实例类型： RDS_MYSQL、POLARX1、POLARX2_STANDARD、POLARX2_ENTERPRISE、POLARDB_M', 'description' => '源实例类型： RDS_MYSQL、POLARX1、POLARX2_STANDARD、POLARX2_ENTERPRISE、POLARDB_M', 'type' => 'string', 'required' => false, 'example' => 'POLARX2', 'maxLength' => 20, 'minLength' => 1, 'default' => 'POLARX1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '返回消息。>请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => '*****'], 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '6352AC16-76BF-5135-B1EA-ED49293526E6'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'SlinkTaskId' => ['description' => 'slink任务id。', 'type' => 'string', 'example' => 'etx-szr2rr6i*****'], ], ], ], 'description' => '', ], ], ], 'title' => 'SQL评估', 'summary' => '用于创建 SQL 语句评估任务，通过该接口，用户提交 SQL 语句，系统将对其进行静态分析与风险评估，输出其在目标数据库实例上的执行风险、兼容性问题。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSQLEvaluateTask'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"6352AC16-76BF-5135-B1EA-ED49293526E6\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', ], 'CreateStoragePool' => [ 'summary' => '创建资源存储池', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '201295', 'abilityTreeNodes' => ['FEATUREdrdsUWIQBY', 'FEATUREdrdsVN1FAR'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-bjxxxxxxxx'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['title' => '资源组ID', 'description' => '资源组ID', 'type' => 'string', 'required' => false, 'example' => 'rg-xxxxx'], ], [ 'name' => 'StoragePoolName', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => '存储池名称', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ 'name' => 'StoragePoolDNList', 'in' => 'query', 'schema' => ['description' => '存储池DN列表', 'type' => 'string', 'required' => false, 'example' => 'node6'."\n"], ], ], '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' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], 'Code' => ['description' => '接口返回Code', 'type' => 'string', 'example' => '200'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '创建存储池', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStoragePool'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', ], 'CreateStructureImportTask' => [ 'summary' => '用于创建数据库结构导入任务，支持将包含 DDL语句的 SQL 脚本文件或文本内容导入到目标数据库实例中，自动执行建表、创建索引、视图、存储过程等结构化操作。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '154938', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例id。>您可以调用[describedbinstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例id。', 'type' => 'string', 'required' => false, 'example' => 'pxc-********'], ], [ 'name' => 'SlinkTaskId', 'in' => 'query', 'schema' => ['description' => '目标任务id。>您可以调用[describeslinktasks](~~196830~~)接口查看目标任务的执行状态，包括任务id。', 'type' => 'string', 'required' => true, 'example' => 'etx-szr2rr6i*****'], ], [ 'name' => 'Config', 'in' => 'formData', 'schema' => ['description' => '配置信息。', 'type' => 'string', 'required' => false, 'example' => '[{\\"schemaName\\":\\"transfer_test\\",\\"tableList\\":[]}]'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '返回消息。>请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => '*****'], 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '73559800-3c8c-****-bd40-99cfcff3fe1e'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'SlinkTaskId' => ['description' => 'slink任务id。', 'type' => 'string', 'example' => 'etx-szr2rr6i*****'], ], ], ], 'description' => '', ], ], ], 'title' => '创建数据结构导入任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStructureImportTask'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"73559800-3c8c-****-bd40-99cfcff3fe1e\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', ], 'CreateSubCNInstance' => [ 'summary' => '创建自定义地址', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '162467', 'abilityTreeNodes' => ['FEATUREdrdsDBGOD6'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例id。>您可以调用[describedbinstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzravgpt8q****'], ], [ 'name' => 'IsAutoCreate', 'in' => 'query', 'schema' => ['description' => '自动计算资源参数'."\n" .'- **true**：', 'type' => 'boolean', 'required' => false], ], [ 'name' => 'ReadType', 'in' => 'query', 'schema' => ['description' => '读写类型：行存读写（ReadWrite）、列存只读（ColumnarRead）', 'type' => 'string', 'required' => false, 'example' => 'ReadWrite'], ], ], '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' => 'D6A4256F-7B83-5BD7-9AC0-72E1FAC05330'], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '2209883'], ], ], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '创建自定义地址', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardbx:CreateSubCNInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6A4256F-7B83-5BD7-9AC0-72E1FAC05330\\",\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]', ], 'CreateSupabaseNetType' => [ 'summary' => '开通Supabase公网地址', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '地域ID', 'description' => '地域ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxsp-*********'], ], [ 'name' => 'ConnectionString', 'in' => 'query', 'schema' => ['title' => '自定义连接地址前缀', 'description' => '自定义连接地址前缀', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'pxsp-*********'."\n"], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], 'Data' => [ 'title' => '操作结果', 'description' => '操作结果', 'type' => 'object', 'properties' => [ 'DBInstanceName' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'example' => 'pxc-*********'], 'ConnectionString' => ['title' => '公网连接地址', 'description' => '公网连接地址', 'type' => 'string', 'example' => 'test2.polarx.huhehaote.rds.aliyuncs.com'], 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'integer', 'format' => 'int32', 'example' => '******'], ], ], 'AccessDeniedDetail' => [ 'title' => '无权限访问详情', 'description' => '无权限访问详情', 'type' => 'object', 'properties' => [ 'AuthAction' => ['title' => '鉴权动作', 'description' => '鉴权动作', 'type' => 'string', 'example' => 'xxx'], 'AuthPrincipalType' => ['title' => '鉴权主体类型', 'description' => '鉴权主体类型', 'type' => 'string', 'example' => '222'], 'NoPermissionType' => ['title' => '无权限类型', 'description' => '无权限类型', 'type' => 'string', 'example' => 'ImplicitDeny'], 'PolicyType' => ['title' => '策略类型', 'description' => '策略类型', 'type' => 'string', 'example' => 'System'], 'EncodedDiagnosticMessage' => ['title' => '诊断信息', 'description' => '诊断信息', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], 'AuthPrincipalOwnerId' => ['title' => '鉴权主体OwnerId', 'description' => '鉴权主体OwnerId', 'type' => 'string', 'example' => '111'], 'AuthPrincipalDisplayName' => ['title' => '鉴权主体名称', 'description' => '鉴权主体名称', 'type' => 'string', 'example' => 'xxx'], ], ], ], 'description' => '', ], ], ], 'title' => '开通Supabase公网', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-*********\\",\\n \\"ConnectionString\\": \\"test2.polarx.huhehaote.rds.aliyuncs.com\\",\\n \\"TaskId\\": 0\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"System\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n }\\n}","type":"json"}]', ], 'CreateSuperAccount' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-************'], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => '账号名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dba'], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => ['description' => '账号密码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testdbapassword'], ], [ 'name' => 'AccountDescription', 'in' => 'query', 'schema' => ['description' => '账号描述。', 'type' => 'string', 'required' => false, 'example' => 'testdbadescription'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '成功为空，失败返回错误信息。', 'type' => 'string', 'example' => '*****'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => '创建高权限账号', 'summary' => '调用CreateSuperAccount接口创建高权限账号，一个实例只能有一个高权限账号。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSuperAccount'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n *****\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n","errorExample":""}]', ], 'CreateTransformOperation' => [ 'summary' => '创建转换任务，用于改变实例的某种状态或配置。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '196930', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域id。>您可以调用[describeregions](~~196841~~)接口查看polardb-x支持的地域详情，包括地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxx'], ], [ 'name' => 'Operation', 'in' => 'query', 'schema' => ['description' => '本次操作类型', 'type' => 'string', 'required' => false, 'example' => 'finish'], ], ], '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' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'Current DB instance does not support this operation.', 'description' => '当前实例不支持这个操作'], ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist or is not supported.', 'description' => '指定实例不存在'], ['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid Parameter.', 'description' => '参数有误'], ['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前的实例状态不支持此操作'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '创建转换任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTransformOperation'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\"\\n}","type":"json"}]', ], 'DeleteAccount' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86232', 'abilityTreeNodes' => ['FEATUREdrds0ML0VG'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-*********'], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => '删除的账号名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testaccount'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'SecurityAccountName', 'in' => 'query', 'schema' => ['description' => '安全管理员账号名称。'."\n" ."\n" .'> 若已开启三权分立模式，该参数必填，未开启三权分立可以不填。', 'type' => 'string', 'required' => false, 'example' => 'securityAccount'], ], [ 'name' => 'SecurityAccountPassword', 'in' => 'query', 'schema' => ['description' => '安全管理员账号密码。'."\n" ."\n" .'> 若已开启三权分立模式，该参数必填，未开启三权分立可以不填。', 'type' => 'string', 'required' => false, 'example' => 'securityPassword'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '成功为空，失败返回错误信息。', 'type' => 'string', 'example' => '****'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => '删除实例账号', 'summary' => '调用DeleteAccount接口删除账号。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccount'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n ****\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n","errorExample":""}]', ], 'DeleteCustomEndpoint' => [ 'summary' => '删除用户端域名', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '236568', 'abilityTreeNodes' => ['FEATUREdrds0SX279'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名。', 'type' => 'string', 'required' => false, 'example' => 'pxc-hzravgpt8q****'], ], [ 'name' => 'CustomEndpointId', 'in' => 'query', 'schema' => ['description' => '用户端域名id', 'type' => 'string', 'required' => false, 'example' => 'pxe-8if3zrfsu****hgw'], ], ], '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' => '9B2F3840-****-475C-B269-2D5C3A31797C'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => '删除用户端域名', 'description' => '删除指定数据库实例的自定义连接地址，关闭该域名的访问入口。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomEndpoint'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-****-475C-B269-2D5C3A31797C\\"\\n}","type":"json"}]', ], 'DeleteDB' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********'], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => ['description' => '待删除的数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testdb'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '成功为空，失败返回错误信息。', 'type' => 'string', 'example' => '*****'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => '删除数据库', 'summary' => '调用DeleteDB接口删除数据库。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDB'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n *****\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n","errorExample":""}]', ], 'DeleteDBInstance' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsD0NTUP'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], ], 'description' => '', ], ], ], 'title' => '删除实例', 'summary' => '调用DeleteDBInstance接口删除实例。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBInstance'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n","errorExample":""}]', ], 'DeleteEvaluateAndImportTask' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '111383', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域id。>您可以调用[describeregions](~~196841~~)接口查看polardb-x支持的地域详情，包括地域id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'SlinkTaskId', 'in' => 'query', 'schema' => ['description' => '切换任务id。', 'type' => 'string', 'required' => false, 'example' => 'etx-szr2rr6i*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '14036EBE-***-44DB-ACE9-AC6157D3A6FC'], 'Message' => ['description' => '返回消息。>请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'msg'], 'Data' => ['description' => '删除任务是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => '删除评估导入任务', 'summary' => '删除评估导入任务', 'description' => '该接口用于删除已创建的评估任务，并执行后续的数据导入操作。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEvaluateAndImportTask'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-***-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Message\\": \\"msg\\",\\n \\"Data\\": true,\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DeleteGdnInstance' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '218653', 'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'], ], 'parameters' => [ [ 'name' => 'GdnInstanceName', 'in' => 'query', 'schema' => ['description' => 'GDN实例名', 'type' => 'string', 'required' => true, 'example' => 'gdn-yq****dorhkzttoi'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], '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' => '14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC'], 'Message' => ['description' => '请求返回消息。'."\n" .'> 请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => '****'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '2209883'], ], ], ], ], ], ], 'title' => '删除GDN实例', 'summary' => '删除GDN实例', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGdnInstance'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Message\\": \\"****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]', ], 'DeleteMem0' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hz1fds'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。'."\n" ."\n", 'type' => 'string', 'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9'], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '******'], ], ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string'], 'AuthPrincipalType' => ['type' => 'string'], 'AuthPrincipalOwnerId' => ['type' => 'string'], 'AuthPrincipalDisplayName' => ['type' => 'string'], 'PolicyType' => ['type' => 'string'], 'NoPermissionType' => ['type' => 'string'], 'EncodedDiagnosticMessage' => ['type' => 'string'], ], ], ], 'description' => '', ], ], ], 'title' => '关闭记忆引擎', 'summary' => '关闭记忆引擎', 'description' => '删除指定数据库实例的自定义连接地址，关闭该域名的访问入口。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardbx:DeleteMem0', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\",\\n \\"Data\\": {\\n \\"TaskId\\": 0\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"PolicyType\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\"\\n }\\n}","type":"json"}]', ], 'DeletePolardbxSupabaseInstance' => [ 'summary' => '删除Supabase实例', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '地域ID', 'description' => '地域ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxsp-*********'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], 'AccessDeniedDetail' => [ 'title' => '无权限访问详情', 'description' => '无权限访问详情', 'type' => 'object', 'properties' => [ 'AuthAction' => ['title' => '鉴权动作', 'description' => '鉴权动作', 'type' => 'string', 'example' => 'xxx'], 'AuthPrincipalType' => ['title' => '鉴权主体类型', 'description' => '鉴权主体类型', 'type' => 'string', 'example' => '222'], 'NoPermissionType' => ['title' => '无权限类型', 'description' => '无权限类型', 'type' => 'string', 'example' => 'ImplicitDeny'], 'PolicyType' => ['title' => '策略类型', 'description' => '策略类型', 'type' => 'string', 'example' => 'PRIORITY'], 'EncodedDiagnosticMessage' => ['title' => '诊断信息', 'description' => '诊断信息', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], 'AuthPrincipalOwnerId' => ['title' => '鉴权主体OwnerId', 'description' => '鉴权主体OwnerId', 'type' => 'string', 'example' => '111'], 'AuthPrincipalDisplayName' => ['title' => '鉴权主体名称', 'description' => '鉴权主体名称', 'type' => 'string', 'example' => 'xxx'], ], ], 'Data' => [ 'title' => '删除结果', 'description' => '删除结果', 'type' => 'object', 'properties' => [ 'DBInstanceName' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'example' => 'pxsp-xxxxxxxxxx'], 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2209883'], ], ], ], 'description' => '', ], ], ], 'title' => '删除Supabase实例', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n },\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxsp-xxxxxxxxxx\\",\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]', ], 'DeleteSubCNInstance' => [ 'summary' => '删除自定义地址', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '162467', 'abilityTreeNodes' => ['FEATUREdrdsDBGOD6'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。'."\n" ."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'InstanceClusterName', 'in' => 'query', 'schema' => ['type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1A586DCB-39A6-4050-81CC-C7BD4CCDB49F'], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => '后端任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '2209883'], ], ], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '删除自定义地址', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A586DCB-39A6-4050-81CC-C7BD4CCDB49F\\",\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]', ], 'DeleteSupabaseNetType' => [ 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '地域ID', 'description' => '地域ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxsp-*********'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], 'Data' => [ 'title' => '操作结果', 'description' => '操作结果', 'type' => 'object', 'properties' => [ 'DBInstanceName' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'example' => 'pxc-********'], 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'integer', 'format' => 'int32', 'example' => '2209883'], ], ], 'AccessDeniedDetail' => [ 'title' => '无权限访问详情', 'description' => '无权限访问详情', 'type' => 'object', 'properties' => [ 'AuthAction' => ['title' => '鉴权动作', 'description' => '鉴权动作', 'type' => 'string', 'example' => 'xxx'], 'AuthPrincipalType' => ['title' => '鉴权主体类型', 'description' => '鉴权主体类型', 'type' => 'string', 'example' => '222'], 'NoPermissionType' => ['title' => '无权限类型', 'description' => '无权限类型', 'type' => 'string', 'example' => 'ImplicitDeny'], 'PolicyType' => ['title' => '策略类型', 'description' => '策略类型', 'type' => 'string', 'example' => 'PRIORITY'], 'EncodedDiagnosticMessage' => ['title' => '诊断信息', 'description' => '诊断信息', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], 'AuthPrincipalOwnerId' => ['title' => '鉴权主体OwnerId', 'description' => '鉴权主体OwnerId', 'type' => 'string', 'example' => '111'], 'AuthPrincipalDisplayName' => ['title' => '鉴权主体名称', 'description' => '鉴权主体名称', 'type' => 'string', 'example' => 'xxx'], ], ], ], 'description' => '', ], ], ], 'title' => '关闭 Supabase 公网', 'summary' => '释放Supabase公网地址', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-********\\",\\n \\"TaskId\\": 2209883\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n }\\n}","type":"json"}]', ], 'DescribeAccountList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********'], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => '账号名称，需要查询某个账号时输入。', 'type' => 'string', 'required' => false, 'example' => 'testaccount'], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => ['description' => '账号类型，需要查询某类账号时输入，null返回所有账号。'."\n" ."\n" .'- 开启三权分立前：0代表普通账号，1代表高权限账号；'."\n" .'- 开启三权分立后，0代表普通账号，2代表系统管理员账号，3代表安全管理员账号，4代表审计管理员账号。', 'type' => 'string', 'required' => false, 'example' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '返回信息，成功返回success，错误返回对应错误码。', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GmtCreated' => ['description' => '账号创建时间.', 'type' => 'string', 'example' => '2012-06-08T15:00Z'], 'DBInstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'pxc-*********'], 'AccountDescription' => ['description' => '账号描述。', 'type' => 'string', 'example' => 'testaccount desc'], 'DBName' => ['description' => '账号被授予权限的数据库。', 'type' => 'string', 'example' => 'testdb'], 'AccountPrivilege' => ['description' => '账号被授予的权限。', 'type' => 'string', 'example' => 'ReadWrite'], 'AccountType' => ['description' => '账号类型。'."\n" ."\n" .'- 开启三权分立前：0代表普通账号，1代表高权限账号；'."\n" .'- 开启三权分立后，0代表普通账号，2代表系统管理员账号，3代表安全管理员账号，4代表审计管理员账号。', 'type' => 'string', 'example' => '0'], 'AccountName' => ['description' => '账号名称。', 'type' => 'string', 'example' => 'testAccount'], ], 'description' => '', ], ], ], 'description' => '', ], ], ], 'title' => '查询实例账号信息', 'summary' => '调用DescribeAccountList接口获取账号列表。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccountList'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"GmtCreated\\": \\"2012-06-08T15:00Z\\",\\n \\"DBInstanceName\\": \\"pxc-*********\\",\\n \\"AccountDescription\\": \\"testaccount desc\\",\\n \\"DBName\\": \\"testdb\\",\\n \\"AccountPrivilege\\": \\"ReadWrite\\",\\n \\"AccountType\\": \\"0\\",\\n \\"AccountName\\": \\"testAccount\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n \\n 2012-06-08T15:00Z\\n pxc-*********\\n testaccount desc\\n testdb\\n ReadWrite\\n 0\\n testAccount\\n \\n","errorExample":""}]', ], 'DescribeActiveOperationMaintainConf' => [ 'summary' => '调用DescribeActiveOperationMaintainConf接口展示运维时间配置。', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '103014', 'abilityTreeNodes' => ['FEATUREdrdsZVW4NQ'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '区域ID', 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果集。', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'requestid', 'description' => '请求ID。', 'type' => 'string', 'example' => '1A586DCB-39A6-4050-81CC-C7BD4CCDB49F'], 'Config' => [ 'title' => '配置信息', 'description' => '配置信息。', 'type' => 'object', 'properties' => [ 'CreatedTime' => ['title' => '创建时间', 'description' => '创建时间。', 'type' => 'string', 'example' => '2021-08-11T10:08:27Z'], 'CycleTime' => ['title' => '循环时间', 'description' => '循环时间。', 'type' => 'string', 'example' => '1,2,3,4,5,6,7'], 'CycleType' => ['title' => '循环类型', 'description' => '循环类型。', 'type' => 'string', 'example' => 'Week'], 'MaintainEndTime' => ['title' => '运维结束时间', 'description' => '运维结束时间。', 'type' => 'string', 'example' => '04:00:00Z'], 'MaintainStartTime' => ['title' => '运维开始时间', 'description' => '运维开始时间。', 'type' => 'string', 'example' => '04:00:00Z'], 'ModifiedTime' => ['title' => '修改时间', 'description' => '修改时间。', 'type' => 'string', 'example' => '2021-08-11T10:08:27Z'], 'Status' => ['title' => '状态', 'description' => '状态。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], 'HasConfig' => ['title' => '用户是否配置：1:已经配置。 0.未配置', 'description' => '是否已配置：'."\n" ."\n" .'- 1：已经配置；'."\n" .'- 0：未配置。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => '该请求使用与先前相同但不相同的请求相同的客户端令牌。 除非请求相同，否则请勿将客户端令牌与其他请求重用。'], ], ], 'title' => '展示运维时间配置', 'changeSet' => [ ['createdAt' => '2021-11-17T06:21:51.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveOperationMaintainConf'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1A586DCB-39A6-4050-81CC-C7BD4CCDB49F\\",\\n \\"Config\\": {\\n \\"CreatedTime\\": \\"2021-08-11T10:08:27Z\\",\\n \\"CycleTime\\": \\"1,2,3,4,5,6,7\\",\\n \\"CycleType\\": \\"Week\\",\\n \\"MaintainEndTime\\": \\"04:00:00Z\\",\\n \\"MaintainStartTime\\": \\"04:00:00Z\\",\\n \\"ModifiedTime\\": \\"2021-08-11T10:08:27Z\\",\\n \\"Status\\": 1\\n },\\n \\"HasConfig\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 1A586DCB-39A6-4050-81CC-C7BD4CCDB49F\\n \\n 2021-08-11T10:08:27Z\\n 1,2,3,4,5,6,7\\n Week\\n 04:00:00Z\\n 04:00:00Z\\n 2021-08-11T10:08:27Z\\n 1\\n \\n 1\\n","errorExample":""}]', ], 'DescribeActiveOperationTaskCount' => [ 'summary' => '获取运维事件总数。', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '103006', 'abilityTreeNodes' => ['FEATUREdrdsZVW4NQ'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => ['description' => '产品， 默认polarx。', 'type' => 'string', 'required' => false, 'example' => 'polarx'], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => ['description' => '保留参数，无需填写。', 'type' => 'string', 'required' => false, 'example' => 'Category'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果集。', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EC7E27FC-58F8-4722-89BB-D1B6D0971956'], 'NeedPop' => ['description' => '是否需要弹窗：'."\n" ."\n" .'- 1：需要'."\n" .'- 0：不需要', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'TaskCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], ], ], ], ], 'title' => '获取运维事件总数', 'changeSet' => [ ['createdAt' => '2021-11-17T06:21:51.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveOperationTaskCount'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC7E27FC-58F8-4722-89BB-D1B6D0971956\\",\\n \\"NeedPop\\": 1,\\n \\"TaskCount\\": 20\\n}","errorExample":""},{"type":"xml","example":"\\n EC7E27FC-58F8-4722-89BB-D1B6D0971956\\n 1\\n 20\\n","errorExample":""}]', ], 'DescribeActiveOperationTasks' => [ 'summary' => '调用DescribeActiveOperationTasks接口获取运维事件。', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '102988', 'abilityTreeNodes' => ['FEATUREdrdsZVW4NQ'], ], 'parameters' => [ [ 'name' => 'Region', 'in' => 'query', 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => ['description' => '任务类型，all代表查询该用户下所有的任务，固定取值为all。', 'type' => 'string', 'required' => false, 'example' => 'all'], ], [ 'name' => 'ProductId', 'in' => 'query', 'schema' => ['description' => '产品名， 默认值为polarx。', 'type' => 'string', 'required' => false, 'example' => 'polarx'], ], [ 'name' => 'DbType', 'in' => 'query', 'schema' => ['description' => '数据库类型，固定值：polarx。', 'type' => 'string', 'required' => false, 'example' => 'polarx'], ], [ 'name' => 'InsName', 'in' => 'query', 'schema' => ['description' => '实例名，默认为空字符串。', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxxxx'], ], [ 'name' => 'ChangeLevel', 'in' => 'query', 'schema' => ['description' => '变更级别，默认all：'."\n" ."\n" .'- **all**：选择全部异常修复和系统运维的级别'."\n" .'- **S0**：异常修复'."\n" .'- **S1**：系统运维', 'type' => 'string', 'required' => false, 'example' => 'all'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => '每页记录数, 默认每页25条。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '25'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => '页码，大于0，默认1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => '任务状态，取值：'."\n" ."\n" .'- **-1**：选择全部待执行和执行中的任务 '."\n" .'- **3**：待执行 '."\n" .'- **4**：执行中', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-1'], ], [ 'name' => 'AllowChange', 'in' => 'query', 'schema' => ['description' => '是否允许修改时间，取值：'."\n" ."\n" .'- **-1**：允许修改全部运维事件的时间'."\n" .'- **0**：不允许 '."\n" .'- **1**：允许', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-1'], ], [ 'name' => 'AllowCancel', 'in' => 'query', 'schema' => ['description' => '是否允许取消，取值：'."\n" .'- **-1**：允许取消全部运维事件'."\n" .'- **0**：不允许 '."\n" .'- **1**：允许', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-1'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回结果集。', 'type' => 'object', 'properties' => [ 'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'xxxx'], 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '23'], 'Items' => [ 'description' => '参数列表。', 'type' => 'array', 'items' => [ 'description' => '参数列表。', 'type' => 'object', 'properties' => [ 'AllowCancel' => ['description' => '是否允许取消'."\n" ."\n" .'- **0**：否'."\n" .'- **1**：是', 'type' => 'string', 'example' => '0'], 'AllowChange' => ['description' => '是否允许修改'."\n" ."\n" .'- **0**：否'."\n" .'- **1**：是', 'type' => 'string', 'example' => '0'], 'ChangeLevel' => ['description' => '变动等级（可忽略）。', 'type' => 'string', 'example' => 'Risk'], 'ChangeLevelEn' => ['description' => '变动等级英文。', 'type' => 'string', 'example' => 'Risk repairment'], 'ChangeLevelZh' => ['description' => '变动等级中文。', 'type' => 'string', 'example' => '风险修复'], 'CreatedTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-06-15T16:00:00Z'], 'CurrentAVZ' => ['description' => '当前AVZ。', 'type' => 'string', 'example' => 'cn-shanghai-et-a'], 'DbType' => ['description' => '数据库类型。', 'type' => 'string', 'example' => 'polarx'], 'DbVersion' => ['description' => '数据库版本。', 'type' => 'string', 'example' => '2.0'], 'Deadline' => ['description' => '截止时间。', 'type' => 'string', 'example' => '2021-06-15T16:00:00Z'], 'Id' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'Impact' => ['description' => '影响（不输出）。', 'type' => 'string', 'example' => '--'], 'ImpactEn' => ['description' => '影响英文。', 'type' => 'string', 'example' => 'Transient instance disconnection'], 'ImpactZh' => ['description' => '影响中文。', 'type' => 'string', 'example' => '中断'], 'InsComment' => ['description' => '描述。', 'type' => 'string', 'example' => 'xxx'], 'InsName' => ['description' => '实例名。', 'type' => 'string', 'example' => 'pxc-dd'], 'ModifiedTime' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2021-06-15T16:00:00Z'], 'PrepareInterval' => ['description' => '准备间隔。', 'type' => 'string', 'example' => '03:00:00'], 'Region' => ['description' => '区域。', 'type' => 'string', 'example' => 'cn-shanghai-et15-b01'], 'ResultInfo' => ['description' => '结果信息（可忽略）。', 'type' => 'string', 'example' => '--'], 'StartTime' => ['description' => '开始时间。', 'type' => 'string', 'example' => '2021-06-15T16:00:00Z'], 'Status' => ['description' => '状态 ：'."\n" ."\n" .'- **3**：待执行 '."\n" .'- **4**：执行中', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], 'SubInsNames' => [ 'description' => '子实例列表。', 'type' => 'array', 'items' => ['description' => '子实例列表项。', 'type' => 'string', 'example' => 'pxc-xx'], ], 'SwitchTime' => ['description' => '切换时间。', 'type' => 'string', 'example' => '2021-06-15T16:00:00Z'], 'TaskType' => ['description' => '任务类型。', 'type' => 'string', 'example' => 'rds_apsaradb_transfer'], 'TaskTypeEn' => ['description' => '任务类型英文（可忽略）。', 'type' => 'string', 'example' => '--'], 'TaskTypeZh' => ['description' => '任务类型中文（可忽略）。', 'type' => 'string', 'example' => '--'], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => '该请求使用与先前相同但不相同的请求相同的客户端令牌。 除非请求相同，否则请勿将客户端令牌与其他请求重用。'], ], ], 'title' => '获取运维事件', 'changeSet' => [ ['createdAt' => '2021-11-24T08:08:20.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveOperationTasks'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 12,\\n \\"RequestId\\": \\"xxxx\\",\\n \\"PageNumber\\": 1,\\n \\"TotalRecordCount\\": 23,\\n \\"Items\\": [\\n {\\n \\"AllowCancel\\": \\"0\\",\\n \\"AllowChange\\": \\"0\\",\\n \\"ChangeLevel\\": \\"Risk\\",\\n \\"ChangeLevelEn\\": \\"Risk repairment\\",\\n \\"ChangeLevelZh\\": \\"风险修复\\",\\n \\"CreatedTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"CurrentAVZ\\": \\"cn-shanghai-et-a\\",\\n \\"DbType\\": \\"polarx\\",\\n \\"DbVersion\\": \\"2.0\\",\\n \\"Deadline\\": \\"2021-06-15T16:00:00Z\\",\\n \\"Id\\": 1,\\n \\"Impact\\": \\"--\\",\\n \\"ImpactEn\\": \\"Transient instance disconnection\\",\\n \\"ImpactZh\\": \\"中断\\",\\n \\"InsComment\\": \\"xxx\\",\\n \\"InsName\\": \\"pxc-dd\\",\\n \\"ModifiedTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"PrepareInterval\\": \\"03:00:00\\",\\n \\"Region\\": \\"cn-shanghai-et15-b01\\",\\n \\"ResultInfo\\": \\"--\\",\\n \\"StartTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"Status\\": 3,\\n \\"SubInsNames\\": [\\n \\"pxc-xx\\"\\n ],\\n \\"SwitchTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"TaskType\\": \\"rds_apsaradb_transfer\\",\\n \\"TaskTypeEn\\": \\"--\\",\\n \\"TaskTypeZh\\": \\"--\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 12\\n xxxx\\n 1\\n 23\\n \\n 0\\n 0\\n Risk\\n Risk repairment\\n 风险修复\\n 2021-06-15T16:00:00Z\\n cn-shanghai-et-a\\n polarx\\n 2.0\\n 2021-06-15T16:00:00Z\\n 1\\n --\\n Transient instance disconnection\\n 中断\\n xxx\\n pxc-dd\\n 2021-06-15T16:00:00Z\\n 03:00:00\\n cn-shanghai-et15-b01\\n --\\n 2021-06-15T16:00:00Z\\n 3\\n pxc-xx\\n 2021-06-15T16:00:00Z\\n rds_apsaradb_transfer\\n --\\n --\\n \\n","errorExample":""}]', ], 'DescribeArchiveTableList' => [ 'summary' => '冷存储表列表', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '137155', 'abilityTreeNodes' => ['FEATUREdrds9ED9RQ'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '100', 'minimum' => '20', 'description' => ''], ], [ 'name' => 'PageIndex', 'in' => 'query', 'schema' => ['title' => '分页下表， 从1开始', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '1000', 'minimum' => '1', 'description' => '分页下表， 从1开始'], ], [ 'name' => 'SchemaName', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => ''], ], [ 'name' => 'TableName', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'requestId', 'type' => 'string', 'description' => 'requestId'], 'Data' => [ 'title' => '数据', 'type' => 'object', 'properties' => [ 'Total' => ['title' => '总数', 'type' => 'integer', 'format' => 'int64', 'description' => '总数'], 'PageIndex' => ['title' => '页面下标', 'type' => 'integer', 'format' => 'int64', 'description' => '页面下标'], 'PageSize' => ['title' => '页面大小', 'type' => 'integer', 'format' => 'int64', 'description' => '页面大小'], 'Tables' => [ 'type' => 'array', 'items' => [ 'title' => '冷存储表信息', 'type' => 'object', 'properties' => [ 'SchemaName' => ['title' => '库名', 'type' => 'string', 'description' => '库名'], 'TableName' => ['title' => '表名', 'type' => 'string', 'description' => '表名'], 'CreatedDate' => ['title' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'description' => '创建时间'], 'SpaceSize' => ['title' => '占用空间大小', 'type' => 'number', 'format' => 'double', 'description' => '占用空间大小'], 'FileCount' => ['title' => '文件个数', 'type' => 'integer', 'format' => 'int32', 'description' => '文件个数'], 'LastSuccessArchiveTime' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], 'ArchiveStatus' => ['type' => 'string', 'description' => ''], ], 'description' => '冷存储表信息', ], 'description' => '', ], 'TobeArchivedConut' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'RunningCount' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'SuccessCount' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'PausedCount' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], ], 'description' => '数据', ], ], 'description' => '', ], ], ], 'changeSet' => [ ['createdAt' => '2022-07-28T08:28:31.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeArchiveTableList'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": {\\n \\"Total\\": 0,\\n \\"PageIndex\\": 0,\\n \\"PageSize\\": 0,\\n \\"Tables\\": [\\n {\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"CreatedDate\\": 0,\\n \\"SpaceSize\\": 0,\\n \\"FileCount\\": 0,\\n \\"LastSuccessArchiveTime\\": 0,\\n \\"ArchiveStatus\\": \\"\\"\\n }\\n ],\\n \\"TobeArchivedConut\\": 0,\\n \\"RunningCount\\": 0,\\n \\"SuccessCount\\": 0,\\n \\"PausedCount\\": 0\\n }\\n}","type":"json"}]', ], 'DescribeAvailableCrossRegions' => [ 'summary' => '该接口用于查询支持跨区域操作的可用区域列表，通常用于多区域部署或数据复制场景。', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '193733', 'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => false, 'example' => 'pxc-hzjasd****'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], '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' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], 'Message' => ['description' => '接口额外返回信息，成功返回success，错误返回对应错误码。', 'type' => 'string', 'example' => '*****'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '参数详情。', 'type' => 'array', 'items' => [ 'description' => '监控数据。', 'type' => 'object', 'properties' => [ 'Regions' => [ 'description' => '实例ID。', 'type' => 'array', 'items' => ['description' => '实例ID。', 'type' => 'string', 'example' => '[]'], ], ], ], ], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '查询夸可用区', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableCrossRegions'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Message\\": \\"*****\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Regions\\": [\\n \\"[]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', ], 'DescribeBackupPolicy' => [ 'summary' => '调用DescribeBackupPolicy接口查询实例备份设置。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '86236', 'abilityTreeNodes' => ['FEATUREdrdsE1M93A'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域的ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => ['description' => '返回信息，成功返回success，错误返回对应错误码。', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['description' => '请求ID。'."\n" ."\n", 'type' => 'string', 'example' => 'B87E2AB3-B7C9-4394-9160-7F639F732031'], 'Success' => ['description' => ' 请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '返回体。', 'type' => 'object', 'properties' => [ 'LogLocalRetentionSpace' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'DBInstanceName' => ['type' => 'string', 'description' => ''], 'BackupWay' => ['type' => 'string', 'description' => ''], 'BackupPeriod' => ['type' => 'string', 'description' => ''], 'ForceCleanOnHighSpaceUsage' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'BackupType' => ['type' => 'string', 'description' => ''], 'LocalLogRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'RemoveLogRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'BackupPlanBegin' => ['type' => 'string', 'description' => ''], 'BackupSetRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'IsEnabled' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'ColdDataBackupInterval' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'ColdDataBackupRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'LocalLogRetentionNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'IsCrossRegionDataBackupEnabled' => ['type' => 'boolean', 'description' => ''], 'IsCrossRegionLogBackupEnabled' => ['type' => 'boolean', 'description' => ''], 'DestCrossRegion' => ['type' => 'string', 'description' => ''], 'CrossRegionDataBackupRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'CrossRegionLogBackupRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'CrossRegionFilterValue' => ['type' => 'string'], ], ], ], ], ], ], 'title' => '查询实例备份设置', 'changeSet' => [ ['createdAt' => '2024-06-19T01:48:19.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2024-06-19T01:48:19.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2023-09-01T08:17:05.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2023-06-14T05:41:55.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2022-07-28T08:28:30.000Z', 'description' => '响应参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupPolicy'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"B87E2AB3-B7C9-4394-9160-7F639F732031\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LogLocalRetentionSpace\\": 0,\\n \\"DBInstanceName\\": \\"\\",\\n \\"BackupWay\\": \\"\\",\\n \\"BackupPeriod\\": \\"\\",\\n \\"ForceCleanOnHighSpaceUsage\\": 0,\\n \\"BackupType\\": \\"\\",\\n \\"LocalLogRetention\\": 0,\\n \\"RemoveLogRetention\\": 0,\\n \\"BackupPlanBegin\\": \\"\\",\\n \\"BackupSetRetention\\": 0,\\n \\"IsEnabled\\": 0,\\n \\"ColdDataBackupInterval\\": 0,\\n \\"ColdDataBackupRetention\\": 0,\\n \\"LocalLogRetentionNumber\\": 0,\\n \\"IsCrossRegionDataBackupEnabled\\": true,\\n \\"IsCrossRegionLogBackupEnabled\\": true,\\n \\"DestCrossRegion\\": \\"\\",\\n \\"CrossRegionDataBackupRetention\\": 0,\\n \\"CrossRegionLogBackupRetention\\": 0,\\n \\"CrossRegionFilterValue\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n B87E2AB3-B7C9-4394-9160-7F639F732031\\n true\\n \\n 30\\n pxc-xxxxxx\\n P\\n 1001000\\n 1\\n 0\\n 30\\n 7\\n 03:00Z\\n 7\\n 1\\n 30\\n 30\\n 60\\n false\\n false\\n cn-shanghai\\n 30\\n 30\\n \\n","errorExample":""}]', ], 'DescribeBackupSet' => [ 'summary' => '调用DescribeBackupSet接口查看备份集详情。', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '135043', 'abilityTreeNodes' => ['FEATUREdrdsE1M93A'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['title' => 'polardb-x实例名', 'description' => 'PolarDB-X实例名称。', 'type' => 'string', 'required' => true, 'example' => 'pxc-htri0ori2r****'], ], [ 'name' => 'BackupSetId', 'in' => 'query', 'schema' => ['title' => '备份集ID', 'description' => '备份集ID。', 'type' => 'string', 'required' => true, 'example' => '111'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '区域', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DestCrossRegion', 'in' => 'query', 'schema' => ['description' => '跨地域备份的目标地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'successs'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1A6D328C-84B8-40DC-BF49-6C73984D7494'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '数据列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'EndTime' => ['title' => '备份结束时间', 'description' => '备份结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1650251308000'], 'Status' => ['title' => '状态', 'description' => '备份集状态：'."\n" ."\n" .'- **0**： 备份中；'."\n" .'- **1**：备份成功；'."\n" .'- **2**：备份失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'BackupSetSize' => ['title' => '备份集大小', 'description' => '备份集大小， 单位为byte。'."\n" ."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '88803195'], 'BackupSetId' => ['title' => '备份集ID', 'description' => '备份集ID。'."\n" ."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '111'], 'BackupType' => ['title' => '备份类型', 'description' => '备份类型：'."\n" ."\n" .'- **0**：快速备份；'."\n" .'- **1**：一致性备份。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'BeginTime' => ['title' => '备份开始时间', 'description' => '备份开始时间。'."\n" ."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1650250861754'], 'BackupModel' => ['title' => '备份模式', 'description' => '备份模式：'."\n" ."\n" .'- **0**：自动备份；'."\n" .'- **1**：手动备份。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'OSSList' => [ 'description' => '备份集OSS信息列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'BackupSetFile' => ['title' => 'OSS 文件名', 'description' => 'OSS文件名。', 'type' => 'string', 'example' => 'hins3084_data_20220418110623_qp.xb'], 'LinkExpiredTime' => ['title' => '过期时间', 'description' => 'OSS文件链接过期时间。', 'type' => 'string', 'example' => '2022-04-20T08:01:37Z'], 'IntranetDownloadLink' => ['title' => '内网OSS 下载地址', 'description' => '内网OSS下载地址。', 'type' => 'string', 'example' => 'http://pre-rdsbak-cn-beijing.oss-cn-beijing-internal.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?'], 'DownloadLink' => ['title' => '外网下载地址', 'description' => '外网下载地址。', 'type' => 'string', 'example' => 'https://pre-rdsbak-cn-xxx.oss-cn-beijing.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?OSSAccessKeyId=LTAI****************&Expires=1650441697&dd=7KJzkUSbXf6dwy'], ], 'description' => '', ], ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], 'title' => 'DescribeBackupSet', 'changeSet' => [ ['createdAt' => '2023-09-01T08:17:04.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2022-12-07T03:41:43.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2022-04-18T08:41:04.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupSet'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successs\\",\\n \\"RequestId\\": \\"1A6D328C-84B8-40DC-BF49-6C73984D7494\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"EndTime\\": 1650251308000,\\n \\"Status\\": 1,\\n \\"BackupSetSize\\": 88803195,\\n \\"BackupSetId\\": 111,\\n \\"BackupType\\": 1,\\n \\"BeginTime\\": 1650250861754,\\n \\"BackupModel\\": 0,\\n \\"OSSList\\": [\\n {\\n \\"BackupSetFile\\": \\"hins3084_data_20220418110623_qp.xb\\",\\n \\"LinkExpiredTime\\": \\"2022-04-20T08:01:37Z\\",\\n \\"IntranetDownloadLink\\": \\"http://pre-rdsbak-cn-beijing.oss-cn-beijing-internal.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?\\",\\n \\"DownloadLink\\": \\"https://pre-rdsbak-cn-xxx.oss-cn-beijing.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?OSSAccessKeyId=LTAI****************&Expires=1650441697&dd=7KJzkUSbXf6dwy\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n successs\\n 1A6D328C-84B8-40DC-BF49-6C73984D7494\\n true\\n \\n 1650251308000\\n 1\\n 88803195\\n 111\\n 1\\n 1650250861754\\n 0\\n \\n hins3084_data_20220418110623_qp.xb\\n 2022-04-20T08:01:37Z\\n http://pre-rdsbak-cn-beijing.oss-cn-beijing-internal.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?\\n https://pre-rdsbak-cn-xxx.oss-cn-beijing.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?OSSAccessKeyId=LTAI****************&Expires=1650441697&dd=7KJzkUSbXf6dwy\\n \\n \\n","errorExample":""}]', ], 'DescribeBackupSetList' => [ 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86237', 'abilityTreeNodes' => ['FEATUREdrdsE1M93A'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域的ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。'."\n" ."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-xxxxxx'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => '开始时间的时间戳， 单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1635707845000'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => '结束时间的时间戳， 单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1635707845000'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => '每页的数据大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => '分页下标，从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'DestCrossRegion', 'in' => 'query', 'schema' => ['description' => '备份集所在的地域，指定后可返回某个具体地域的备份集，一次仅支持指定一个地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '返回信息，成功为success，错误返回错误码。', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1A6D328C-84B8-40DC-BF49-6C73984D7494'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'EndTime' => ['description' => '备份结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1635706960956'], 'Status' => ['description' => '备份集状态：'."\n" ."\n" .'- **0**： 备份中；'."\n" .'- **1**：备份成功；'."\n" .'- **2**：备份失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'BackupSetSize' => ['description' => '备份集大小， 单位为byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '88803195'], 'BackupSetId' => ['description' => '备份集ID。', 'type' => 'string', 'example' => '111'], 'BackupType' => ['description' => '备份类型：'."\n" ."\n" .'- **0**：快速备份；'."\n" .'- **1**：一致性备份。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'BeginTime' => ['description' => '备份开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1635706960956'], 'BackupModel' => ['description' => '备份模式：'."\n" ."\n" .'- **0**：自动备份；'."\n" .'- **1**：手动备份。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], 'description' => '', ], ], ], 'description' => '', ], ], ], 'title' => '查看备份集列表', 'summary' => '调用DescribeBackupSetList接口查看备份集列表。', 'changeSet' => [ ['createdAt' => '2024-06-19T01:48:18.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2024-06-19T01:48:18.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2023-09-01T08:17:04.000Z', 'description' => '请求参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupSetList'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1A6D328C-84B8-40DC-BF49-6C73984D7494\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"EndTime\\": 1635706960956,\\n \\"Status\\": 1,\\n \\"BackupSetSize\\": 88803195,\\n \\"BackupSetId\\": \\"111\\",\\n \\"BackupType\\": 1,\\n \\"BeginTime\\": 1635706960956,\\n \\"BackupModel\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 1A6D328C-84B8-40DC-BF49-6C73984D7494\\n true\\n \\n 1635706960956\\n 1\\n 88803195\\n 111\\n 1\\n 1635706960956\\n 0\\n \\n","errorExample":""}]', ], 'DescribeBinaryLogList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86238', 'abilityTreeNodes' => ['FEATUREdrdsAS582G'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => '分页获取当前binlog列表时，需填写当前页码，默认从第1页开始。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'pattern' => '^\\d+$', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => '每页获取binlog数量，默认填写30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '5', 'example' => '30', 'pattern' => '^\\d+$', 'default' => '30'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '当前实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hz1fds'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => '查询binlog列表开始时间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-09-09 10:27:46'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => '查询binlog列表结束时间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-11-09 10:27:46'], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9'], 'PageNumber' => ['description' => '当前查询的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'PageSize' => ['description' => '当前页显示的binlog数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], 'TotalNumber' => ['description' => '查询到的binlog文件总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'LogList' => [ 'description' => 'binlog文件列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'EndTime' => ['description' => '当前binlog结束时间。', 'type' => 'string', 'example' => '2021-11-09 10:27:46'], 'ModifiedTime' => ['description' => '最后更新时间。', 'type' => 'string', 'example' => '2021-11-09 10:27:46'], 'UploadHost' => ['description' => '备份host。', 'type' => 'string', 'example' => '10.110.88.9'], 'UploadStatus' => ['description' => '备份状态：'."\n" ."\n" .'- 0：未备份； '."\n" .'- 1：备份中； '."\n" .'- 2：已备份。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'DownloadLink' => ['description' => '文件下载链接，2天内有效。', 'type' => 'string', 'example' => 'http://polarx-cdc-binlog-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/polardbx_cdc/pxc-hzfd132143sfds1/binlog.000001?Expires=1636469502&OSSAccessKeyId=LT13fds12dsafddsf&Signature=fdpm%bdsfadsa%2F%bdsafdsaf%3D'], 'BeginTime' => ['description' => '日志开始时间。', 'type' => 'string', 'example' => '2021-09-09 10:27:46'], 'LogSize' => ['description' => '当前日志文件大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '536870912'], 'FileName' => ['description' => 'binlog文件名称。', 'type' => 'string', 'example' => 'binlog.000001'], 'CreatedTime' => ['description' => '文件创建时间。', 'type' => 'string', 'example' => '2021-09-09 10:27:46'], 'PurgeStatus' => ['description' => '清理状态：'."\n" ."\n" .'- 0：未删除； '."\n" .'- 1：已删除。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'Id' => ['description' => '当前记录的唯一ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], ], 'description' => '', ], ], ], 'description' => '', ], ], ], 'title' => '查询Binlog日志', 'summary' => '调用DescribeBinaryLogList接口查询Binlog日志。', 'description' => '- binlog文件默认保存15天。'."\n" .'- 返回的日志列表中包含日志记录结束时间在查询开始时间之后，并且日志记录开始时间在查询结束时间之前的所有日志。'."\n" .'- 当DownloadLink不为NULL时，用户可以根据此URL下载备份文件，此URL自生成后2天内有效，请在过期时间之前下载。', 'changeSet' => [ ['createdAt' => '2021-11-17T02:57:11.000Z', 'description' => '错误码发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBinaryLogList'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalNumber\\": 100,\\n \\"LogList\\": [\\n {\\n \\"EndTime\\": \\"2021-11-09 10:27:46\\",\\n \\"ModifiedTime\\": \\"2021-11-09 10:27:46\\",\\n \\"UploadHost\\": \\"10.110.88.9\\",\\n \\"UploadStatus\\": 2,\\n \\"DownloadLink\\": \\"http://polarx-cdc-binlog-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/polardbx_cdc/pxc-hzfd132143sfds1/binlog.000001?Expires=1636469502&OSSAccessKeyId=LT13fds12dsafddsf&Signature=fdpm%bdsfadsa%2F%bdsafdsaf%3D\\",\\n \\"BeginTime\\": \\"2021-09-09 10:27:46\\",\\n \\"LogSize\\": 536870912,\\n \\"FileName\\": \\"binlog.000001\\",\\n \\"CreatedTime\\": \\"2021-09-09 10:27:46\\",\\n \\"PurgeStatus\\": 0,\\n \\"Id\\": 100\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9\\n 1\\n 30\\n 100\\n \\n 2021-11-09 10:27:46\\n 2021-11-09 10:27:46\\n 10.110.88.9\\n 2\\n http://polarx-cdc-binlog-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/polardbx_cdc/pxc-hzfd132143sfds1/binlog.000001?Expires=1636469502&OSSAccessKeyId=LT13fds12dsafddsf&Signature=fdpm%bdsfadsa%2F%bdsafdsaf%3D\\n 2021-09-09 10:27:46\\n 536870912\\n binlog.000001\\n 2021-09-09 10:27:46\\n 0\\n 100\\n \\n","errorExample":""}]', ], 'DescribeCdcClassList' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '162466', 'abilityTreeNodes' => ['FEATUREdrdsAS582G'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pxc-hzjasd****'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => '实例名', 'type' => 'string', 'required' => false, 'example' => 'pxc-hzrh51fze****pon-cdc'], ], ], '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' => '6BA32080EEA'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'ClassCodeList' => [ 'description' => 'array', 'type' => 'array', 'items' => [ 'description' => 'object', 'type' => 'object', 'properties' => [ 'Mem' => ['description' => '租户总的内存大小，单位：GB。', 'type' => 'string', 'example' => '2048'], 'ClassCode' => ['description' => '实例规格。', 'type' => 'string', 'example' => 'polarx.n2.small.2e.cdc'], 'CpuCore' => ['description' => 'CPU核心数。', 'type' => 'string', 'example' => '2'], ], ], ], ], ], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '规格列表', 'summary' => '查询实例规格列表', 'description' => '- binlog文件默认保存15天。'."\n" .'- 返回的日志列表中包含日志记录结束时间在查询开始时间之后，并且日志记录开始时间在查询结束时间之前的所有日志。'."\n" .'- 当DownloadLink不为NULL时，用户可以根据此URL下载备份文件，此URL自生成后2天内有效，请在过期时间之前下载。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCdcClassList'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BA32080EEA\\",\\n \\"Data\\": {\\n \\"ClassCodeList\\": [\\n {\\n \\"Mem\\": \\"2048\\",\\n \\"ClassCode\\": \\"polarx.n2.small.2e.cdc\\",\\n \\"CpuCore\\": \\"2\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeCdcInfo' => [ 'summary' => '查询CDC信息。', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '162461', 'abilityTreeNodes' => ['FEATUREdrdsAS582G'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => '实例所在地域', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => '实例名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********'], ], ], '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' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], 'HttpStatusCode' => ['description' => '请求状态码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '200'], 'Success' => ['description' => '请求是否成功', 'type' => 'boolean', 'required' => true, 'example' => 'true'], 'Data' => [ 'description' => '实例数据', 'type' => 'object', 'properties' => [ 'CdcNewVersion' => ['description' => 'cdc最新版本', 'type' => 'string', 'required' => true, 'example' => 'polarx-cdc-kernel-***'], 'BinlogSize' => ['description' => 'binlog大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '524288000'], 'ServerId' => ['description' => 'server id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3014767486'], 'CheckSumSwitch' => ['description' => 'check sum开关', 'type' => 'string', 'example' => 'ON'], 'VersionSupportMultiCdc' => ['description' => '是否支持cdc多流', 'type' => 'boolean', 'example' => 'true'], 'BinlogPersistTime' => ['description' => 'binlog保存的天数', 'type' => 'integer', 'format' => 'int32', 'example' => '15'], 'InstanceTopologyList' => [ 'description' => '实例列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceName' => ['description' => '实例名', 'type' => 'string', 'example' => 'pxc-***'], 'Comment' => ['description' => '实例类型备注', 'type' => 'string', 'example' => '***'], 'PhysicalNodes' => [ 'description' => '节点数组', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Disk' => ['description' => '磁盘大小，MB', 'type' => 'integer', 'format' => 'int32', 'example' => '204800'], 'NodeClass' => ['description' => '实例规格', 'type' => 'string', 'example' => 'polarx.x4.large.2e.cdc'], 'Version' => ['description' => '实例版本', 'type' => 'string', 'example' => 'polarx-cdc-kernel-***'], 'AZone' => ['description' => '实例所在可用区', 'type' => 'string', 'example' => 'cn-hangzhou-h'], 'Status' => ['description' => '实例状态', 'type' => 'string', 'example' => 'ACTIVATION'], 'NodeId' => ['description' => '节点id', 'type' => 'string', 'example' => '***'], 'NodeName' => ['description' => '节点的名称。', 'type' => 'string', 'example' => 'pxc-c-***'], ], 'description' => '', ], ], 'GroupName' => ['description' => '多流流组名称', 'type' => 'string', 'example' => 'test'], 'HashLevel' => ['description' => '拆分级别', 'type' => 'string', 'example' => 'RECORD'], 'StreamNum' => ['description' => '拆分数量', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'ClusterType' => ['description' => '集群类型', 'type' => 'string', 'example' => 'BINLOG_X'], ], 'description' => '', ], ], 'EnableCyclicReplication' => ['description' => '支持双向复制', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '查询CDC实例信息', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCdcInfo'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CdcNewVersion\\": \\"polarx-cdc-kernel-***\\",\\n \\"BinlogSize\\": 524288000,\\n \\"ServerId\\": 3014767486,\\n \\"CheckSumSwitch\\": \\"ON\\",\\n \\"VersionSupportMultiCdc\\": true,\\n \\"BinlogPersistTime\\": 15,\\n \\"InstanceTopologyList\\": [\\n {\\n \\"InstanceName\\": \\"pxc-***\\",\\n \\"Comment\\": \\"***\\",\\n \\"PhysicalNodes\\": [\\n {\\n \\"Disk\\": 204800,\\n \\"NodeClass\\": \\"polarx.x4.large.2e.cdc\\",\\n \\"Version\\": \\"polarx-cdc-kernel-***\\",\\n \\"AZone\\": \\"cn-hangzhou-h\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"NodeId\\": \\"***\\",\\n \\"NodeName\\": \\"pxc-c-***\\"\\n }\\n ],\\n \\"GroupName\\": \\"test\\",\\n \\"HashLevel\\": \\"RECORD\\",\\n \\"StreamNum\\": 2,\\n \\"ClusterType\\": \\"BINLOG_X\\"\\n }\\n ],\\n \\"EnableCyclicReplication\\": true\\n }\\n}","type":"json"}]', ], 'DescribeCdcVersionList' => [ 'summary' => '获取CDC版本列表', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '167760', 'abilityTreeNodes' => ['FEATUREdrdsV6IT1E'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => '实例所属地域的ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => false, 'example' => 'pxc-bjrl7****k2vp7'], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['type' => 'string'], ], ], 'responses' => [ 200 => [ 'headers' => [], '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' => '97632117-E477-5FE8-B424-F059CBBDD919'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'VersionList' => [ 'description' => '关联的旧版项目id，可忽略', 'type' => 'array', 'items' => ['description' => '关联的旧版项目id，可忽略', 'type' => 'string', 'example' => '[{\'Version\': \'2022-07-28\'}]'], ], ], ], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CDC版本获取', 'description' => '- binlog文件默认保存15天。'."\n" .'- 返回的日志列表中包含日志记录结束时间在查询开始时间之后，并且日志记录开始时间在查询结束时间之前的所有日志。'."\n" .'- 当DownloadLink不为NULL时，用户可以根据此URL下载备份文件，此URL自生成后2天内有效，请在过期时间之前下载。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCdcVersionList'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeCdcVersionList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"97632117-E477-5FE8-B424-F059CBBDD919\\",\\n \\"Data\\": {\\n \\"VersionList\\": [\\n \\"[{\'Version\': \'2022-07-28\'}]\\"\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeCharacterSet' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。'."\n" ."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-*********'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域的ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '返回信息，正确返回success，错误返回错误码。', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['description' => '请求ID。'."\n" ."\n", 'type' => 'string', 'example' => '709C1E40-092D-4A3D-9958-6D7438******'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'Engine' => ['description' => '目标实例下数据库的存储类型，目前仅支持polarx。'."\n" ."\n", 'type' => 'string', 'example' => 'polarx'], 'CharacterSet' => [ 'description' => '实例支持的字符编码集，取值范围如下：'."\n" ."\n" .'- utf8mb4'."\n" .'- gbk'."\n" .'- latin1'."\n" .'- utf8', 'type' => 'array', 'items' => ['description' => '字符集。', 'type' => 'string', 'example' => 'utf8'], ], ], ], ], 'description' => '', ], ], ], 'title' => '查询字符集', 'summary' => '调用DescribeCharacterSet接口查询目标实例下数据库所支持的字符集类型。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCharacterSet'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"709C1E40-092D-4A3D-9958-6D7438******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Engine\\": \\"polarx\\",\\n \\"CharacterSet\\": [\\n \\"utf8\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 709C1E40-092D-4A3D-9958-6D7438******\\n true\\n \\n polarx\\n utf8\\n \\n","errorExample":""}]', ], 'DescribeColdDataBasicInfo' => [ 'summary' => '冷存储基础信息', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '137149', 'abilityTreeNodes' => ['FEATUREdrdsONAWER'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'requestId', 'type' => 'string', 'description' => 'requestId'], 'Data' => [ 'title' => '详情信息', 'type' => 'object', 'properties' => [ 'EnableStatus' => ['title' => '是否开启冷存储', 'type' => 'boolean', 'description' => '是否开启冷存储'], 'CloudProduct' => ['title' => '底层存储云产品', 'type' => 'string', 'description' => '底层存储云产品'], 'VolumeName' => ['title' => '存储卷名', 'type' => 'string', 'description' => '存储卷名'], 'BackupSetSpaceSize' => ['title' => '有效备份集数据大小', 'type' => 'number', 'format' => 'double', 'description' => '有效备份集数据大小'], 'BackupSetCount' => ['title' => '备份集个数', 'type' => 'integer', 'format' => 'int32', 'description' => '备份集个数'], 'CurrentSpaceSize' => ['title' => '冷存储数据大小', 'type' => 'number', 'format' => 'double', 'description' => '冷存储数据大小'], 'DataRedundancyType' => ['type' => 'string', 'description' => ''], 'WriteAccessNum' => ['type' => 'number', 'format' => 'double', 'description' => ''], 'ReadAccessNum' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], 'RegionId' => ['type' => 'string', 'description' => ''], ], 'description' => '详情信息', ], ], 'description' => '', ], ], ], 'changeSet' => [ ['createdAt' => '2022-07-28T08:28:31.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeColdDataBasicInfo'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": {\\n \\"EnableStatus\\": true,\\n \\"CloudProduct\\": \\"\\",\\n \\"VolumeName\\": \\"\\",\\n \\"BackupSetSpaceSize\\": 0,\\n \\"BackupSetCount\\": 0,\\n \\"CurrentSpaceSize\\": 0,\\n \\"DataRedundancyType\\": \\"\\",\\n \\"WriteAccessNum\\": 0,\\n \\"ReadAccessNum\\": 0,\\n \\"RegionId\\": \\"\\"\\n }\\n}","type":"json"}]', ], 'DescribeColumnarClassList' => [ 'summary' => '查询实例列存规格列表', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '198142', 'abilityTreeNodes' => ['FEATUREdrdsGUBPOK'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。'."\n" ."\n", 'type' => 'string', 'required' => true, 'example' => 'pxc-********'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => '实例名', 'type' => 'string', 'required' => false, 'example' => 'pxc-shrvdc****wtf5uk-cdc'], ], ], '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' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'ClassCodeList' => [ 'description' => 'object', 'type' => 'array', 'items' => [ 'description' => 'object', 'type' => 'object', 'properties' => [ 'Mem' => ['description' => '内存大小，单位：GB。', 'type' => 'string', 'example' => '2048'], 'ClassCode' => ['description' => '实例规格。', 'type' => 'string', 'example' => 'polarx.n8.large.col'], 'CpuCore' => ['description' => 'CPU核数。', 'type' => 'string', 'example' => '2'], ], ], ], ], ], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '查询列存规格列表', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeColumnarClassList'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\",\\n \\"Data\\": {\\n \\"ClassCodeList\\": [\\n {\\n \\"Mem\\": \\"2048\\",\\n \\"ClassCode\\": \\"polarx.n8.large.col\\",\\n \\"CpuCore\\": \\"2\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeColumnarInfo' => [ 'summary' => '查询列存信息', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '197943', 'abilityTreeNodes' => ['FEATUREdrdsGUBPOK'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => '实例所在地域ID。'."\n" .'> 您可以调用[DescribeRegions](~~196841~~)接口查看PolarDB-X支持的地域详情，包括地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****'], ], ], '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' => '14036EBE-****-44DB-ACE9-AC6157D3A6FC'], 'HttpStatusCode' => ['description' => '请求状态码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '200'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'ColumnarNewVersion' => ['description' => '列存新版本', 'type' => 'string', 'required' => true, 'example' => 'polarx-col-kernel-5.4.20-20250819_17555906'], 'BinlogSize' => ['description' => 'binlog大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '524288000'], 'ServerId' => ['description' => 'server id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '53755321'], 'CheckSumSwitch' => ['description' => 'check sum开关', 'type' => 'string', 'example' => 'ON'], 'BinlogPersistTime' => ['description' => 'binlog保存的天数', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], 'ColumnarVersion' => ['description' => '列存版本', 'type' => 'string', 'example' => 'polarx-col-kernel-5.4.20-20250819_17555906'], 'ClassCode' => ['description' => '实例规格', 'type' => 'string', 'example' => 'polarx.n8.medium.col'], 'InstanceTopologyList' => [ 'description' => '实例列表', 'type' => 'array', 'items' => [ 'description' => '实例列表', 'type' => 'object', 'properties' => [ 'InstanceName' => ['description' => '实例名', 'type' => 'string', 'example' => 'pxc-***'], 'Comment' => ['description' => '实例类型备注', 'type' => 'string', 'example' => '***'], 'PhysicalNodes' => [ 'description' => '节点数组', 'type' => 'array', 'items' => [ 'description' => '节点数组', 'type' => 'object', 'properties' => [ 'Disk' => ['description' => '磁盘大小，MB', 'type' => 'integer', 'format' => 'int32', 'example' => '204800'], 'NodeClass' => ['description' => '实例规格', 'type' => 'string', 'example' => 'polarx.n8.medium.col'], 'Version' => ['description' => '实例版本', 'type' => 'string', 'example' => 'polarx-col-kernel-5.4.20-20250819_17555906'], 'AZone' => ['description' => '实例所在可用区', 'type' => 'string', 'example' => 'cn-hangzhou-h'], 'Status' => ['description' => '实例状态', 'type' => 'string', 'example' => 'ACTIVATION'], 'NodeId' => ['description' => '节点id', 'type' => 'string', 'example' => '***'], ], ], ], ], ], ], ], ], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '查询列存信息', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeColumnarInfo'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-****-44DB-ACE9-AC6157D3A6FC\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ColumnarNewVersion\\": \\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\n \\"BinlogSize\\": 524288000,\\n \\"ServerId\\": 53755321,\\n \\"CheckSumSwitch\\": \\"ON\\",\\n \\"BinlogPersistTime\\": 30,\\n \\"ColumnarVersion\\": \\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\n \\"ClassCode\\": \\"polarx.n8.medium.col\\",\\n \\"InstanceTopologyList\\": [\\n {\\n \\"InstanceName\\": \\"pxc-***\\",\\n \\"Comment\\": \\"***\\",\\n \\"PhysicalNodes\\": [\\n {\\n \\"Disk\\": 204800,\\n \\"NodeClass\\": \\"polarx.n8.medium.col\\",\\n \\"Version\\": \\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\n \\"AZone\\": \\"cn-hangzhou-h\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"NodeId\\": \\"***\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeColumnarVersionList' => [ 'summary' => '查询列存版本信息', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '198141', 'abilityTreeNodes' => ['FEATUREdrdsV6IT1E'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => '实例名称。'."\n" ."\n", 'type' => 'string', 'required' => false, 'example' => 'pxc-hzjasd****'], ], ], 'responses' => [ 200 => [ 'headers' => [], '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' => '9B2F3840-****-475C-B269-2D5C3A31797C'], 'Data' => [ 'description' => '参数详情。', 'type' => 'object', 'properties' => [ 'VersionList' => [ 'description' => '版本列表', 'type' => 'array', 'items' => ['description' => '字符串', 'type' => 'string', 'example' => 'string'], 'enumValueTitles' => ['[\\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\"polarx-col-kernel-5.4.20-20250714_17524769\\",\\"polarx-col-kernel-5.4.20-20250618_17502340\\",\\"polarx-col-kernel-5.4.20-20250606_17491985_hotfix\\",\\"polarx-col-kernel-5.4.20-20250529_17484868\\",\\"polarx-col-kernel-5.4.20-20250328_17431324\\",\\"polarx-col-kernel-5.4.20-20250210_17391594\\",\\"polarx-col-kernel-5.4.20-20241224_17350237\\"]' => '[\\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\"polarx-col-kernel-5.4.20-20250714_17524769\\",\\"polarx-col-kernel-5.4.20-20250618_17502340\\",\\"polarx-col-kernel-5.4.20-20250606_17491985_hotfix\\",\\"polarx-col-kernel-5.4.20-20250529_17484868\\",\\"polarx-col-kernel-5.4.20-20250328_17431324\\",\\"polarx-col-kernel-5.4.20-20250210_17391594\\",\\"polarx-col-kernel-5.4.20-20241224_17350237\\"]'], ], ], ], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '查询列存版本信息', 'description' => '- binlog文件默认保存15天。'."\n" .'- 返回的日志列表中包含日志记录结束时间在查询开始时间之后，并且日志记录开始时间在查询结束时间之前的所有日志。'."\n" .'- 当DownloadLink不为NULL时，用户可以根据此URL下载备份文件，此URL自生成后2天内有效，请在过期时间之前下载。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeColumnarVersionList'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-****-475C-B269-2D5C3A31797C\\",\\n \\"Data\\": {\\n \\"VersionList\\": [\\n \\"string\\"\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeComponentPropeties' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。>您可以调用[describeregions](~~196841~~)接口查看polardb-x支持的地域详情，包括地域id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'CommodityCode', 'in' => 'query', 'schema' => ['description' => '商品类型。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'learn_EasDedicatedPrepay_public_cn'], ], [ 'name' => 'ComponentName', 'in' => 'query', 'schema' => ['title' => '资源组ID', 'description' => '资源组ID', 'type' => 'string', 'required' => true, 'example' => 'rg-xxxxx'], ], [ 'name' => 'StorageType', 'in' => 'query', 'schema' => ['description' => '存储类型', 'type' => 'string', 'required' => false, 'example' => 'cloud_auto'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => 'A501A191-BD70-5E50-98A9-C2A486A82****'], 'Properties' => [ 'description' => '异常事件的导出参数。', 'type' => 'array', 'items' => [ 'description' => '异常事件的导出参数。', 'type' => 'object', 'properties' => [ 'PropertyCode' => ['description' => '商品模块。', 'type' => 'string', 'example' => 'dn_node_spec'], 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => '4核32G'], 'OrderIndex' => ['description' => '商品模块属性显示顺序。'."\n" ."\n" .'不同商品模块返回内容不同。', 'type' => 'string', 'example' => '1'], 'Value' => ['description' => '标签值', 'type' => 'string', 'example' => '172.27.35.'], ], ], ], ], 'description' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '查询组件属性', 'summary' => '该接口用于获取指定组件的属性信息，包括属性名称、类型等。', 'changeSet' => [ ['createdAt' => '2025-11-25T08:38:45.000Z', 'description' => '请求参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentPropeties'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A501A191-BD70-5E50-98A9-C2A486A82****\\",\\n \\"Properties\\": [\\n {\\n \\"PropertyCode\\": \\"dn_node_spec\\",\\n \\"Name\\": \\"4核32G\\",\\n \\"OrderIndex\\": \\"1\\",\\n \\"Value\\": \\"172.27.35.\\"\\n }\\n ]\\n}","type":"json"}]', ], 'DescribeCustomEndpointList' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '236590', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => true, 'example' => 'pxc-xxx'], ], [ 'name' => 'CustomEndpointIds', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['title' => '自定义连接ID，多个ID使用英文逗号分隔', 'description' => '自定义域名ID', 'type' => 'string', 'required' => false, 'example' => 'pxe-b6e****no4pfap1s'], ], [ 'name' => 'CheckDeleteCN', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['title' => '', 'description' => '查询CN是否被删除', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => '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' => '6352AC16-76BF-5135-B1EA-ED49293526E6'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'CanDeleteCount' => ['description' => '是否是可删除节点。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'Endpoints' => [ 'description' => 'Endpoint详细信息。', 'type' => 'array', 'items' => [ 'description' => 'Endpoint详细信息。', 'type' => 'object', 'properties' => [ 'CustomEndpointId' => ['description' => '用户端域名id。', 'type' => 'string', 'example' => 'pxe-b6e****o4pfap1s'], 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'Name'], 'DBInstanceName' => ['description' => '实例ID。'."\n" ."\n", 'type' => 'string', 'example' => 'pxc-hz****zoxherr7'], 'ConnectionString' => ['description' => '实例连接地址', 'type' => 'string', 'example' => 'pxc-shra****zq0j01.polarx.rds.aliyuncs.com'], 'Port' => ['description' => '实例连接端口', 'type' => 'integer', 'format' => 'int32', 'example' => '3306'], 'VpcId' => ['description' => '访问端点所在的专有网络ID。', 'type' => 'string', 'example' => 'vpc-uf61h****dj1zg5fqp5x7'], 'VSwitchId' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-8vbkw****5yh4nrd639ih'], 'NodeAutoEnter' => ['description' => '节点在被添加或恢复后，是否自动加入集群并开始提供服务', 'type' => 'string', 'example' => 'true'], 'NodeRole' => ['description' => '若希望查询云原生版读写分离架构实例中只读节点的指标，您在传入具体**NodeId**的同时，还需要在本参数传入**READONLY**。'."\n" .'> 其余情况请无需传入（或传入**MASTER**）。', 'type' => 'string', 'example' => 'same_azone_as_last'], 'CnNames' => [ 'description' => '[\\"pxc-i-vb1sqa7llp\\",\\"pxc-i-bemprx50ad\\"]', 'type' => 'array', 'items' => ['description' => 'string', 'type' => 'string', 'example' => 'string'], ], 'Status' => ['description' => '状态', 'type' => 'string', 'example' => 'created'], ], ], ], ], ], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => '查询自用户定义域名列表', 'summary' => '查询自用户定义域名列表', 'description' => '该接口用于获取用户已配置的自定义终端节点（Endpoint）列表，便于管理和查看私有连接或VPC终端服务的设置。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomEndpointList'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6352AC16-76BF-5135-B1EA-ED49293526E6\\",\\n \\"Data\\": {\\n \\"CanDeleteCount\\": 0,\\n \\"Endpoints\\": [\\n {\\n \\"CustomEndpointId\\": \\"pxe-b6e****o4pfap1s\\",\\n \\"Name\\": \\"Name\\",\\n \\"DBInstanceName\\": \\"pxc-hz****zoxherr7\\",\\n \\"ConnectionString\\": \\"pxc-shra****zq0j01.polarx.rds.aliyuncs.com\\",\\n \\"Port\\": 3306,\\n \\"VpcId\\": \\"vpc-uf61h****dj1zg5fqp5x7\\",\\n \\"VSwitchId\\": \\"vsw-8vbkw****5yh4nrd639ih\\",\\n \\"NodeAutoEnter\\": \\"true\\",\\n \\"NodeRole\\": \\"same_azone_as_last\\",\\n \\"CnNames\\": [\\n \\"string\\"\\n ],\\n \\"Status\\": \\"created\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeDBInstanceAttribute' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '86240', 'abilityTreeNodes' => ['FEATUREdrds9ED9RQ'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['title' => '资源组ID', 'description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzaxhezhs5***'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], 'DBInstance' => [ 'description' => '数据库实例信息。', 'type' => 'object', 'properties' => [ 'Type' => ['description' => '实例类型：'."\n" ."\n" .'- **ReadWrite**： 主实例；'."\n" .'- **ReadOnly**： 只读实例。', 'type' => 'string', 'example' => 'ReadWrite'], 'Status' => ['description' => '实例状态，详情请参见[实例状态表](~~339826~~)。', 'type' => 'string', 'example' => 'Running'], 'RightsSeparationStatus' => ['description' => '三权分立状态：'."\n" ."\n" .'- **disabled**：未开启；'."\n" .'- **enabled**：开启；'."\n" .'- **processing**： 处理中；'."\n" .'- **unknown**：未知，可能是实例无法连接导致。', 'type' => 'string', 'example' => 'disabled'], 'DBNodeCount' => ['description' => '实例节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'Expired' => ['description' => '是否过期：'."\n" ."\n" .'- **true**：过期；'."\n" .'- **false**：正常。', 'type' => 'string', 'example' => 'false'], 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-08-31T08:56:25.000+0000'], 'PayType' => ['description' => '实例付费方式，取值：'."\n" ."\n" .'- **Postpaid**：按量付费；'."\n" .'- **Prepaid**：包年包月。', 'type' => 'string', 'example' => 'Postpaid'], 'Port' => ['description' => '内网连接端口。', 'type' => 'string', 'example' => '3306'], 'LockMode' => ['description' => '实例锁定模式：'."\n" ."\n" .'- **Unlock**：正常；'."\n" .'- **ManualLock**：手动触发锁定；'."\n" .'- **LockByExpiration**：实例过期自动锁定；'."\n" .'- **LockByRestoration**：实例回滚前的自动锁定；'."\n" .'- **LockByDiskQuota**：实例空间满自动锁定；'."\n" .'- **LockReadInstanceByDiskQuota**：只读实例空间满自动锁定。', 'type' => 'string', 'example' => 'Unlock'], 'Description' => ['description' => '实例描述。', 'type' => 'string', 'example' => 'test instance'], 'ConnectionString' => ['description' => '内网连接信息。', 'type' => 'string', 'example' => 'pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com'], 'StorageUsed' => ['description' => '已经使用的存储，单位为B。', 'type' => 'integer', 'format' => 'int64', 'example' => '17042505728'], 'ExpireDate' => ['description' => '到期时间。格式为yyyy-MM-ddTHH:mm:ss.sss+0000（UTC时间）。', 'type' => 'string', 'example' => '2022-08-31T16:00:00.000+0000'], 'CommodityCode' => ['description' => '实例商品种类，固定取值为drds_polarxpost_public_cn。', 'type' => 'string', 'example' => 'drds_polarxpost_public_cn'], 'MaintainStartTime' => ['description' => '实例可维护开始时间，此处为UTC时间，加8小时才是控制台上显示的可维护时间段。', 'type' => 'string', 'example' => '06:00'], 'DBInstanceType' => ['description' => '实例类型：'."\n" ."\n" .'- **ReadWrite**： 主实例；'."\n" .'- **ReadOnly**： 只读实例。', 'type' => 'string', 'example' => 'ReadWrite'], 'DBNodeClass' => ['description' => '实例节点规格。', 'type' => 'string', 'example' => 'polarx.x4.large.2e'], 'LatestMinorVersion' => ['description' => '当前实例支持的最新内核版本。', 'type' => 'string', 'example' => 'polarx-kernel_5.4.11-16301083_xcluster-20210805'], 'MaintainEndTime' => ['description' => '实例可维护结束时间，此处为UTC时间，加8小时为控制台上显示的可维护时间段。', 'type' => 'string', 'example' => '06:00'], 'DBType' => ['description' => '数据库类型，固定取值为polarx。', 'type' => 'string', 'example' => 'polarx'], 'RightsSeparationEnabled' => ['description' => '三权分立状态：'."\n" ."\n" .'- **false**：未开启'."\n" .'- **true**：开启', 'type' => 'boolean', 'example' => 'false'], 'VPCId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-xxxxx'], 'MinorVersion' => ['description' => '当前内核版本。', 'type' => 'string', 'example' => 'polarx-kernel_5.4.11-16301083_xcluster-20210805'], 'RegionId' => ['description' => '实例所在地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], 'Network' => ['description' => '实例的网络类型，仅支持取值VPC，表示专有网络。', 'type' => 'string', 'example' => 'VPC'], 'DBVersion' => ['description' => '数据库版本。', 'type' => 'string', 'example' => '5.5'], 'VSwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-********'], 'ZoneId' => ['description' => '实例所在可用区。', 'type' => 'string', 'example' => 'cn-hangzhou-a'], 'Engine' => ['description' => '数据库类型，固定取值为polarx。', 'type' => 'string', 'example' => 'polarx'], 'KindCode' => ['description' => '实例引擎版本，内部参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '18'], 'Id' => ['description' => '主实例的ID，如果没有返回此参数则表示该实例是主实例。', 'type' => 'string', 'example' => 'pxc-zkralxpc5d****'], 'DBNodes' => [ 'description' => '数据库节点信息。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ComputeNodeId' => ['description' => '计算节点名称。', 'type' => 'string', 'example' => 'pxc-i-********'], 'NodeClass' => ['description' => '节点规格。', 'type' => 'string', 'example' => 'polarx.x4.large.2e'], 'DataNodeId' => ['description' => '存储节点名称。', 'type' => 'string', 'example' => 'pxc-xdb-xxxxxx'], 'ZoneId' => ['description' => '节点所在可用区名称。', 'type' => 'string', 'example' => 'cn-hangzhou-a'], 'Id' => ['description' => '逻辑节点ID。', 'type' => 'string', 'example' => 'pxi-*********'], 'RegionId' => ['description' => '节点所在地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], ], 'description' => '', ], ], 'ConnAddrs' => [ 'description' => '连接地址信息。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => ['description' => '连接的种类，**VPC**为内网连接，**PUBLIC**为公网连接。', 'type' => 'string', 'example' => 'VPC'], 'VSwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-*********'], 'Port' => ['description' => '连接端口号。', 'type' => 'integer', 'format' => 'int64', 'example' => '3306'], 'VPCId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-xxxxxx'], 'ConnectionString' => ['description' => '连接地址。', 'type' => 'string', 'example' => 'polardbx-xxx.aliyuncs.com'], 'VpcInstanceId' => ['description' => 'vpc 内部CloudInstanceId，可以忽略', 'type' => 'string', 'example' => 'pxc-zkralxpc5d****'], ], 'description' => '', ], ], 'ReadDBInstances' => [ 'description' => '只读实例名称列表。', 'type' => 'array', 'items' => ['description' => '只读实例名称。', 'type' => 'string', 'example' => 'pxr-*********'], ], 'ColumnarReadDBInstances' => [ 'description' => '列存只读实例信息。', 'type' => 'array', 'items' => ['title' => '', 'description' => '列存只读实例信息。', 'type' => 'string', 'example' => 'xxx'], ], 'ResourceGroupId' => ['title' => '资源组ID', 'description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-*********'], 'TagSet' => [ 'title' => '标签集合', 'description' => '标签集合。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['title' => '标签名称', 'description' => '标签名称。', 'type' => 'string', 'example' => 'key2'], 'Value' => ['title' => '标签值', 'description' => '标签值。', 'type' => 'string', 'example' => 'value2'], ], 'description' => '', ], ], 'CnNodeCount' => ['description' => 'CN节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'DnNodeCount' => ['description' => 'DN节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'CnNodeClassCode' => ['description' => 'CN节点规格：'."\n" .'- **polarx.x4.medium.2e**：2核8G'."\n" .'- **polarx.x4.large.2e**：4核16G'."\n" .'- **polarx.x8.large.2e**：4核32G'."\n" .'- **polarx.x4.xlarge.2e**：8核32G'."\n" .'- **polarx.x8.xlarge.2e**：8核64G'."\n" .'- **polarx.x4.2xlarge.2e**：16核64G'."\n" .'- **polarx.x8.2xlarge.2e**：16核128G'."\n" .'- **polarx.x4.4xlarge.2e**：32核128G'."\n" .'- **polarx.x8.4xlarge.2e**：32核256G'."\n" .'- **polarx.st.8xlarge.2e**：60核470G'."\n" .'- **polarx.st.12xlarge.2e**：90核720G', 'type' => 'string', 'example' => 'polarx.x4.xlarge.2e'], 'DnNodeClassCode' => ['description' => 'DN节点规格：'."\n" .'- **mysql.n2.medium.25**：2核4G'."\n" .'- **mysql.n4.medium.25**：2核8G'."\n" .'- **mysql.x8.medium.25**：2核16G'."\n" .'- **mysql.n2.large.25**：4核8G'."\n" .'- **mysql.n4.large.25**：4核16G'."\n" .'- **mysql.x8.large.25**：4核32G'."\n" .'- **mysql.n2.xlarge.25**：8核16G'."\n" .'- **mysql.n4.xlarge.25**：8核32G'."\n" .'- **mysql.x8.xlarge.25**：8核64G'."\n" .'- **mysql.n4.2xlarge.25**：16核64G'."\n" .'- **mysql.x8.2xlarge.25**：16核128G'."\n" .'- **mysql.x4.4xlarge.25**：32核128G'."\n" .'- **mysql.x8.4xlarge.25**：32核256G'."\n" .'- **mysql.st.8xlarge.25**：60核470G'."\n" .'- **mysql.st.12xlarge.25**：90核720G', 'type' => 'string', 'example' => 'mysql.x8.large.25'], 'Series' => ['description' => '实例系列，取值如下：'."\n" ."\n" .'- **enterprise**：企业版'."\n" .'- **standard**：标准版', 'type' => 'string', 'example' => 'enterprise'], 'LTSVersions' => [ 'type' => 'array', 'items' => ['description' => 'LTS版本号。', 'type' => 'string', 'example' => 'X.X.X.X'], 'required' => true, 'description' => '', ], 'TopologyType' => ['title' => '拓扑类型：'."\n" ."\n" .'- **3azones**：三可用区；'."\n" .'- **1azone**：单可用区。', 'description' => '拓扑类型：'."\n" ."\n" .'- **3azones**：三可用区；'."\n" .'- **1azone**：单可用区。', 'type' => 'string', 'deprecated' => false, 'required' => true, 'example' => '3azones', 'pattern' => '', 'default' => '3azones'], 'PrimaryZone' => ['title' => '主可用区。', 'description' => '主可用区。', 'type' => 'string', 'deprecated' => false, 'required' => true, 'example' => 'cn-shenzhen-e', 'pattern' => '', 'default' => ''], 'SecondaryZone' => ['title' => '次可用区。', 'description' => '次可用区。', 'type' => 'string', 'deprecated' => false, 'example' => 'cn-shenzhen-a', 'pattern' => '', 'default' => ''], 'TertiaryZone' => ['title' => '第三可用区。', 'description' => '第三可用区。', 'type' => 'string', 'deprecated' => false, 'example' => 'cn-shenzhen-e', 'pattern' => '', 'default' => ''], 'DifferentDNSpec' => [ 'description' => '实例的DN节点之间的规格是否相同，取值如下：'."\n" ."\n" .'- true：规格不同'."\n" .'- false：规格相同', 'type' => 'boolean', 'enumValueTitles' => [], 'example' => 'false', ], 'ColumnarInstanceName' => ['description' => '列存引擎实例名称。', 'type' => 'string', 'example' => 'xxxx'], 'CanNotCreateColumnar' => ['description' => '是否支持列存索引功能。', 'type' => 'boolean', 'example' => 'true'], 'GdnInstanceName' => ['type' => 'string', 'description' => ''], 'GdnMemberList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Role' => ['type' => 'string', 'description' => ''], 'MemberName' => ['type' => 'string', 'description' => ''], 'Status' => ['type' => 'string', 'description' => ''], ], 'description' => '', ], 'description' => '', ], 'SpecCategory' => ['type' => 'string', 'description' => ''], 'GdnRole' => ['type' => 'string', 'description' => ''], 'PrimaryInstanceId' => ['type' => 'string', 'description' => ''], 'StorageType' => ['type' => 'string', 'description' => ''], 'CpuType' => ['type' => 'string', 'description' => ''], 'EngineVersion' => ['type' => 'string', 'description' => ''], 'DnStorageSpace' => ['description' => 'DN数据节点磁盘空间大小，单位GB', 'type' => 'string'], 'AiGatewayEnabled' => ['type' => 'string'], ], ], ], 'description' => '', ], ], ], 'title' => '查询实例属性', 'summary' => '调用DescribeDBInstanceAttribute接口获取实例属性。', 'changeSet' => [ ['createdAt' => '2025-12-18T14:58:28.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2025-07-16T13:57:44.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2025-07-16T13:57:44.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2025-07-16T13:57:44.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2025-07-03T12:46:48.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2024-12-13T12:18:59.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2024-06-27T07:25:11.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2024-05-23T13:51:12.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2023-11-14T01:40:58.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2023-11-03T07:24:16.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2023-09-14T06:50:41.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2022-12-15T06:20:33.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2022-09-28T08:48:21.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2022-05-30T11:01:37.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2021-12-08T09:22:38.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2021-11-04T02:49:19.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2021-10-27T08:10:45.000Z', 'description' => '响应参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceAttribute'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeDBInstanceAttribute', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"DBInstance\\": {\\n \\"Type\\": \\"ReadWrite\\",\\n \\"Status\\": \\"Running\\",\\n \\"RightsSeparationStatus\\": \\"disabled\\",\\n \\"DBNodeCount\\": 2,\\n \\"Expired\\": \\"false\\",\\n \\"CreateTime\\": \\"2021-08-31T08:56:25.000+0000\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"Port\\": \\"3306\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"Description\\": \\"test instance\\",\\n \\"ConnectionString\\": \\"pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com\\",\\n \\"StorageUsed\\": 17042505728,\\n \\"ExpireDate\\": \\"2022-08-31T16:00:00.000+0000\\",\\n \\"CommodityCode\\": \\"drds_polarxpost_public_cn\\",\\n \\"MaintainStartTime\\": \\"06:00\\",\\n \\"DBInstanceType\\": \\"ReadWrite\\",\\n \\"DBNodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"LatestMinorVersion\\": \\"polarx-kernel_5.4.11-16301083_xcluster-20210805\\",\\n \\"MaintainEndTime\\": \\"06:00\\",\\n \\"DBType\\": \\"polarx\\",\\n \\"RightsSeparationEnabled\\": false,\\n \\"VPCId\\": \\"vpc-xxxxx\\",\\n \\"MinorVersion\\": \\"polarx-kernel_5.4.11-16301083_xcluster-20210805\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Network\\": \\"VPC\\",\\n \\"DBVersion\\": \\"5.5\\",\\n \\"VSwitchId\\": \\"vsw-********\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"Engine\\": \\"polarx\\",\\n \\"KindCode\\": 18,\\n \\"Id\\": \\"pxc-zkralxpc5d****\\",\\n \\"DBNodes\\": [\\n {\\n \\"ComputeNodeId\\": \\"pxc-i-********\\",\\n \\"NodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"DataNodeId\\": \\"pxc-xdb-xxxxxx\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"Id\\": \\"pxi-*********\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"ConnAddrs\\": [\\n {\\n \\"Type\\": \\"VPC\\",\\n \\"VSwitchId\\": \\"vsw-*********\\",\\n \\"Port\\": 3306,\\n \\"VPCId\\": \\"vpc-xxxxxx\\",\\n \\"ConnectionString\\": \\"polardbx-xxx.aliyuncs.com\\",\\n \\"VpcInstanceId\\": \\"pxc-zkralxpc5d****\\"\\n }\\n ],\\n \\"ReadDBInstances\\": [\\n \\"pxr-*********\\"\\n ],\\n \\"ColumnarReadDBInstances\\": [\\n \\"xxx\\"\\n ],\\n \\"ResourceGroupId\\": \\"rg-*********\\",\\n \\"TagSet\\": [\\n {\\n \\"Key\\": \\"key2\\",\\n \\"Value\\": \\"value2\\"\\n }\\n ],\\n \\"CnNodeCount\\": 2,\\n \\"DnNodeCount\\": 2,\\n \\"CnNodeClassCode\\": \\"polarx.x4.xlarge.2e\\",\\n \\"DnNodeClassCode\\": \\"mysql.x8.large.25\\",\\n \\"Series\\": \\"enterprise\\",\\n \\"LTSVersions\\": [\\n \\"X.X.X.X\\"\\n ],\\n \\"TopologyType\\": \\"3azones\\",\\n \\"PrimaryZone\\": \\"cn-shenzhen-e\\",\\n \\"SecondaryZone\\": \\"cn-shenzhen-a\\",\\n \\"TertiaryZone\\": \\"cn-shenzhen-e\\",\\n \\"DifferentDNSpec\\": false,\\n \\"ColumnarInstanceName\\": \\"xxxx\\",\\n \\"CanNotCreateColumnar\\": true,\\n \\"GdnInstanceName\\": \\"\\",\\n \\"GdnMemberList\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"MemberName\\": \\"\\",\\n \\"Status\\": \\"\\"\\n }\\n ],\\n \\"SpecCategory\\": \\"\\",\\n \\"GdnRole\\": \\"\\",\\n \\"PrimaryInstanceId\\": \\"\\",\\n \\"StorageType\\": \\"\\",\\n \\"CpuType\\": \\"\\",\\n \\"EngineVersion\\": \\"\\",\\n \\"DnStorageSpace\\": \\"\\",\\n \\"AiGatewayEnabled\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n \\n ReadWrite\\n Running\\n disabled\\n 2\\n false\\n 2021-08-31T08:56:25.000+0000\\n Postpaid\\n 3306\\n Unlock\\n test instance\\n pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com\\n 17042505728\\n 2022-08-31T16:00:00.000+0000\\n drds_polarxpost_public_cn\\n 06:00\\n ReadWrite\\n polarx.x4.large.2e\\n polarx-kernel_5.4.11-16301083_xcluster-20210805\\n 06:00\\n polarx\\n false\\n vpc-xxxxx\\n polarx-kernel_5.4.11-16301083_xcluster-20210805\\n cn-hangzhou\\n VPC\\n 5.5\\n vsw-********\\n cn-hangzhou-a\\n polarx\\n 18\\n pxc-zkralxpc5d****\\n \\n pxc-i-********\\n polarx.x4.large.2e\\n pxc-xdb-xxxxxx\\n cn-hangzhou-a\\n pxi-*********\\n cn-hangzhou\\n \\n \\n VPC\\n vsw-*********\\n 3306\\n vpc-xxxxxx\\n polardbx-xxx.aliyuncs.com\\n pxc-zkralxpc5d****\\n \\n pxr-*********\\n rg-*********\\n \\n key2\\n value2\\n \\n 2\\n 2\\n polarx.x4.xlarge.2e\\n mysql.x8.large.25\\n enterprise\\n X.X.X.X\\n 3azones\\n cn-shenzhen-e\\n cn-shenzhen-a\\n cn-shenzhen-e\\n \\n","errorExample":""}]', ], 'DescribeDBInstanceConfig' => [ 'summary' => '调用DescribeDBInstanceConfig接口获取实例配置参数。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '86241', 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域的ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。'."\n" ."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-*********'], ], [ 'name' => 'ConfigName', 'in' => 'query', 'schema' => ['description' => '配置标识， 默认：htap。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'htap'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。'."\n" ."\n", 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'ConfigName' => ['description' => '配置Key。', 'type' => 'string', 'example' => 'htap'], 'DbInstanceName' => ['description' => '实例ID。'."\n" ."\n", 'type' => 'string', 'example' => 'pxc-sprcym7g7w****'], 'ConfigValue' => ['description' => '配置项，说明如下：'."\n" ."\n" .'- attendHtapList：开启Htap的实例列表。'."\n" .'- autoAttendHtap：是否自动把新建的只读实例加入到HTAP列表里。'."\n" .'- delayExecutionStrategy：当只读延迟到达storageDelayThreshold设定的值时，将只读流量切回主实例。默认值为1，取值为0或1。'."\n" .'- enableConsistentReplicaRead：是否开启一致性读。'."\n" .'- storageDelayThreshold：只读实例延迟阈值，默认3s，范围为：0~3600*24。'."\n" .'- enableHtap：是否开始Htap。'."\n" .'- masterReadWeight：主节点读权重，设置100表示100%的流量打到主节点，范围为：0~100。', 'type' => 'string', 'example' => '{\\"attendHtapList\\":[\\"pxc-hzruyzes08****\\"],\\"autoAttendHtap\\":\\"true\\",\\"delayExecutionStrategy\\":1,\\"enableConsistentReplicaRead\\":true,\\"enableHtap\\":\\"true\\",\\"masterReadWeight\\":100,\\"storageDelayThreshold\\":3}'], ], ], ], 'description' => '', ], ], ], 'title' => '查询实例配置参数', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceConfig'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"ConfigName\\": \\"htap\\",\\n \\"DbInstanceName\\": \\"pxc-sprcym7g7w****\\",\\n \\"ConfigValue\\": \\"{\\\\\\\\\\\\\\"attendHtapList\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"pxc-hzruyzes08****\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"autoAttendHtap\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"delayExecutionStrategy\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"enableConsistentReplicaRead\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"enableHtap\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"masterReadWeight\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"storageDelayThreshold\\\\\\\\\\\\\\":3}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n \\n htap\\n pxc-sprcym7g7w****\\n {\\\\\\"attendHtapList\\\\\\":[\\\\\\"pxc-hzruyzes08****\\\\\\"],\\\\\\"autoAttendHtap\\\\\\":\\\\\\"true\\\\\\",\\\\\\"delayExecutionStrategy\\\\\\":1,\\\\\\"enableConsistentReplicaRead\\\\\\":true,\\\\\\"enableHtap\\\\\\":\\\\\\"true\\\\\\",\\\\\\"masterReadWeight\\\\\\":100,\\\\\\"storageDelayThreshold\\\\\\":3}\\n \\n","errorExample":""}]', ], 'DescribeDBInstanceEndpoint' => [ 'summary' => '查看自定义地址', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '236590', 'abilityTreeNodes' => ['FEATUREdrdsTQTDLY'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '实例ID。'."\n" ."\n", 'type' => 'string', 'required' => true, 'example' => 'pxc-hzjasd****'], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => '分页查询时每页行数。最大值为100。默认值：当不设置值或设置的值小于10时，默认值为10。当设置的值大于100时，默认值为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000'], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => '下一个查询开始Token', 'type' => 'string', 'required' => false, 'example' => 'xxdds'], ], ], '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' => 'A501A191-BD70-5E50-98A9-C2A486A82****'], 'Data' => [ 'description' => '监控数据。', 'type' => 'object', 'properties' => [ 'Items' => [ 'description' => '内部连接的方式，固定取值为1，表示经典网络。', 'type' => 'array', 'items' => [ 'description' => '节点信息。', 'type' => 'object', 'properties' => [ 'Endpoint' => [ 'description' => '实例的连接地址。', 'type' => 'object', 'properties' => [ 'Address' => ['description' => '地址', 'type' => 'string', 'example' => '10.21.1.82'], 'Class' => ['description' => '实例的规格类型（即规格代码）。', 'type' => 'string', 'example' => 'mdb.shard.4x.large.d'], 'EndpointGroupId' => ['description' => '终端节点所属终端节点组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'epg-bp14wgzai7flglwdtkxfa'], 'Id' => ['description' => '逻辑节点ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2899'], 'Kind' => ['description' => '载荷类型：`agentTurn`（Agent 对话）/ `systemEvent`（系统事件）'."\n", 'type' => 'string', 'example' => 'instance'], 'NetType' => ['description' => '连接串网络类型，取值范围如下：'."\n" .'* **Public**：公网地址'."\n" .'* **Private**：私网地址'."\n" .'* **Inner**：私网地址（经典网络）', 'type' => 'string', 'example' => 'VPC'], 'TargetName' => ['description' => '对象名称。', 'type' => 'string', 'example' => 'sas-app'], 'TunnelId' => ['description' => '隧道ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '3522367'], 'Type' => ['description' => '实例类型：'."\n" ."\n" .'- **ReadWrite**： 主实例；'."\n" .'- **ReadOnly**： 只读实例。', 'type' => 'string', 'example' => 'TXT'], 'UserVisible' => ['description' => '用户可见', 'type' => 'boolean'], 'Vip' => ['description' => '策略防护的高防实例IP。', 'type' => 'string', 'example' => 'http://100.100.100.200/latest/meta-data'], 'VpcId' => ['description' => '访问端点所在的专有网络ID。', 'type' => 'string', 'example' => 'vpc-bp1s9j8s4h4uqejp9k2z3'], 'Vport' => ['description' => 'VIP端口，如80、8080和443等。', 'type' => 'integer', 'format' => 'int64', 'example' => 'vport'], 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => '`curl uUys2ThR.popscan.xaliyun.com`'], 'VSwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-2ze51hh6s8tsjgy19g5eu'], 'ReadType' => ['description' => '读写类型：行存读写（ReadWrite）、列存只读（ColumnarRead）', 'type' => 'string', 'example' => '0'], 'IsDefault' => ['description' => '是否是默认交换机。', 'type' => 'boolean', 'example' => 'True'], ], ], 'RealServer' => [ 'description' => '源站地址。', 'type' => 'array', 'items' => [ 'description' => '源站地址。', 'type' => 'object', 'properties' => [ 'Activated' => ['description' => '节点是否启用，计算层仅启用主可用区节点，在实例执行主备切换后计算层备用节点会切换为主节点，所有存储层节点均启用。', 'type' => 'boolean', 'example' => 'False'], 'Class' => ['description' => '实例的规格类型（即规格代码）。', 'type' => 'string', 'example' => 'dds.cs.mid'], 'Ip' => ['description' => 'IP地址。', 'type' => 'string', 'example' => '172.29.32.166'], 'Port' => ['description' => '连接端口号。', 'type' => 'string', 'example' => '3306'], 'ReplicaId' => ['description' => '副本ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '节点id'], 'Weight' => ['description' => '目的路由的权重值。'."\n" ."\n" .'- 对于支持IPsec-VPN连接双隧道模式的VPN网关实例，目的路由的权重值默认为**100**，且无实际意义。'."\n" .'- 对于支持IPsec-VPN连接单隧道模式的VPN网关实例，目的路由权重值代表目的路由的优先级：'."\n" .' - **100**：表示高优先级。存在目标网段相同的多条目的路由时，该目的路由关联的IPsec连接为主链路。'."\n" .' - **0**：表示低优先级。存在目标网段相同的多条目的路由时，该目的路由关联的IPsec连接为备链路。', 'type' => 'integer', 'format' => 'int64', 'example' => '255'], ], ], ], ], ], ], ], ], 'NextToken' => ['description' => '下一个查询开始Token', 'type' => 'string', 'example' => 'xxdds'], 'MaxResults' => ['description' => '分页查询时每页行数。最大值为100。默认值：当不设置值或设置的值小于10时，默认值为10。当设置的值大于100时，默认值为100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => '查看自定义地址', 'description' => '该接口用于获取用户已配置的自定义终端节点（Endpoint）列表，便于管理和查看私有连接或VPC终端服务的设置。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A501A191-BD70-5E50-98A9-C2A486A82****\\",\\n \\"Data\\": {\\n \\"Items\\": [\\n {\\n \\"Endpoint\\": {\\n \\"Address\\": \\"10.21.1.82\\",\\n \\"Class\\": \\"mdb.shard.4x.large.d\\",\\n \\"EndpointGroupId\\": 0,\\n \\"Id\\": 2899,\\n \\"Kind\\": \\"instance\\",\\n \\"NetType\\": \\"VPC\\",\\n \\"TargetName\\": \\"sas-app\\",\\n \\"TunnelId\\": 3522367,\\n \\"Type\\": \\"TXT\\",\\n \\"UserVisible\\": true,\\n \\"Vip\\": \\"http://100.100.100.200/latest/meta-data\\",\\n \\"VpcId\\": \\"vpc-bp1s9j8s4h4uqejp9k2z3\\",\\n \\"Vport\\": 0,\\n \\"ZoneId\\": \\"`curl uUys2ThR.popscan.xaliyun.com`\\",\\n \\"VSwitchId\\": \\"vsw-2ze51hh6s8tsjgy19g5eu\\",\\n \\"ReadType\\": \\"0\\",\\n \\"IsDefault\\": true\\n },\\n \\"RealServer\\": [\\n {\\n \\"Activated\\": true,\\n \\"Class\\": \\"dds.cs.mid\\",\\n \\"Ip\\": \\"172.29.32.166\\",\\n \\"Port\\": \\"3306\\",\\n \\"ReplicaId\\": 0,\\n \\"Weight\\": 255\\n }\\n ]\\n }\\n ]\\n },\\n \\"NextToken\\": \\"xxdds\\",\\n \\"MaxResults\\": 1000\\n}","type":"json"}]', ], 'DescribeDBInstanceHA' => [ 'summary' => '查询实例的HA信息', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '132465', 'abilityTreeNodes' => ['FEATUREdrdsHIZOSR'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['type' => 'string', 'description' => ''], 'RequestId' => ['type' => 'string', 'description' => ''], 'Success' => ['type' => 'boolean', 'description' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ 'TopologyType' => ['type' => 'string', 'description' => ''], 'PrimaryRegionId' => ['type' => 'string', 'description' => ''], 'PrimaryAzoneId' => ['type' => 'string', 'description' => ''], 'SecondaryRegionId' => ['type' => 'string', 'description' => ''], 'SecondaryAzoneId' => ['type' => 'string', 'description' => ''], ], 'description' => '', ], ], 'description' => '', ], ], ], 'changeSet' => [ ['createdAt' => '2022-05-11T12:44:50.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceHA'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TopologyType\\": \\"\\",\\n \\"PrimaryRegionId\\": \\"\\",\\n \\"PrimaryAzoneId\\": \\"\\",\\n \\"SecondaryRegionId\\": \\"\\",\\n \\"SecondaryAzoneId\\": \\"\\"\\n }\\n}","type":"json"}]', ], 'DescribeDBInstanceSSL' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86243', 'abilityTreeNodes' => ['FEATUREdrdsUULYZA'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。'."\n" ."\n", 'type' => 'string', 'required' => false, 'example' => 'pxc-*********'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域的ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。'."\n" ."\n", 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'SSLEnabled' => ['description' => '实例是否开启SSL：'."\n" ."\n" .'- **true**：开启'."\n" .'- **false**： 关闭', 'type' => 'boolean', 'example' => 'false'], 'SSLExpiredTime' => ['description' => '证书过期时间。', 'type' => 'string', 'example' => '2022-11-04T09:39:07Z'], 'CertCommonName' => ['description' => '证书绑定域名。', 'type' => 'string', 'example' => 'pxc-sddddddcym7g7w****.polarx.singapore.rds.aliyuncs.com'], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => '该请求使用与先前相同但不相同的请求相同的客户端令牌。 除非请求相同，否则请勿将客户端令牌与其他请求重用。'], ['errorCode' => 'InvalidAction', 'errorMessage' => 'The specified Action is invalid.', 'description' => '指定的Action无效。'], ], 404 => [ ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => '数据库实例不存在'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '接口暂时不可用'], ], ], 'title' => '查看SSL信息', 'summary' => '查看SSL信息。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceSSL'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"SSLEnabled\\": false,\\n \\"SSLExpiredTime\\": \\"2022-11-04T09:39:07Z\\",\\n \\"CertCommonName\\": \\"pxc-sddddddcym7g7w****.polarx.singapore.rds.aliyuncs.com\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n \\n false\\n 2022-11-04T09:39:07Z\\n pxc-sddddddcym7g7w****.polarx.singapore.rds.aliyuncs.com\\n \\n","errorExample":""}]', ], 'DescribeDBInstanceTDE' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86244', 'abilityTreeNodes' => ['FEATUREdrds9HBOA5'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。'."\n" ."\n", 'type' => 'string', 'required' => false, 'example' => 'pxc-********'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属的地域ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。'."\n" ."\n", 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'TDEStatus' => ['description' => '是否开启TDE：'."\n" ."\n" .'- 0 = 未开启；'."\n" .'- 1 = 已开启。', 'type' => 'string', 'example' => '0'], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'The current engine version does not support the operation.', 'description' => '当前引擎版本不支持操作。'], ], ], 'title' => '获取实例TDE的详细信息', 'summary' => '调用DescribeDBInstanceTDE接口获取实例TDE的详细信息。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceTDE'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"TDEStatus\\": \\"0\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n \\n 0\\n \\n","errorExample":""}]', ], 'DescribeDBInstanceTopology' => [ 'summary' => '调用DescribeDBInstanceTopology接口获取实例拓扑信息。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '86245', 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属的地域ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。'."\n" ."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => '查询拓扑中历史实例范围开始时间，格式为yyyy-MM-dd HH:mm:ss。', 'type' => 'string', 'required' => false, 'example' => '2021-10-21T10:30:45Z 04:00:00'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => '查询拓扑中历史实例范围结束时间，格式为yyyy-MM-dd HH:mm:ss。', 'type' => 'string', 'required' => false, 'example' => '2021-10-22T10:30:45Z 04:00:00'], ], [ 'name' => 'MinuteSimple', 'in' => 'query', 'schema' => ['description' => '是否查询历史拓扑。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。'."\n" ."\n", 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'LogicInstanceTopology' => [ 'description' => '拓扑信息。', 'type' => 'object', 'properties' => [ 'DBInstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'pxc-sprcym7g7w****'], 'DBInstanceCreateTime' => ['description' => '实例创建时间，格式为yyyy-MM-dd HH:mm:ss。', 'type' => 'string', 'example' => '2021-10-21T10:30:45Z 04:00:00'], 'MaintainStartTime' => ['description' => '运维开始时间，格式为HH:mm:ss。', 'type' => 'string', 'example' => '04:00:00'], 'MaintainEndTime' => ['description' => '运维结束时间，格式为HH:mm:ss。', 'type' => 'string', 'example' => '05:00:00'], 'LockReason' => ['description' => '锁定原因。', 'type' => 'string', 'example' => '欠费'], 'DBInstanceStatus' => ['description' => '实例状态。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'], 'LockMode' => ['description' => '锁定状态 ：'."\n" ."\n" .'- **0**：未锁定；'."\n" .'- **1**：锁定。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'EngineVersion' => ['description' => '引擎版本，默认2.0。', 'type' => 'string', 'example' => '2.0'], 'DBInstanceStorage' => ['description' => '存储节点个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'DBInstanceConnType' => ['description' => '表示用lvs做负载均衡。', 'type' => 'string', 'example' => 'lvs'], 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => '304726047'], 'Engine' => ['description' => '引擎， 默认：polarx。', 'type' => 'string', 'example' => 'polarx'], 'DBInstanceDescription' => ['description' => '实例描述。', 'type' => 'string', 'example' => 'pxc-sprcym7******'], 'DBInstanceStatusDescription' => ['description' => '实例状态描述。', 'type' => 'string', 'example' => 'TDE_MODIFYING'], 'Items' => [ 'description' => '节点列表。', 'type' => 'array', 'items' => [ 'description' => '节点信息。', 'type' => 'object', 'properties' => [ 'DBInstanceCreateTime' => ['description' => '实例创建时间。', 'type' => 'string', 'example' => '2021-10-21T10:30:45Z'], 'DBInstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'pxc-i-tk6t4z****'], 'CharacterType' => ['description' => '节点属性，取值如下：'."\n" ."\n" .'- **polarx_cn**：计算节点；'."\n" .'- **polarx_store**：数据节点；'."\n" .'- **polarx_gms**：GMS节点。', 'type' => 'string', 'example' => '节点角色'], 'MaintainStartTime' => ['description' => '运维开始时间。', 'type' => 'string', 'example' => '不展示'], 'DiskSize' => ['description' => '磁盘大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '3145728'], 'MaintainEndTime' => ['description' => '运维结束时间。', 'type' => 'string', 'example' => '不展示'], 'LockReason' => ['description' => '锁定原因。', 'type' => 'string', 'example' => '不展示'], 'DBInstanceStatus' => ['description' => '实例状态。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'], 'LockMode' => ['description' => '是否锁定，取值如下：'."\n" ."\n" .'- **0**：未锁定；'."\n" .'- **1**：锁定。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'EngineVersion' => ['description' => '引擎版本，默认2.0。', 'type' => 'string', 'example' => '5.7'], 'DBInstanceConnType' => ['description' => '连接类型。', 'type' => 'integer', 'format' => 'int32', 'example' => '不展示'], 'MaxConnections' => ['description' => '最大连接数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4000'], 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => '304726049'], 'Engine' => ['description' => '引擎版本，取值如下：'."\n" ."\n" .'- **mysql **'."\n" .'- **polarx_cdc**'."\n" .'- **polarx_dn**', 'type' => 'string', 'example' => 'mysql'], 'MaxIops' => ['description' => '最大Iops。', 'type' => 'integer', 'format' => 'int32', 'example' => '7000'], 'DBInstanceDescription' => ['description' => '实例描述。', 'type' => 'string', 'example' => '不展示'], 'DBInstanceStatusDescription' => ['description' => '实例状态描述。', 'type' => 'string', 'example' => '不展示'], 'ConnectionIp' => [ 'description' => '数据结构体。', 'type' => 'array', 'items' => [ 'description' => '连接信息。', 'type' => 'object', 'properties' => [ 'Port' => ['description' => '端口。', 'type' => 'string', 'example' => '3306'], 'DBInstanceNetType' => ['description' => '内部连接的方式，固定取值为1，表示经典网络。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'ConnectionString' => ['description' => '连接信息。', 'type' => 'string', 'example' => 'pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com'], ], ], ], 'Region' => ['description' => '节点所属地域，如果为RDS节点，多个子节点的地域以 \';\' 分割。', 'type' => 'string', 'example' => 'cn-hangzhou'], 'Azone' => ['description' => '节点所属可用区，如果为RDS节点，多个子节点的可用区以\';\'分割。', 'type' => 'string', 'example' => 'cn-hangzhou-a'], 'Role' => ['description' => '节点角色，取值如下：'."\n" ."\n" .'- **master**：主节点'."\n" .'- **standby**：备节点', 'type' => 'string', 'example' => 'master'], 'Activated' => ['description' => '节点是否启用，计算层仅启用主可用区节点，在实例执行主备切换后计算层备用节点会切换为主节点，所有存储层节点均启用。', 'type' => 'boolean', 'example' => 'true'], 'AzoneRoleList' => [ 'description' => 'RDS三节点的数据信息列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Azone' => ['description' => 'RDS三节点中某个节点所属可用区。', 'type' => 'string', 'example' => 'cn-hangzhou-a'], 'Role' => ['description' => 'RDS三节点中某个节点的角色，取值如下：'."\n" ."\n" .'- **leader**：主节点'."\n" .'- **follower**：从节点'."\n" .'- **logger**：日志节点', 'type' => 'string', 'example' => 'leader'], ], 'description' => '', ], ], 'Status' => ['description' => '节点状态：'."\n" ."\n" .'- **0**：运行中'."\n" .'- **1**：创建中'."\n" .'- **2**：异常'."\n" .'- **3**：已过期'."\n" .'- **4**：释放中'."\n" .'- **5**：已释放'."\n" .'- **6**：锁定', 'type' => 'string', 'example' => '0'], 'NodeClass' => ['description' => '节点规格：'."\n" ."\n" .'- **polarx.x4.medium.2e**：2核8 GB'."\n" .'- **polarx.x4.large.2e**：4核16 GB'."\n" .'- **polarx.x8.large.2e**：4核32 GB'."\n" .'- **polarx.x4.xlarge.2e**：8核32 GB'."\n" .'- **polarx.x8.xlarge.2e**：8核64 GB'."\n" .'- **polarx.x4.2xlarge.2e**：16核64 GB'."\n" .'- **polarx.x8.2xlarge.2e**：16核128 GB'."\n" .'- **polarx.x4.4xlarge.2e**：32核128 GB'."\n" .'- **polarx.x8.4xlarge.2e**：32核256 GB'."\n" .'- **polarx.st.8xlarge.2e**：60核470 GB'."\n" .'- **polarx.st.12xlarge.2e**：90核720 GB', 'type' => 'string', 'example' => 'polarx.x4.large.2e'], 'Version' => ['description' => '日志节点版本。', 'type' => 'string', 'example' => 'polarx-cdc-kernel-2.0.0-3985896'], 'PhyInstanceName' => ['description' => '物理实例名', 'type' => 'string', 'example' => 'pxc-unrbk8oyz**********'], 'StorageUsed' => ['description' => '存储空间的使用量，单位为MB。', 'type' => 'string', 'example' => '16681'], 'InstanceClusterName' => ['title' => '实例CN集群名称，例如default', 'type' => 'string'], 'ReadType' => ['title' => '读写类型，例如ReadWrite', 'type' => 'string'], ], ], ], 'HistoryItems' => [ 'description' => '历史节点列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CharacterType' => ['description' => '节点属性，取值如下：'."\n" ."\n" .'- **polarx_cn**：计算节点；'."\n" .'- **polarx_store**：数据节点；'."\n" .'- **polarx_gms**：GMS节点。', 'type' => 'string', 'example' => '节点角色'], 'Role' => ['description' => '节点角色，取值如下：'."\n" ."\n" .'- **master**：主节点'."\n" .'- **standby**：备节点', 'type' => 'string', 'example' => 'master'], 'DBInstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'pxc-sprcym7g7w****'], 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => '304726049'], 'Region' => ['description' => '节点所属地域，如果为RDS节点，多个子节点的地域以 \';\' 分割。', 'type' => 'string', 'example' => 'cn-hangzhou'], 'Azone' => ['description' => '节点所属可用区，如果为RDS节点，多个子节点的可用区以\';\'分割。', 'type' => 'string', 'example' => 'cn-hangzhou-a'], 'Activated' => ['description' => '节点是否启用，计算层仅启用主可用区节点，在实例执行主备切换后计算层备用节点会切换为主节点，所有存储层节点均启用。', 'type' => 'boolean', 'example' => 'true'], 'PhyInstanceName' => ['description' => '物理实例名。', 'type' => 'string', 'example' => 'pxc-unrbk8oyz**********'], ], 'description' => '', ], ], ], ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'RAM.Permission.Denied', 'errorMessage' => 'RAM authentication failed.', 'description' => 'RAM鉴权失败'], ], [ ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => '数据库实例不存在'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => '查询实例拓扑信息', 'changeSet' => [ ['createdAt' => '2025-05-21T10:58:52.000Z', 'description' => '错误码发生变更'], ['createdAt' => '2025-05-21T10:58:52.000Z', 'description' => '错误码发生变更'], ['createdAt' => '2024-10-17T06:54:57.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2024-04-28T09:07:55.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2023-08-02T02:57:45.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2023-07-26T06:30:36.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2023-07-19T05:56:08.000Z', 'description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更'], ['createdAt' => '2022-05-31T05:37:48.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2021-11-17T02:57:11.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2021-11-17T02:57:11.000Z', 'description' => '响应参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceTopology'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeDBInstanceTopology', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"LogicInstanceTopology\\": {\\n \\"DBInstanceName\\": \\"pxc-sprcym7g7w****\\",\\n \\"DBInstanceCreateTime\\": \\"2021-10-21T10:30:45Z 04:00:00\\",\\n \\"MaintainStartTime\\": \\"04:00:00\\",\\n \\"MaintainEndTime\\": \\"05:00:00\\",\\n \\"LockReason\\": \\"欠费\\",\\n \\"DBInstanceStatus\\": 8,\\n \\"LockMode\\": 0,\\n \\"EngineVersion\\": \\"2.0\\",\\n \\"DBInstanceStorage\\": 1,\\n \\"DBInstanceConnType\\": \\"lvs\\",\\n \\"DBInstanceId\\": \\"304726047\\",\\n \\"Engine\\": \\"polarx\\",\\n \\"DBInstanceDescription\\": \\"pxc-sprcym7******\\",\\n \\"DBInstanceStatusDescription\\": \\"TDE_MODIFYING\\",\\n \\"Items\\": [\\n {\\n \\"DBInstanceCreateTime\\": \\"2021-10-21T10:30:45Z\\",\\n \\"DBInstanceName\\": \\"pxc-i-tk6t4z****\\",\\n \\"CharacterType\\": \\"节点角色\\",\\n \\"MaintainStartTime\\": \\"不展示\\",\\n \\"DiskSize\\": 3145728,\\n \\"MaintainEndTime\\": \\"不展示\\",\\n \\"LockReason\\": \\"不展示\\",\\n \\"DBInstanceStatus\\": 8,\\n \\"LockMode\\": 0,\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"DBInstanceConnType\\": 0,\\n \\"MaxConnections\\": 4000,\\n \\"DBInstanceId\\": \\"304726049\\",\\n \\"Engine\\": \\"mysql\\",\\n \\"MaxIops\\": 7000,\\n \\"DBInstanceDescription\\": \\"不展示\\",\\n \\"DBInstanceStatusDescription\\": \\"不展示\\",\\n \\"ConnectionIp\\": [\\n {\\n \\"Port\\": \\"3306\\",\\n \\"DBInstanceNetType\\": 1,\\n \\"ConnectionString\\": \\"pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com\\"\\n }\\n ],\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Azone\\": \\"cn-hangzhou-a\\",\\n \\"Role\\": \\"master\\",\\n \\"Activated\\": true,\\n \\"AzoneRoleList\\": [\\n {\\n \\"Azone\\": \\"cn-hangzhou-a\\",\\n \\"Role\\": \\"leader\\"\\n }\\n ],\\n \\"Status\\": \\"0\\",\\n \\"NodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"Version\\": \\"polarx-cdc-kernel-2.0.0-3985896\\",\\n \\"PhyInstanceName\\": \\"pxc-unrbk8oyz**********\\",\\n \\"StorageUsed\\": \\"16681\\",\\n \\"InstanceClusterName\\": \\"\\",\\n \\"ReadType\\": \\"\\"\\n }\\n ],\\n \\"HistoryItems\\": [\\n {\\n \\"CharacterType\\": \\"节点角色\\",\\n \\"Role\\": \\"master\\",\\n \\"DBInstanceName\\": \\"pxc-sprcym7g7w****\\",\\n \\"DBInstanceId\\": \\"304726049\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Azone\\": \\"cn-hangzhou-a\\",\\n \\"Activated\\": true,\\n \\"PhyInstanceName\\": \\"pxc-unrbk8oyz**********\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n \\n \\n pxc-sprcym7g7w****\\n 2021-10-21T10:30:45Z 04:00:00\\n 04:00:00\\n 05:00:00\\n 欠费\\n 8\\n 0\\n 2.0\\n 1\\n lvs\\n 304726047\\n polarx\\n pxc-sprcym7******\\n TDE_MODIFYING\\n \\n 2021-10-21T10:30:45Z\\n pxc-i-tk6t4z****\\n 节点角色\\n 不展示\\n 3145728\\n 不展示\\n 不展示\\n 8\\n 0\\n 5.7\\n 4000\\n 304726049\\n mysql\\n 7000\\n 不展示\\n 不展示\\n \\n 3306\\n 1\\n pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com\\n \\n cn-hangzhou\\n cn-hangzhou-a\\n master\\n true\\n \\n cn-hangzhou-a\\n leader\\n \\n 0\\n polarx.x4.large.2e\\n polarx-cdc-kernel-2.0.0-3985896\\n pxc-unrbk8oyz**********\\n \\n \\n 节点角色\\n master\\n pxc-sprcym7g7w****\\n 304726049\\n cn-hangzhou\\n cn-hangzhou-a\\n true\\n pxc-unrbk8oyz**********\\n \\n \\n \\n","errorExample":""}]', ], 'DescribeDBInstanceViaEndpoint' => [ 'summary' => '通过实例的连接地址获取实例的基本信息', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '163711', 'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'], ], 'parameters' => [ [ 'name' => 'Endpoint', 'in' => 'query', 'schema' => ['description' => '实例的连接地址。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hz*******.polarx.rds.aliyuncs.com'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC'], 'DBInstance' => [ 'description' => '实例信息', 'type' => 'object', 'properties' => [ 'Type' => ['description' => '实例类型：'."\n" ."\n" .'- **ReadWrite**： 主实例；'."\n" .'- **ReadOnly**： 只读实例。', 'type' => 'string', 'example' => 'ReadWrite'], 'Status' => ['description' => '实例状态，详情请参见[实例状态表](~~339826~~)。', 'type' => 'string', 'example' => 'Running'], 'RightsSeparationStatus' => ['description' => '三权分立状态：'."\n" ."\n" .'- **disabled**：未开启；'."\n" .'- **enabled**：开启；'."\n" .'- **processing**： 处理中；'."\n" .'- **unknown**：未知，可能是实例无法连接导致。', 'type' => 'string', 'example' => 'disabled'], 'DBNodeCount' => ['description' => '实例节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'Expired' => ['description' => '是否过期：'."\n" ."\n" .'- **true**：过期；'."\n" .'- **false**：正常。', 'type' => 'string', 'example' => 'false'], 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-08-31T08:56:25.000+0000'], 'PayType' => ['description' => '实例付费方式，取值：'."\n" ."\n" .'- **Postpaid**：按量付费；'."\n" .'- **Prepaid**：包年包月。', 'type' => 'string', 'example' => 'Postpaid'], 'Port' => ['description' => '实例连接端口', 'type' => 'string', 'example' => '3306'], 'LockMode' => ['description' => '实例锁定模式：'."\n" ."\n" .'- **Unlock**：正常；'."\n" .'- **ManualLock**：手动触发锁定；'."\n" .'- **LockByExpiration**：实例过期自动锁定；'."\n" .'- **LockByRestoration**：实例回滚前的自动锁定；'."\n" .'- **LockByDiskQuota**：实例空间满自动锁定；'."\n" .'- **LockReadInstanceByDiskQuota**：只读实例空间满自动锁定。', 'type' => 'string', 'example' => 'Unlock'], 'Description' => ['description' => '实例描述。', 'type' => 'string', 'example' => 'test instance'], 'ConnectionString' => ['description' => '实例连接地址', 'type' => 'string', 'example' => 'pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com'], 'StorageUsed' => ['description' => '已经使用的存储，单位为B。', 'type' => 'integer', 'format' => 'int64', 'example' => '17042505728'], 'ExpireDate' => ['description' => '到期时间。格式为yyyy-MM-ddTHH:mm:ss.sss+0000（UTC时间）。', 'type' => 'string', 'example' => '2022-08-31T16:00:00.000+0000'], 'CommodityCode' => ['description' => '实例商品种类，固定取值为drds_polarxpost_public_cn。', 'type' => 'string', 'example' => 'drds_polarxpost_public_cn'], 'MaintainStartTime' => ['description' => '实例可维护开始时间，此处为UTC时间，加8小时才是控制台上显示的可维护时间段。', 'type' => 'string', 'example' => '06:00'], 'DBInstanceType' => ['description' => '实例类型：'."\n" ."\n" .'- **ReadWrite**： 主实例；'."\n" .'- **ReadOnly**： 只读实例。', 'type' => 'string', 'example' => 'ReadWrite'], 'DBNodeClass' => ['description' => '实例节点规格。', 'type' => 'string', 'example' => 'polarx.x4.large.2e'], 'LatestMinorVersion' => ['description' => '当前实例支持的最新内核版本。', 'type' => 'string', 'example' => 'polarx-kernel_5.4.11-16301083_xcluster-20210805'], 'MaintainEndTime' => ['description' => '实例可维护结束时间，此处为UTC时间，加8小时为控制台上显示的可维护时间段。', 'type' => 'string', 'example' => '06:00'], 'DBType' => ['description' => '数据库类型，固定取值为polarx。', 'type' => 'string', 'example' => 'polarx'], 'RightsSeparationEnabled' => ['description' => '三权分立状态：'."\n" ."\n" .'- **false**：未开启'."\n" .'- **true**：开启', 'type' => 'boolean', 'example' => 'false'], 'VPCId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-xxxxx'], 'MinorVersion' => ['description' => '当前内核版本。', 'type' => 'string', 'example' => 'polarx-kernel_5.4.11-16301083_xcluster-20210805'], 'RegionId' => ['description' => '实例所在地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], 'Network' => ['description' => '实例的网络类型，仅支持取值VPC，表示专有网络。', 'type' => 'string', 'example' => 'VPC'], 'DBVersion' => ['description' => '数据库版本。', 'type' => 'string', 'example' => '5.5'], 'VSwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-********'], 'ZoneId' => ['description' => '实例所在可用区。', 'type' => 'string', 'example' => 'cn-hangzhou-a'], 'Engine' => ['description' => '数据库类型，固定取值为MySQL。', 'type' => 'string', 'example' => 'MySQL'], 'KindCode' => ['description' => '实例引擎版本，内部参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '18'], 'Id' => ['description' => '主实例的ID，如果没有返回此参数则表示该实例是主实例。', 'type' => 'string', 'example' => 'pxc-zkralxpc5d****'], 'DBNodes' => [ 'description' => '数据库节点信息。', 'type' => 'array', 'items' => [ 'description' => '数据库节点信息。', 'type' => 'object', 'properties' => [ 'ComputeNodeId' => ['description' => '计算节点名称。', 'type' => 'string', 'example' => 'pxc-i-********'], 'NodeClass' => ['description' => '节点规格。', 'type' => 'string', 'example' => 'polarx.x4.large.2e'], 'DataNodeId' => ['description' => '存储节点名称。', 'type' => 'string', 'example' => 'pxc-xdb-xxxxxx'], 'ZoneId' => ['description' => '节点所在可用区名称。', 'type' => 'string', 'example' => 'cn-hangzhou-a'], 'Id' => ['description' => '逻辑节点ID。', 'type' => 'string', 'example' => 'pxi-*********'], 'RegionId' => ['description' => '节点所在地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], ], ], ], 'ConnAddrs' => [ 'description' => '连接地址信息。', 'type' => 'array', 'items' => [ 'description' => '连接地址信息。', 'type' => 'object', 'properties' => [ 'Type' => ['description' => '连接的种类，**VPC**为内网连接，**PUBLIC**为公网连接。', 'type' => 'string', 'example' => 'VPC'], 'VSwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-*********'], 'Port' => ['description' => '连接端口号。', 'type' => 'integer', 'format' => 'int64', 'example' => '3306'], 'VPCId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-xxxxxx'], 'ConnectionString' => ['description' => '连接地址。', 'type' => 'string', 'example' => 'polardbx-xxx.aliyuncs.com'], 'VpcInstanceId' => ['description' => 'vpc 内部CloudInstanceId，可以忽略', 'type' => 'string', 'example' => 'pxc-zkralxpc5d****'], ], ], ], 'ReadDBInstances' => [ 'description' => '只读实例名称。', 'type' => 'array', 'items' => ['description' => '只读实例名称。', 'type' => 'string', 'example' => 'pxr-*********'], ], 'ResourceGroupId' => ['title' => '资源组ID', 'description' => '资源组ID', 'type' => 'string', 'example' => 'rg-xxxx'], 'TagSet' => [ 'title' => '标签集合', 'description' => '标签集合', 'type' => 'array', 'items' => [ 'description' => '标签集合。', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '标签名称', 'description' => '标签名称', 'type' => 'string', 'example' => 'key2'], 'Value' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'example' => 'value2'], ], ], ], 'CnNodeCount' => ['description' => 'CN节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'DnNodeCount' => ['description' => 'DN节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'CnNodeClassCode' => ['description' => 'CN节点规格：'."\n" .'- **polarx.x4.medium.2e**：2核8G'."\n" .'- **polarx.x4.large.2e**：4核16G'."\n" .'- **polarx.x8.large.2e**：4核32G'."\n" .'- **polarx.x4.xlarge.2e**：8核32G'."\n" .'- **polarx.x8.xlarge.2e**：8核64G'."\n" .'- **polarx.x4.2xlarge.2e**：16核64G'."\n" .'- **polarx.x8.2xlarge.2e**：16核128G'."\n" .'- **polarx.x4.4xlarge.2e**：32核128G'."\n" .'- **polarx.x8.4xlarge.2e**：32核256G'."\n" .'- **polarx.st.8xlarge.2e**：60核470G'."\n" .'- **polarx.st.12xlarge.2e**：90核720G', 'type' => 'string', 'example' => 'polarx.x4.xlarge.2e'], 'DnNodeClassCode' => ['description' => 'DN节点规格：'."\n" .'- **mysql.n2.medium.25**：2核4G'."\n" .'- **mysql.n4.medium.25**：2核8G'."\n" .'- **mysql.x8.medium.25**：2核16G'."\n" .'- **mysql.n2.large.25**：4核8G'."\n" .'- **mysql.n4.large.25**：4核16G'."\n" .'- **mysql.x8.large.25**：4核32G'."\n" .'- **mysql.n2.xlarge.25**：8核16G'."\n" .'- **mysql.n4.xlarge.25**：8核32G'."\n" .'- **mysql.x8.xlarge.25**：8核64G'."\n" .'- **mysql.n4.2xlarge.25**：16核64G'."\n" .'- **mysql.x8.2xlarge.25**：16核128G'."\n" .'- **mysql.x4.4xlarge.25**：32核128G'."\n" .'- **mysql.x8.4xlarge.25**：32核256G'."\n" .'- **mysql.st.8xlarge.25**：60核470G'."\n" .'- **mysql.st.12xlarge.25**：90核720G', 'type' => 'string', 'example' => 'mysql.x8.large.25'], 'Series' => ['description' => '实例系列，取值如下：'."\n" ."\n" .'- **enterprise**：企业版'."\n" .'- **standard**：标准版', 'type' => 'string', 'example' => 'enterprise'], 'LTSVersions' => [ 'description' => 'LTS版本号。', 'type' => 'array', 'items' => ['description' => 'LTS版本号。', 'type' => 'string', 'example' => 'X.X.X.X'], 'required' => true, ], ], ], ], 'description' => '', ], ], ], 'title' => '通过连接地址获取实例信息', 'changeSet' => [ ['createdAt' => '2023-08-14T06:52:03.000Z', 'description' => '请求参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceViaEndpoint'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC\\",\\n \\"DBInstance\\": {\\n \\"Type\\": \\"ReadWrite\\",\\n \\"Status\\": \\"Running\\",\\n \\"RightsSeparationStatus\\": \\"disabled\\",\\n \\"DBNodeCount\\": 2,\\n \\"Expired\\": \\"false\\",\\n \\"CreateTime\\": \\"2021-08-31T08:56:25.000+0000\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"Port\\": \\"3306\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"Description\\": \\"test instance\\",\\n \\"ConnectionString\\": \\"pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com\\",\\n \\"StorageUsed\\": 17042505728,\\n \\"ExpireDate\\": \\"2022-08-31T16:00:00.000+0000\\",\\n \\"CommodityCode\\": \\"drds_polarxpost_public_cn\\",\\n \\"MaintainStartTime\\": \\"06:00\\",\\n \\"DBInstanceType\\": \\"ReadWrite\\",\\n \\"DBNodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"LatestMinorVersion\\": \\"polarx-kernel_5.4.11-16301083_xcluster-20210805\\",\\n \\"MaintainEndTime\\": \\"06:00\\",\\n \\"DBType\\": \\"polarx\\",\\n \\"RightsSeparationEnabled\\": false,\\n \\"VPCId\\": \\"vpc-xxxxx\\",\\n \\"MinorVersion\\": \\"polarx-kernel_5.4.11-16301083_xcluster-20210805\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Network\\": \\"VPC\\",\\n \\"DBVersion\\": \\"5.5\\",\\n \\"VSwitchId\\": \\"vsw-********\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"KindCode\\": 18,\\n \\"Id\\": \\"pxc-zkralxpc5d****\\",\\n \\"DBNodes\\": [\\n {\\n \\"ComputeNodeId\\": \\"pxc-i-********\\",\\n \\"NodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"DataNodeId\\": \\"pxc-xdb-xxxxxx\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"Id\\": \\"pxi-*********\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"ConnAddrs\\": [\\n {\\n \\"Type\\": \\"VPC\\",\\n \\"VSwitchId\\": \\"vsw-*********\\",\\n \\"Port\\": 3306,\\n \\"VPCId\\": \\"vpc-xxxxxx\\",\\n \\"ConnectionString\\": \\"polardbx-xxx.aliyuncs.com\\",\\n \\"VpcInstanceId\\": \\"pxc-zkralxpc5d****\\"\\n }\\n ],\\n \\"ReadDBInstances\\": [\\n \\"pxr-*********\\"\\n ],\\n \\"ResourceGroupId\\": \\"rg-xxxx\\",\\n \\"TagSet\\": [\\n {\\n \\"Key\\": \\"key2\\",\\n \\"Value\\": \\"value2\\"\\n }\\n ],\\n \\"CnNodeCount\\": 2,\\n \\"DnNodeCount\\": 2,\\n \\"CnNodeClassCode\\": \\"polarx.x4.xlarge.2e\\",\\n \\"DnNodeClassCode\\": \\"mysql.x8.large.25\\",\\n \\"Series\\": \\"enterprise\\",\\n \\"LTSVersions\\": [\\n \\"X.X.X.X\\"\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeDBInstances' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '86242', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '实例所属地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'enum' => [ 'cn-shenzhen', 'cn-beijing', 'cn-wulanchabu', 'cn-shenzhen-finance-1', 'cn-north-2-gov-1', 'cn-qingdao', 'cn-shanghai', 'cn-shanghai-finance-1', 'cn-hongkong', 'cn-hangzhou-finance', 'ap-southeast-1', 'eu-central-1', 'cn-huhehaote', 'ap-southeast-5', 'us-east-1', 'cn-zhangjiakou', 'us-west-1', 'cn-hangzhou', 'ap-northeast-1', 'cn-zhengzhou-jva', 'cn-shanghai-cloudspe', 'ap-southeast-6', 'ap-southeast-7', ], ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => '分页下标：从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'pattern' => '^\\d+$', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '页面大小，取值如下：'."\n" ."\n" .'- 30'."\n" .'- 50'."\n" .'- 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '5', 'enumValueTitles' => [], 'example' => '30', 'pattern' => '^\\d+$', 'default' => '30', 'enum' => ['30', '50', '100'], ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['title' => '资源组ID', 'description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyst47******'], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => ['title' => '标签过滤条件', 'description' => '标签列表。', 'type' => 'string', 'required' => false, 'example' => '[{\\"TagKey\\":\\"test\\",\\"TagValue\\":\\"test-value\\"}]'], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['title' => '实例名称', 'description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'dinga93c84f4d***'], ], [ 'name' => 'Series', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => '实例系列，取值如下：'."\n" ."\n" .'- **enterprise**：企业版'."\n" .'- **standard**：标准版', 'type' => 'string', 'required' => false, 'example' => 'enterprise'], ], [ 'name' => 'MustHasCdc', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '是否必须有日志引擎。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'DbVersion', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => '数据库描述/备注', 'type' => 'string', 'required' => false, 'example' => 'app-test'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], 'PageNumber' => ['description' => '页面下标。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'PageSize' => ['description' => '页面大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], 'TotalNumber' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], 'DBInstances' => [ 'description' => '实例列表。', 'type' => 'array', 'items' => [ 'description' => '实例详情。', 'type' => 'object', 'properties' => [ 'Type' => ['description' => '实例类型：'."\n" ."\n" .'- **ReadWrite**： 主实例'."\n" .'- **ReadOnly**： 只读实例', 'type' => 'string', 'example' => 'ReadWrite'], 'Status' => ['description' => '实例状态，详情请参见[实例状态表](~~339826~~)。', 'type' => 'string', 'example' => 'Running'], 'CommodityCode' => ['description' => '商品类型。', 'type' => 'string', 'example' => 'drds_polarxpre_public_cn'], 'ExpireTime' => ['description' => '过期时间。', 'type' => 'string', 'example' => '2021-12-01T16:00:00.000+0000'], 'Expired' => ['description' => '是否过期。', 'type' => 'boolean', 'example' => 'false'], 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-11-01T03:49:50.000+0000'], 'PayType' => ['description' => '实例付费方式，取值：'."\n" ."\n" .'- **Postpaid**：按量付费；'."\n" .'- **Prepaid**：包年包月。', 'type' => 'string', 'example' => 'Prepaid'], 'LockReason' => ['description' => '锁定原因。', 'type' => 'string', 'example' => '欠费'], 'DBType' => ['description' => '数据库类型。', 'type' => 'string', 'example' => 'polarx'], 'LockMode' => ['description' => '是否锁定。', 'type' => 'string', 'example' => 'Unlock'], 'VPCId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'VPCID'], 'MinorVersion' => ['description' => '当前内核版本。', 'type' => 'string', 'example' => 'polarx-kernel_5.4.12-16349923_xcluster-20210926'], 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], 'Network' => ['description' => '网络类型。', 'type' => 'string', 'example' => 'VPC'], 'DBVersion' => ['description' => '数据库版本。', 'type' => 'string', 'example' => '5.7'], 'Description' => ['description' => '数据库描述。', 'type' => 'string', 'example' => '测试'], 'NodeClass' => ['description' => '规格。', 'type' => 'string', 'example' => 'polarx.x4.large.2e'], 'StorageUsed' => ['description' => '存储使用。', 'type' => 'integer', 'format' => 'int64', 'example' => '40658534400'], 'NodeCount' => ['description' => '节点个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-g'], 'Engine' => ['description' => '引擎型号。', 'type' => 'string', 'example' => 'polarx'], 'Id' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'pxc-hzr2yeov******'], 'Nodes' => [ 'description' => '节点列表。', 'type' => 'array', 'items' => [ 'description' => '节点列表。', 'type' => 'object', 'properties' => [ 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-g'], 'Id' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'pxi-zd89wrzqh******'], 'RegionId' => ['description' => '区域ID。', 'type' => 'string', 'example' => 'cn-hangzhou-g-aliyun'], 'ClassCode' => ['description' => '实例规格。', 'type' => 'string', 'example' => 'polarx.x4.large.2e'], 'Name' => ['type' => 'string', 'description' => ''], ], ], ], 'ReadDBInstances' => [ 'description' => '只读实例列表。', 'type' => 'array', 'items' => ['description' => '只读实例名称。', 'type' => 'string', 'example' => 'pxr-hzr2yeov******'], ], 'ColumnarReadDBInstances' => [ 'description' => '列存只读实例信息。', 'type' => 'array', 'items' => ['description' => '列存只读实例信息。', 'type' => 'string', 'example' => 'xxxxxxxx'], ], 'ResourceGroupId' => ['title' => '资源组ID', 'description' => '资源组ID', 'type' => 'string', 'example' => 'rg-xxxxxx'], 'TagSet' => [ 'title' => '标签集合', 'description' => '标签集合。', 'type' => 'array', 'items' => [ 'description' => '标签集合。', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '标签名称', 'description' => '标签名称。', 'type' => 'string', 'example' => 'key1'], 'Value' => ['title' => '标签值', 'description' => '标签值。', 'type' => 'string', 'example' => 'value1'], ], ], ], 'DBInstanceName' => ['title' => '数据库实例名称', 'description' => '数据库实例名称。', 'type' => 'string', 'example' => 'pxc-xxxxx'], 'DnNodeCount' => ['description' => 'DN节点个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'CnNodeCount' => ['description' => 'CN节点个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'CnNodeClassCode' => ['description' => 'CN节点规格。'."\n" ."\n" .'- **polarx.x4.medium.2e**：2核8G'."\n" .'- **polarx.x4.large.2e**：4核16G'."\n" .'- **polarx.x8.large.2e**：4核32G'."\n" .'- **polarx.x4.xlarge.2e**：8核32G'."\n" .'- **polarx.x8.xlarge.2e**：8核64G'."\n" .'- **polarx.x4.2xlarge.2e**：16核64G'."\n" .'- **polarx.x8.2xlarge.2e**：16核128G'."\n" .'- **polarx.x4.4xlarge.2e**：32核128G'."\n" .'- **polarx.x8.4xlarge.2e**：32核256G'."\n" .'- **polarx.st.8xlarge.2e**：60核470G'."\n" .'- **polarx.st.12xlarge.2e**：90核720G', 'type' => 'string', 'example' => 'polarx.x4.large.2e'], 'DnNodeClassCode' => ['description' => 'DN节点规格。'."\n" .'- **mysql.n2.medium.25**：2核4G'."\n" .'- **mysql.n4.medium.25**：2核8G'."\n" .'- **mysql.x8.medium.25**：2核16G'."\n" .'- **mysql.n2.large.25**：4核8G'."\n" .'- **mysql.n4.large.25**：4核16G'."\n" .'- **mysql.x8.large.25**：4核32G'."\n" .'- **mysql.n2.xlarge.25**：8核16G'."\n" .'- **mysql.n4.xlarge.25**：8核32G'."\n" .'- **mysql.x8.xlarge.25**：8核64G'."\n" .'- **mysql.n4.2xlarge.25**：16核64G'."\n" .'- **mysql.x8.2xlarge.25**：16核128G'."\n" .'- **mysql.x4.4xlarge.25**：32核128G'."\n" .'- **mysql.x8.4xlarge.25**：32核256G'."\n" .'- **mysql.st.8xlarge.25**：60核470G'."\n" .'- **mysql.st.12xlarge.25**：90核720G', 'type' => 'string', 'example' => 'mysql.n4.medium.25'], 'Series' => ['description' => '实例系列，取值如下：'."\n" ."\n" .'- **enterprise**：企业版'."\n" .'- **standard**：标准版', 'type' => 'string', 'example' => 'enterprise'], 'ContainBinlogX' => ['description' => '是否包含多流日志服务，取值如下：'."\n" ."\n" .'- **true**：是'."\n" .'- **false**：否', 'type' => 'boolean', 'example' => 'true'], 'SupportBinlogX' => ['description' => '当前实例是否支持多流，取值如下：'."\n" ."\n" .'- **true**：是'."\n" .'- **false**：否', 'type' => 'boolean', 'example' => 'true'], 'CdcInstanceName' => ['description' => '日志节点名称。', 'type' => 'string', 'example' => 'pxc-c-dmlgit****'], 'TopologyType' => ['title' => '拓扑类型：'."\n" ."\n" .'- **3azones**：三可用区；'."\n" .'- **1azone**：单可用区。', 'description' => '拓扑类型：'."\n" ."\n" .'- **3azones**：三可用区；'."\n" .'- **1azone**：单可用区。', 'type' => 'string', 'deprecated' => false, 'required' => true, 'example' => '3azones', 'pattern' => '', 'default' => '3azones'], 'TertiaryZone' => ['title' => '第三可用区。', 'description' => '第三可用区。', 'type' => 'string', 'deprecated' => false, 'example' => 'cn-hangzhou-k', 'pattern' => '', 'default' => ''], 'PrimaryZone' => ['title' => '主可用区。', 'description' => '主可用区。', 'type' => 'string', 'deprecated' => false, 'required' => true, 'example' => 'cn-hangzhou-j', 'pattern' => '', 'default' => ''], 'SecondaryZone' => ['title' => '次可用区。', 'description' => '次可用区。', 'type' => 'string', 'deprecated' => false, 'example' => 'cn-hangzhou-l', 'pattern' => '', 'default' => ''], 'ColumnarInstanceName' => ['description' => '列存引擎实例名称。', 'type' => 'string', 'example' => 'xxxxxxxx'], 'isInGdn' => ['type' => 'boolean', 'description' => ''], 'gdnRole' => ['type' => 'string', 'description' => ''], 'CpuType' => ['type' => 'string', 'description' => ''], 'PrimaryInstanceId' => ['type' => 'string', 'description' => ''], 'StorageType' => ['type' => 'string', 'description' => ''], 'EngineVersion' => ['type' => 'string', 'description' => ''], ], ], ], ], ], ], ], 'title' => '查询数据库实例列表', 'summary' => '调用DescribeDBInstances接口查询实例列表。', 'changeSet' => [ ['createdAt' => '2025-12-18T14:58:28.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2025-11-24T06:09:11.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2025-09-10T12:06:51.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2025-09-10T12:06:51.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2025-09-10T12:06:51.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2025-09-10T12:06:51.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2025-09-10T12:06:51.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2025-07-03T12:46:48.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2024-12-13T12:13:04.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2024-09-26T11:06:29.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2024-05-22T03:23:47.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2024-03-21T02:48:01.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2023-11-03T07:24:16.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2023-09-14T06:50:41.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2023-06-20T07:56:49.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2022-12-26T06:35:27.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ['createdAt' => '2022-12-26T06:35:27.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ['createdAt' => '2022-09-13T11:18:35.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2022-09-13T11:18:35.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2022-05-30T11:01:37.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2021-12-09T02:04:58.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2021-12-09T01:58:43.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2021-12-08T09:22:38.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstances'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeDBInstances', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalNumber\\": 30,\\n \\"DBInstances\\": [\\n {\\n \\"Type\\": \\"ReadWrite\\",\\n \\"Status\\": \\"Running\\",\\n \\"CommodityCode\\": \\"drds_polarxpre_public_cn\\",\\n \\"ExpireTime\\": \\"2021-12-01T16:00:00.000+0000\\",\\n \\"Expired\\": false,\\n \\"CreateTime\\": \\"2021-11-01T03:49:50.000+0000\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"LockReason\\": \\"欠费\\",\\n \\"DBType\\": \\"polarx\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"VPCId\\": \\"VPCID\\",\\n \\"MinorVersion\\": \\"polarx-kernel_5.4.12-16349923_xcluster-20210926\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Network\\": \\"VPC\\",\\n \\"DBVersion\\": \\"5.7\\",\\n \\"Description\\": \\"测试\\",\\n \\"NodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"StorageUsed\\": 40658534400,\\n \\"NodeCount\\": 5,\\n \\"ZoneId\\": \\"cn-hangzhou-g\\",\\n \\"Engine\\": \\"polarx\\",\\n \\"Id\\": \\"pxc-hzr2yeov******\\",\\n \\"Nodes\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-g\\",\\n \\"Id\\": \\"pxi-zd89wrzqh******\\",\\n \\"RegionId\\": \\"cn-hangzhou-g-aliyun\\",\\n \\"ClassCode\\": \\"polarx.x4.large.2e\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"ReadDBInstances\\": [\\n \\"pxr-hzr2yeov******\\"\\n ],\\n \\"ColumnarReadDBInstances\\": [\\n \\"xxxxxxxx\\"\\n ],\\n \\"ResourceGroupId\\": \\"rg-xxxxxx\\",\\n \\"TagSet\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"DBInstanceName\\": \\"pxc-xxxxx\\",\\n \\"DnNodeCount\\": 2,\\n \\"CnNodeCount\\": 2,\\n \\"CnNodeClassCode\\": \\"polarx.x4.large.2e\\",\\n \\"DnNodeClassCode\\": \\"mysql.n4.medium.25\\",\\n \\"Series\\": \\"enterprise\\",\\n \\"ContainBinlogX\\": true,\\n \\"SupportBinlogX\\": true,\\n \\"CdcInstanceName\\": \\"pxc-c-dmlgit****\\",\\n \\"TopologyType\\": \\"3azones\\",\\n \\"TertiaryZone\\": \\"cn-hangzhou-k\\",\\n \\"PrimaryZone\\": \\"cn-hangzhou-j\\",\\n \\"SecondaryZone\\": \\"cn-hangzhou-l\\",\\n \\"ColumnarInstanceName\\": \\"xxxxxxxx\\",\\n \\"isInGdn\\": true,\\n \\"gdnRole\\": \\"\\",\\n \\"CpuType\\": \\"\\",\\n \\"PrimaryInstanceId\\": \\"\\",\\n \\"StorageType\\": \\"\\",\\n \\"EngineVersion\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n 1\\n 30\\n 30\\n \\n ReadWrite\\n Running\\n drds_polarxpre_public_cn\\n 2021-12-01T16:00:00.000+0000\\n false\\n 2021-11-01T03:49:50.000+0000\\n Prepaid\\n 欠费\\n polarx\\n Unlock\\n VPCID\\n polarx-kernel_5.4.12-16349923_xcluster-20210926\\n cn-hangzhou\\n VPC\\n 5.7\\n 测试\\n polarx.x4.large.2e\\n 40658534400\\n 5\\n cn-hangzhou-g\\n polarx\\n pxc-hzr2yeov******\\n \\n cn-hangzhou-g\\n pxi-zd89wrzqh******\\n polarx.x4.large.2e\\n cn-hangzhou-g-aliyun\\n \\n pxr-hzr2yeov******\\n rg-xxxxxx\\n \\n key1\\n value1\\n \\n pxc-xxxxx\\n 2\\n 2\\n polarx.x4.large.2e\\n mysql.n4.medium.25\\n enterprise\\n true\\n true\\n pxc-c-dmlgit****\\n 3azones\\n cn-hangzhou-k\\n cn-hangzhou-j\\n cn-hangzhou-l\\n xxxxx\\n \\n","errorExample":""}]', ], 'DescribeDBNodePerformance' => [ 'summary' => '调用DescribeDBNodePerformance接口查询实例性能数据。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '101459', 'abilityTreeNodes' => ['FEATUREdrdsD0NTUP'], ], 'parameters' => [ [ 'name' => 'Key', 'in' => 'query', 'schema' => ['description' => '指标名称，多个用英文逗号分隔，最多6个。详细内容请参见[性能参数表](~~332726~~)章节。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Cpu_Usage,Mem_Usage'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => '查询开始时间, 格式： YYYY-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2012-06-08T15:00Z'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => 'PolarDB-X实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-*******'], ], [ 'name' => 'DBNodeIds', 'in' => 'query', 'schema' => ['description' => '节点名称，多个用英文逗号分隔，CDC节点和计算节点一次最多支持10个节点，数据节点一次最多支持1个节点。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-i-******,pxc-i-*******'], ], [ 'name' => 'CharacterType', 'in' => 'query', 'schema' => ['description' => '节点类型。目前包含polarx\\_cn、polarx\\_dn、polarx\\_cdc、polarx\\_gms、polarx\\_columnar。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'polarx_cn'], ], [ 'name' => 'DBNodeRole', 'in' => 'query', 'schema' => ['description' => '节点类型，取值：'."\n" .'- master：主节点'."\n" .'- slave：备节点。 针对 DN 和 GMS节点。'."\n" .'- standby： 备节点。针对 CN 节点。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'master'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => '查询结束时间, 格式： YYYY-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2012-06-18T15:00Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'EndTime' => ['description' => '查询结束时间, 格式： YYYY-MM-ddTHH:mm:ssZ（UTC时间）。', 'type' => 'string', 'example' => '2021-10-20T02:00Z'], 'StartTime' => ['description' => '查询开始时间, 格式： YYYY-MM-ddTHH:mm:ssZ（UTC时间）。', 'type' => 'string', 'example' => '2021-10-20T00:00Z'], 'DBInstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'pxc-********'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EFB5E10B-5268-170F-A378-9AF86CCEACC8'], 'PerformanceKeys' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PerformanceItem' => [ 'description' => '性能数据列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MetricName' => ['description' => '具体的性能指标度量名称。', 'type' => 'string', 'example' => 'logic_tps'], 'DBNodeId' => ['description' => '节点名称。', 'type' => 'string', 'example' => 'pxc-i-********'], 'Measurement' => ['description' => '性能指标。', 'type' => 'string', 'example' => 'Logic_TPS'], 'Points' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PerformanceItemValue' => [ 'description' => '性能数据数组。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Value' => ['description' => '监控指标数据值。', 'type' => 'string', 'example' => '42.38'], 'Timestamp' => ['description' => '监控指标的具体时间点，格式为时间戳，单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1600822800000'], ], 'description' => '', ], ], ], 'description' => '', ], ], 'description' => '', ], ], ], 'description' => '', ], ], 'description' => '', ], ], ], 'title' => '查询实例性能数据', 'description' => '注意： '."\n" .'- **endpoint**和其他接口有区别，国内和新加坡需使用**polardbx.aliyuncs.com**， 其他地域使用**polardbx.{region id}.aliyunc.com**。'."\n" .'- 调试此API接口的时候，如果报服务不可用的错，请确认下**endpoint**是否正确，可通过切换**服务地址**到**迪拜**或者**印度**，将**endpoint**切换到**polardbx.aliyuncs.com**。', 'changeSet' => [ ['createdAt' => '2025-03-24T09:42:13.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2021-10-26T07:02:41.000Z', 'description' => 'OpenAPI 下线'], ['createdAt' => '2021-10-26T07:02:41.000Z', 'description' => '请求参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBNodePerformance'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2021-10-20T02:00Z\\",\\n \\"StartTime\\": \\"2021-10-20T00:00Z\\",\\n \\"DBInstanceName\\": \\"pxc-********\\",\\n \\"RequestId\\": \\"EFB5E10B-5268-170F-A378-9AF86CCEACC8\\",\\n \\"PerformanceKeys\\": {\\n \\"PerformanceItem\\": [\\n {\\n \\"MetricName\\": \\"logic_tps\\",\\n \\"DBNodeId\\": \\"pxc-i-********\\",\\n \\"Measurement\\": \\"Logic_TPS\\",\\n \\"Points\\": {\\n \\"PerformanceItemValue\\": [\\n {\\n \\"Value\\": \\"42.38\\",\\n \\"Timestamp\\": 1600822800000\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 2021-10-20T02:00Z\\n 2021-10-20T00:00Z\\n pxc-********\\n EFB5E10B-5268-170F-A378-9AF86CCEACC8\\n \\n logic_tps\\n pxc-i-********\\n Logic_TPS\\n \\n 42.38\\n 1600822800000\\n \\n \\n","errorExample":""}]', ], 'DescribeDataImportTaskInfo' => [ 'summary' => '查询数据导入任务的执行详情。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '104724', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'FailPageNumber', 'in' => 'query', 'schema' => ['description' => '请求失败的页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'pattern' => '^\\d+$', 'default' => '1'], ], [ 'name' => 'FailPageSize', 'in' => 'query', 'schema' => ['description' => '每页显示多少条“失败记录”。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '5', 'example' => '10', 'pattern' => '^\\d+$', 'default' => '30'], ], [ 'name' => 'SuccessPageNumber', 'in' => 'query', 'schema' => ['description' => '请求成功的页码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'SuccessPageSize', 'in' => 'query', 'schema' => ['description' => '每页显示多少条“成功记录”。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '15'], ], [ 'name' => 'SlinkTaskId', 'in' => 'query', 'schema' => ['description' => '任务id。', 'type' => 'string', 'required' => true, 'example' => 'etx-szr2rr6i*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '返回信息。当任务状态为success时，该参数才有值，否则返回值为空。', 'type' => 'string', 'example' => 'success'], 'Data' => [ 'description' => '返回结果集。', 'type' => 'object', 'properties' => [ 'DataImportTaskDetailInfo' => [ 'description' => '任务详情。', 'type' => 'object', 'properties' => [ 'FsmId' => ['description' => '进度id。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'FsmState' => ['description' => '数据迁移或同步任务中的一种状态标识。', 'type' => 'string', 'example' => 'RECON_FINISHED_CATCH_UP'], 'FsmStatus' => ['description' => '数据迁移、导入、同步等系统中的状态。', 'type' => 'string', 'example' => 'IMPORT_NOT_BEGIN'], 'ServiceDetailList' => [ 'description' => '数据导入任务详情。', 'type' => 'array', 'items' => [ 'description' => '数据导入任务详情。', 'type' => 'object', 'properties' => [ 'Id' => ['description' => '服务详情id。', 'type' => 'integer', 'format' => 'int64', 'example' => '1991609'], 'Status' => ['description' => '任务执行状态。', 'type' => 'string', 'example' => 'FINISHED'], 'TaskDetailList' => [ 'description' => '任务详情。', 'type' => 'array', 'items' => [ 'description' => '任务详情。', 'type' => 'object', 'properties' => [ 'Delay' => ['description' => '延迟时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '58329'], 'LastError' => ['description' => '最近错误信息。', 'type' => 'string', 'example' => 'null'], 'PhysicalDbName' => ['description' => '物理库名称。', 'type' => 'string', 'example' => 'drds_test'], 'Progress' => ['description' => '数据导入进度。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'Statistics' => ['description' => '字段记录的是数据迁移/导入任务执行过程中的性能与运行时指标', 'type' => 'string', 'example' => '{'."\n" .' "applyCount": 0,'."\n" .' "cpuUseRatio": 41,'."\n" .' "fsmId": 1,'."\n" .' "fullGcCount": '."\n" .'}'], 'Status' => ['description' => '任务状态。', 'type' => 'string', 'example' => 'active'], 'TaskId' => ['description' => '任务id。', 'type' => 'integer', 'format' => 'int64', 'example' => 'fc3b1568-ad96-****-adca-dfe018b38077'], 'Type' => ['description' => '任务类型。', 'type' => 'string', 'example' => 'FULL_COPY'], ], ], ], 'Type' => ['description' => 'FULL_COPY全量复制，INC_COPY增量复制', 'type' => 'string', 'example' => 'FULL_COPY'], ], ], ], ], ], ], ], 'Code' => ['description' => '请求返回码。>请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], 'Success' => ['description' => '请求是否成功。', 'type' => 'string', 'example' => 'true'], 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '9B2F3840-5C98-****-B269-2D5C3A31797C'], ], 'description' => '', ], ], ], 'title' => '获取数据导入任务信息', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDataImportTaskInfo'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"DataImportTaskDetailInfo\\": {\\n \\"FsmId\\": 1,\\n \\"FsmState\\": \\"RECON_FINISHED_CATCH_UP\\",\\n \\"FsmStatus\\": \\"IMPORT_NOT_BEGIN\\",\\n \\"ServiceDetailList\\": [\\n {\\n \\"Id\\": 1991609,\\n \\"Status\\": \\"FINISHED\\",\\n \\"TaskDetailList\\": [\\n {\\n \\"Delay\\": 58329,\\n \\"LastError\\": \\"null\\",\\n \\"PhysicalDbName\\": \\"drds_test\\",\\n \\"Progress\\": 0,\\n \\"Statistics\\": \\"{\\\\n \\\\\\"applyCount\\\\\\": 0,\\\\n \\\\\\"cpuUseRatio\\\\\\": 41,\\\\n \\\\\\"fsmId\\\\\\": 1,\\\\n \\\\\\"fullGcCount\\\\\\": \\\\n}\\",\\n \\"Status\\": \\"active\\",\\n \\"TaskId\\": 0,\\n \\"Type\\": \\"FULL_COPY\\"\\n }\\n ],\\n \\"Type\\": \\"FULL_COPY\\"\\n }\\n ]\\n }\\n },\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-****-B269-2D5C3A31797C\\"\\n}","type":"json"}]', ], 'DescribeDbList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属的地域ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********'], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['description' => '数据库名字。', 'type' => 'string', 'required' => false, 'example' => 'db_name'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '返回信息，成功返回success，错误返回对应错误码。', 'type' => 'string', 'example' => 'Success'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], 'Success' => ['description' => '请求是否成功。'."\n", 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '数据库列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'test'], 'DBDescription' => ['description' => '数据库描述。', 'type' => 'string', 'example' => 'test'], 'DBInstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'pxc-********'], 'CharacterSetName' => ['description' => '字符集。', 'type' => 'string', 'example' => 'utf8mb4'], 'Accounts' => [ 'description' => '账户列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccountPrivilege' => ['description' => '权限。', 'type' => 'string', 'example' => 'ReadWrite'], 'AccountName' => ['description' => '账户名称。', 'type' => 'string', 'example' => 'root4test'], ], 'description' => '', ], ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], 'title' => '查询获取实例下的数据库信息', 'summary' => '调用DescribeDbList接口获取数据库列表。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDbList'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"DBName\\": \\"test\\",\\n \\"DBDescription\\": \\"test\\",\\n \\"DBInstanceName\\": \\"pxc-********\\",\\n \\"CharacterSetName\\": \\"utf8mb4\\",\\n \\"Accounts\\": [\\n {\\n \\"AccountPrivilege\\": \\"ReadWrite\\",\\n \\"AccountName\\": \\"root4test\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n Success\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n true\\n \\n test\\n test\\n pxc-********\\n utf8mb4\\n \\n ReadWrite\\n root4test\\n \\n \\n","errorExample":""}]', ], 'DescribeDistributeTableList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '86248', 'abilityTreeNodes' => ['FEATUREdrdsTIBR6Q'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********'], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sbtest1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '返回信息，成功返回success，错误返回对应错误码。', 'type' => 'string', 'example' => 'Success'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], 'Success' => ['description' => '是否请求成功', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'Tables' => [ 'description' => '表列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TableName' => ['description' => '表名。', 'type' => 'string', 'example' => 'sbtest1'], 'TableType' => ['description' => '表类型。', 'type' => 'string', 'example' => 'multi'], 'TbKey' => ['description' => '表key。', 'type' => 'string', 'example' => '“”'], 'DbKey' => ['description' => '数据key。', 'type' => 'string', 'example' => 'id'], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], 'title' => '获取数据库表列表', 'summary' => '调用DescribeDistributeTableList接口获取数据库表列表。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDistributeTableList'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Tables\\": [\\n {\\n \\"TableName\\": \\"sbtest1\\",\\n \\"TableType\\": \\"multi\\",\\n \\"TbKey\\": \\"“”\\",\\n \\"DbKey\\": \\"id\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n Success\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n true\\n \\n \\n sbtest1\\n multi\\n “”\\n id\\n \\n \\n","errorExample":""}]', ], 'DescribeEnabledCrossRegions' => [ 'summary' => '该接口用于查询当前已启用的跨可用区。', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '193730', 'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称', 'type' => 'string', 'required' => false, 'example' => 'pxc-bjxxxxxxxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '*****'], 'Data' => [ 'description' => '参数详情。', 'type' => 'array', 'items' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'Regions' => [ 'description' => '是否支持vpc。', 'type' => 'array', 'items' => ['description' => '可用区。', 'type' => 'string', 'example' => '[{\'RegionEndpoint\': \'nlb.cn-north-2-gov-1.aliyuncs.com\', \'RegionId\': \'cn-north-2-gov-1\', \'LocalName\': \'China North 2 Ali Gov 1\'}]'], ], ], ], ], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '查询已启用的跨可用区', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnabledCrossRegions'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"*****\\",\\n \\"Data\\": [\\n {\\n \\"Regions\\": [\\n \\"[{\'RegionEndpoint\': \'nlb.cn-north-2-gov-1.aliyuncs.com\', \'RegionId\': \'cn-north-2-gov-1\', \'LocalName\': \'China North 2 Ali Gov 1\'}]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', ], 'DescribeEvaluateAndImportTask' => [ 'summary' => '查询 PolarDB-X 评估导入任务的列表。（单个）', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '111376', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'SlinkTaskId', 'in' => 'query', 'schema' => ['description' => '连接任务id。', 'type' => 'string', 'required' => false, 'example' => 'etx-szr2rr6i*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '73559800-****-11ec-bd40-99cfcff3fe1e'], 'Message' => ['description' => '请求返回消息。>请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'Success'], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'Bid' => ['description' => '导入任务的业务id。', 'type' => 'string', 'example' => '26842'], 'Creator' => ['description' => '导入任务的创建人', 'type' => 'string', 'example' => '346650'], 'Deleted' => ['description' => '导入任务是否成功。', 'type' => 'boolean', 'example' => 'false'], 'GmtCreated' => ['description' => '任务创建时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-06-08T15:00Z'], 'GmtModified' => ['description' => '修改时间，时间戳格式。', 'type' => 'integer', 'format' => 'int64', 'example' => '1605080537000'], 'Id' => ['description' => '任务id。', 'type' => 'integer', 'format' => 'int64', 'example' => '76251'], 'RegionId' => ['description' => '地域id。', 'type' => 'string', 'example' => 'cn-hangzhou'], 'SlinkDstResId' => ['description' => '目标端实例ID。', 'type' => 'string', 'example' => 'pxc-hzrehc60jz5zye'], 'SlinkDstUserName' => ['description' => '目标端数据连接用户名。', 'type' => 'string', 'example' => 'dts_dtdba'], 'SlinkSrcResId' => ['description' => '源端实例ID。', 'type' => 'string', 'example' => 'drdshbga69378w4p'], 'SlinkSrcUserName' => ['description' => '源端数据连接用户名。', 'type' => 'string', 'example' => 'dtdba'], 'SlinkStage' => ['description' => '同步所处的“阶段”。', 'type' => 'string', 'example' => 'DATA_IMPORT_RUNNING'], 'SlinkStatus' => ['description' => '同步的“运行状态”。', 'type' => 'string', 'example' => 'IMPORT_RUNNING'], 'SlinkTaskId' => ['description' => 'slink任务id。', 'type' => 'string', 'example' => 'etx-szr2rr6i*****'], 'SlinkType' => ['description' => '同步类型。', 'type' => 'string', 'example' => 'evaluate_import'], 'SlinkSrcDb' => ['description' => 'slink源数据库名称。', 'type' => 'string', 'example' => 'fr_import'], 'SlinkDstDb' => ['description' => 'slink目标数据库名称。', 'type' => 'string', 'example' => 'fr_import'], 'SlinkTaskDesc' => ['description' => 'slinktask描述。', 'type' => 'string', 'example' => 'drdsprod_to_2.0'], 'Context' => ['description' => '小结信息。', 'type' => 'string', 'example' => '"{\\"structureImportResult\\":{\\"status\\":\\"finish\\",\\"finishedNum\\":382,\\"totalNum\\":382,\\"percentage\\":100},\\"switchTips\\":\\"正向同步延迟较小时才允许开始正向切换\\",\\"autoTableSuggestionSwitch\\":false,\\"structureAlterationMap\\":{},\\"acceptFilterMap\\":{\\"fr_import\\":[\\"dy_dr_new\\"],\\"e3plus_drp_prod_new\\":[],\\"qbtong_prod\\":[],\\"e3plus_account_prod\\":[],\\"e3plus_drp_prod\\":[]},\\"structChunkMap\\":{},\\"count\\":1,\\"requestId\\":\\"9380D025-C9B1-51D6-A4B9-733C4879CC4A\\"}",'], 'SlinkSrcResType' => ['description' => '源端资源类型。', 'type' => 'string', 'example' => 'POLARX1'], ], ], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => '查询评估导入任务列表', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEvaluateAndImportTask'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73559800-****-11ec-bd40-99cfcff3fe1e\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"Bid\\": \\"26842\\",\\n \\"Creator\\": \\"346650\\",\\n \\"Deleted\\": false,\\n \\"GmtCreated\\": 0,\\n \\"GmtModified\\": 1605080537000,\\n \\"Id\\": 76251,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SlinkDstResId\\": \\"pxc-hzrehc60jz5zye\\",\\n \\"SlinkDstUserName\\": \\"dts_dtdba\\",\\n \\"SlinkSrcResId\\": \\"drdshbga69378w4p\\",\\n \\"SlinkSrcUserName\\": \\"dtdba\\",\\n \\"SlinkStage\\": \\"DATA_IMPORT_RUNNING\\",\\n \\"SlinkStatus\\": \\"IMPORT_RUNNING\\",\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\",\\n \\"SlinkType\\": \\"evaluate_import\\",\\n \\"SlinkSrcDb\\": \\"fr_import\\",\\n \\"SlinkDstDb\\": \\"fr_import\\",\\n \\"SlinkTaskDesc\\": \\"drdsprod_to_2.0\\",\\n \\"Context\\": \\"\\\\\\"{\\\\\\\\\\\\\\"structureImportResult\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"finish\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"finishedNum\\\\\\\\\\\\\\":382,\\\\\\\\\\\\\\"totalNum\\\\\\\\\\\\\\":382,\\\\\\\\\\\\\\"percentage\\\\\\\\\\\\\\":100},\\\\\\\\\\\\\\"switchTips\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"正向同步延迟较小时才允许开始正向切换\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"autoTableSuggestionSwitch\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"structureAlterationMap\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"acceptFilterMap\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"fr_import\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"dy_dr_new\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"e3plus_drp_prod_new\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"qbtong_prod\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"e3plus_account_prod\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"e3plus_drp_prod\\\\\\\\\\\\\\":[]},\\\\\\\\\\\\\\"structChunkMap\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"requestId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"9380D025-C9B1-51D6-A4B9-733C4879CC4A\\\\\\\\\\\\\\"}\\\\\\",\\",\\n \\"SlinkSrcResType\\": \\"POLARX1\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DescribeEvaluateAndImportTasks' => [ 'summary' => '查询 PolarDB-X 评估导入任务的列表。（多个）', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '103609', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。>您可以调用[describeregions](~~196841~~)接口查看polardb-x支持的地域详情，包括地域id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'pattern' => '^\\d+$', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '5', 'example' => '0', 'pattern' => '^\\d+$', 'default' => '30'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '81519FDE-713B-****-B6F1-231479A4C9DB'], 'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'Message' => ['description' => '返回消息。>请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'success'], 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'TotalNumber' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'Data' => [ 'description' => '恢复任务详情。', 'type' => 'array', 'items' => [ 'description' => '恢复任务详情。', 'type' => 'object', 'properties' => [ 'Bid' => ['description' => '导入任务的业务id。', 'type' => 'string', 'example' => '26842'], 'Creator' => ['description' => '导入任务的创建人', 'type' => 'string', 'example' => '346650'], 'Deleted' => ['description' => '是否已经删除', 'type' => 'boolean', 'example' => 'fase'], 'GmtCreated' => ['description' => '任务创建时间戳，单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-01-08T15:00Z'], 'GmtModified' => ['description' => '修改时间，指元数据信息。', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-04-02T02:10:59Z'], 'Id' => ['description' => '任务id。', 'type' => 'integer', 'format' => 'int64', 'example' => 'ap-northeast-1'], 'RegionId' => ['description' => '地域id。', 'type' => 'string', 'example' => 'cn-zhangjiakou'], 'SlinkDstResId' => ['description' => '目标端实例ID。', 'type' => 'string', 'example' => 'pxc-hzrehc****5zye'], 'SlinkDstUserName' => ['description' => '目标端数据连接用户名。', 'type' => 'string', 'example' => 'dts_temp_2_23'], 'SlinkSrcResId' => ['description' => '源端实例ID。', 'type' => 'string', 'example' => 'drdshbga*****w4p'], 'SlinkSrcUserName' => ['description' => '源端数据连接用户名。', 'type' => 'string', 'example' => 'dtdba'], 'SlinkStage' => ['description' => '同步所处的“阶段”。', 'type' => 'string', 'example' => 'DATA_IMPORT_RUNNING'], 'SlinkStatus' => ['description' => '同步的“运行状态”。', 'type' => 'string', 'example' => 'IMPORT_NOT_BEGIN'], 'SlinkTaskId' => ['description' => 'slink任务id。', 'type' => 'string', 'example' => 'etx-szr2rr6i*****'], 'SlinkType' => ['description' => '同步类型。', 'type' => 'string', 'example' => 'evaluate_import'], 'SlinkSrcDb' => ['description' => 'slink源数据库名称。', 'type' => 'string', 'example' => 'stock'], 'SlinkDstDb' => ['description' => 'slink目标数据库名称。', 'type' => 'string', 'example' => 'e3plus_*****_prod'], 'SlinkTaskDesc' => ['description' => 'slinktask描述。', 'type' => 'string', 'example' => 'test'], 'SlinkSrcResType' => ['description' => '源端资源类型。', 'type' => 'string', 'example' => 'RDS_MYSQL'], ], ], ], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'], ], 'description' => '', ], ], ], 'title' => '查询评估导入任务列表', 'description' => 'CreateDataImportTask 接口用于创建数据导入任务，支持将存储在OSS、ECS或直接传入的SQL/CSV文件导入到目标数据库实例中。通过指定实例ID、数据库名、引擎类型、数据来源（如OSS路径）及导入类型，系统将异步或同步执行数据写入操作，适用于数据迁移、初始化和补录等场景，返回任务ID以便后续状态查询与管理。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEvaluateAndImportTasks'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"81519FDE-713B-****-B6F1-231479A4C9DB\\",\\n \\"PageSize\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"PageNumber\\": 1,\\n \\"TotalNumber\\": 0,\\n \\"Data\\": [\\n {\\n \\"Bid\\": \\"26842\\",\\n \\"Creator\\": \\"346650\\",\\n \\"Deleted\\": true,\\n \\"GmtCreated\\": 0,\\n \\"GmtModified\\": 0,\\n \\"Id\\": 0,\\n \\"RegionId\\": \\"cn-zhangjiakou\\",\\n \\"SlinkDstResId\\": \\"pxc-hzrehc****5zye\\",\\n \\"SlinkDstUserName\\": \\"dts_temp_2_23\\",\\n \\"SlinkSrcResId\\": \\"drdshbga*****w4p\\",\\n \\"SlinkSrcUserName\\": \\"dtdba\\",\\n \\"SlinkStage\\": \\"DATA_IMPORT_RUNNING\\",\\n \\"SlinkStatus\\": \\"IMPORT_NOT_BEGIN\\",\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\",\\n \\"SlinkType\\": \\"evaluate_import\\",\\n \\"SlinkSrcDb\\": \\"stock\\",\\n \\"SlinkDstDb\\": \\"e3plus_*****_prod\\",\\n \\"SlinkTaskDesc\\": \\"test\\",\\n \\"SlinkSrcResType\\": \\"RDS_MYSQL\\"\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DescribeEvents' => [ 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '103087', 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '区域ID', 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['title' => '开始时间', 'description' => '开始时间。', 'type' => 'string', 'required' => false, 'example' => '2021-10-18T03:07:25Z'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['title' => '结束时间', 'description' => '结束时间。', 'type' => 'string', 'required' => false, 'example' => '2021-10-18T03:07:25Z'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['title' => '页面大小', 'description' => '页面大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => '页面下标', 'description' => '页面下标。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果集。', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '4748127A-6D50-432C-B635-433467074C27'], 'TotalRecordCount' => ['title' => '总页数', 'description' => '总页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], 'EventItems' => [ 'title' => '事件体', 'description' => '事件体。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'EventId' => ['title' => '事件ID', 'description' => '事件ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '50421290'], 'EventName' => ['title' => '事件名称', 'description' => '事件名称。', 'type' => 'string', 'example' => 'ModifySecurityIps'], 'EventPayload' => ['title' => '补充信息', 'description' => '补充信息。', 'type' => 'string', 'example' => '{\\"Domain\\": \\"rds-cn-hangzhou.aliyuncs.com\\"}'], 'EventReason' => ['title' => '原因', 'description' => '原因。', 'type' => 'string', 'example' => 'FROM_USER'], 'EventRecordTime' => ['title' => '记录时间', 'description' => '记录时间。', 'type' => 'string', 'example' => '2021-10-15T06:39:49Z'], 'EventTime' => ['title' => '事件时间', 'description' => '事件时间。', 'type' => 'string', 'example' => '2021-10-15T06:35:00Z'], 'EventType' => ['title' => '事件类型', 'description' => '事件类型。', 'type' => 'string', 'example' => 'SecurityManagement'], 'EventUserType' => ['title' => '事件用户类型', 'description' => '事件用户类型。', 'type' => 'string', 'example' => 'USRE'], 'RegionId' => ['title' => '区域ID', 'description' => '区域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], 'ResourceName' => ['title' => '资源名', 'description' => '资源名。', 'type' => 'string', 'example' => 'px-bp1v8udesc89g156g'], 'ResourceType' => ['title' => '资源类型', 'description' => '资源类型。', 'type' => 'string', 'example' => 'instance'], ], 'description' => '', ], ], 'PageSize' => ['title' => '页面大小', 'description' => '页面大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], 'PageNumber' => ['title' => '页面下标', 'description' => '页面下标。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], ], ], 'title' => '获取历史事件', 'summary' => '获取历史事件。', 'changeSet' => [ ['createdAt' => '2021-11-17T06:21:51.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEvents'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4748127A-6D50-432C-B635-433467074C27\\",\\n \\"TotalRecordCount\\": 20,\\n \\"EventItems\\": [\\n {\\n \\"EventId\\": 50421290,\\n \\"EventName\\": \\"ModifySecurityIps\\",\\n \\"EventPayload\\": \\"{\\\\\\\\\\\\\\"Domain\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"rds-cn-hangzhou.aliyuncs.com\\\\\\\\\\\\\\"}\\",\\n \\"EventReason\\": \\"FROM_USER\\",\\n \\"EventRecordTime\\": \\"2021-10-15T06:39:49Z\\",\\n \\"EventTime\\": \\"2021-10-15T06:35:00Z\\",\\n \\"EventType\\": \\"SecurityManagement\\",\\n \\"EventUserType\\": \\"USRE\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceName\\": \\"px-bp1v8udesc89g156g\\",\\n \\"ResourceType\\": \\"instance\\"\\n }\\n ],\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 4748127A-6D50-432C-B635-433467074C27\\n 20\\n \\n 50421290\\n ModifySecurityIps\\n {\\\\\\"Domain\\\\\\": \\\\\\"rds-cn-hangzhou.aliyuncs.com\\\\\\"}\\n FROM_USER\\n 2021-10-15T06:39:49Z\\n 2021-10-15T06:35:00Z\\n SecurityManagement\\n USRE\\n cn-hangzhou\\n px-bp1v8udesc89g156g\\n instance\\n \\n 20\\n 1\\n","errorExample":""}]', ], 'DescribeGdnInstances' => [ 'summary' => '获取GDN实例列表', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '218651', 'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'], ], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => '页面大小。', 'type' => 'string', 'required' => false, 'example' => '30'], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => ['description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。', 'type' => 'string', 'required' => false, 'example' => '50'], ], [ 'name' => 'FilterType', 'in' => 'query', 'schema' => [ 'description' => '消息过滤类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'gdn_id、'."\n" .'polarx_id', ], ], [ 'name' => 'FilterValue', 'in' => 'query', 'schema' => ['description' => '查询资源时的筛选值。'."\n" ."\n" .'与FilterKey配合使用。', 'type' => 'string', 'required' => false, 'example' => 'gdn-***、'."\n" .'pxc-***'], ], [ 'name' => 'GDNId', 'in' => 'query', 'schema' => ['description' => 'GDN ID。', 'type' => 'string', 'required' => false, 'example' => 'gdn-***'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7B044BD1-6402-5DE9-9AED-63D15A994E37'], 'Message' => ['description' => '请求返回消息。'."\n" .'> 请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'success'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'], 'Data' => [ 'description' => '实例详情列表。', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => '页面下标。', 'type' => 'string', 'example' => '1'], 'PageSize' => ['description' => '页面大小。', 'type' => 'string', 'example' => '30'], 'TotalNumber' => ['description' => '总数。', 'type' => 'string', 'example' => '130'], 'GdnInstanceList' => [ 'description' => 'GDN实例列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GdnInstanceName' => ['description' => 'GDN实例名', 'type' => 'string', 'example' => 'gdn-***'], 'GmtCreated' => ['description' => '创建时间', 'type' => 'string', 'example' => '2025-01-02T13:11:10.000+0000'], 'SwitchHistory' => ['description' => '切换日志', 'type' => 'string', 'example' => '""'], 'Status' => ['description' => '状态。', 'type' => 'string', 'example' => 'Creating'], 'MemberList' => [ 'description' => '成员列表。', 'type' => 'array', 'items' => [ 'description' => '结构体', 'type' => 'object', 'properties' => [ 'MemberName' => ['description' => '成员名（polarx实例名）。', 'type' => 'string', 'example' => 'pxc-***'], 'Role' => ['description' => '成员角色。', 'type' => 'string', 'example' => 'primary、'."\n" .'standby'], 'Status' => ['description' => '成员状态。', 'type' => 'string', 'example' => 'Creating'], 'GmtCreated' => ['description' => '创建时间', 'type' => 'string', 'example' => '2025-01-02T13:11:10.000+0000'], 'SecondsBehindMaster' => ['description' => '数据延迟', 'type' => 'string', 'example' => '1s'], 'CommodityCode' => ['description' => '商品code', 'type' => 'string', 'example' => 'drds_polarxpre_public_cn'], 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], 'ClassCode' => ['description' => '实例规格。', 'type' => 'string', 'example' => 'polarx.x4.medium.2e'], 'PayType' => ['description' => '实例付费方式，取值：'."\n" ."\n" .'- **Postpaid**：按量付费；'."\n" .'- **Prepaid**：包年包月。', 'type' => 'string', 'example' => 'Prepaid'], 'ExpireTime' => ['description' => '过期时间。', 'type' => 'string', 'example' => '2025-01-02T13:11:10.000+0000'], 'PrimaryZone' => ['description' => '主可用区。', 'type' => 'string', 'example' => 'cn-zhangjiakou-a'], 'SecondaryZone' => ['description' => '次可用区。', 'type' => 'string', 'example' => 'cn-zhangjiakou-a'], 'TertiaryZone' => ['description' => '第三可用区。', 'type' => 'string', 'example' => 'cn-zhangjiakou-a'], 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-zhangjiakou-a'], 'CnNodeClassCode' => ['description' => 'CN节点规格。'."\n" ."\n" .'- **polarx.x4.medium.2e**：2核8G'."\n" .'- **polarx.x4.large.2e**：4核16G'."\n" .'- **polarx.x8.large.2e**：4核32G'."\n" .'- **polarx.x4.xlarge.2e**：8核32G'."\n" .'- **polarx.x8.xlarge.2e**：8核64G'."\n" .'- **polarx.x4.2xlarge.2e**：16核64G'."\n" .'- **polarx.x8.2xlarge.2e**：16核128G'."\n" .'- **polarx.x4.4xlarge.2e**：32核128G'."\n" .'- **polarx.x8.4xlarge.2e**：32核256G'."\n" .'- **polarx.st.8xlarge.2e**：60核470G'."\n" .'- **polarx.st.12xlarge.2e**：90核720G', 'type' => 'string', 'example' => 'polarx.x4.medium.2e'], 'DnNodeClassCode' => ['description' => 'DN节点规格。'."\n" .'- **mysql.n2.medium.25**：2核4G'."\n" .'- **mysql.n4.medium.25**：2核8G'."\n" .'- **mysql.x8.medium.25**：2核16G'."\n" .'- **mysql.n2.large.25**：4核8G'."\n" .'- **mysql.n4.large.25**：4核16G'."\n" .'- **mysql.x8.large.25**：4核32G'."\n" .'- **mysql.n2.xlarge.25**：8核16G'."\n" .'- **mysql.n4.xlarge.25**：8核32G'."\n" .'- **mysql.x8.xlarge.25**：8核64G'."\n" .'- **mysql.n4.2xlarge.25**：16核64G'."\n" .'- **mysql.x8.2xlarge.25**：16核128G'."\n" .'- **mysql.x4.4xlarge.25**：32核128G'."\n" .'- **mysql.x8.4xlarge.25**：32核256G'."\n" .'- **mysql.st.8xlarge.25**：60核470G'."\n" .'- **mysql.st.12xlarge.25**：90核720G', 'type' => 'string', 'example' => 'mysql.n4.medium.25'], 'CnNodeCount' => ['description' => 'CN节点个数。', 'type' => 'string', 'example' => '2'], 'DnNodeCount' => ['description' => 'DN节点个数。', 'type' => 'string', 'example' => '2'], 'TaskStatus' => ['description' => '切换任务状态', 'type' => 'string', 'example' => 'prepared：参数初始化完毕'."\n" .'set_old_primary_readonly：原主实例已禁写'."\n" .'set_new_primary_read_write：已切换'."\n" .'timeout：任务超时'."\n" .'rollback：已回滚'."\n"], 'DataSyncStatus' => ['type' => 'string', 'description' => ''], 'ReadWriteStatus' => ['type' => 'string', 'description' => ''], ], ], ], 'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test'], 'MysqlVersion' => ['description' => '实例支持的MySQL版本。', 'type' => 'string', 'example' => '5.7'], 'GdnMode' => ['type' => 'string', 'description' => ''], 'RplSyncDdl' => ['type' => 'boolean', 'description' => ''], 'RplDmlStrategy' => ['type' => 'string', 'description' => ''], 'RplConflictStrategy' => ['type' => 'string', 'description' => ''], ], 'description' => '', ], ], ], ], ], ], ], ], 'title' => '获取GDN实例列表信息', 'changeSet' => [ ['createdAt' => '2025-10-14T13:06:12.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2025-10-14T13:06:12.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2025-02-18T11:58:37.000Z', 'description' => '响应参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGdnInstances'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B044BD1-6402-5DE9-9AED-63D15A994E37\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"TotalNumber\\": \\"130\\",\\n \\"GdnInstanceList\\": [\\n {\\n \\"GdnInstanceName\\": \\"gdn-***\\",\\n \\"GmtCreated\\": \\"2025-01-02T13:11:10.000+0000\\",\\n \\"SwitchHistory\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Status\\": \\"Creating\\",\\n \\"MemberList\\": [\\n {\\n \\"MemberName\\": \\"pxc-***\\",\\n \\"Role\\": \\"primary、\\\\nstandby\\",\\n \\"Status\\": \\"Creating\\",\\n \\"GmtCreated\\": \\"2025-01-02T13:11:10.000+0000\\",\\n \\"SecondsBehindMaster\\": \\"1s\\",\\n \\"CommodityCode\\": \\"drds_polarxpre_public_cn\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ClassCode\\": \\"polarx.x4.medium.2e\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"ExpireTime\\": \\"2025-01-02T13:11:10.000+0000\\",\\n \\"PrimaryZone\\": \\"cn-zhangjiakou-a\\",\\n \\"SecondaryZone\\": \\"cn-zhangjiakou-a\\",\\n \\"TertiaryZone\\": \\"cn-zhangjiakou-a\\",\\n \\"ZoneId\\": \\"cn-zhangjiakou-a\\",\\n \\"CnNodeClassCode\\": \\"polarx.x4.medium.2e\\",\\n \\"DnNodeClassCode\\": \\"mysql.n4.medium.25\\",\\n \\"CnNodeCount\\": \\"2\\",\\n \\"DnNodeCount\\": \\"2\\",\\n \\"TaskStatus\\": \\"prepared：参数初始化完毕\\\\nset_old_primary_readonly：原主实例已禁写\\\\nset_new_primary_read_write：已切换\\\\ntimeout：任务超时\\\\nrollback：已回滚\\\\n\\",\\n \\"DataSyncStatus\\": \\"\\",\\n \\"ReadWriteStatus\\": \\"\\"\\n }\\n ],\\n \\"Description\\": \\"test\\",\\n \\"MysqlVersion\\": \\"5.7\\",\\n \\"GdnMode\\": \\"\\",\\n \\"RplSyncDdl\\": true,\\n \\"RplDmlStrategy\\": \\"\\",\\n \\"RplConflictStrategy\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeMem0Info' => [ 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '地域', 'description' => '地域', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-spsil01pww4hfz'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], 'Data' => [ 'title' => '返回数据', 'description' => '返回数据', 'type' => 'object', 'properties' => [ 'Instance' => [ 'title' => '实例信息', 'description' => '实例信息', 'type' => 'object', 'properties' => [ 'InstanceId' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 'pxc-spsil01pww4hfz-mem'], 'RegionId' => ['title' => '地域ID', 'description' => '地域ID', 'type' => 'string', 'example' => 'ap-southeast-1'], 'ZoneId' => ['title' => '可用区ID', 'description' => '可用区ID', 'type' => 'string', 'example' => 'ap-southeast-1a'], 'ClassCode' => ['title' => '实例规格', 'description' => '实例规格', 'type' => 'string', 'example' => 'mysql.x2.large.2c'], 'NodeCount' => ['title' => '节点数量', 'description' => '节点数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2026-02-17T02:00:20Z'], 'Status' => ['title' => '实例状态', 'description' => '实例状态', 'type' => 'string', 'example' => 'Running'], 'StorageType' => ['title' => '存储类型', 'description' => '存储类型', 'type' => 'string', 'example' => 'local_ssd'], 'VPCId' => ['title' => 'VPC ID', 'description' => 'VPC ID', 'type' => 'string', 'example' => 'vpc-t4n4hf9xey7ea3lp4bwwx'], 'VSwitchId' => ['title' => '交换机ID', 'description' => '交换机ID', 'type' => 'string', 'example' => 'vsw-t4ny14pr37spmjsbv5dc2'], 'ConnAddrs' => [ 'title' => '连接地址列表', 'description' => '连接地址列表', 'type' => 'array', 'items' => [ 'title' => '连接地址列表', 'description' => '连接地址列表', 'type' => 'object', 'properties' => [ 'Type' => ['title' => '连接地址类型', 'description' => '连接地址类型', 'type' => 'string', 'example' => 'VPC'], 'VPCId' => ['title' => 'VPC ID', 'description' => 'VPC ID', 'type' => 'string', 'example' => 'vpc-t4n4hf9xey7ea3lp4bwwx'], 'VSwitchId' => ['title' => '交换机ID', 'description' => '交换机ID', 'type' => 'string', 'example' => 'vsw-t4ny14pr37spmjsbv5dc2'], 'Port' => ['title' => '端口', 'description' => '端口', 'type' => 'integer', 'format' => 'int32', 'example' => '3306'], 'VpcInstanceId' => ['title' => 'VPC实例ID', 'description' => 'VPC实例ID', 'type' => 'string', 'example' => 'pxc-spsil01pww4hfzjayd-cn-20251013180429'], 'ConnectionString' => ['title' => '连接地址', 'description' => '连接地址', 'type' => 'string', 'example' => 'pxc-spsil01pww4hfz.polarx.singapore.rds.aliyuncs.com'], ], ], ], ], ], ], ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string'], 'AuthPrincipalType' => ['type' => 'string'], 'AuthPrincipalOwnerId' => ['type' => 'string'], 'AuthPrincipalDisplayName' => ['type' => 'string'], 'PolicyType' => ['type' => 'string'], 'NoPermissionType' => ['type' => 'string'], 'EncodedDiagnosticMessage' => ['type' => 'string'], ], ], ], 'description' => '', ], ], ], 'title' => '查看记忆引擎信息', 'summary' => '查看记忆引擎信息', 'description' => '> * PolarDB-X 2.0 SQL审计与分析功能本身免费使用，但日志服务会对存储空间、读取流量、请求数量、数据加工、数据投递等进行收费，更多关于SQL审计功能的详情，请参见[开启SQL审计与分析](~~184619~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeMem0Info', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"Data\\": {\\n \\"Instance\\": {\\n \\"InstanceId\\": \\"pxc-spsil01pww4hfz-mem\\",\\n \\"RegionId\\": \\"ap-southeast-1\\",\\n \\"ZoneId\\": \\"ap-southeast-1a\\",\\n \\"ClassCode\\": \\"mysql.x2.large.2c\\",\\n \\"NodeCount\\": 1,\\n \\"CreateTime\\": \\"2026-02-17T02:00:20Z\\",\\n \\"Status\\": \\"Running\\",\\n \\"StorageType\\": \\"local_ssd\\",\\n \\"VPCId\\": \\"vpc-t4n4hf9xey7ea3lp4bwwx\\",\\n \\"VSwitchId\\": \\"vsw-t4ny14pr37spmjsbv5dc2\\",\\n \\"ConnAddrs\\": [\\n {\\n \\"Type\\": \\"VPC\\",\\n \\"VPCId\\": \\"vpc-t4n4hf9xey7ea3lp4bwwx\\",\\n \\"VSwitchId\\": \\"vsw-t4ny14pr37spmjsbv5dc2\\",\\n \\"Port\\": 3306,\\n \\"VpcInstanceId\\": \\"pxc-spsil01pww4hfzjayd-cn-20251013180429\\",\\n \\"ConnectionString\\": \\"pxc-spsil01pww4hfz.polarx.singapore.rds.aliyuncs.com\\"\\n }\\n ]\\n }\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"PolicyType\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\"\\n }\\n}","type":"json"}]', ], 'DescribeMem0SecurityIps' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。'."\n" ."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-htri0****r4k9p'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。'."\n" ."\n", 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], 'Data' => [ 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'Groups' => [ 'description' => '消费的服务对应的组别。', 'type' => 'array', 'items' => [ 'description' => '消费的服务对应的组别。', 'type' => 'object', 'properties' => [ 'GroupName' => ['description' => '白名单分组名称。', 'type' => 'string', 'example' => 'bigdata'], 'IpLists' => ['description' => '已经用于DNAT条目的IP，是否还可用于SNAT条目，取值：'."\n" ."\n" .'- **true**：还可用于SNAT条目。'."\n" ."\n" .'- **false**：不可用于SNAT条目。', 'type' => 'string', 'example' => '127.0.0.1'], 'GroupTag' => ['description' => '分组标签。', 'type' => 'string', 'example' => 'test'], ], ], ], 'CustinsName' => ['description' => '记忆引擎实例名', 'type' => 'string', 'example' => 'pxc-***-mem'], ], ], 'AccessDeniedDetail' => [ 'description' => '访问被拒绝的详细原因。', 'type' => 'object', 'properties' => [ 'AuthAction' => ['description' => '说明如上。', 'type' => 'string', 'example' => 'xxx'], 'AuthPrincipalType' => ['description' => '说明如上。', 'type' => 'string', 'example' => '222'], 'AuthPrincipalOwnerId' => ['description' => '说明如上。', 'type' => 'string', 'example' => '111'], 'AuthPrincipalDisplayName' => ['description' => '请求中用于鉴权的身份标识。', 'type' => 'string', 'example' => 'xxx'], 'PolicyType' => ['description' => 'PolicyType', 'type' => 'string', 'example' => 'System'], 'NoPermissionType' => ['description' => 'NoPermissionType', 'type' => 'string', 'example' => 'ImplicitDeny'], 'EncodedDiagnosticMessage' => ['description' => '编码诊断信息。', 'type' => 'string', 'example' => 'AQEAAAAAacnceTlBNjlFODgyLTlBMDUtNUUyRC04MzE5LUQwMzZDRjJFQTM3NA=='], ], ], ], 'description' => '', ], ], ], 'title' => '查看记忆引擎白名单', 'summary' => '查询记忆引擎白名单', 'description' => '> * PolarDB-X 2.0 SQL审计与分析功能本身免费使用，但日志服务会对存储空间、读取流量、请求数量、数据加工、数据投递等进行收费，更多关于SQL审计功能的详情，请参见[开启SQL审计与分析](~~184619~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"Groups\\": [\\n {\\n \\"GroupName\\": \\"bigdata\\",\\n \\"IpLists\\": \\"127.0.0.1\\",\\n \\"GroupTag\\": \\"test\\"\\n }\\n ],\\n \\"CustinsName\\": \\"pxc-***-mem\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\",\\n \\"PolicyType\\": \\"System\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAacnceTlBNjlFODgyLTlBMDUtNUUyRC04MzE5LUQwMzZDRjJFQTM3NA==\\"\\n }\\n}","type":"json"}]', ], 'DescribeOpenBackupSet' => [ 'summary' => '开放商业备份集的实例拓扑信息和下载链接，满足线下恢复云上实例的需要。', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '245672', 'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'example' => 'pxc-********'], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => ['description' => '实例所需恢复的时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2024-10-14T00:00:00Z'], ], ], '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' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], 'Data' => ['description' => '一个包含实例拓扑信息和备份集下载链接的结构体。'."\n" .'> canBinlogRecoverToTimeUTC 字段表示该备份集所能恢复到的时间点，该时间点在输入参数RestoreTime附近。由于存在DN有最近的本地binlog还没上传的情况，不保证能恢复到所希望的时间点。', 'type' => 'any', 'example' => '{"gmsBackupSet": {"pubFullDownloadUrl": "https://xxxxx","dnName": "pxc-xdb-m-xxxxxx","hostInstanceId": 0001,"binlogs": [],"backupEndTime": "2024-10-21T10:11:56Z","backupLinkExpiredTime": "2024-10-23T06:13:54Z","dnBackupSetId": "00088","notCompletedBinlogs": [],"commitIndex": "15249275","innerFullDownloadUrl": "http://xxxxx","backupStartTime": "2024-10-21T10:09:20Z","backupSetSize": 526118912},"dnBackupSets": [],"insName": "pxc-xxxxx","backupSetId": "cb-xxxxx","canBinlogRecoverToTime": 1729567925000,"backupEndTime": "2024-10-21T10:12:16Z","canBinlogRecoverToTimeUTC": "2024-10-22T03:32:05Z","canBackupMinRecoverToTimeUTC": "2024-10-21T10:11:56Z","pitrInvalid": false,"backupStartTime": "2024-10-21T10:09:16Z","canBackupMinRecoverToTime": 1729505516000}'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => '获取用于线下恢复的备份集信息', 'responseParamsDescription' => '>PolarDB-X开源版的备份集导入工具将使用Data字段中结构体，把备份集导入成开源版恢复所需要的结构。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOpenBackupSet'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Data\\": \\"{\\\\\\"gmsBackupSet\\\\\\": {\\\\\\"pubFullDownloadUrl\\\\\\": \\\\\\"https://xxxxx\\\\\\",\\\\\\"dnName\\\\\\": \\\\\\"pxc-xdb-m-xxxxxx\\\\\\",\\\\\\"hostInstanceId\\\\\\": 0001,\\\\\\"binlogs\\\\\\": [],\\\\\\"backupEndTime\\\\\\": \\\\\\"2024-10-21T10:11:56Z\\\\\\",\\\\\\"backupLinkExpiredTime\\\\\\": \\\\\\"2024-10-23T06:13:54Z\\\\\\",\\\\\\"dnBackupSetId\\\\\\": \\\\\\"00088\\\\\\",\\\\\\"notCompletedBinlogs\\\\\\": [],\\\\\\"commitIndex\\\\\\": \\\\\\"15249275\\\\\\",\\\\\\"innerFullDownloadUrl\\\\\\": \\\\\\"http://xxxxx\\\\\\",\\\\\\"backupStartTime\\\\\\": \\\\\\"2024-10-21T10:09:20Z\\\\\\",\\\\\\"backupSetSize\\\\\\": 526118912},\\\\\\"dnBackupSets\\\\\\": [],\\\\\\"insName\\\\\\": \\\\\\"pxc-xxxxx\\\\\\",\\\\\\"backupSetId\\\\\\": \\\\\\"cb-xxxxx\\\\\\",\\\\\\"canBinlogRecoverToTime\\\\\\": 1729567925000,\\\\\\"backupEndTime\\\\\\": \\\\\\"2024-10-21T10:12:16Z\\\\\\",\\\\\\"canBinlogRecoverToTimeUTC\\\\\\": \\\\\\"2024-10-22T03:32:05Z\\\\\\",\\\\\\"canBackupMinRecoverToTimeUTC\\\\\\": \\\\\\"2024-10-21T10:11:56Z\\\\\\",\\\\\\"pitrInvalid\\\\\\": false,\\\\\\"backupStartTime\\\\\\": \\\\\\"2024-10-21T10:09:16Z\\\\\\",\\\\\\"canBackupMinRecoverToTime\\\\\\": 1729505516000}\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n {\\"gmsBackupSet\\": {\\"pubFullDownloadUrl\\": \\"https://xxxxx\\",\\"dnName\\": \\"pxc-xdb-m-xxxxxx\\",\\"hostInstanceId\\": 0001,\\"binlogs\\": [],\\"backupEndTime\\": \\"2024-10-21T10:11:56Z\\",\\"backupLinkExpiredTime\\": \\"2024-10-23T06:13:54Z\\",\\"dnBackupSetId\\": \\"00088\\",\\"notCompletedBinlogs\\": [],\\"commitIndex\\": \\"15249275\\",\\"innerFullDownloadUrl\\": \\"http://xxxxx\\",\\"backupStartTime\\": \\"2024-10-21T10:09:20Z\\",\\"backupSetSize\\": 526118912},\\"dnBackupSets\\": [],\\"insName\\": \\"pxc-xxxxx\\",\\"backupSetId\\": \\"cb-xxxxx\\",\\"canBinlogRecoverToTime\\": 1729567925000,\\"backupEndTime\\": \\"2024-10-21T10:12:16Z\\",\\"canBinlogRecoverToTimeUTC\\": \\"2024-10-22T03:32:05Z\\",\\"canBackupMinRecoverToTimeUTC\\": \\"2024-10-21T10:11:56Z\\",\\"pitrInvalid\\": false,\\"backupStartTime\\": \\"2024-10-21T10:09:16Z\\",\\"canBackupMinRecoverToTime\\": 1729505516000}\\n","errorExample":""}]', ], 'DescribeParameterGroups' => [ 'summary' => '该接口用于查询用户创建或系统支持的数据库参数组列表，包括各参数组的基本信息、关联引擎类型及修改时间等。', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '230979', 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], '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' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], 'Data' => [ 'description' => '实例详情列表。', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。'."\n" ."\n", 'type' => 'string', 'example' => '1E5DCFFC-A00D-****-836E-73318F8CA577'], 'ParameterGroups' => [ 'description' => '参数模板名称。', 'type' => 'array', 'items' => [ 'description' => '参数模板列表。', 'type' => 'object', 'properties' => [ 'ParameterGroupId' => ['description' => '参数模板ID。'."\n" .'> 您可以通过[DescribeParameterGroups](~~207178~~)接口查询目标地域下所有参数模板的详细信息，包括参数模板ID。', 'type' => 'string', 'example' => 'rpg-s1y1xy06****fqs7y'], 'GmtCreated' => ['description' => '账号创建时间。', 'type' => 'string', 'example' => '2024-12-19T16:41:31+08:00'], 'GmtModified' => ['description' => '修改时间，时间戳格式。', 'type' => 'string', 'example' => '1605079985000'], 'DbType' => ['description' => '数据库类型。', 'type' => 'string', 'example' => 'polarx'], 'DbVersion' => ['description' => '数据库版本。', 'type' => 'string', 'example' => '5.7'], 'DnParamCount' => ['description' => 'DN参数数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'DnForceRestart' => ['description' => 'DN强制重启', 'type' => 'boolean'], 'CnParamCount' => ['description' => 'CN参数数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'CnForceRestart' => ['description' => 'CN强制重启', 'type' => 'boolean'], 'Series' => ['description' => '实例系列，取值如下：'."\n" ."\n" .'- **enterprise**：企业版'."\n" .'- **standard**：标准版', 'type' => 'string', 'example' => 'enterprise'], 'ParameterGroupName' => ['description' => '参数模板名称。', 'type' => 'string', 'example' => 'dstest_api_new'], 'ParameterGroupType' => ['description' => '参数模板类型', 'type' => 'string', 'example' => '0'], ], ], ], ], ], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => '查询参数组信息', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterGroups'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Data\\": {\\n \\"RequestId\\": \\"1E5DCFFC-A00D-****-836E-73318F8CA577\\",\\n \\"ParameterGroups\\": [\\n {\\n \\"ParameterGroupId\\": \\"rpg-s1y1xy06****fqs7y\\",\\n \\"GmtCreated\\": \\"2024-12-19T16:41:31+08:00\\",\\n \\"GmtModified\\": \\"1605079985000\\",\\n \\"DbType\\": \\"polarx\\",\\n \\"DbVersion\\": \\"5.7\\",\\n \\"DnParamCount\\": 10,\\n \\"DnForceRestart\\": true,\\n \\"CnParamCount\\": 10,\\n \\"CnForceRestart\\": true,\\n \\"Series\\": \\"enterprise\\",\\n \\"ParameterGroupName\\": \\"dstest_api_new\\",\\n \\"ParameterGroupType\\": \\"0\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeParameterTemplates' => [ 'summary' => '调用DescribeParameterTemplates接口获取实例参数模版列表。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '86254', 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ParamLevel', 'in' => 'query', 'schema' => ['description' => '参数级别，取值如下：'."\n" .'- **compute**：计算层；'."\n" .'- **storage**：存储层。', 'type' => 'string', 'required' => false, 'example' => 'compute'], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'Engine' => ['description' => '引擎，默认polarx。', 'type' => 'string', 'example' => 'polarx'], 'EngineVersion' => ['description' => '引擎版本，默认2.0。', 'type' => 'string', 'example' => '2.0'], 'ParameterCount' => ['description' => '参数个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '218'], 'Parameters' => [ 'description' => '参数列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CheckingCode' => ['description' => '检测约制。', 'type' => 'string', 'example' => '[0|1]'], 'ParameterName' => ['description' => '参数名。', 'type' => 'string', 'example' => 'loose_enable_gts'], 'Dynamic' => ['description' => '是否动态：'."\n" ."\n" .'- **0**：否；'."\n" .'- **1**：是。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ParameterValue' => ['description' => '参数值。', 'type' => 'string', 'example' => '1'], 'ParameterDescription' => ['description' => '参数描述。', 'type' => 'string', 'example' => 'polarx hatp addition param'], 'Revisable' => ['description' => '是否可以修改'."\n" ."\n" .'- **0**：不能修改；'."\n" .'- **1**：修改。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'UserChangable' => ['title' => '用户可以修改', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => '数据库实例不存在'], ], ], 'title' => '查看参数模版详情', 'changeSet' => [ ['createdAt' => '2024-09-26T14:17:02.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2024-09-26T14:17:02.000Z', 'description' => '请求参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterTemplates'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeParameterTemplates', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"Engine\\": \\"polarx\\",\\n \\"EngineVersion\\": \\"2.0\\",\\n \\"ParameterCount\\": 218,\\n \\"Parameters\\": [\\n {\\n \\"CheckingCode\\": \\"[0|1]\\",\\n \\"ParameterName\\": \\"loose_enable_gts\\",\\n \\"Dynamic\\": 0,\\n \\"ParameterValue\\": \\"1\\",\\n \\"ParameterDescription\\": \\"polarx hatp addition param\\",\\n \\"Revisable\\": 0,\\n \\"UserChangable\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n \\n polarx\\n 2.0\\n 218\\n \\n [0|1]\\n loose_enable_gts\\n 0\\n 1\\n polarx hatp addition param\\n 0\\n \\n \\n","errorExample":""}]', ], 'DescribeParameters' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86253', 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********'], ], [ 'name' => 'ParamLevel', 'in' => 'query', 'schema' => ['description' => '参数级别，取值：'."\n" ."\n" .'- compute：计算层 ；'."\n" .'- storage：存储层。'."\n" ."\n", 'type' => 'string', 'required' => false, 'example' => 'compute'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。'."\n" ."\n", 'type' => 'string', 'example' => '6BA32080EEA'], 'Data' => [ 'description' => '参数详情。', 'type' => 'object', 'properties' => [ 'EngineVersion' => ['description' => '引擎版本，默认2.0。'."\n" ."\n", 'type' => 'string', 'example' => '2.0'], 'Engine' => ['description' => '引擎，默认polarx。'."\n" ."\n", 'type' => 'string', 'example' => 'polarx'], 'ConfigParameters' => [ 'description' => '原始参数列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ParameterDescription' => ['description' => '参数描述。', 'type' => 'string', 'example' => '存储节点私有协议开关(-1关闭，0开启)'], 'ParameterName' => ['description' => '参数名称。', 'type' => 'string', 'example' => 'CONN_POOL_XPROTO_STORAGE_DB_PORT'], 'ParameterValue' => ['description' => '参数值。', 'type' => 'string', 'example' => '-1'], ], 'description' => '', ], ], 'RunningParameters' => [ 'description' => '运行中的参数详情列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ParameterDescription' => ['description' => '参数描述。', 'type' => 'string', 'example' => '存储节点私有协议开关(-1关闭，0开启)'], 'ParameterName' => ['description' => '参数名称。', 'type' => 'string', 'example' => 'CONN_POOL_XPROTO_STORAGE_DB_PORT'], 'ParameterValue' => ['description' => '参数取值。', 'type' => 'string', 'example' => '-1'], ], 'description' => '', ], ], 'DBInstanceId' => ['type' => 'string', 'description' => ''], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => '数据库实例不存在'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => '获取参数列表', 'summary' => '调用DescribeParameters接口获取实例参数。', 'changeSet' => [ ['createdAt' => '2024-09-26T14:21:16.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2024-09-26T14:21:16.000Z', 'description' => '响应参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameters'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6BA32080EEA\\",\\n \\"Data\\": {\\n \\"EngineVersion\\": \\"2.0\\",\\n \\"Engine\\": \\"polarx\\",\\n \\"ConfigParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"存储节点私有协议开关(-1关闭，0开启)\\",\\n \\"ParameterName\\": \\"CONN_POOL_XPROTO_STORAGE_DB_PORT\\",\\n \\"ParameterValue\\": \\"-1\\"\\n }\\n ],\\n \\"RunningParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"存储节点私有协议开关(-1关闭，0开启)\\",\\n \\"ParameterName\\": \\"CONN_POOL_XPROTO_STORAGE_DB_PORT\\",\\n \\"ParameterValue\\": \\"-1\\"\\n }\\n ],\\n \\"DBInstanceId\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 6BA32080EEA\\n \\n 2.0\\n polarx\\n \\n 存储节点私有协议开关(-1关闭，0开启)\\n CONN_POOL_XPROTO_STORAGE_DB_PORT\\n -1\\n \\n \\n 存储节点私有协议开关(-1关闭，0开启)\\n CONN_POOL_XPROTO_STORAGE_DB_PORT\\n -1\\n \\n \\n","errorExample":""}]', ], 'DescribePolarxDataNodes' => [ 'summary' => '该接口用于查询PolarDB-X实例中所有数据节点（Data Nodes）的详细信息，包括节点状态、存储使用情况、网络地址等，便于运维管理和监控。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '86255', 'abilityTreeNodes' => ['FEATUREdrds0SX279'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => '页码。取值为大于0且不超过integer数据类型的最大值，默认值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'pattern' => '^\\d+$', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '5', 'example' => '30', 'pattern' => '^\\d+$', 'default' => '30', 'enum' => ['30', '50', '100'], ], ], [ 'name' => 'NodeType', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'title' => '查询节点类型'."\n" .'- all: 表示同时查询 dn 与 gms 节点'."\n" .'- gms: 表示只查询 gms 节点'."\n" .'- dn: 表示只查询 dn 节点', 'description' => '查询节点类型'."\n" .'- all: 表示同时查询 dn 与 gms 节点'."\n" .'- gms: 表示只查询 gms 节点'."\n" .'- dn: 表示只查询 dn 节点', 'type' => 'string', 'required' => false, 'example' => 'dn', 'default' => 'all', 'enum' => ['all', 'dn', 'gms'], ], ], [ 'name' => 'SearchKey', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['title' => '关键词', 'description' => '关键词', 'type' => 'string', 'required' => false, 'example' => 'pc-bp1c5w4fx****2274'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => 'BD99340C-4A45-548B-****-27584B0BCFFF'], 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'TotalNumber' => ['description' => '总节点数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'DBInstanceDataNodes' => [ 'description' => '节点信息列表。', 'type' => 'array', 'items' => [ 'description' => '节点信息列表。', 'type' => 'object', 'properties' => [ 'DBInstanceName' => ['description' => '实例id。', 'type' => 'string', 'example' => 'pxc-hzrp5m****04w4'], 'DBInstanceId' => ['description' => '实例id。', 'type' => 'string', 'example' => 'pxc-hzrlcjc****sz9'], 'DBInstanceDescription' => ['description' => '节点实例描述。', 'type' => 'string', 'example' => 'pxc-z****nfxsxy728 : PROD-OMS-Auto-生产库克隆实例'], ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => '分页格式非法'], ], ], 'title' => '查看数据节点信息', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePolarxDataNodes'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BD99340C-4A45-548B-****-27584B0BCFFF\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 0,\\n \\"TotalNumber\\": 0,\\n \\"DBInstanceDataNodes\\": [\\n {\\n \\"DBInstanceName\\": \\"pxc-hzrp5m****04w4\\",\\n \\"DBInstanceId\\": \\"pxc-hzrlcjc****sz9\\",\\n \\"DBInstanceDescription\\": \\"pxc-z****nfxsxy728 : PROD-OMS-Auto-生产库克隆实例\\"\\n }\\n ]\\n}","type":"json"}]', ], 'DescribeRdsVpcs' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '97702', 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。>您可以调用[describeregions](~~196841~~)接口查看polardb-x支持的地域详情，包括地域id。', 'type' => 'string', 'required' => true, 'example' => 'cn-zhangjiakou'], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => '可用区id。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-h'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Vpcs' => [ 'description' => 'vpc信息。', 'type' => 'object', 'properties' => [ 'Vpc' => [ 'description' => 'vpc信息。', 'type' => 'array', 'items' => [ 'description' => 'vpc信息。', 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'vpc状态', 'type' => 'string', 'example' => 'True'], 'VpcName' => ['description' => 'vpc的名称。', 'type' => 'string', 'example' => 'cloud_auto_test'], 'VpcId' => ['description' => 'vpc的id。', 'type' => 'string', 'example' => 'vpc-2zekldxxy28nobay7o1f3'], 'IsDefault' => ['description' => '是否是默认vpc。取值范围如下：***true**：是默认vpc***false**：非默认vpc', 'type' => 'boolean', 'example' => 'False'], 'CidrBlock' => ['description' => 'vpc的ipv4网段。', 'type' => 'string', 'example' => '47.121.246.0/24'], 'RegionNo' => ['description' => 'vpc所在的地域。', 'type' => 'string', 'example' => 'cn-shanghai'], 'GmtCreate' => ['description' => '创建vpc的时间点。', 'type' => 'string', 'example' => 'Mon May 12 10:13:14 CST 2025'], 'AliUid' => ['description' => '阿里云账号id。', 'type' => 'string', 'example' => '314****36'], 'VSwitchs' => [ 'description' => 'vpc的交换机信息。', 'type' => 'array', 'items' => [ 'description' => 'vpc的交换机信息。', 'type' => 'object', 'properties' => [ 'Status' => ['description' => '交换机状态', 'type' => 'string', 'example' => 'Available'], 'VSwitchId' => ['description' => '交换机id。', 'type' => 'string', 'example' => 'vsw-8vbkwmpn****4nrd639ih'], 'IsDefault' => ['description' => '是否是默认交换机。', 'type' => 'boolean', 'example' => 'false'], 'CidrBlock' => ['description' => '交换机网段。', 'type' => 'string', 'example' => '10.0.0.0/24'], 'GmtCreate' => ['description' => '创建时间，精确到毫秒的unix时间戳。', 'type' => 'string', 'example' => '1574156944000'], 'GmtModified' => ['description' => '最后修改时间（时间戳）', 'type' => 'string', 'example' => '2025-09-03T19:19:13+08:00'], 'IzNo' => ['description' => '可用区id。', 'type' => 'string', 'example' => 'cn-beijing-g'], 'VSwitchName' => ['description' => '交换机名称。', 'type' => 'string', 'example' => 'cloud_auto_g'], ], ], ], 'GmtModified' => ['description' => '最后修改vpc的时间。', 'type' => 'string', 'example' => '2024-09-29 17:47:56'], 'Bid' => ['description' => '专有网络id。', 'type' => 'string', 'example' => '26842'], ], ], ], ], ], 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '4C1A7CFB-9F73-5041-8C74-27626E58985A'], ], 'description' => '', ], ], ], 'title' => '查询VPC列表', 'summary' => 'PolarDB-X 侧查询VPC列表的API。', 'description' => '该接口用于获取用户账号下可用于实例专有网络（VPC）列表，以便在创建或管理数据库实例时选择合适的网络环境。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsVpcs'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Vpcs\\": {\\n \\"Vpc\\": [\\n {\\n \\"Status\\": \\"True\\",\\n \\"VpcName\\": \\"cloud_auto_test\\",\\n \\"VpcId\\": \\"vpc-2zekldxxy28nobay7o1f3\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"47.121.246.0/24\\",\\n \\"RegionNo\\": \\"cn-shanghai\\",\\n \\"GmtCreate\\": \\"Mon May 12 10:13:14 CST 2025\\",\\n \\"AliUid\\": \\"314****36\\",\\n \\"VSwitchs\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-8vbkwmpn****4nrd639ih\\",\\n \\"IsDefault\\": false,\\n \\"CidrBlock\\": \\"10.0.0.0/24\\",\\n \\"GmtCreate\\": \\"1574156944000\\",\\n \\"GmtModified\\": \\"2025-09-03T19:19:13+08:00\\",\\n \\"IzNo\\": \\"cn-beijing-g\\",\\n \\"VSwitchName\\": \\"cloud_auto_g\\"\\n }\\n ],\\n \\"GmtModified\\": \\"2024-09-29 17:47:56\\",\\n \\"Bid\\": \\"26842\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"4C1A7CFB-9F73-5041-8C74-27626E58985A\\"\\n}","type":"json"}]', ], 'DescribeRdsVswitches' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '232624', 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => '可用区id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-a'], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => '访问端点所在的专有网络ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1ndou****twoedlmru0'], ], ], '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' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'VswitchList' => [ 'description' => 'Vswitch列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => ['description' => '节点ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'babac91eff704edf9bdccfaa6ba4efce'], 'VpcInstanceId' => ['description' => 'vpc id。', 'type' => 'string', 'example' => 'vpc-uf6lis7xmm****t9wrxb5'], 'IzNo' => ['description' => '可用区id。', 'type' => 'string', 'example' => 'cn-hangzhou-j'], 'CidrBlock' => ['description' => 'vpc的ip地址段。', 'type' => 'string', 'example' => '172.16.0.0/24'], 'Description' => ['description' => '数据库描述。', 'type' => 'string', 'example' => 'describe'], 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'szt-backup'], 'AvailabeIpCount' => ['description' => '可用ip数量。', 'type' => 'string', 'example' => '16378'], 'IsDefault' => ['description' => '是否是默认vpc。取值范围如下：***true**：是默认vpc***false**：非默认vpc', 'type' => 'string', 'example' => 'true'], 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'drdshbgae0han226'], ], 'description' => '', ], ], ], ], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '查询Vswitch列表', 'summary' => '该接口用于查询RDS实例可用的专有网络（VPC）交换机（vSwitch）列表。', 'description' => '该接口用于获取用户账号下可用于实例专有网络（VPC）列表，以便在创建或管理数据库实例时选择合适的网络环境。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsVswitches'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"VswitchList\\": [\\n {\\n \\"Id\\": 0,\\n \\"VpcInstanceId\\": \\"vpc-uf6lis7xmm****t9wrxb5\\",\\n \\"IzNo\\": \\"cn-hangzhou-j\\",\\n \\"CidrBlock\\": \\"172.16.0.0/24\\",\\n \\"Description\\": \\"describe\\",\\n \\"Name\\": \\"szt-backup\\",\\n \\"AvailabeIpCount\\": \\"16378\\",\\n \\"IsDefault\\": \\"true\\",\\n \\"InstanceId\\": \\"drdshbgae0han226\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeRegions' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86259', 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => ' 错误代码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['description' => ' 错误信息。', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'ErrorCode' => ['description' => '错误代码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Regions' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Region' => [ 'description' => '区域列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SupportPolarx10' => ['description' => '支持polardb-x 1.0版本。', 'type' => 'boolean', 'example' => 'true'], 'SupportPolarx20' => ['description' => '支持polardb-x 2.0版本。', 'type' => 'boolean', 'example' => 'true'], 'RegionId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ch-hangzhou'], 'Zones' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Zone' => [ 'description' => '可用区列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ZoneId' => ['description' => '可用区。', 'type' => 'string', 'example' => 'cn-hangzhou-a'], 'VpcEnabled' => ['description' => '是否支持vpc。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'description' => '', ], ], 'description' => '', ], ], ], 'description' => '', ], ], 'description' => '', ], ], ], 'title' => '查看可选的地域和可用区', 'summary' => '调用DescribeRegions接口获取地域列表。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200,\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"SupportPolarx10\\": true,\\n \\"SupportPolarx20\\": true,\\n \\"RegionId\\": \\"ch-hangzhou\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"VpcEnabled\\": true\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n success\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n true\\n 200\\n \\n true\\n true\\n ch-hangzhou\\n \\n cn-hangzhou-a\\n true\\n \\n \\n","errorExample":""}]', ], 'DescribeRplInspectionTask' => [ 'summary' => '该接口用于查询实例的复制延迟巡检任务的详细信息。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '104354', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'FailPageNumber', 'in' => 'query', 'schema' => ['description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'pattern' => '^\\d+$', 'default' => '1'], ], [ 'name' => 'FailPageSize', 'in' => 'query', 'schema' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '5', 'example' => '10', 'pattern' => '^\\d+$', 'default' => '30'], ], [ 'name' => 'SuccessPageNumber', 'in' => 'query', 'schema' => ['description' => '请求页数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'SuccessPageSize', 'in' => 'query', 'schema' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '15'], ], [ 'name' => 'SlinkTaskId', 'in' => 'query', 'schema' => ['description' => '切换任务id。', 'type' => 'string', 'required' => false, 'example' => 'etx-szr2rr6i*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], 'Message' => ['description' => '任务错误信息。', 'type' => 'string', 'example' => '*****'], 'Data' => [ 'description' => '任务详情。', 'type' => 'object', 'properties' => [ 'InspectionTaskList' => [ 'description' => '机器任务信息。', 'type' => 'array', 'items' => [ 'description' => '机器任务信息。', 'type' => 'object', 'properties' => [ 'CreateTime' => ['description' => '任务创建时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-09-25T02:36:20.000+0000'], 'Description' => ['description' => '巡检任务描述。', 'type' => 'string', 'example' => 'For database: wms ,Found SIMPLE sequences in 1.0. PolarDB-X 2.0 does not support SIMPLE sequence any more， please use show sequence to check them.'], 'Id' => ['description' => '任务id。', 'type' => 'integer', 'format' => 'int64', 'example' => '10142'], 'SlinkTaskId' => ['description' => 'slinktaskid。', 'type' => 'string', 'example' => 'etx-hzrez23btmb6aq'], 'Stage' => ['description' => '阶段名称。', 'type' => 'string', 'example' => 'CONNECTIVITY'], 'Status' => ['description' => '任务状态。', 'type' => 'string', 'example' => 'SUCCEEDED'], 'UpdateTime' => ['description' => '最近一次任务更新时间（时间戳格式）。', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-09-23T03:25:21.000+0000'], ], ], ], 'SlinkStage' => ['description' => 'slink状态。', 'type' => 'string', 'example' => 'PRE_CHECK'], ], ], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => '获取实例巡检任务', 'description' => '数据同步阶段，主动发起对复制链路的诊断任务，检查是否存在延迟、中断、数据不一致等异常问题。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRplInspectionTask'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Message\\": \\"*****\\",\\n \\"Data\\": {\\n \\"InspectionTaskList\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"Description\\": \\"For database: wms ,Found SIMPLE sequences in 1.0. PolarDB-X 2.0 does not support SIMPLE sequence any more， please use show sequence to check them.\\",\\n \\"Id\\": 10142,\\n \\"SlinkTaskId\\": \\"etx-hzrez23btmb6aq\\",\\n \\"Stage\\": \\"CONNECTIVITY\\",\\n \\"Status\\": \\"SUCCEEDED\\",\\n \\"UpdateTime\\": 0\\n }\\n ],\\n \\"SlinkStage\\": \\"PRE_CHECK\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DescribeScaleOutMigrateTaskList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86260', 'abilityTreeNodes' => ['FEATUREdrds0SX279'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Progress' => ['description' => '迁移任务进度。', 'type' => 'integer', 'format' => 'int32', 'example' => '32'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], ], 'description' => '', ], ], ], 'title' => '展示数据迁移任务进度', 'summary' => '展示ScaleOut迁移任务进度。', 'changeSet' => [ ['createdAt' => '2024-05-23T01:30:55.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2024-05-23T01:30:55.000Z', 'description' => '请求参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeScaleOutMigrateTaskList'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Progress\\": 32,\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 32\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n","errorExample":""}]', ], 'DescribeSecurityIps' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '接口额外返回信息，成功返回success，错误返回对应错误码。', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'DBInstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'pxc-hzjasd****'], 'GroupItems' => [ 'description' => '白名单分组列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GroupName' => ['description' => '白名单分组名称。', 'type' => 'string', 'example' => 'defaultGroup'], 'SecurityIPList' => ['description' => '分组白名单详情。', 'type' => 'string', 'example' => '127.0.0.1,172.168.0.0'], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], 'title' => '查看实例白名单信息', 'summary' => '调用DescribeSecurityIps接口查看实例白名单。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSecurityIps'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-hzjasd****\\",\\n \\"GroupItems\\": [\\n {\\n \\"GroupName\\": \\"defaultGroup\\",\\n \\"SecurityIPList\\": \\"127.0.0.1,172.168.0.0\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC\\n true\\n \\n pxc-hzjasd****\\n \\n defaultGroup\\n 127.0.0.1,172.168.0.0\\n \\n \\n","errorExample":""}]', ], 'DescribeShowStorageInfo' => [ 'summary' => '查询实例的存储空间使用详情，包括总容量、已用空间、剩余空间等信息。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '207374', 'abilityTreeNodes' => ['FEATUREdrdsHFP8VD'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-**************'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['title' => '资源组ID', 'description' => '资源组ID', 'type' => 'string', 'required' => false, 'example' => 'rg-xxxxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ 'StorageInfos' => [ 'description' => '存储信息列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Class' => ['description' => '实例的规格类型（即规格代码）。', 'type' => 'string', 'example' => 'polar.mysql.x4.large'], 'DbCount' => ['description' => '数据库数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], 'Deletable' => ['description' => '是否可删除', 'type' => 'boolean', 'example' => 'True'], 'GroupCount' => ['description' => '节点组的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], 'InstKind' => ['description' => '实例的角色类型，常见值包括：'."\n" .'MASTER：主实例'."\n" .'READONLY：只读实例'."\n" .'STANDBY：备实例（高可用场景）', 'type' => 'string', 'example' => 'MASTER'], 'IsHealthy' => ['description' => '实例或集群当前是否处于健康状态。', 'type' => 'boolean', 'example' => 'true'], 'LeaderNode' => ['description' => '主节点（Leader）的标识。', 'type' => 'string', 'example' => '11.117.237.205:3029'], 'Status' => ['description' => '实例状态。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'StorageInstName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'pxc-xdb-m-pxcbjrylg49skcxb17394'], ], 'description' => '', ], ], ], ], 'Code' => ['description' => '请求返回码。>请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => '200'], ], 'description' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '查询存储空间信息', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeShowStorageInfo'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"StorageInfos\\": [\\n {\\n \\"Class\\": \\"polar.mysql.x4.large\\",\\n \\"DbCount\\": 3,\\n \\"Deletable\\": true,\\n \\"GroupCount\\": 12,\\n \\"InstKind\\": \\"MASTER\\",\\n \\"IsHealthy\\": true,\\n \\"LeaderNode\\": \\"11.117.237.205:3029\\",\\n \\"Status\\": 0,\\n \\"StorageInstName\\": \\"pxc-xdb-m-pxcbjrylg49skcxb17394\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', ], 'DescribeSlowLogRecords' => [ 'summary' => '支持查询PolarDB-X计算节点和存储节点的慢SQL明细。', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '246562', 'abilityTreeNodes' => ['FEATUREdrdsSFVKQ0'], ], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => '分页每页大小。默认值：100。'."\n" ."\n" .'限制：最大支持一次返回100条记录。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '100'], ], [ 'name' => 'Page', 'in' => 'query', 'schema' => ['description' => '页码。默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => '查询开始时间，格式： YYYY-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => true, 'example' => '2024-10-09T02:26'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => '查询开始时间，格式： YYYY-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => true, 'example' => '2024-11-22T02:22Z'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'example' => 'pxc-bjxxxxxxxx'], ], [ 'name' => 'DBNodeIds', 'in' => 'query', 'schema' => ['description' => '节点ID。支持传入多个节点ID，多个ID间用英文逗号（`,`）分隔。查询存储节点的时候，该项为必填项。', 'type' => 'string', 'required' => false, 'example' => 'pxc-i-mezcj4ejdz'], ], [ 'name' => 'CharacterType', 'in' => 'query', 'schema' => [ 'description' => '节点类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => ['polarx_dn' => 'polarx_dn', 'polarx_cn' => 'polarx_cn'], 'example' => 'polarx_cn', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['description' => '数据库名。', 'type' => 'string', 'required' => false, 'example' => 'testdb'], ], ], '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' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'pxc-********'], 'PageNumber' => ['description' => '当前查询的页码。', 'type' => 'string', 'example' => '1'], 'PageRecordCount' => ['description' => '分页每页大小。', 'type' => 'string', 'example' => '30'], 'TotalCount' => ['description' => '总条目数。', 'type' => 'string', 'example' => '3'], 'Items' => [ 'description' => '慢日志明细列表。', 'type' => 'array', 'items' => [ 'description' => '慢日志明细列表。', 'type' => 'object', 'properties' => [ 'SQLHash' => ['description' => '慢日志统计里的 SQL 语句唯一标识符', 'type' => 'string', 'example' => 'c8df07e5d45cd68da8b4771c2016e20b'], 'SQLText' => ['description' => 'SQL语句。', 'type' => 'string', 'example' => 'select * from test '], 'QueryStartTime' => ['description' => '时间戳，格式：YYYY-MM-ddTHH:mm.ss.SSSZ（UTC时间）。'."\n" ."\n" .'- 在CN慢日志，该字段表示执行开始时间。'."\n" .'- 在DN慢日志，该字段表示执行完成时间。', 'type' => 'string', 'example' => '2024-11-22T02:22:22.444Z'], 'QueryTime' => ['description' => 'SQL语句执行时长，单位：秒（s）。', 'type' => 'string', 'example' => '3.000'], 'QueryTimeMS' => ['description' => 'SQL语句执行时长，单位：秒（ms）。', 'type' => 'string', 'example' => '3000.000'], 'LockTimeMS' => ['description' => '锁定时长。单位：毫秒（ms）。仅DN有该字段。', 'type' => 'string', 'example' => '1'], 'ParseRowCounts' => ['description' => '扫描行数。仅DN有该字段。', 'type' => 'string', 'example' => '10'], 'ReturnRowCounts' => ['description' => '返回行数。仅DN有该字段。', 'type' => 'string', 'example' => '20'], 'HostAddress' => ['description' => '连接数据库的客户端名称及地址。', 'type' => 'string', 'example' => '****[****] @ [1XX.XX.XX.XX]'."\n"], 'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'dcdev'], 'CNname' => ['description' => '计算节点名称。仅CN有该字段。', 'type' => 'string', 'example' => 'pxc-i-xxxx'], 'Extension' => ['description' => '拓展字段。仅CN有该字段。', 'type' => 'string', 'example' => 'tddl:5.4.19-20240927'], 'Fail' => [ 'description' => '是否失败。仅CN有该字段。', 'type' => 'string', 'enumValueTitles' => ['0', 2 => '2'], 'example' => '0', ], 'InsName' => ['description' => '实例名。仅DN有该字段。', 'type' => 'string', 'example' => 'pxc-xdb-s-xxxx'], 'IsBind' => [ 'description' => '是否为Prepare模式。仅CN有该字段。', 'type' => 'string', 'enumValueTitles' => ['0', '1'], 'example' => '0', ], 'WT' => [ 'description' => '负载类型。仅CN有该字段。', 'type' => 'string', 'enumValueTitles' => ['TP' => 'TP', 'AP' => 'AP'], 'example' => 'TP', ], 'Params' => ['description' => 'Prepare模式下的参数。仅CN有该字段。', 'type' => 'string', 'example' => '["1"]'], 'Frows' => ['description' => '拉取行数。仅CN有该字段。', 'type' => 'string', 'example' => '1'], 'Rows' => ['description' => '影响/返回行数。仅CN有该字段。', 'type' => 'string', 'example' => '1'], 'SCNT' => ['description' => '物理SQL数。仅CN有该字段。', 'type' => 'string', 'example' => '1'], 'SqlType' => ['description' => 'SQL类型。仅CN有该字段。', 'type' => 'string', 'example' => 'select'], 'TooLong' => [ 'description' => '是否过长。仅CN有该字段。', 'type' => 'string', 'enumValueTitles' => ['0', '1'], 'example' => '0', ], 'TraceId' => ['description' => '跟踪ID。仅CN有该字段。', 'type' => 'string', 'example' => '17a5c5c840006000'], 'TransactionPolicy' => ['description' => '事务策略。仅CN有该字段。', 'type' => 'string', 'example' => 'XA'], 'TrxId' => ['description' => '事务ID。仅CN有该字段。', 'type' => 'string', 'example' => '17a5c5c840006000'], 'TemplateId' => ['description' => '内核模板ID。仅CN有该字段。', 'type' => 'string', 'example' => 'af33ffee'], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => '开始时间格式非法'], ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist or is not supported.', 'description' => '指定实例不存在'], ], 404 => [ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The specified DBInstanceId does not exist.', 'description' => '实例ID不存在'], ], ], 'title' => '查询慢日志明细', 'changeSet' => [ ['createdAt' => '2025-03-13T15:47:20.000Z', 'description' => '响应参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"DBInstanceId\\": \\"pxc-********\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageRecordCount\\": \\"30\\",\\n \\"TotalCount\\": \\"3\\",\\n \\"Items\\": [\\n {\\n \\"SQLHash\\": \\"c8df07e5d45cd68da8b4771c2016e20b\\",\\n \\"SQLText\\": \\"select * from test \\",\\n \\"QueryStartTime\\": \\"2024-11-22T02:22:22.444Z\\",\\n \\"QueryTime\\": \\"3.000\\",\\n \\"QueryTimeMS\\": \\"3000.000\\",\\n \\"LockTimeMS\\": \\"1\\",\\n \\"ParseRowCounts\\": \\"10\\",\\n \\"ReturnRowCounts\\": \\"20\\",\\n \\"HostAddress\\": \\"****[****] @ [1XX.XX.XX.XX]\\\\n\\",\\n \\"DBName\\": \\"dcdev\\",\\n \\"CNname\\": \\"pxc-i-xxxx\\",\\n \\"Extension\\": \\"tddl:5.4.19-20240927\\",\\n \\"Fail\\": \\"0\\",\\n \\"InsName\\": \\"pxc-xdb-s-xxxx\\",\\n \\"IsBind\\": \\"0\\",\\n \\"WT\\": \\"TP\\",\\n \\"Params\\": \\"[\\\\\\"1\\\\\\"]\\",\\n \\"Frows\\": \\"1\\",\\n \\"Rows\\": \\"1\\",\\n \\"SCNT\\": \\"1\\",\\n \\"SqlType\\": \\"select\\",\\n \\"TooLong\\": \\"0\\",\\n \\"TraceId\\": \\"17a5c5c840006000\\",\\n \\"TransactionPolicy\\": \\"XA\\",\\n \\"TrxId\\": \\"17a5c5c840006000\\",\\n \\"TemplateId\\": \\"af33ffee\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n pxc-********\\n 1\\n 30\\n 3\\n \\n c8df07e5d45cd68da8b4771c2016e20b\\n select * from test \\n 2024-11-22T02:22:22.444Z\\n 3.000\\n 3000.000\\n 1\\n 10\\n 20\\n ****[****] @ [1XX.XX.XX.XX]\\n\\n dcdev\\n pxc-i-xxxx\\n tddl:5.4.19-20240927\\n 0\\n pxc-xdb-s-xxxx\\n 0\\n TP\\n [\\"1\\"]\\n 1\\n 1\\n 1\\n select\\n 0\\n 17a5c5c840006000\\n XA\\n 17a5c5c840006000\\n af33ffee\\n \\n","errorExample":""}]', ], 'DescribeSqlAuditInfo' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86262', 'abilityTreeNodes' => ['FEATUREdrdsB0CUNV'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域id>您可以调用[describeregions](~~196841~~)查看polardb-x支持的地域详情，包括地域id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => '实例id。>您可以调用[describedbinstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-****************'], ], [ 'name' => 'AuditAccountName', 'in' => 'query', 'schema' => ['description' => '审计管理员账号名称。>若已开启三权分立模式，该参数必填。详情请参见[三权分立](~~213824~~)。', 'type' => 'string', 'required' => false, 'example' => 'test_daa'], ], [ 'name' => 'AuditAccountPassword', 'in' => 'query', 'schema' => ['description' => '审计管理员账号的密码。>若已开启三权分立模式，该参数必填。更多关于三权分立模块的信息，请参见[三权分立](~~213824~~)。', 'type' => 'string', 'required' => false, 'example' => '******'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => 'DC3ABA3E-0F8A-4596-9104-F5155C******'], 'Data' => [ 'description' => '返回结果集。', 'type' => 'object', 'properties' => [ 'SLSLogStore' => ['description' => 'sls的logstore名称。', 'type' => 'string', 'example' => 'polardbx-sqlaudit-log'], 'SLSProject' => ['description' => 'slsproject的名称。', 'type' => 'string', 'example' => 'polardbx-sqlaudit-cn-hangzhou-1852045029120897'], 'IsEnabled' => ['description' => 'sql审计功能是否开启。', 'type' => 'boolean', 'example' => 'true'], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => '数据库实例不存在'], ], ], 'title' => '查看SQL审计信息', 'summary' => '该接口用于查看SQL审计信息。', 'description' => '> * PolarDB-X 2.0 SQL审计与分析功能本身免费使用，但日志服务会对存储空间、读取流量、请求数量、数据加工、数据投递等进行收费，更多关于SQL审计功能的详情，请参见[开启SQL审计与分析](~~184619~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlAuditInfo'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC3ABA3E-0F8A-4596-9104-F5155C******\\",\\n \\"Data\\": {\\n \\"SLSLogStore\\": \\"polardbx-sqlaudit-log\\",\\n \\"SLSProject\\": \\"polardbx-sqlaudit-cn-hangzhou-1852045029120897\\",\\n \\"IsEnabled\\": true\\n }\\n}","type":"json"}]', ], 'DescribeSqlFlashbackTaskList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '121676', 'abilityTreeNodes' => ['FEATUREdrds73QXOU'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'PolardbxInstanceId', 'in' => 'query', 'schema' => ['description' => 'PolarDB-X实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-**********'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], 'Message' => ['description' => '请求结果描述信息。', 'type' => 'string', 'example' => 'OK'], 'Success' => ['description' => '当前API是否请求成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '请求结果数据内容。', 'type' => 'object', 'properties' => [ 'SqlFlashbackTasks' => [ 'description' => '闪回任务返回对象。', 'type' => 'array', 'items' => [ 'description' => '闪回任务返回对象。', 'type' => 'object', 'properties' => [ 'GmtModified' => ['description' => '闪回任务在数据库的最后更新时间（单位：ms）。', 'type' => 'string', 'example' => '1568611469000'], 'SearchEndTime' => ['description' => '提交SQL闪回时输入的结束时间（单位：ms）。', 'type' => 'string', 'example' => '1568609597000'], 'RecallStatus' => ['description' => '数据召回任务状态：'."\n" ."\n" .'- **1**：进行中；'."\n" .'- **2**：已完成。', 'type' => 'string', 'example' => '1'], 'SqlPk' => ['description' => 'SQL涉及的主键值。', 'type' => 'string', 'example' => 'id'], 'RecallRestoreType' => ['description' => 'SQL闪回恢复类型： '."\n" ."\n" .'- **1**：镜像恢复；'."\n" .'- **2**：逆向恢复。'."\n", 'type' => 'string', 'example' => '0'], 'TableName' => ['description' => '数据所属的表。', 'type' => 'string', 'example' => 'test'], 'GmtCreate' => ['description' => '闪回任务在数据库的创建时间（单位：ms）。', 'type' => 'string', 'example' => '1568611408000'], 'InstId' => ['description' => 'PolarDB-X实例ID。', 'type' => 'string', 'example' => 'pxc-********'], 'SearchStartTime' => ['description' => '提交SQL闪回时输入的开始时间（单位：ms）。', 'type' => 'string', 'example' => '1568609597000'], 'RecallType' => ['description' => '回溯类型：'."\n" ."\n" .'- **0**：精确查找；'."\n" .'- **1**：模糊查找。'."\n" ."\n", 'type' => 'string', 'example' => '0'], 'TraceId' => ['description' => 'SQL的trace_id。', 'type' => 'string', 'example' => '13ed05705f801000'], 'DbName' => ['description' => '执行闪回任务的数据库名称。', 'type' => 'string', 'example' => 'test'], 'SqlType' => ['description' => 'SQL的类型，取值范围为INSERT、UPDATE、DELETE，多种类型间用英文逗号（,）分隔。', 'type' => 'string', 'example' => 'INSERT,UPDATE'], 'Id' => ['description' => '主键ID。', 'type' => 'string', 'example' => '111'], 'ExpireTime' => ['description' => '下载地址过期时间（单位：ms）。', 'type' => 'string', 'example' => '1569216270000'], 'SqlCounter' => ['description' => '恢复的数据行数。', 'type' => 'string', 'example' => '100'], 'RecallProgress' => ['description' => '闪回任务执行进度（取值范围1～100）。', 'type' => 'string', 'example' => '10'], 'DownloadUrl' => ['description' => '结果文件下载地址。', 'type' => 'string', 'example' => 'http://...'], ], ], ], ], ], ], 'description' => '', ], ], ], 'title' => '查看SQL闪回任务的列表', 'summary' => '调用DescribeSqlFlashbackTaskList接口查看SQL闪回任务的列表。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlFlashbackTaskList'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SqlFlashbackTasks\\": [\\n {\\n \\"GmtModified\\": \\"1568611469000\\",\\n \\"SearchEndTime\\": \\"1568609597000\\",\\n \\"RecallStatus\\": \\"1\\",\\n \\"SqlPk\\": \\"id\\",\\n \\"RecallRestoreType\\": \\"0\\",\\n \\"TableName\\": \\"test\\",\\n \\"GmtCreate\\": \\"1568611408000\\",\\n \\"InstId\\": \\"pxc-********\\",\\n \\"SearchStartTime\\": \\"1568609597000\\",\\n \\"RecallType\\": \\"0\\",\\n \\"TraceId\\": \\"13ed05705f801000\\",\\n \\"DbName\\": \\"test\\",\\n \\"SqlType\\": \\"INSERT,UPDATE\\",\\n \\"Id\\": \\"111\\",\\n \\"ExpireTime\\": \\"1569216270000\\",\\n \\"SqlCounter\\": \\"100\\",\\n \\"RecallProgress\\": \\"10\\",\\n \\"DownloadUrl\\": \\"http://...\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n OK\\n true\\n \\n \\n 1568611469000\\n 1568609597000\\n 1\\n id\\n 0\\n test\\n 1568611408000\\n pxc-********\\n 1568609597000\\n 0\\n 13ed05705f801000\\n test\\n INSERT,UPDATE\\n 111\\n 1569216270000\\n 100\\n 10\\n http://...\\n \\n \\n","errorExample":""}]', ], 'DescribeStoragePoolInfo' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属的地域ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-*********'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['title' => '资源组ID', 'description' => '资源组ID', 'type' => 'string', 'required' => false, 'example' => 'rg-xxxxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '实例详情列表。', 'type' => 'object', 'properties' => [ 'StoragePools' => [ 'description' => '存储池。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Class' => ['description' => '实例的规格类型（即规格代码）。', 'type' => 'string', 'example' => 'polar.mysql.x4.large'], 'DnIdList' => [ 'description' => 'DN列表。', 'type' => 'array', 'items' => ['description' => 'DN列表。', 'type' => 'string', 'example' => '[]'], 'example' => '[pxc-xdb-s-pxcbj****xxnwp0wac2c4\\",\\"pxc-xdb-s-pxcbjr3b8****p0wa1589\\"]', ], 'DnIdString' => ['description' => 'DN id', 'type' => 'string', 'example' => 'pxc-xdb-s-pxcshr****rh7fn2654fc'], 'Extra' => ['description' => '保留字段。', 'type' => 'string', 'example' => '{\\"appId\\":\\"APP_ETLUP1E5FMI5ND5IFO8W\\"}'], 'GmtCreated' => ['description' => '账号创建时间。', 'type' => 'string', 'example' => '2025-08-27 23:19:52.0'], 'GmtModified' => ['description' => '修改时间，时间戳格式。', 'type' => 'string', 'example' => '2025-09-02 16:52:47.0'], 'IdleDNIdList' => [ 'description' => '空闲DN列表。', 'type' => 'array', 'items' => ['description' => '空闲DN列表。', 'type' => 'string', 'example' => '[]'], 'example' => 'none', ], 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'test-cacheapi'], 'UnDeletableDNId' => ['description' => '禁止删除的DN。', 'type' => 'string', 'example' => 'pxc-xdb-s-hzr*****6j4se284344'], ], 'description' => '', ], ], ], ], 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], 'Code' => ['description' => '接口返回Code', 'type' => 'string', 'example' => '200'], ], 'description' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '查询存储池信息', 'summary' => '该接口用于查询存储池的详细信息，包括容量、使用情况、状态等。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStoragePoolInfo'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"StoragePools\\": [\\n {\\n \\"Class\\": \\"polar.mysql.x4.large\\",\\n \\"DnIdList\\": [\\n \\"[]\\"\\n ],\\n \\"DnIdString\\": \\"pxc-xdb-s-pxcshr****rh7fn2654fc\\",\\n \\"Extra\\": \\"{\\\\\\\\\\\\\\"appId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"APP_ETLUP1E5FMI5ND5IFO8W\\\\\\\\\\\\\\"}\\",\\n \\"GmtCreated\\": \\"2025-08-27 23:19:52.0\\",\\n \\"GmtModified\\": \\"2025-09-02 16:52:47.0\\",\\n \\"IdleDNIdList\\": [\\n \\"[]\\"\\n ],\\n \\"Name\\": \\"test-cacheapi\\",\\n \\"UnDeletableDNId\\": \\"pxc-xdb-s-hzr*****6j4se284344\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', ], 'DescribeStructureImportTaskInfo' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '161642', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai'], ], [ 'name' => 'SlinkTaskId', 'in' => 'query', 'schema' => ['description' => '目标任务id。', 'type' => 'string', 'required' => true, 'example' => 'etx-szr2rr6i*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], 'Message' => ['description' => '返回消息。>请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'success'], 'Data' => [ 'description' => '返回结果集。', 'type' => 'object', 'properties' => [ 'StructureImportResult' => [ 'description' => '结构导入任务的导入结果。', 'type' => 'object', 'properties' => [ 'Status' => ['description' => '导入状态。', 'type' => 'string', 'example' => 'finish'], 'FinishedNum' => ['description' => '已完成的记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '118'], 'TotalNum' => ['description' => '结果总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'ExceptionFullTableName' => ['description' => '异常的表名。', 'type' => 'string', 'example' => 'hash_realtime_new.wm_in_job_et'], 'ExceptionDetail' => ['description' => '异常原因。', 'type' => 'string', 'example' => 'java.sql.SQLException: [1a7a5f22aa403000][10.239.190.4:3058][hash_realtime_new]ERR-CODE: [TDDL-5123][ERR_INSTANCE_READ_ONLY_OPTION_NOT_SUPPORT] server is running with the instance-read-only option so it cannot execute this statement'], 'Percentage' => ['description' => '当前进度（百分比）。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], ], ], 'SlinkStage' => ['description' => 'slink状态。', 'type' => 'string', 'example' => 'STRUCTURE_IMPORT'], ], ], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => '查询数据导入任务信息', 'summary' => '该接口用于查询数据库结构导入任务的详细信息。', 'description' => 'CreateDataImportTask 接口用于创建数据导入任务，支持将存储在OSS、ECS或直接传入的SQL/CSV文件导入到目标数据库实例中。通过指定实例ID、数据库名、引擎类型、数据来源（如OSS路径）及导入类型，系统将异步或同步执行数据写入操作，适用于数据迁移、初始化和补录等场景，返回任务ID以便后续状态查询与管理。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStructureImportTaskInfo'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"StructureImportResult\\": {\\n \\"Status\\": \\"finish\\",\\n \\"FinishedNum\\": 118,\\n \\"TotalNum\\": 1,\\n \\"ExceptionFullTableName\\": \\"hash_realtime_new.wm_in_job_et\\",\\n \\"ExceptionDetail\\": \\"java.sql.SQLException: [1a7a5f22aa403000][10.239.190.4:3058][hash_realtime_new]ERR-CODE: [TDDL-5123][ERR_INSTANCE_READ_ONLY_OPTION_NOT_SUPPORT] server is running with the instance-read-only option so it cannot execute this statement\\",\\n \\"Percentage\\": 100\\n },\\n \\"SlinkStage\\": \\"STRUCTURE_IMPORT\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DescribeSupabaseApiKey' => [ 'summary' => '查询Supabase API Key', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '地域ID', 'description' => '地域ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxsp-*********'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], 'Data' => [ 'title' => 'ApiKey信息', 'description' => 'ApiKey信息', 'type' => 'object', 'properties' => [ 'DBInstanceName' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'example' => 'pxsp-*********'], 'AnonKey' => ['title' => '匿名访问密钥', 'description' => '匿名访问密钥', 'type' => 'string', 'example' => '*********'], 'ServiceRoleKey' => ['title' => '服务角色密钥', 'description' => '服务角色密钥', 'type' => 'string', 'example' => '*********'], ], ], 'AccessDeniedDetail' => [ 'title' => '无权限访问详情', 'description' => '无权限访问详情', 'type' => 'object', 'properties' => [ 'AuthAction' => ['title' => '鉴权动作', 'description' => '鉴权动作', 'type' => 'string', 'example' => 'xxx'], 'AuthPrincipalType' => ['title' => '鉴权主体类型', 'description' => '鉴权主体类型', 'type' => 'string', 'example' => '222'], 'NoPermissionType' => ['title' => '无权限类型', 'description' => '无权限类型', 'type' => 'string', 'example' => 'ImplicitDeny'], 'PolicyType' => ['title' => '策略类型', 'description' => '策略类型', 'type' => 'string', 'example' => 'System'], 'EncodedDiagnosticMessage' => ['title' => '诊断信息', 'description' => '诊断信息', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], 'AuthPrincipalOwnerId' => ['title' => '鉴权主体OwnerId', 'description' => '鉴权主体OwnerId', 'type' => 'string', 'example' => '111'], 'AuthPrincipalDisplayName' => ['title' => '鉴权主体名称', 'description' => '鉴权主体名称', 'type' => 'string', 'example' => 'xxx'], ], ], ], 'description' => '', ], ], ], 'title' => '查询Supabase API Key', 'description' => '- binlog文件默认保存15天。'."\n" .'- 返回的日志列表中包含日志记录结束时间在查询开始时间之后，并且日志记录开始时间在查询结束时间之前的所有日志。'."\n" .'- 当DownloadLink不为NULL时，用户可以根据此URL下载备份文件，此URL自生成后2天内有效，请在过期时间之前下载。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxsp-*********\\",\\n \\"AnonKey\\": \\"*********\\",\\n \\"ServiceRoleKey\\": \\"*********\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"System\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n }\\n}","type":"json"}]', ], 'DescribeSupabaseInstanceAttribute' => [ 'summary' => '查询Supabase实例详情', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '地域ID', 'description' => '地域ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxsp-*********'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], 'Data' => [ 'title' => '实例详情', 'description' => '实例详情', 'type' => 'object', 'properties' => [ 'DBInstanceName' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'example' => 'pxc-supabase-001'], 'Status' => ['title' => '实例状态', 'description' => '实例状态', 'type' => 'string', 'example' => 'Running'], 'RegionId' => ['title' => '地域ID', 'description' => '地域ID', 'type' => 'string', 'example' => 'cn-hangzhou'], 'ZoneId' => ['title' => '可用区ID', 'description' => '可用区ID', 'type' => 'string', 'example' => 'cn-zhangjiakou-a'], 'SupabaseClassCode' => ['title' => 'Supabase规格代码', 'description' => 'Supabase规格代码', 'type' => 'string', 'example' => 'polarx.supabase.x4.xlarge'], 'NodeClass' => ['title' => '节点规格', 'description' => '节点规格', 'type' => 'string', 'example' => 'polarx.supabase.x2.small'], 'NodeCount' => ['title' => '节点数量', 'description' => '节点数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'VpcId' => ['title' => 'VPC ID', 'description' => 'VPC ID', 'type' => 'string', 'example' => 'vpc-********'], 'VSwitchId' => ['title' => '交换机ID', 'description' => '交换机ID', 'type' => 'string', 'example' => 'vsw-********'], 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-07-13 10:01:50 +0800'], 'TopologyType' => ['title' => '拓扑类型', 'description' => '拓扑类型', 'type' => 'string', 'example' => '1azone'], 'EngineVersion' => ['title' => '引擎版本', 'description' => '引擎版本', 'type' => 'string', 'example' => '2.0'], 'MinorVersion' => ['title' => '小版本', 'description' => '小版本', 'type' => 'string', 'example' => 'polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213'], 'LockMode' => ['title' => '锁定模式', 'description' => '锁定模式', 'type' => 'string', 'example' => 'Unlock'], 'Expired' => ['title' => '是否过期', 'description' => '是否过期', 'type' => 'boolean', 'example' => 'false'], 'PolarDBXDBInstanceName' => ['title' => '关联的PolarDB-X实例名', 'description' => '关联的PolarDB-X实例名', 'type' => 'string', 'example' => 'pxc-*********'], 'ConnAddrs' => [ 'title' => '连接地址列表', 'description' => '连接地址列表', 'type' => 'array', 'items' => [ 'description' => '连接地址。', 'type' => 'object', 'properties' => [ 'ConnectionString' => ['title' => '连接地址', 'description' => '连接地址', 'type' => 'string', 'example' => 'pxsp-********.rds.aliyuncs.com'], 'Port' => ['title' => '端口', 'description' => '端口', 'type' => 'integer', 'format' => 'int32', 'example' => '3306'], 'NetType' => ['title' => '网络类型', 'description' => '网络类型', 'type' => 'string', 'example' => '0'], 'VpcId' => ['title' => 'VPC ID', 'description' => 'VPC ID', 'type' => 'string', 'example' => 'vpc-********'], ], ], ], 'Nodes' => [ 'title' => '节点列表', 'description' => '节点列表', 'type' => 'array', 'items' => [ 'description' => '节点ID。', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'example' => '2005777'], 'Name' => ['title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'example' => 'pxsp-********'], 'ZoneId' => ['title' => '可用区ID', 'description' => '可用区ID', 'type' => 'string', 'example' => 'cn-hangzhou-a'], 'ClassCode' => ['title' => '规格代码', 'description' => '规格代码', 'type' => 'string', 'example' => 'polarx.supabase.x2.small'], ], ], ], 'TenantMode' => ['title' => '多租户模式', 'description' => '多租户模式', 'type' => 'boolean', 'example' => 'false'], ], ], 'AccessDeniedDetail' => [ 'title' => '无权限访问详情', 'description' => '无权限访问详情', 'type' => 'object', 'properties' => [ 'AuthAction' => ['title' => '鉴权动作', 'description' => '鉴权动作', 'type' => 'string', 'example' => 'xxx'], 'AuthPrincipalType' => ['title' => '鉴权主体类型', 'description' => '鉴权主体类型', 'type' => 'string', 'example' => '222'], 'NoPermissionType' => ['title' => '无权限类型', 'description' => '无权限类型', 'type' => 'string', 'example' => 'ImplicitDeny'], 'PolicyType' => ['title' => '策略类型', 'description' => '策略类型', 'type' => 'string', 'example' => 'PRIORITY'], 'EncodedDiagnosticMessage' => ['title' => '诊断信息', 'description' => '诊断信息', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], 'AuthPrincipalOwnerId' => ['title' => '鉴权主体OwnerId', 'description' => '鉴权主体OwnerId', 'type' => 'string', 'example' => '111'], 'AuthPrincipalDisplayName' => ['title' => '鉴权主体名称', 'description' => '鉴权主体名称', 'type' => 'string', 'example' => 'xxx'], ], ], ], 'description' => '', ], ], ], 'title' => '查询 Supabase 实例详情', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-supabase-001\\",\\n \\"Status\\": \\"Running\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-zhangjiakou-a\\",\\n \\"SupabaseClassCode\\": \\"polarx.supabase.x4.xlarge\\",\\n \\"NodeClass\\": \\"polarx.supabase.x2.small\\",\\n \\"NodeCount\\": 1,\\n \\"VpcId\\": \\"vpc-********\\",\\n \\"VSwitchId\\": \\"vsw-********\\",\\n \\"CreateTime\\": \\"2025-07-13 10:01:50 +0800\\",\\n \\"TopologyType\\": \\"1azone\\",\\n \\"EngineVersion\\": \\"2.0\\",\\n \\"MinorVersion\\": \\"polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"Expired\\": false,\\n \\"PolarDBXDBInstanceName\\": \\"pxc-*********\\",\\n \\"ConnAddrs\\": [\\n {\\n \\"ConnectionString\\": \\"pxsp-********.rds.aliyuncs.com\\",\\n \\"Port\\": 3306,\\n \\"NetType\\": \\"0\\",\\n \\"VpcId\\": \\"vpc-********\\"\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"Id\\": \\"2005777\\",\\n \\"Name\\": \\"pxsp-********\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"ClassCode\\": \\"polarx.supabase.x2.small\\"\\n }\\n ],\\n \\"TenantMode\\": false\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n }\\n}","type":"json"}]', ], 'DescribeSupabaseInstances' => [ 'summary' => '查询Supabase实例列表', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '地域ID', 'description' => '地域ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => '分页页码（从1起，默认1）', 'description' => '分页页码（从1起，默认1）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['title' => '每页大小（默认20，最大100）', 'description' => '每页大小（默认20，最大100）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '30'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['title' => '实例名称（精确过滤，逗号分隔多个）', 'description' => '实例名称（精确过滤，逗号分隔多个）', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'pxsp-hz********'], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['title' => '实例描述（模糊匹配）', 'description' => '实例描述（模糊匹配）', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'project name'], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => '分页查询时每页行数。最大值为100。默认值：当不设置值或设置的值小于10时，默认值为10。当设置的值大于100时，默认值为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000'], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => '下一个查询开始Token', 'type' => 'string', 'required' => false, 'example' => 'xxdds'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], 'Data' => [ 'title' => '实例列表分页结果', 'description' => '实例列表分页结果', 'type' => 'object', 'properties' => [ 'TotalNumber' => ['title' => '总条数', 'description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'PageNumber' => ['title' => '分页页码', 'description' => '分页页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'PageSize' => ['title' => '每页大小', 'description' => '每页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], 'Instances' => [ 'title' => '实例列表', 'description' => '实例列表', 'type' => 'array', 'items' => [ 'description' => '集群ID。', 'type' => 'object', 'properties' => [ 'DBInstanceName' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'example' => 'pxsp-jinwusp30'], 'Description' => ['title' => '实例描述', 'description' => '实例描述', 'type' => 'string', 'example' => '我的 Supabase 项目'], 'Status' => ['title' => '实例状态', 'description' => '实例状态', 'type' => 'string', 'example' => 'RUNNING'], 'RegionId' => ['title' => '地域ID', 'description' => '地域ID', 'type' => 'string', 'example' => 'cn-beijing'], 'ZoneId' => ['title' => '可用区ID', 'description' => '可用区ID', 'type' => 'string', 'example' => 'cn-beijing-i'], 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2026-06-08T07:19:05.000+0000'], 'SupabaseClassCode' => ['title' => 'Supabase规格代码', 'description' => 'Supabase规格代码', 'type' => 'string', 'example' => 'polarx.supabase.x4.2xlarge'], 'TenantMode' => ['title' => '多租户模式', 'description' => '多租户模式', 'type' => 'boolean', 'example' => 'MySQL'], ], ], ], ], ], 'AccessDeniedDetail' => [ 'title' => '无权限访问详情', 'description' => '无权限访问详情', 'type' => 'object', 'properties' => [ 'AuthAction' => ['title' => '鉴权动作', 'description' => '鉴权动作', 'type' => 'string', 'example' => 'xxx'], 'AuthPrincipalType' => ['title' => '鉴权主体类型', 'description' => '鉴权主体类型', 'type' => 'string', 'example' => '222'], 'NoPermissionType' => ['title' => '无权限类型', 'description' => '无权限类型', 'type' => 'string', 'example' => 'ImplicitDeny'], 'PolicyType' => ['title' => '策略类型', 'description' => '策略类型', 'type' => 'string', 'example' => 'System'], 'EncodedDiagnosticMessage' => ['title' => '诊断信息', 'description' => '诊断信息', 'type' => 'string', 'example' => 'AQEAAAAAacnceTlBNjlFODgyLTlBMDUtNUUyRC04MzE5LUQwMzZDRjJFQTM3NA=='], 'AuthPrincipalOwnerId' => ['title' => '鉴权主体OwnerId', 'description' => '鉴权主体OwnerId', 'type' => 'string', 'example' => '111'], 'AuthPrincipalDisplayName' => ['title' => '鉴权主体名称', 'description' => '鉴权主体名称', 'type' => 'string', 'example' => 'xxx'], ], ], 'MaxResults' => ['description' => '分页查询时每页行数。最大值为100。默认值：当不设置值或设置的值小于10时，默认值为10。当设置的值大于100时，默认值为100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'], 'NextToken' => ['description' => '下一个查询开始Token', 'type' => 'string', 'example' => 'xxdds'], ], 'description' => '', ], ], ], 'title' => '查询 Supabase 实例列表', 'description' => '该接口用于获取用户已配置的自定义终端节点（Endpoint）列表，便于管理和查看私有连接或VPC终端服务的设置。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"Data\\": {\\n \\"TotalNumber\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"Instances\\": [\\n {\\n \\"DBInstanceName\\": \\"pxsp-jinwusp30\\",\\n \\"Description\\": \\"我的 Supabase 项目\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-i\\",\\n \\"CreateTime\\": \\"2026-06-08T07:19:05.000+0000\\",\\n \\"SupabaseClassCode\\": \\"polarx.supabase.x4.2xlarge\\",\\n \\"TenantMode\\": true\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"System\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAacnceTlBNjlFODgyLTlBMDUtNUUyRC04MzE5LUQwMzZDRjJFQTM3NA==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n },\\n \\"MaxResults\\": 1000,\\n \\"NextToken\\": \\"xxdds\\"\\n}","type":"json"}]', ], 'DescribeSupabaseIpWhitelist' => [ 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '地域ID', 'description' => '地域ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-zhangjiakou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pcsp-**************'], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['title' => '白名单分组名', 'description' => '白名单分组名', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'default'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], 'Data' => [ 'title' => '白名单信息', 'description' => '白名单信息', 'type' => 'object', 'properties' => [ 'DBInstanceName' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'example' => 'pxc-unrf5ssig0ecg8'], 'GroupItems' => [ 'title' => '白名单分组列表', 'description' => '白名单分组列表', 'type' => 'array', 'items' => [ 'description' => '白名单分组列表。', 'type' => 'object', 'properties' => [ 'GroupName' => ['title' => '分组名称', 'description' => '分组名称', 'type' => 'string', 'example' => 'defaultGroup'], 'SecurityIPList' => ['title' => 'IP白名单', 'description' => 'IP白名单', 'type' => 'string', 'example' => '127.0.0.1,172.168.0.0'], 'GroupTag' => ['title' => '分组标签', 'description' => '分组标签', 'type' => 'string', 'example' => 'group1'], ], ], ], ], ], 'AccessDeniedDetail' => [ 'title' => '无权限访问详情', 'description' => '无权限访问详情', 'type' => 'object', 'properties' => [ 'AuthAction' => ['title' => '鉴权动作', 'description' => '鉴权动作', 'type' => 'string', 'example' => 'xxx'], 'AuthPrincipalType' => ['title' => '鉴权主体类型', 'description' => '鉴权主体类型', 'type' => 'string', 'example' => '222'], 'NoPermissionType' => ['title' => '无权限类型', 'description' => '无权限类型', 'type' => 'string', 'example' => 'ImplicitDeny'], 'PolicyType' => ['title' => '策略类型', 'description' => '策略类型', 'type' => 'string', 'example' => 'PRIORITY'], 'EncodedDiagnosticMessage' => ['title' => '诊断信息', 'description' => '诊断信息', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], 'AuthPrincipalOwnerId' => ['title' => '鉴权主体OwnerId', 'description' => '鉴权主体OwnerId', 'type' => 'string', 'example' => '111'], 'AuthPrincipalDisplayName' => ['title' => '鉴权主体名称', 'description' => '鉴权主体名称', 'type' => 'string', 'example' => 'xxx'], ], ], ], 'description' => '', ], ], ], 'title' => '查询 Supabase IP白名单', 'summary' => '查询Supabase IP白名单', 'description' => '- binlog文件默认保存15天。'."\n" .'- 返回的日志列表中包含日志记录结束时间在查询开始时间之后，并且日志记录开始时间在查询结束时间之前的所有日志。'."\n" .'- 当DownloadLink不为NULL时，用户可以根据此URL下载备份文件，此URL自生成后2天内有效，请在过期时间之前下载。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-unrf5ssig0ecg8\\",\\n \\"GroupItems\\": [\\n {\\n \\"GroupName\\": \\"defaultGroup\\",\\n \\"SecurityIPList\\": \\"127.0.0.1,172.168.0.0\\",\\n \\"GroupTag\\": \\"group1\\"\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n }\\n}","type":"json"}]', ], 'DescribeTags' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '117148', 'abilityTreeNodes' => ['FEATUREdrdsJGJ3OD'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '地域', 'description' => '地域', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxx', 'maxItems' => 51], ], [ 'name' => 'TagKey', 'in' => 'query', 'schema' => ['title' => '标签Key', 'description' => '标签Key', 'type' => 'string', 'required' => false, 'example' => 'test'], ], ], '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' => 'requestid'], 'TagInfos' => [ 'title' => '标签信息列表', 'description' => '标签信息列表', 'type' => 'array', 'items' => [ 'description' => '标签信息', 'type' => 'object', 'properties' => [ 'TagKey' => ['title' => '标签Key', 'description' => '标签Key', 'type' => 'string', 'example' => 'testKey'], 'TagValue' => ['title' => '标签Value', 'description' => '标签Value', 'type' => 'string', 'example' => 'testValue'], 'DBInstanceIds' => [ 'title' => '标签关联数据库实例列表', 'description' => '标签关联数据库实例列表', 'type' => 'array', 'items' => ['description' => '实例名称', 'type' => 'string', 'example' => '数据库实例'], ], ], ], ], ], ], ], ], 'title' => '获取标签信息', 'summary' => '获取标签信息。', 'changeSet' => [ ['createdAt' => '2021-12-28T11:48:03.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTags'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"requestid\\",\\n \\"TagInfos\\": [\\n {\\n \\"TagKey\\": \\"testKey\\",\\n \\"TagValue\\": \\"testValue\\",\\n \\"DBInstanceIds\\": [\\n \\"数据库实例\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', ], 'DescribeTasks' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => '任务开始时间。', 'type' => 'string', 'required' => true, 'example' => '2021-11-01'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => '任务结束时间。', 'type' => 'string', 'required' => true, 'example' => '2021-11-04'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => '分页每页大小，取值范围为：5~1000。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '20', 'default' => '30'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => '分页页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '30', 'default' => '1'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D6045D78-C119-5A17-9DEA-0F810394E008'], 'PageNumber' => ['description' => '分页页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'PageRecordCount' => ['description' => '分页每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], 'TotalRecordCount' => ['description' => '分页总共条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'Items' => [ 'description' => '结果项列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => ['description' => '任务状态：'."\n" ."\n" .'- **RUNNING**: 任务运行中；'."\n" .'- **FAILED**：任务失败中断。', 'type' => 'string', 'example' => 'RUNNING'], 'FinishTime' => ['description' => '任务结束时间，格式为yyyy-MM-dd\'T\'HH:mm:ss\'Z\'。', 'type' => 'string', 'example' => '2021-10-20T20:00:00Z'], 'Progress' => ['description' => '任务进度，单位%。', 'type' => 'string', 'example' => '80'], 'BeginTime' => ['description' => '任务开始时间，格式为yyyy-MM-dd\'T\'HH:mm:ss\'Z\'。', 'type' => 'string', 'example' => '2021-10-20T19:40:00Z'], 'TaskErrorCode' => ['description' => '任务失败的code。', 'type' => 'string', 'example' => 'TaskErrorCode'], 'DBName' => ['description' => '任务相关的数据库名，一般为空。', 'type' => 'string', 'example' => 'DBName'], 'ProgressInfo' => ['description' => '任务进度详细情况，一般为空。', 'type' => 'string', 'example' => 'ProgressInfo'], 'ScaleOutToken' => ['description' => '如果是扩容任务，则会有一个扩容ID，后台唯一键。', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '20089398'], 'TaskErrorMessage' => ['description' => '任务失败信息。', 'type' => 'string', 'example' => 'TaskErrorMessage'], 'TaskAction' => ['description' => '任务Action，后端任务类型唯一键。', 'type' => 'string', 'example' => 'multi_scale_out'], ], 'description' => '', ], ], ], 'description' => '', ], ], ], 'staticInfo' => [], 'title' => '获取实例任务列表', 'summary' => '获取实例任务列表。', 'changeSet' => [ ['createdAt' => '2022-12-07T03:41:43.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2021-10-14T12:57:46.000Z', 'description' => '请求参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTasks'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6045D78-C119-5A17-9DEA-0F810394E008\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"TotalRecordCount\\": 2,\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"RUNNING\\",\\n \\"FinishTime\\": \\"2021-10-20T20:00:00Z\\",\\n \\"Progress\\": \\"80\\",\\n \\"BeginTime\\": \\"2021-10-20T19:40:00Z\\",\\n \\"TaskErrorCode\\": \\"TaskErrorCode\\",\\n \\"DBName\\": \\"DBName\\",\\n \\"ProgressInfo\\": \\"ProgressInfo\\",\\n \\"ScaleOutToken\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"TaskId\\": \\"20089398\\",\\n \\"TaskErrorMessage\\": \\"TaskErrorMessage\\",\\n \\"TaskAction\\": \\"multi_scale_out\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n D6045D78-C119-5A17-9DEA-0F810394E008\\n 1\\n 30\\n 2\\n \\n RUNNING\\n 2021-10-20T20:00:00Z\\n 80\\n 2021-10-20T19:40:00Z\\n TaskErrorCode\\n DBName\\n ProgressInfo\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n 20089398\\n TaskErrorMessage\\n multi_scale_out\\n \\n","errorExample":""}]', ], 'DescribeTransformStatus' => [ 'summary' => '该接口主要用于查询标准版实例向企业版实例升级（或转换）任务的当前状态。', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '196927', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxx'], ], [ 'name' => 'QueryReport', 'in' => 'query', 'schema' => ['description' => '校验报告。', '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 of the request', 'type' => 'string', 'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9'], 'Data' => [ 'description' => '监控数据。', 'type' => 'object', 'properties' => [ 'EnterpriseInsName' => ['description' => '企业版企业名称。', 'type' => 'string', 'example' => 'pxc-*****'], 'StandardInsName' => ['description' => '标准版实例名称。', 'type' => 'string', 'example' => 'pxc-*****'], 'Phase' => ['description' => '当前迁移/升级阶段。', 'type' => 'string', 'example' => 'none'], 'CanSwitch' => ['description' => '是否可以进行迁移切换，返回值为：'."\n" .'- **true**：是。'."\n" .'- **false**：否。'."\n" ."\n" .'> 此参数供云原生数据库PolarDB产品的一键升级功能使用。', 'type' => 'boolean'], 'CanUndoSwitch' => ['description' => '是否可以撤销切换操作。', 'type' => 'boolean'], 'CanCancel' => ['description' => '是否可取消', 'type' => 'boolean', 'example' => 'true'], 'CanFinish' => ['description' => '当前任务是否已完成。', 'type' => 'boolean', 'example' => 'true'], 'ReportTime' => ['description' => '数据报表生成日期。', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-09-02 16:52:47.0'."\n"], 'ReportSummary' => ['description' => '报表摘要信息。', 'type' => 'object'], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'Current DB instance does not support this operation.', 'description' => '当前实例不支持这个操作'], ['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前的实例状态不支持此操作'], ['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid Parameter.', 'description' => '参数有误'], ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist or is not supported.', 'description' => '指定实例不存在'], ['errorCode' => 'Transform.UnSupportedDbVersion', 'errorMessage' => 'Only database engine version 5.7 is supported.', 'description' => '只有数据库引擎版本为5.7的是支持的。'], ], 403 => [ ['errorCode' => 'Transform.IncorrectEngineVersion', 'errorMessage' => 'The current engine version is not the latest. Please upgrade to the latest version.', 'description' => '当前实例版本不是最新版本，请升级到最新版本。'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '查询实例升级状态', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTransformStatus'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\",\\n \\"Data\\": {\\n \\"EnterpriseInsName\\": \\"pxc-*****\\",\\n \\"StandardInsName\\": \\"pxc-*****\\",\\n \\"Phase\\": \\"none\\",\\n \\"CanSwitch\\": true,\\n \\"CanUndoSwitch\\": true,\\n \\"CanCancel\\": true,\\n \\"CanFinish\\": true,\\n \\"ReportTime\\": 0,\\n \\"ReportSummary\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n}","type":"json"}]', ], 'DescribeUserEncryptionKeyList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86265', 'abilityTreeNodes' => ['FEATUREdrds9HBOA5'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'pxc-hzjasd****'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'KeyIds' => [ 'description' => '密钥列表。', 'type' => 'array', 'items' => ['description' => '用户密钥。', 'type' => 'string', 'example' => 'RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******'], ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'The current engine version does not support the operation.', 'description' => '当前引擎版本不支持操作。'], ], ], 'title' => '获取用户TDE秘钥列表', 'summary' => '调用DescribeUserEncryptionKeyList接口获取用户TDE秘钥列表。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUserEncryptionKeyList'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Data\\": {\\n \\"KeyIds\\": [\\n \\"RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n \\n RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******\\n \\n","errorExample":""}]', ], 'DisableRightsSeparation' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86266', 'abilityTreeNodes' => ['FEATUREdrdsUFZO07'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hanghzou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '数据库实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-sprcym7g7w****'], ], [ 'name' => 'DbaAccountName', 'in' => 'query', 'schema' => ['description' => 'dba账号名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'account_1'], ], [ 'name' => 'DbaAccountPassword', 'in' => 'query', 'schema' => ['description' => 'dba账号密码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '成功返回success，错误返回对应错误码。', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['description' => '唯一请求ID。', 'type' => 'string', 'example' => 'FE5D94E3-3C93-3594-95D9-AAED2A980915'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'DisableRightsSeparation', 'summary' => '关闭三权分立。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableRightsSeparation'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FE5D94E3-3C93-3594-95D9-AAED2A980915\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n FE5D94E3-3C93-3594-95D9-AAED2A980915\\n true\\n","errorExample":""}]', ], 'DisableSqlAudit' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域id。>您可以调用[describeregions](~~196841~~)接口查看polardb-x支持的地域详情，包括地域id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => '实例id。>您可以调用[describedbinstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-****************'], ], [ 'name' => 'AuditAccountName', 'in' => 'query', 'schema' => ['description' => '审计管理员账号名称。>若已开启三权分立模式，该参数必填。更多关于三权分立模块的信息，请参见[三权分立](~~213824~~)。', 'type' => 'string', 'required' => false, 'example' => 'test_daa'], ], [ 'name' => 'AuditAccountPassword', 'in' => 'query', 'schema' => ['description' => '审计管理员账号的密码。>若已开启三权分立模式，该参数必填。更多关于三权分立模块的信息，请参见[三权分立](~~213824~~)。', 'type' => 'string', 'required' => false, 'example' => 'Pw@11111'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => 'DC3DAE3E-0F8A-4596-9104-F5167C******'], ], 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => '数据库实例不存在'], ], ], 'title' => '关闭SQL审计', 'summary' => '关闭SQL审计功能。', 'description' => '> SQL审计与分析功能关闭后将不再向日志服务写入数据，但您仍可以查看历史数据，这部分历史数据会产生存储和索引费用。您可以通过删除所有数据来停用日志服务，日志停止服务后将不再计费。关于停用日志服务，详情请参见[停用日志服务](~~90650~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableSqlAudit'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC3DAE3E-0F8A-4596-9104-F5167C******\\"\\n}","type":"json"}]', ], 'EnableRightsSeparation' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86271', 'abilityTreeNodes' => ['FEATUREdrdsUFZO07'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-htri0ori2r4k9p'], ], [ 'name' => 'SecurityAccountName', 'in' => 'query', 'schema' => ['description' => '安全管理员账号。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'account_sec'], ], [ 'name' => 'SecurityAccountPassword', 'in' => 'query', 'schema' => ['description' => '安全管理员密码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*****'], ], [ 'name' => 'SecurityAccountDescription', 'in' => 'query', 'schema' => ['description' => '安全管理员账号描述。', 'type' => 'string', 'required' => false, 'example' => 'test123'], ], [ 'name' => 'AuditAccountName', 'in' => 'query', 'schema' => ['description' => '审计员账号名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'account_audit'], ], [ 'name' => 'AuditAccountPassword', 'in' => 'query', 'schema' => ['description' => '审计员账号密码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '******'], ], [ 'name' => 'AuditAccountDescription', 'in' => 'query', 'schema' => ['description' => '审计员账号描述。', 'type' => 'string', 'required' => false, 'example' => 'test123'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '成功返回success，错误返回对应错误码。', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['description' => '唯一请求ID。', 'type' => 'string', 'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'EnableRightsSeparation', 'summary' => '打开三权分立。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableRightsSeparation'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73559800-3c8c-11ec-bd40-99cfcff3fe1e\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 73559800-3c8c-11ec-bd40-99cfcff3fe1e\\n true\\n","errorExample":""}]', ], 'EnableSqlAudit' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86272', 'abilityTreeNodes' => ['FEATUREdrdsD0NTUP'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-****************'], ], [ 'name' => 'ExpireAfterDays', 'in' => 'query', 'schema' => ['description' => '审计日志保留天数：'."\n" ."\n" .'- 0：不保留（即关闭日志自动过期）'."\n" ."\n" .'- 0 ：日志保留 N 天后自动删除'."\n" ."\n" .'- >常见取值：30、45、90、180、365', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '365', 'minimum' => '1', 'example' => '45', 'default' => '45'], ], [ 'name' => 'AuditAccountName', 'in' => 'query', 'schema' => ['description' => '审计管理员账号名称。>若已开启三权分立模式，该参数必填。更多关于三权分立模块的信息，请参见[三权分立](~~213824~~)。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test_daa'], ], [ 'name' => 'AuditAccountPassword', 'in' => 'query', 'schema' => ['description' => '审计管理员账号的密码。>若已开启三权分立模式，该参数必填。更多关于三权分立模块的信息，请参见[三权分立](~~213824~~)。', 'type' => 'string', 'required' => false, 'example' => 'Pw@11111'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => 'DC3ABA3E-0F8A-4596-9104-F5167C******'], ], 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => '数据库实例不存在'], ], ], 'title' => '开启SQL审计', 'summary' => '开启SQL审计功能。', 'description' => '> * PolarDB-X 2.0 SQL审计与分析功能本身免费使用，但日志服务会对存储空间、读取流量、请求数量、数据加工、数据投递等进行收费，更多关于SQL审计功能的详情，请参见[开启SQL审计与分析](~~184619~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableSqlAudit'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DC3ABA3E-0F8A-4596-9104-F5167C******\\"\\n}","type":"json"}]', ], 'ListTagResources' => [ 'summary' => '标签列表获取。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '115498', 'abilityTreeNodes' => ['FEATUREdrdsJGJ3OD'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '地域', 'description' => '地域', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['title' => '下一个查询开始Token', 'description' => '下一个查询开始Token', 'type' => 'string', 'required' => false, 'example' => 'xxdds'], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['title' => '资源类型', 'description' => '资源类型，必须填写：PolarDBXInstance', 'type' => 'string', 'required' => true, 'example' => 'PolarDBXInstance'], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '资源ID,最多 50个子项', 'description' => '资源ID,最多 50个子项', 'type' => 'array', 'items' => ['description' => '资源ID', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxxx'], 'required' => false, 'maxItems' => 51, ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '标签列表，最多包含20个子项', 'description' => '标签列表，最多包含20个子项', 'type' => 'array', 'items' => [ 'description' => '标签', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '标签键', 'description' => '标签键', 'type' => 'string', 'required' => false, 'example' => '1'], 'Value' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'required' => false, 'example' => '2'], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'NextToken' => ['title' => '下一个查询开始Token，NextToken为空说明没有下一个', 'description' => '下一个查询开始Token，NextToken为空说明没有下一个', 'type' => 'string', 'example' => 'xxdd'], 'RequestId' => ['description' => '请求Id', 'type' => 'string', 'example' => 'xxxx-xxxxxx'], 'TagResources' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TagResource' => [ 'title' => '资源列表', 'description' => '资源列表', 'type' => 'array', 'items' => [ 'description' => '标签信息', 'type' => 'object', 'properties' => [ 'ResourceType' => ['title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'example' => 'PolarDBXInstance'], 'TagValue' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'example' => '1'], 'ResourceId' => ['title' => '资源ID', 'description' => '资源ID', 'type' => 'string', 'example' => 'pxc-xxxx'], 'TagKey' => ['title' => '标签键', 'description' => '标签键', 'type' => 'string', 'example' => '1'], ], ], ], ], 'description' => '', ], ], 'description' => '', ], ], ], 'title' => '标签列表获取', 'changeSet' => [ ['createdAt' => '2022-01-12T02:49:34.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2022-01-12T02:49:34.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2022-01-12T02:38:57.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2021-12-28T11:48:03.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"xxdd\\",\\n \\"RequestId\\": \\"xxxx-xxxxxx\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"PolarDBXInstance\\",\\n \\"TagValue\\": \\"1\\",\\n \\"ResourceId\\": \\"pxc-xxxx\\",\\n \\"TagKey\\": \\"1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'MigrateDBInstance' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '172659', 'abilityTreeNodes' => ['FEATUREdrds7CT80F'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'SwitchMode', 'in' => 'query', 'schema' => ['description' => '切换模式。取值：'."\n" ."\n" .'- 0：立即切换。'."\n" .'- 1：在可运维时间段内切换。', 'type' => 'string', 'required' => false, 'example' => '0', 'default' => '0'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pxc-xxx'], ], [ 'name' => 'TopologyType', 'in' => 'query', 'schema' => ['description' => '拓扑类型：'."\n" ."\n" .'- **3azones**：三可用区；'."\n" .'- **1azone**：单可用区。', 'type' => 'string', 'required' => true, 'example' => '3azones'], ], [ 'name' => 'PrimaryZoneId', 'in' => 'query', 'schema' => ['description' => '多可用区实例，主可用区的可用区ID。**如果需要创建多可用区实例，该参数必填。**', 'type' => 'string', 'required' => true, 'example' => 'cn-zhangjiakou-b'], ], [ 'name' => 'SecondaryZoneId', 'in' => 'query', 'schema' => ['description' => '备可用区ID。'."\n" .'> 本参数和ZoneId属性不能相同。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-l'], ], [ 'name' => 'TertiaryZoneId', 'in' => 'query', 'schema' => ['description' => '第三可用区。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-h'], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => '访问端点所在的专有网络ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-****'], ], [ 'name' => 'VswitchId', 'in' => 'query', 'schema' => ['description' => 'Vswitch ID, 创建 VPC 网络类型的 DRDS 时必须指定', 'type' => 'string', 'required' => false, 'example' => 'vsw-****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'MigrateDBInstanceResponse', 'description' => 'MigrateDBInstanceResponse', 'type' => 'object', 'properties' => [ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Message' => ['description' => '成功返回success，错误返回对应错误码。', 'type' => 'string', 'example' => '*****'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '实例可用区迁移', 'summary' => '该接口用于将实例从一个可用区迁移到另一个可用区。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateDBInstance'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","type":"json"}]', ], 'ModifyAccountDescription' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86275', 'abilityTreeNodes' => ['FEATUREdrdsJGJ3OD'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****'], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => '实例账号名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'account'], ], [ 'name' => 'AccountDescription', 'in' => 'query', 'schema' => ['description' => '账号描述。', 'type' => 'string', 'required' => false, 'example' => '测试账号'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '接口额外返回信息，成功返回success，错误返回对应错误码。', 'type' => 'string', 'example' => 'msg'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => '修改实例的账号描述信息', 'summary' => '调用ModifyAccountDescription接口修改账号备注描述。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountDescription'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"msg\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n msg\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n true\\n","errorExample":""}]', ], 'ModifyAccountPrivilege' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-htri0ori2r4k9p'], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => '账号名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'account_sec'], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'sbtest'], ], [ 'name' => 'AccountPrivilege', 'in' => 'query', 'schema' => ['description' => '账号权限，取值如下：'."\n" ."\n" .'- **ReadWrite**'."\n" .'- **ReadOnly**'."\n" .'- **DMLOnly**'."\n" .'- **DDLOnly**', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ReadWrite'], ], [ 'name' => 'SecurityAccountName', 'in' => 'query', 'schema' => ['description' => '安全管理员账号名称。', 'type' => 'string', 'required' => false, 'example' => 'account_audit'], ], [ 'name' => 'SecurityAccountPassword', 'in' => 'query', 'schema' => ['description' => '安全管理员账号密码。', 'type' => 'string', 'required' => false, 'example' => '*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '成功返回success，错误返回对应错误码。', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['description' => '唯一请求ID。', 'type' => 'string', 'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'ModifyAccountPrivilege', 'summary' => '修改普通账号的权限。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountPrivilege'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73559800-3c8c-11ec-bd40-99cfcff3fe1e\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 73559800-3c8c-11ec-bd40-99cfcff3fe1e\\n true\\n","errorExample":""}]', ], 'ModifyActiveOperationMaintainConf' => [ 'summary' => '调用ModifyActiveOperationMaintainConf接口修改运维事件时间配置。', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '103016', 'abilityTreeNodes' => ['FEATUREdrdsZVW4NQ'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'CycleType', 'in' => 'query', 'schema' => ['description' => '循环模式：Week，周。'."\n", 'type' => 'string', 'required' => true, 'example' => 'Week'], ], [ 'name' => 'CycleTime', 'in' => 'query', 'schema' => ['description' => '周选择 ：1-7。', 'type' => 'string', 'required' => true, 'example' => '1,2,3,4,5,6,7'], ], [ 'name' => 'MaintainStartTime', 'in' => 'query', 'schema' => ['description' => '开始时间。', 'type' => 'string', 'required' => true, 'example' => '02:00:00Z'], ], [ 'name' => 'MaintainEndTime', 'in' => 'query', 'schema' => ['description' => '结束时间。', 'type' => 'string', 'required' => true, 'example' => '02:00:00Z'], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => '是否开启：'."\n" ."\n" .'- **1**： 开启'."\n" .'- **0**： 关闭', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], ], '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' => '4035409E-7297-4115-ABC9-C1C3942BC069'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => '该请求使用与先前相同但不相同的请求相同的客户端令牌。 除非请求相同，否则请勿将客户端令牌与其他请求重用。'], ], ], 'title' => '修改运维事件时间配置', 'changeSet' => [ ['createdAt' => '2022-12-07T03:41:43.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2021-11-17T06:21:51.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyActiveOperationMaintainConf'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4035409E-7297-4115-ABC9-C1C3942BC069\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4035409E-7297-4115-ABC9-C1C3942BC069\\n","errorExample":""}]', ], 'ModifyActiveOperationTasks' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '103010', 'abilityTreeNodes' => ['FEATUREdrdsZVW4NQ'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域IID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'Ids', 'in' => 'query', 'schema' => ['description' => '运维事件ID。', 'type' => 'string', 'required' => true, 'example' => '1'], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => ['description' => '开始切换时间，格式为：YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2021-08-15T12:00:00Z'], ], [ 'name' => 'ImmediateStart', 'in' => 'query', 'schema' => ['description' => '是否立即执行：'."\n" ."\n" .'- 1：立即执行'."\n" .'- 0：指定时间执行', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '8C9CC90A-9532-4752-B59F-580112C5A45B'], 'Ids' => ['description' => '运维事件ID列表， 以英文逗号隔开。', 'type' => 'string', 'example' => '1'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => '该请求使用与先前相同但不相同的请求相同的客户端令牌。 除非请求相同，否则请勿将客户端令牌与其他请求重用。'], ], ], 'title' => '修改运维事件执行时间', 'summary' => '调用ModifyActiveOperationTasks接口修改运维事件执行时间。', 'changeSet' => [ ['createdAt' => '2022-12-07T03:41:44.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2021-11-17T06:21:51.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyActiveOperationTasks'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8C9CC90A-9532-4752-B59F-580112C5A45B\\",\\n \\"Ids\\": \\"1\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 8C9CC90A-9532-4752-B59F-580112C5A45B\\n 1\\n","errorExample":""}]', ], 'ModifyCdcClass' => [ 'summary' => '修改CDC配置', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '162467', 'abilityTreeNodes' => ['FEATUREdrdsDBGOD6'], ], 'parameters' => [ [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => '实例名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzrh51fze****pon-cdc'], ], [ 'name' => 'CdcClass', 'in' => 'query', 'schema' => ['description' => '实例规格', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'premium'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域Id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai'], ], [ 'name' => 'CDCNodeCount', 'in' => 'query', 'schema' => ['description' => 'CDC节点数', 'type' => 'string', 'required' => false, 'example' => '1', 'default' => ' '], ], [ 'name' => 'SwitchMode', 'in' => 'query', 'schema' => ['description' => '切换模式', 'type' => 'string', 'required' => false, 'example' => '0'], ], ], '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' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '2209883'], ], ], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '修改CDC配置', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCdcClass'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]', ], 'ModifyColumnarClass' => [ 'summary' => '修改列存规格', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '198145', 'abilityTreeNodes' => ['FEATUREdrdsDBGOD6'], ], 'parameters' => [ [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => '实例名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzrh51fze****pon-cdc'], ], [ 'name' => 'ColumnarClass', 'in' => 'query', 'schema' => ['description' => '列存规格', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'polarx.n8.large.col'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。>您可以调用[describeregions](~~196841~~)接口查看polardb-x支持的地域详情，包括地域id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai'], ], [ 'name' => 'ColumnarNodeCount', 'in' => 'query', 'schema' => ['description' => '列存节点数', 'type' => 'string', 'required' => false, 'example' => '**', 'default' => ' '], ], [ 'name' => 'SwitchMode', 'in' => 'query', 'schema' => ['description' => '切换模式', 'type' => 'string', 'required' => false, 'example' => '0'], ], ], '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' => '9B2F3840-****-475C-B269-2D5C3A31797C'], 'Data' => [ 'description' => '返回的策略详情。', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '******'], ], ], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '修改列存规格', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyColumnarClass'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-****-475C-B269-2D5C3A31797C\\",\\n \\"Data\\": {\\n \\"TaskId\\": 0\\n }\\n}","type":"json"}]', ], 'ModifyCustomEndpoint' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '236585', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-zhangjiakou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例Id', 'type' => 'string', 'required' => true, 'example' => 'mydatabase'], ], [ 'name' => 'CustomEndpointId', 'in' => 'query', 'schema' => ['description' => '用户端域名id', 'type' => 'string', 'required' => true, 'example' => 'cep-002'], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => '名称。', 'type' => 'string', 'required' => false, 'example' => 'secondary-endpoint'], ], [ 'name' => 'NodeIds', 'in' => 'query', 'schema' => ['description' => 'node ids', 'type' => 'string', 'required' => false, 'example' => 'node3'], ], [ 'name' => 'NodeAutoEnter', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '节点在被添加或恢复后，是否自动加入集群并开始提供服务', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], ], [ 'name' => 'NodeRole', 'in' => 'query', 'schema' => ['description' => '节点作用。', 'type' => 'string', 'required' => false, 'example' => 'master'], ], ], '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' => '1A586DCB-39A6-4050-81CC-C7BD4CCDB49F'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '修改自定义端地址', 'summary' => '该接口用于修改自定义集群地址（Custom Endpoint）的配置。', 'description' => '在 PolarDB-X 中，除了默认的主地址（Primary Endpoint）和只读地址（Read-only Endpoint）外，用户还可以创建自定义地址（Custom Endpoint），用于实现更灵活的读写分离、负载均衡或业务隔离策略。ModifyCustomEndpoint 接口允许你动态调整这些自定义地址的属性，而无需重启实例。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCustomEndpoint'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A586DCB-39A6-4050-81CC-C7BD4CCDB49F\\"\\n}","type":"json"}]', ], 'ModifyCustomEndpointNet' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '236587', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pxc-********'], ], [ 'name' => 'CustomEndpointId', 'in' => 'query', 'schema' => ['description' => '用户端域名id', 'type' => 'string', 'required' => true, 'example' => 'cep-002'], ], [ 'name' => 'ConnPrefix', 'in' => 'query', 'schema' => ['description' => '链接前缀。', 'type' => 'string', 'required' => false, 'example' => 'pxc-****'], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => ['description' => '公网地址端口。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3306'], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => '访问端点所在的专有网络ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1ndoug37dtwoedlmru0'], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-*********'], ], ], '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' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => '修改自定义网络端点', 'summary' => '该接口用于修改自定义网络端点的子网、安全组及公网访问等网络配置。', 'description' => '删除指定数据库实例的自定义连接地址，关闭该域名的访问入口。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCustomEndpointNet'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', ], 'ModifyDBInstanceClass' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '86278', 'abilityTreeNodes' => ['FEATUREdrds0SX279', 'FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****'], ], [ 'name' => 'TargetDBInstanceClass', 'in' => 'query', 'schema' => ['description' => '**标准版变配目标规格**'."\n" ."\n" .'**主实例节点规格(标准版使用)（通用）：**'."\n" .'- mysql.n2.medium.25 2核4G（通用）'."\n" .'- mysql.n4.medium.25 2核8G（通用）'."\n" .'- mysql.n8.medium.25 2核16G（通用）'."\n" .'- mysql.n2.large.25 4核8G（通用）'."\n" .'- mysql.n4.large.25 4核16G（通用）'."\n" .'- mysql.n8.large.25 4核32G（通用）'."\n" .'- mysql.n2.xlarge.25 8核16G（通用）'."\n" .'- mysql.n4.xlarge.25 8核32G（通用）'."\n" .'- mysql.n8.xlarge.25 8核64G（通用）'."\n" .'- mysql.n2.2xlarge.25 16核32G（通用）'."\n" .'- mysql.n4.2xlarge.25 16核64G（通用）'."\n" .'- mysql.n8.2xlarge.25 16核128G（通用）'."\n" ."\n" .'**主实例节点规格(标准版使用)（独享）：**'."\n" .'- mysql.x2.medium.25 2核4GB（独享）'."\n" .'- mysql.x4.medium.25 2核8GB（独享）'."\n" .'- mysql.x8.medium.25 2核16G（独享）'."\n" .'- mysql.x2.large.25 4核8GB（独享）'."\n" .'- mysql.x4.large.25 4核16G（独享）'."\n" .'- mysql.x8.large.25 4核32G（独享）'."\n" .'- mysql.x2.xlarge.25 8核16GB（独享）'."\n" .'- mysql.x4.xlarge.25 8核32G（独享）'."\n" .'- mysql.x8.xlarge.25 8核64G（独享）'."\n" .'- mysql.x2.2xlarge.25 16核32GB（独享）'."\n" .'- mysql.x4.2xlarge.25 16核64G（独享）'."\n" .'- mysql.x8.2xlarge.25 16核128G（独享）'."\n" ."\n" .'**只读实例节点规格(标准版使用) 通用** '."\n" ."\n" .'- rds.mysql.s2.xlarge 2核8G（通用）'."\n" .'- mysqlro.x4.large.1 4核16G（通用）'."\n" .'- mysqlro.x4.xlarge.1 8核32G（通用）'."\n" .'- mysqlro.x4.2xlarge.1 16核64G（通用） '."\n" ."\n" .'**只读实例节点规格(标准版使用) 独享** '."\n" ."\n" .'- mysqlro.x8.large.1 4核32G（独享） '."\n" .'- mysqlro.x8.xlarge.1 8核64G（独享） '."\n" .'- mysqlro.x8.2xlarge.1 16核128G（独享） '."\n" .'- mysqlro.x4.4xlarge.1 32核128G（独享） '."\n" .'- mysqlro.x8.4xlarge.1 32核256G（独享） ', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mysql.n2.medium.25'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => '客户端token，保证唯一任意字符串。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], ], [ 'name' => 'CnClass', 'in' => 'query', 'schema' => ['description' => '**企业版计算节点变配目标规格**'."\n" ."\n" .'**主实例计算节点规格（企业版CN）通用** '."\n" .'- polarx.x4.medium.2e 2核8G（通用）'."\n" .'- polarx.x4.large.2e 4核16G（通用）'."\n" .'- polarx.x4.xlarge.2e 8核32G（通用）'."\n" .'- polarx.x4.2xlarge.2e 16核64G（通用）'."\n" ."\n" .'**主实例计算节点规格（企业版CN）独享** '."\n" .'- polarx.x8.large.2e 4核32G（独享）'."\n" .'- polarx.x8.xlarge.2e 8核64G（独享）'."\n" .'- polarx.x8.2xlarge.2e 16核128G（独享）'."\n" .'- polarx.x4.4xlarge.2e 32核128G（独享）'."\n" .'- polarx.x8.4xlarge.2e 32核256G（独享）'."\n" .'- polarx.st.8xlarge.2e 60核470G（独享）'."\n" .'- polarx.st.12xlarge.2e 90核720G（独享）'."\n" ."\n" .'**只读实例计算节点规格（企业版CN）通用** '."\n" ."\n" .'- polarxro.x4.medium.2e 2核8G（通用）'."\n" .'- polarxro.x4.large.2e 4核16G（通用）'."\n" .'- polarxro.x4.xlarge.2e 8核32G（通用）'."\n" .'- polarxro.x4.2xlarge.2e 16核64G（通用）'."\n" ."\n" .'**只读实例计算节点规格（企业版CN）独享** '."\n" ."\n" .'- polarxro.x8.large.2e 4核32G（独享）'."\n" .'- polarxro.x8.xlarge.2e 8核64G（独享）'."\n" .'- polarxro.x8.2xlarge.2e 16核128G（独享）'."\n" .'- polarxro.x4.4xlarge.2e 32核128G（独享）'."\n" .'- polarxro.x8.4xlarge.2e 32核256G（独享）'."\n" .'- polarxro.st.8xlarge.2e 60核470G（独占物理机）'."\n" .'- polarxro.st.12xlarge.2e 90核720G（独占物理机）', 'type' => 'string', 'required' => false, 'example' => 'polarx.x4.medium.2e'], ], [ 'name' => 'DnClass', 'in' => 'query', 'schema' => ['description' => '**企业版存储节点变配目标规格**'."\n" ."\n" .'**存储节点规格（企业版DN）通用** '."\n" ."\n" .'- mysql.n4.medium.25 2核8G（通用）'."\n" .'- mysql.n4.large.25 4核16G（通用）'."\n" .'- mysql.n4.xlarge.25 8核32G（通用）'."\n" .'- mysql.n4.2xlarge.25 16核64G（通用）'."\n" ."\n" .'**存储节点规格（企业版DN）独享** '."\n" ."\n" .'- mysql.x8.large.25 4核32G（独享）'."\n" .'- mysql.x8.xlarge.25 8核64G（独享）'."\n" .'- mysql.x8.2xlarge.25 16核128G（独享）'."\n" .'- mysql.x4.4xlarge.25 32核128G（独享）'."\n" .'- mysql.x8.4xlarge.25 32核256G（独享）'."\n" .'- mysql.st.8xlarge.25 60核470G（独享）'."\n" .'- mysql.st.12xlarge.25 90核720G（独享）'."\n" ."\n" .'**只读实例存储节点规格（企业版DN）通用** '."\n" ."\n" .'- rds.mysql.s2.xlarge 2核8G（通用）'."\n" .'- mysqlro.x4.large.1 4核16G（通用）'."\n" .'- mysqlro.x4.xlarge.1 8核32G（通用）'."\n" .'- mysqlro.x4.2xlarge.1 16核64G（通用）'."\n" ."\n" .'**只读实例存储节点规格（企业版DN）独享** '."\n" ."\n" .'- mysqlro.x8.large.1 4核32G（独享）'."\n" .'- mysqlro.x8.xlarge.1 8核64G（独享）'."\n" .'- mysqlro.x8.2xlarge.1 16核128G（独享）'."\n" .'- mysqlro.x4.4xlarge.1 32核128G（独享）'."\n" .'- mysqlro.x8.4xlarge.1 32核256G（独享）'."\n" .'- rds.mysql.st.h43 60核470G（独占物理机）'."\n" .'- rds.mysql.st.v52 90核720G（独占物理机）', 'type' => 'string', 'required' => false, 'example' => 'mysql.n4.medium.25'], ], [ 'name' => 'SpecifiedDNScale', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '是否为DN多规格变配', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], ], [ 'name' => 'SpecifiedDNSpecMapJson', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'DN多规格变配时，每个DN的目标规格', 'type' => 'string', 'required' => false, 'example' => '{"pxc-xdb-s-htr3rh44ki3s6a4354":"mysql.n4.medium.25","pxc-xdb-s-htr3rh44ki3s6a71c6":"mysql.n4.medium.25"}'], ], [ 'name' => 'SwitchTimeMode', 'in' => 'query', 'schema' => ['description' => '切换时间'."\n" .'- 0: 立即执行'."\n" .'- 1: 在运维时间内执行', 'type' => 'string', 'required' => false, 'example' => '0'], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => ['description' => '切换开始时间，切换时间为：[开始时间T, T+30m]，暂未开放使用', 'type' => 'string', 'required' => false, 'example' => '2024-12-11T17:10:00Z'], ], [ 'name' => 'DnStorageSpace', 'in' => 'query', 'schema' => ['description' => '变配目标磁盘大小'."\n" ."\n" .'- 实例为固定大小磁盘时，不能变配磁盘，此时不传 DnStorageSpace'."\n" .'- DnStorageSpace 范围：[20, 3072]', 'type' => 'string', 'required' => false, 'example' => '50'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'OrderId' => ['description' => '交易订单ID，实例升配或降配，变更实例规格，会产生交易订单。', 'type' => 'string', 'example' => '20211103105558'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"20211103105558\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 20211103105558\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]', 'title' => ' ModifyDBInstanceClass', 'summary' => '调用ModifyDBInstanceClass接口修改实例规格。', 'changeSet' => [ ['createdAt' => '2024-12-11T17:47:47.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2024-12-11T17:47:47.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2022-05-30T11:01:37.000Z', 'description' => '请求参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceClass'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardbx:ModifyDBInstanceClass', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], ], 'ModifyDBInstanceConfig' => [ 'summary' => '调用ModifyDBInstanceConfig接口修改实例配置项。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86279', 'abilityTreeNodes' => ['FEATUREdrdsTQTDLY'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****'], ], [ 'name' => 'ConfigName', 'in' => 'query', 'schema' => ['description' => '待修改的配置项，详情请参见[计算层变量](~~316576~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ENABLE_CONSISTENT_REPLICA_READ'], ], [ 'name' => 'ConfigValue', 'in' => 'query', 'schema' => ['description' => '如果configName = ENABLE_CONSISTENT_REPLICA_READ， 取值”true”或“false”。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], ], 'description' => '', ], ], ], 'title' => '修改实例配置项', 'changeSet' => [ ['createdAt' => '2022-01-20T04:48:21.000Z', 'description' => '请求参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConfig'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]', ], 'ModifyDBInstanceConnectionString' => [ 'summary' => '修改实例地址链接串。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '115860', 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域Id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例Id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-unrf5ssig0ecg8'], ], [ 'name' => 'NewPrefix', 'in' => 'query', 'schema' => ['description' => '新的地址前缀', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test2'], ], [ 'name' => 'ConnectionString', 'in' => 'query', 'schema' => ['description' => '地址原链接信息', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-unrf5ssig0ecg8.polarx.huhehaote.rds.aliyuncs.com'], ], [ 'name' => 'NewPort', 'in' => 'query', 'schema' => ['description' => '新的地址端口', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3300'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '接口返回信息，一般为错误信息', 'type' => 'string', 'example' => 'success'], 'Data' => [ 'description' => '新的地址链接串信息', 'type' => 'object', 'properties' => [ 'ConnectionString' => ['description' => '地址链接串', 'type' => 'string', 'example' => 'test2.polarx.huhehaote.rds.aliyuncs.com'], 'DBInstanceName' => ['description' => '实例Id', 'type' => 'string', 'example' => 'pxc-unrf5ssig0ecg8'], 'DBInstanceNetType' => ['description' => '地址链接串的网络类型', 'type' => 'string', 'example' => '1'], 'Port' => ['description' => '地址端口', 'type' => 'string', 'example' => '3300'], ], ], 'Code' => ['description' => '接口返回Code', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], 'RequestId' => ['description' => '请求RequestId，唯一标识', 'type' => 'string', 'example' => 'c3cf535c-a585-11ea-8263-00163e04d3a7'], ], 'description' => '', ], ], ], 'title' => '修改实例地址链接串', 'changeSet' => [ ['createdAt' => '2021-12-21T13:26:37.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConnectionString'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"ConnectionString\\": \\"test2.polarx.huhehaote.rds.aliyuncs.com\\",\\n \\"DBInstanceName\\": \\"pxc-unrf5ssig0ecg8\\",\\n \\"DBInstanceNetType\\": \\"1\\",\\n \\"Port\\": \\"3300\\"\\n },\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"c3cf535c-a585-11ea-8263-00163e04d3a7\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n \\n test2.polarx.huhehaote.rds.aliyuncs.com\\n pxc-unrf5ssig0ecg8\\n 1\\n 3300\\n \\n 200\\n c3cf535c-a585-11ea-8263-00163e04d3a7\\n","errorExample":""}]', ], 'ModifyDBInstanceDescription' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****'], ], [ 'name' => 'DBInstanceDescription', 'in' => 'query', 'schema' => ['description' => '实例备注描述。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试实例'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], ], 'description' => '', ], ], ], 'title' => '修改实例描述', 'summary' => '调用ModifyDBInstanceDescription接口修改实例备注描述。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceDescription'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]', ], 'ModifyDBInstanceMaintainTime' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-htri0ori2r4k9p'], ], [ 'name' => 'MaintainTime', 'in' => 'query', 'schema' => ['description' => '可运维时间，采用UTC时间，取值范围为00.00Z-23:59Z。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '21:00Z-00:00Z'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => '唯一token。', 'type' => 'string', 'required' => false, 'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '唯一请求ID。', 'type' => 'string', 'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e'], ], 'description' => '', ], ], ], 'title' => '修改实例可维护时间', 'summary' => '修改实例可维护时间。', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceMaintainTime'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"73559800-3c8c-11ec-bd40-99cfcff3fe1e\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 73559800-3c8c-11ec-bd40-99cfcff3fe1e\\n","errorExample":""}]', ], 'ModifyDBInstanceVip' => [ 'summary' => '该接口用于修改数据库实例绑定的虚拟IP（Virtual IP）地址或其网络属性，支持更换内网IP、调整子网、迁移可用区等操作', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '232184', 'abilityTreeNodes' => ['FEATUREdrds7CT80F'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。'."\n" ."\n", 'type' => 'string', 'required' => true, 'example' => 'pxc-********'], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => '访问端点所在的专有网络ID。', 'type' => 'string', 'required' => true, 'example' => 'vpc-********'], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'required' => true, 'example' => 'vsw-*********'], ], [ 'name' => 'InstanceClusterName', 'in' => 'query', 'schema' => ['title' => '实例CN集群名称，例如default', 'type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'MigrateDBInstanceResponse', 'description' => 'MigrateDBInstanceResponse', 'type' => 'object', 'properties' => [ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Message' => ['description' => '请求返回消息。'."\n" .'> 请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => '*****'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '修改实例虚拟IP', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceVip'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:ModifyDBInstanceVip', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\"\\n}","type":"json"}]', ], 'ModifyDatabaseDescription' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****'], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => ['description' => '数据库名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testDB'], ], [ 'name' => 'DbDescription', 'in' => 'query', 'schema' => ['description' => '数据库备注描述。', 'type' => 'string', 'required' => true, 'example' => '测试数据库'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '接口额外返回信息，成功返回success，错误返回对应错误码。', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'staticInfo' => [], 'title' => '修改数据库描述', 'summary' => '调用ModifyDatabaseDescription接口修改数据库备注描述。', 'changeSet' => [ ['createdAt' => '2022-12-07T03:41:43.000Z', 'description' => '请求参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDatabaseDescription'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n true\\n","errorExample":""}]', ], 'ModifyEngineMigration' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '201956', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'pxc-htri0****r4k9p'], ], [ 'name' => 'SourceDBInstanceName', 'in' => 'query', 'schema' => ['description' => '源数据库实例名称。', 'type' => 'string', 'required' => false, 'example' => 'source456'], ], [ 'name' => 'NewMasterDBInstanceName', 'in' => 'query', 'schema' => ['description' => '迁移完成后的新主实例名称。', 'type' => 'string', 'required' => false, 'example' => 'newmaster789'], ], [ 'name' => 'SwapConnectionString', 'in' => 'query', 'schema' => ['description' => '是否自动交换连接字符串：'."\n" ."\n" .'- true：应用无需修改配置，连接自动指向新实例；'."\n" ."\n" .'- false：需手动更新应用连接地址。', 'type' => 'string', 'required' => false, 'example' => 'true'], ], [ 'name' => 'ConnectionStrings', 'in' => 'query', 'schema' => ['description' => '需要切换的具体连接地址。取值为需要两两交换的地址对应的JSON串。'."\n" .'>当SwapConnectionString取值为true时生效。', 'type' => 'string', 'required' => false, 'example' => '{\\"pc-bp1m9tt23o5kh834y.rwlb.rds.aliyuncs.com\\":\\"rm-bp1ycl5o6ojs957o0.mysql.rds.aliyuncs.com\\"}'], ], ], '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' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], 'Code' => ['description' => '接口返回Code', 'type' => 'string', 'example' => '200'], 'Message' => ['description' => '接口额外返回信息，成功返回success，错误返回对应错误码。', 'type' => 'string', 'example' => 'Success'], 'HttpStatusCode' => ['description' => '请求状态码', 'type' => 'string', 'example' => '200'], 'SuccessResponse' => ['description' => '请求是否成功。'."\n" ."\n", 'type' => 'string', 'example' => 'true'], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'DBInstanceName' => ['description' => '实例Id', 'type' => 'string', 'example' => 'pxc-*********'], 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '42292****'], ], ], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '修改引擎迁移', 'summary' => '该接口用于修改数据库引擎迁移任务的配置或迁移参数，支持调整源库、目标库、迁移对象或迁移模式等设置。', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyEngineMigration'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"SuccessResponse\\": \\"true\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-*********\\",\\n \\"TaskId\\": \\"42292****\\"\\n }\\n}","type":"json"}]', ], 'ModifyMem0SecurityIps' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域Id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例Id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-*********'], ], [ 'name' => 'SecurityIPList', 'in' => 'query', 'schema' => ['description' => '白名单分组里的IP列表，多个IP白名单间用英文逗号（,）分隔。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.0.1,192.168.0.0'], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => '实例的白名单分组名称。', 'type' => 'string', 'required' => false, 'example' => 'default'], ], [ 'name' => 'ModifyMode', 'in' => 'query', 'schema' => ['description' => '白名单修改模式，取值范围如下：'."\n" ."\n" .'- 0：覆盖修改白名单分组；'."\n" .'- 1：新增白名单分组；'."\n" .'- 2：删除白名单分组。', 'type' => 'string', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B87E2AB3-B7C9-4394-9160-7F639F732031'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '2209883'], ], ], 'AccessDeniedDetail' => [ 'description' => '访问被拒绝的详细原因。', 'type' => 'object', 'properties' => [ 'AuthAction' => ['description' => '接口名。', 'type' => 'string', 'example' => 'xxx'], 'AuthPrincipalType' => ['description' => '请求中用于鉴权的身份类型。具体取值为：'."\n" .'- RAM 用户：SubUser'."\n" .'- RAM 角色：AssumedRoleUser'."\n" .'- SSO 联合身份：Federated', 'type' => 'string', 'example' => '222'], 'AuthPrincipalOwnerId' => ['description' => '鉴权主体的主账号ID。', 'type' => 'string', 'example' => '111'], 'AuthPrincipalDisplayName' => ['description' => '请求中用于鉴权的身份标识。', 'type' => 'string', 'example' => 'xxx'], 'PolicyType' => ['description' => 'PolicyType', 'type' => 'string', 'example' => 'PRIORITY'], 'NoPermissionType' => ['description' => '权限策略拒绝的类型，取值如下：'."\n" .'- **ImplicitDeny**：资源持有者未配置相关权限策略给当前用户，缺省拒绝未授权的操作。'."\n" .'- **ExplicitDeny**：资源持有者配置的RAM策略明确拒绝了当前用户访问对应的资源。', 'type' => 'string', 'example' => 'ImplicitDeny'], 'EncodedDiagnosticMessage' => ['description' => '加密后的完整诊断信息。', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], ], ], ], 'description' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '修改记忆引擎白名单', 'summary' => '修改记忆引擎白名单', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B87E2AB3-B7C9-4394-9160-7F639F732031\\",\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\"\\n }\\n}","type":"json"}]', ], 'ModifyParameter' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86282', 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasdyuoo'], ], [ 'name' => 'ParamLevel', 'in' => 'query', 'schema' => ['description' => '参数类型：'."\n" ."\n" .'- **compute**：计算层参数；'."\n" .'- **storage**：存储层参数。', 'type' => 'string', 'required' => false, 'example' => 'compute'], ], [ 'name' => 'Parameters', 'in' => 'query', 'schema' => ['description' => '参数为符合JSON格式的字符串，MapKey表示参数名称，MapValue表示参数值。可修改的具体参数是动态增删的，请通过[DescribeParameterTemplates](~~196856~~)接口获取，一次可以传入多个参数。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{"CONN_POOL_BLOCK_TIMEOUT":6000}'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => '客户端请求Token，任意唯一字符串。', 'type' => 'string', 'required' => false, 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], ], [ 'name' => 'ParameterGroupId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], ], 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => '数据库实例不存在'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => '修改实例参数', 'summary' => '调用ModifyParameter接口修改实例参数，包括计算层和存储层。', 'changeSet' => [ ['createdAt' => '2024-09-29T02:19:05.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2024-09-29T02:19:05.000Z', 'description' => '请求参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyParameter'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]', ], 'ModifySecurityIps' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****'], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => '实例的白名单分组名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'default'], ], [ 'name' => 'SecurityIPList', 'in' => 'query', 'schema' => ['description' => '白名单分组里的IP列表，多个IP白名单间用英文逗号（,）分隔。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.0.1,192.168.0.0'], ], [ 'name' => 'ModifyMode', 'in' => 'query', 'schema' => ['description' => '白名单修改模式，取值范围如下：'."\n" ."\n" .'- 0：覆盖修改白名单分组；'."\n" .'- 1：新增白名单分组；'."\n" .'- 2：删除白名单分组。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '请求返回信息，正确显示success，错误显示错误码。', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => '修改实例白名单', 'summary' => '调用ModifySecurityIps接口修改实例白名单。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySecurityIps'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n true\\n","errorExample":""}]', ], 'ModifySupabaseDashboardPassword' => [ 'summary' => '修改Supabase Dashboard密码', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '地域ID', 'description' => '地域ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-xxx'], ], [ 'name' => 'NewPassword', 'in' => 'query', 'schema' => ['title' => '新密码', 'description' => '新密码', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '********'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], 'AccessDeniedDetail' => [ 'title' => '无权限访问详情', 'description' => '无权限访问详情', 'type' => 'object', 'properties' => [ 'AuthAction' => ['title' => '鉴权动作', 'description' => '鉴权动作', 'type' => 'string', 'example' => 'xxx'], 'AuthPrincipalType' => ['title' => '鉴权主体类型', 'description' => '鉴权主体类型', 'type' => 'string', 'example' => '222'], 'NoPermissionType' => ['title' => '无权限类型', 'description' => '无权限类型', 'type' => 'string', 'example' => 'ImplicitDeny'], 'PolicyType' => ['title' => '策略类型', 'description' => '策略类型', 'type' => 'string', 'example' => 'System'], 'EncodedDiagnosticMessage' => ['title' => '诊断信息', 'description' => '诊断信息', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], 'AuthPrincipalOwnerId' => ['title' => '鉴权主体OwnerId', 'description' => '鉴权主体OwnerId', 'type' => 'string', 'example' => '111'], 'AuthPrincipalDisplayName' => ['title' => '鉴权主体名称', 'description' => '鉴权主体名称', 'type' => 'string', 'example' => 'xxx'], ], ], 'Data' => [ 'title' => '操作结果', 'description' => '操作结果', 'type' => 'object', 'properties' => [ 'DBInstanceName' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'example' => 'pxc-*********'], ], ], ], 'description' => '', ], ], ], 'title' => '修改 Supabase Dashboard 密码', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"System\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n },\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-*********\\"\\n }\\n}","type":"json"}]', ], 'ModifySupabaseSecurityIPList' => [ 'summary' => '修改Supabase IP白名单', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '地域ID', 'description' => '地域ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxsp-*********'], ], [ 'name' => 'SecurityIPList', 'in' => 'query', 'schema' => ['title' => 'IP白名单列表，多个用逗号分隔', 'description' => 'IP白名单列表，多个用逗号分隔', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.0.1,192.168.0.0'], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['title' => '白名单分组名', 'description' => '白名单分组名', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'default'], ], [ 'name' => 'ModifyMode', 'in' => 'query', 'schema' => ['title' => '修改模式：Cover（覆盖）/Append（追加）/Delete（删除）', 'description' => '修改模式：Cover（覆盖）/Append（追加）/Delete（删除）', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Append'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], 'AccessDeniedDetail' => [ 'title' => '无权限访问详情', 'description' => '无权限访问详情', 'type' => 'object', 'properties' => [ 'AuthAction' => ['title' => '鉴权动作', 'description' => '鉴权动作', 'type' => 'string', 'example' => 'xxx'], 'AuthPrincipalType' => ['title' => '鉴权主体类型', 'description' => '鉴权主体类型', 'type' => 'string', 'example' => '222'], 'NoPermissionType' => ['title' => '无权限类型', 'description' => '无权限类型', 'type' => 'string', 'example' => 'ImplicitDeny'], 'PolicyType' => ['title' => '策略类型', 'description' => '策略类型', 'type' => 'string', 'example' => 'PRIORITY'], 'EncodedDiagnosticMessage' => ['title' => '诊断信息', 'description' => '诊断信息', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], 'AuthPrincipalOwnerId' => ['title' => '鉴权主体OwnerId', 'description' => '鉴权主体OwnerId', 'type' => 'string', 'example' => '111'], 'AuthPrincipalDisplayName' => ['title' => '鉴权主体名称', 'description' => '鉴权主体名称', 'type' => 'string', 'example' => 'xxx'], ], ], 'Data' => [ 'title' => '操作结果', 'description' => '操作结果', 'type' => 'object', 'properties' => [ 'DBInstanceName' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'example' => 'pxsp-*********'], 'GroupName' => ['title' => '白名单分组名称', 'description' => '白名单分组名称', 'type' => 'string', 'example' => 'special'], 'SecurityIPList' => ['title' => 'IP白名单', 'description' => 'IP白名单', 'type' => 'string', 'example' => '100.104.187.192/26,100.104.225.192/26,100.104.145.64/26'], ], ], ], 'description' => '', ], ], ], 'title' => '修改 Supabase IP 白名单', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n },\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxsp-*********\\",\\n \\"GroupName\\": \\"special\\",\\n \\"SecurityIPList\\": \\"100.104.187.192/26,100.104.225.192/26,100.104.145.64/26\\"\\n }\\n}","type":"json"}]', ], 'PreCheckSqlFlashbackTask' => [ 'summary' => '该接口用于在执行 SQL 闪回恢复（Flashback） 前，对恢复任务进行前置检查与可行性评估。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '121682', 'abilityTreeNodes' => ['FEATUREdrds73QXOU'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'PolardbxInstanceId', 'in' => 'query', 'schema' => ['description' => '集群id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-*********'], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => '闪回sql执行的开始时间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2025-09-21 14:35:00'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => '闪回sql执行的结束时间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2025-09-21 14:41:00'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '14036EBE-***-44DB-ACE9-AC6157D3A6FC'], 'Message' => ['description' => '请求返回消息。>请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'successs'], 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '返回结果集。', 'type' => 'object', 'properties' => [ 'CheckResult' => [ 'description' => '校验结果。', 'type' => 'object', 'properties' => [ 'CanUpgradeSupportBinlogRowQueryEvents' => ['description' => '能否更新成功。', 'type' => 'boolean'], 'BinlogRowQueryEventEnabled' => ['description' => '是否已开启记录原始 SQL 查询事件，取值范围如下：***true**：开启***false**：关闭', 'type' => 'boolean'], 'SupportBinlogRowQueryEvents' => ['description' => '是否支持日志记录，取值范围如下：***true**：支持***false**：不支持', 'type' => 'boolean'], 'BinlogExists' => ['description' => '是否存在有效的 Binlog 日志文件（用于判断能否进行闪回、同步等操作）', 'type' => 'boolean'], 'HasTable' => ['description' => '是否有下一页，true/false。', 'type' => 'boolean'], ], ], ], ], ], 'description' => '', ], ], ], 'title' => 'SQL闪回恢复检查', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PreCheckSqlFlashbackTask'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-***-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Message\\": \\"successs\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CheckResult\\": {\\n \\"CanUpgradeSupportBinlogRowQueryEvents\\": true,\\n \\"BinlogRowQueryEventEnabled\\": true,\\n \\"SupportBinlogRowQueryEvents\\": true,\\n \\"BinlogExists\\": true,\\n \\"HasTable\\": true\\n }\\n }\\n}","type":"json"}]', ], 'RefreshImportMeta' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '161097', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域id。>您可以调用[describeregions](~~196841~~)接口查看polardb-x支持的地域详情，包括地域id。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例id。>您可以调用[describedbinstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例id。', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxx'], ], [ 'name' => 'SlinkTaskId', 'in' => 'query', 'schema' => ['description' => '任务id。', 'type' => 'string', 'required' => true, 'example' => 'etx-szr2rr6i*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '导入导出任务的结果详情。>若无特殊情况，该参数为空。', 'type' => 'string', 'example' => '*****'], 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => 'AE4F6C34-065F-45AA-B5DC-4B8D816F6305'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '监控数据。', 'type' => 'object', 'properties' => [ 'SlinkTaskId' => ['description' => '导出任务id。', 'type' => 'string', 'example' => 'etx-szr2rr6i*****'], ], ], ], 'description' => '', ], ], ], 'title' => '刷新导入元数据', 'summary' => '该接口用于刷新导入任务的元数据信息。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshImportMeta'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"AE4F6C34-065F-45AA-B5DC-4B8D816F6305\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', ], 'ReleaseColdDataVolume' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '137137', 'abilityTreeNodes' => ['FEATUREdrdsONAWER'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzravgpt8q****'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EA330983-C895-57C0-AE82-5A63106EBB10'], ], 'description' => '', ], ], ], 'title' => 'ReleaseColdDataVolume', 'summary' => '调用ReleaseColdDataVolume接口', 'changeSet' => [ ['createdAt' => '2022-07-28T08:28:31.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseColdDataVolume'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EA330983-C895-57C0-AE82-5A63106EBB10\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EA330983-C895-57C0-AE82-5A63106EBB10\\n","errorExample":""}]', ], 'ReleaseInstancePublicConnection' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86286', 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****'], ], [ 'name' => 'CurrentConnectionString', 'in' => 'query', 'schema' => ['description' => '实例连接串。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasdyuoo.polarx.rds.aliyuncs.com'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], ], 'description' => '', ], ], ], 'title' => '释放实例的外网连接地址', 'summary' => '调用ReleaseInstancePublicConnection接口释放实例公网连接。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseInstancePublicConnection'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]', ], 'ReleaseMem0PublicConnection' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域id。>您可以调用[describeregions](~~196841~~)接口查看polardb-x支持的地域详情，包括地域id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-htri0****r4k9p'], ], [ 'name' => 'CurrentConnectionString', 'in' => 'query', 'schema' => ['title' => '要释放的公网连接串（可选，不传则自动释放 Mem0 公网地址）', 'description' => '要释放的公网连接串（可选，不传则自动释放 Mem0 公网地址）', 'type' => 'string', 'required' => false, 'example' => 'pxc-hzjasdyuoo.polarx.rds.aliyuncs.com'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9'], 'AccessDeniedDetail' => [ 'description' => '访问被拒绝的详细原因。', 'type' => 'object', 'properties' => [ 'AuthAction' => ['description' => '说明如上。', 'type' => 'string', 'example' => 'xxx'], 'AuthPrincipalType' => ['description' => '说明如上。', 'type' => 'string', 'example' => '222'], 'AuthPrincipalOwnerId' => ['description' => '说明如上。', 'type' => 'string', 'example' => '111'], 'AuthPrincipalDisplayName' => ['description' => '请求中用于鉴权的身份标识。', 'type' => 'string', 'example' => 'xxx'], 'PolicyType' => ['description' => 'PolicyType', 'type' => 'string', 'example' => 'PRIORITY'], 'NoPermissionType' => ['description' => 'NoPermissionType', 'type' => 'string', 'example' => 'ImplicitDeny'], 'EncodedDiagnosticMessage' => ['description' => '编码诊断信息。', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], ], ], ], 'description' => '', ], ], ], 'title' => '关闭记忆引擎公网地址', 'summary' => '为 Mem0 实例释放公网域名', 'description' => '该接口用于在回滚任务前，确认无任何活跃连接以保障操作安全。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\"\\n }\\n}","type":"json"}]', ], 'ResetAccountPassword' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-htri0ori2r4k9p'], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => '账号名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'account'], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => ['description' => '账号密码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*****'], ], [ 'name' => 'SecurityAccountName', 'in' => 'query', 'schema' => ['description' => '安全管理员账号。', 'type' => 'string', 'required' => false, 'example' => 'account_sec'], ], [ 'name' => 'SecurityAccountPassword', 'in' => 'query', 'schema' => ['description' => '安全管理员密码。', 'type' => 'string', 'required' => false, 'example' => '*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '返回信息，成功返回success，错误返回对应错误码。', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['description' => '唯一请求ID。', 'type' => 'string', 'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => 'ResetAccountPassword', 'summary' => '重置账号密码。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAccountPassword'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73559800-3c8c-11ec-bd40-99cfcff3fe1e\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 73559800-3c8c-11ec-bd40-99cfcff3fe1e\\n true\\n","errorExample":""}]', ], 'ResetAccountPasswordRestrict' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86288', 'abilityTreeNodes' => ['FEATUREdrds0ML0VG'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域id。>您可以通过[describeregions](~~98041~~)接口查看可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例id。>您可以调用[describedbinstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********'], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => '需要重置密码的账号名称。>仅支持重置普通账号的密码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testaccount'], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => ['description' => '需要重置密码的账号信息，多个账号信息间用英文逗号（,）隔开。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*****'], ], [ 'name' => 'SecurityAccountName', 'in' => 'query', 'schema' => ['description' => '需要重置密码的账号名称。>*仅支持重置普通账号的密码。*您可以调用[describeaccountlist](~~196844~~)接口查看目标实例的账号信息，包括账号名称', 'type' => 'string', 'required' => false, 'example' => 'account_sec'], ], [ 'name' => 'SecurityAccountPassword', 'in' => 'query', 'schema' => ['description' => '安全管理员账号的密码。>若已开启三权分立模式，该参数必填。更多关于三权分置模式的信息，请参见[三权分立](~~213824~~)。', 'type' => 'string', 'required' => false, 'example' => '*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '调用结果的附加信息。', 'type' => 'string', 'example' => '*****'], 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '9B2F3840-5C98-****-B269-2D5C3A31797C'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => '重置账号密码', 'summary' => '重置账号密码。', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAccountPasswordRestrict'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-****-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'ResetMem0AccountPassword' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzravgpt8q****'], ], [ 'name' => 'Mem0ApiKey', 'in' => 'query', 'schema' => ['description' => 'apikey', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'aafdf2e7d0988ef623***', 'maxLength' => 128, 'minLength' => 32], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A501A191-BD70-5E50-98A9-C2A486A82****'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '2209883'], 'Mem0ApiKey' => ['description' => 'API KEY', 'type' => 'string', 'example' => 'aafdf2e7d0988ef***'], ], ], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string'], 'AuthPrincipalType' => ['type' => 'string'], 'AuthPrincipalOwnerId' => ['type' => 'string'], 'AuthPrincipalDisplayName' => ['type' => 'string'], 'PolicyType' => ['type' => 'string'], 'NoPermissionType' => ['type' => 'string'], 'EncodedDiagnosticMessage' => ['type' => 'string'], ], ], ], 'description' => '', ], ], ], 'title' => '重置记忆引擎 API KEY', 'summary' => '重置记忆引擎 API KEY', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A501A191-BD70-5E50-98A9-C2A486A82****\\",\\n \\"Data\\": {\\n \\"TaskId\\": 2209883,\\n \\"Mem0ApiKey\\": \\"aafdf2e7d0988ef***\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"PolicyType\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A501A191-BD70-5E50-98A9-C2A486A82****\\n \\n 2209883\\n aafdf2e7d0988ef***\\n \\n","errorExample":""}]', ], 'RestartDBInstance' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], ], 'description' => '', ], ], ], 'title' => '重启实例', 'summary' => '调用RestartDBInstance接口重启实例。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartDBInstance'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]', ], 'RestartDataImportTask' => [ 'summary' => '重启数据导入任务。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '111381', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。>您可以调用[describeregions](~~196841~~)接口查看polardb-x支持的地域详情，包括地域id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => '页码，取值范围为大于0且不超过integer的最大值。默认值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'pattern' => '^\\d+$', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => '每页记录数，取值范围如下：***30*****50*****100**默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '5', 'example' => '0', 'pattern' => '^\\d+$', 'default' => '30'], ], [ 'name' => 'SlinkTaskId', 'in' => 'query', 'schema' => ['description' => '目标任务id。', 'type' => 'string', 'required' => false, 'example' => 'etx-szr2rr6i*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], 'Message' => ['description' => '请求返回消息。>请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'Success'], 'Data' => ['description' => '返回结果。', 'type' => 'boolean', 'example' => 'true'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => '重启数据导入任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartDataImportTask'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": true,\\n \\"Success\\": true\\n}","type":"json"}]', ], 'RestartSupabaseInstance' => [ 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '地域ID', 'description' => '地域ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxsp-*********'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], 'AccessDeniedDetail' => [ 'title' => '无权限访问详情', 'description' => '无权限访问详情', 'type' => 'object', 'properties' => [ 'AuthAction' => ['title' => '鉴权动作', 'description' => '鉴权动作', 'type' => 'string', 'example' => 'xxx'], 'AuthPrincipalType' => ['title' => '鉴权主体类型', 'description' => '鉴权主体类型', 'type' => 'string', 'example' => '222'], 'NoPermissionType' => ['title' => '无权限类型', 'description' => '无权限类型', 'type' => 'string', 'example' => 'ImplicitDeny'], 'PolicyType' => ['title' => '策略类型', 'description' => '策略类型', 'type' => 'string', 'example' => 'PRIORITY'], 'EncodedDiagnosticMessage' => ['title' => '诊断信息', 'description' => '诊断信息', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], 'AuthPrincipalOwnerId' => ['title' => '鉴权主体OwnerId', 'description' => '鉴权主体OwnerId', 'type' => 'string', 'example' => '111'], 'AuthPrincipalDisplayName' => ['title' => '鉴权主体名称', 'description' => '鉴权主体名称', 'type' => 'string', 'example' => 'xxx'], ], ], 'Data' => [ 'title' => '操作结果', 'description' => '操作结果', 'type' => 'object', 'properties' => [ 'DBInstanceName' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'example' => 'pxsp-*********'], ], ], ], 'description' => '', ], ], ], 'title' => '重启 Supabase 实例', 'summary' => '重启Supabase实例', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n },\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxsp-*********\\"\\n }\\n}","type":"json"}]', ], 'RestoreDBInstance' => [ 'summary' => '克隆PolarDB-X实例', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '206549', 'abilityTreeNodes' => ['FEATUREdrds6M21XK'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => ['description' => '实例付费类型。'."\n" ."\n" .'- PREPAY：包年包月'."\n" .'- POSTPAY：按量付费', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PREPAY'], ], [ 'name' => 'DBNodeCount', 'in' => 'query', 'schema' => ['description' => '实例节点数量，最小为2。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '2'], ], [ 'name' => 'DBNodeClass', 'in' => 'query', 'schema' => ['description' => '节点规格：'."\n" ."\n" .'- polarx.x4.medium.2e：2核8 GB'."\n" .'- polarx.x4.large.2e：4核16 GB'."\n" .'- polarx.x8.large.2e：4核32 GB'."\n" .'- polarx.x4.xlarge.2e：8核32 GB'."\n" .'- polarx.x8.xlarge.2e：8核64 GB'."\n" .'- polarx.x4.2xlarge.2e：16核64 GB'."\n" .'- polarx.x8.2xlarge.2e：16核128 GB'."\n" .'- polarx.x4.4xlarge.2e：32核128 GB'."\n" .'- polarx.x8.4xlarge.2e：32核256 GB'."\n" .'- polarx.st.8xlarge.2e：60核470 GB'."\n" .'- polarx.st.12xlarge.2e：90核720 GB', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'polarx.x4.2xlarge.2d'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => '幂等请求串，保持每次创建不同即可。', 'type' => 'string', 'required' => false, 'example' => 'xxxxxx-xxx'], ], [ 'name' => 'NetworkType', 'in' => 'query', 'schema' => ['description' => '网络类型，仅支持VPC网络。', 'type' => 'string', 'required' => false, 'example' => 'vpc'], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => ['description' => 'VPC ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-*****'], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-*********'], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => ['description' => '预付费时，可以选择买几个月或者几年。'."\n" ."\n" .'> Period设置为Year时，该参数支持的取值为1、2、3。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['description' => '收费周期，包年包月只能选Year、Month， 按量付费默认选择Hour。', 'type' => 'string', 'required' => false, 'example' => 'Month'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => '可以为空，资源组ID，暂时不支持。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => ['description' => '是否自动续费，默认为true。'."\n" ."\n" .'- true：是'."\n" .'- false：否'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => ['description' => 'mysql引擎版本，5.7或者8.0。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5.7'], ], [ 'name' => 'TopologyType', 'in' => 'query', 'schema' => ['description' => '拓扑类型：'."\n" ."\n" .'- 3azones：三可用区；'."\n" .'- 1azone：单可用区。', 'type' => 'string', 'required' => true, 'example' => '3azones'], ], [ 'name' => 'PrimaryZone', 'in' => 'query', 'schema' => ['description' => '主可用区。', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen-e'], ], [ 'name' => 'SecondaryZone', 'in' => 'query', 'schema' => ['description' => '次可用区。', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen-a'], ], [ 'name' => 'TertiaryZone', 'in' => 'query', 'schema' => ['description' => '第三可用区。', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen-e'], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => '实例可用区。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-a'], ], [ 'name' => 'CnClass', 'in' => 'query', 'schema' => ['description' => '计算节点规格：'."\n" ."\n" .'- polarx.x4.medium.2e：2核8 GB'."\n" .'- polarx.x4.large.2e：4核16 GB'."\n" .'- polarx.x8.large.2e：4核32 GB'."\n" .'- polarx.x4.xlarge.2e：8核32 GB'."\n" .'- polarx.x8.xlarge.2e：8核64 GB'."\n" .'- polarx.x4.2xlarge.2e：16核64 GB'."\n" .'- polarx.x8.2xlarge.2e：16核128 GB'."\n" .'- polarx.x4.4xlarge.2e：32核128 GB'."\n" .'- polarx.x8.4xlarge.2e：32核256 GB'."\n" .'- polarx.st.8xlarge.2e：60核470 GB'."\n" .'- polarx.st.12xlarge.2e：90核720 GB', 'type' => 'string', 'required' => false, 'example' => 'polarx.x4.medium.2e'], ], [ 'name' => 'DnClass', 'in' => 'query', 'schema' => ['description' => '存储节点规格：'."\n" ."\n" .'- mysql.n4.medium.25：2核8 GB'."\n" .'- mysql.n4.large.25：4核16 GB'."\n" .'- mysql.x8.large.25：4核32 GB'."\n" .'- mysql.n4.xlarge.25：8核32 GB'."\n" .'- mysql.x8.xlarge.25：8核64 GB'."\n" .'- mysql.n4.2xlarge.25：16核64 GB'."\n" .'- mysql.x8.2xlarge.25：16核128 GB'."\n" .'- mysql.x4.4xlarge.25：32核128 GB'."\n" .'- mysql.x8.4xlarge.25：32核256 GB'."\n" .'- mysql.st.8xlarge.25：60核470 GB'."\n" .'- mysql.st.12xlarge.25：90核720 GB', 'type' => 'string', 'required' => false, 'example' => 'mysql.n4.medium.25'], ], [ 'name' => 'CNNodeCount', 'in' => 'query', 'schema' => ['description' => '计算节点个数。', 'type' => 'string', 'required' => false, 'example' => '2'], ], [ 'name' => 'DNNodeCount', 'in' => 'query', 'schema' => ['description' => '存储节点个数。', 'type' => 'string', 'required' => false, 'example' => '2'], ], [ 'name' => 'CloneInstanceName', 'in' => 'query', 'schema' => ['description' => '源实例名', 'type' => 'string', 'required' => true, 'example' => 'pxc-***'], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => ['description' => '实例所需恢复的时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2024-10-14T00:00:00Z'], ], [ 'name' => 'RecoveryTypeCode', 'in' => 'query', 'schema' => ['description' => '恢复类型', 'type' => 'string', 'required' => true, 'example' => 'Clone'], ], [ 'name' => 'BackupSetId', 'in' => 'query', 'schema' => ['description' => '备份集ID。', 'type' => 'string', 'required' => false, 'example' => '111'], ], [ 'name' => 'BackupSetRegion', 'in' => 'query', 'schema' => ['description' => '备份集所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-chengdu'], ], [ 'name' => 'SourceInstanceRegion', 'in' => 'query', 'schema' => ['description' => '源实例所在地域', 'type' => 'string', 'required' => true, 'example' => 'cn-chengdu'], ], [ 'name' => 'Series', 'in' => 'query', 'schema' => ['description' => '企业版：enterprise'."\n" .'标准版：standard', 'type' => 'string', 'required' => false, 'example' => 'enterprise'], ], [ 'name' => 'StorageType', 'in' => 'query', 'schema' => ['description' => '存储类型', 'type' => 'string', 'required' => false, 'example' => 'cloud_auto'], ], [ 'name' => 'GdnRole', 'in' => 'query', 'schema' => ['description' => 'gdn角色', 'type' => 'string', 'required' => false, 'example' => 'standby'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9B2F3840-XXXX-XXXX-XXXX-2D5C3A31797C'], 'DBInstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'pxc-*********'], 'OrderId' => ['description' => '订单号。', 'type' => 'string', 'example' => '12345'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '恢复实例', 'description' => '****', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B2F3840-XXXX-XXXX-XXXX-2D5C3A31797C\\",\\n \\"DBInstanceName\\": \\"pxc-*********\\",\\n \\"OrderId\\": \\"12345\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9B2F3840-XXXX-XXXX-XXXX-2D5C3A31797C\\n pxc-*********\\n 12345\\n","errorExample":""}]', ], 'SkipCurrentStep' => [ 'summary' => '该接口用于跳过当前步骤。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '200597', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'CurrentStep', 'in' => 'query', 'schema' => ['description' => '任务当前操作步数。', 'type' => 'string', 'required' => false, 'example' => 'PRE_CHECK'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'SlinkTaskId', 'in' => 'query', 'schema' => ['description' => '导入任务id。', 'type' => 'string', 'required' => false, 'example' => 'etx-szr2rr6i*****'], ], ], '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' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], 'Message' => ['description' => '返回消息。>请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => '*****'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'SlinkTaskId' => ['description' => 'slink任务id。', 'type' => 'string', 'example' => 'etx-szr2rr6i*****'], ], ], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '跳过当前步骤', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SkipCurrentStep'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Message\\": \\"*****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', ], 'StartSwitchDatabase' => [ 'summary' => '该接口主要用于在数据库迁移或同步任务的数据库切换。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '201840', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxx'], ], [ 'name' => 'SlinkTaskId', 'in' => 'query', 'schema' => ['description' => '导入任务id。', 'type' => 'string', 'required' => true, 'example' => 'etx-szr2rr6i*****'], ], [ 'name' => 'IsModifyEndpoint', 'in' => 'query', 'schema' => ['description' => '是否修改源或目标实例的连接地址/端口。', 'type' => 'string', 'required' => false, 'example' => 'true'], ], [ 'name' => 'SrcMainConnectString', 'in' => 'query', 'schema' => ['description' => '源实例的主节点连接地址（通常是实例的内网或外网地址）。', 'type' => 'string', 'required' => false, 'example' => 'rm-*********.mysql.rds.aliyuncs.com'], ], [ 'name' => 'DstMainConnectString', 'in' => 'query', 'schema' => ['description' => '目标实例的主节点连接地址。', 'type' => 'string', 'required' => false, 'example' => 'pxc-*********.polarx.rds.aliyuncs.com'], ], [ 'name' => 'SrcMainPort', 'in' => 'query', 'schema' => ['description' => '源实例主节点的端口号。', 'type' => 'string', 'required' => false, 'example' => '3308'], ], [ 'name' => 'DstMainPort', 'in' => 'query', 'schema' => ['description' => '目标实例的端口号。', 'type' => 'string', 'required' => false, 'example' => '3313'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '请求返回消息', 'type' => 'string', 'example' => '*****'], 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '监控数据。', 'type' => 'object', 'properties' => [ 'SlinkTaskId' => ['description' => 'slink任务id。', 'type' => 'string', 'example' => 'etx-szr2rr6i*****'], ], ], ], 'description' => '', ], ], ], 'title' => '开启数据库切换', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartSwitchDatabase'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', ], 'StopDataImportTask' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '111377', 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => '页码，取值为大于0且不超过integer数据类型的最大值，默认值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'pattern' => '^\\d+$', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => '每页记录数，取值范围如下：***30*****50*****100**默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '5', 'example' => '30', 'pattern' => '^\\d+$', 'default' => '30'], ], [ 'name' => 'SlinkTaskId', 'in' => 'query', 'schema' => ['description' => '任务id。', 'type' => 'string', 'required' => false, 'example' => 'etx-szr2rr6i*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '14036EBE-***-44DB-ACE9-AC6157D3A6FC'], 'Message' => ['description' => '请求返回消息。>请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => '*****'], 'Data' => ['description' => '导入任务是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'title' => '停止数据导入任务', 'summary' => '该接口用于停止数据导入。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDataImportTask'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-***-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Message\\": \\"*****\\",\\n \\"Data\\": true,\\n \\"Success\\": true\\n}","type":"json"}]', ], 'SubmitSqlFlashbackTask' => [ 'summary' => '调用SubmitSqlFlashbackTask接口创建SQL闪回任务。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '121601', 'abilityTreeNodes' => ['FEATUREdrds73QXOU'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。'."\n" ."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'], ], [ 'name' => 'PolardbxInstanceId', 'in' => 'query', 'schema' => ['description' => 'PolarDB-X实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-*********'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => '执行闪回SQL的开始时间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-09-10 20:23:23'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => '执行闪回SQL的结束时间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-09-10 23:23:23'], ], [ 'name' => 'RecallRestoreType', 'in' => 'query', 'schema' => ['description' => '恢复类型，取值范围如下：'."\n" ."\n" .'- **1**：镜像恢复；'."\n" .'- **0**：逆向恢复。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0'], ], [ 'name' => 'TraceId', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '闪回SQL的Trace ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ase*****'], ], [ 'name' => 'TableName', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '执行闪回SQL操作的表的名称。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test'], ], [ 'name' => 'SqlType', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'SQL的类型，取值范围为INSERT、UPDATE、DELETE，多种类型间用英文逗号（,）分隔。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'INSERT,UPDATE'], ], [ 'name' => 'SqlPk', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '闪回SQL的主键。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1111'], ], [ 'name' => 'RecallType', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '精确匹配或者模糊匹配，取值范围如下：'."\n" ."\n" .'- **0**：精确匹配；'."\n" .'- **1**：模糊匹配。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '请求结果描述信息。', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], 'Success' => ['description' => '当前API是否请求成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '请求结果数据内容。', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '1111'], ], ], ], 'description' => '', ], ], ], 'title' => '创建 SQL 闪回任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSqlFlashbackTask'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": \\"1111\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n true\\n \\n 1111\\n \\n","errorExample":""}]', ], 'SwitchDBInstanceHA' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '132469', 'abilityTreeNodes' => ['FEATUREdrds7CT80F'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => ''], ], [ 'name' => 'TargetPrimaryRegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => ''], ], [ 'name' => 'TargetPrimaryAzoneId', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => ''], ], [ 'name' => 'SwitchTimeMode', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => ''], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['type' => 'string', 'description' => ''], 'RequestId' => ['type' => 'string', 'description' => ''], 'Success' => ['type' => 'boolean', 'description' => ''], ], 'description' => '', ], ], ], 'changeSet' => [ ['createdAt' => '2022-05-11T12:44:50.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchDBInstanceHA'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'SwitchGdnMemberRole' => [ 'summary' => 'GDN主备切换。', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '218654', 'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域IID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '主实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pxc-********'], ], [ 'name' => 'SwitchMode', 'in' => 'query', 'schema' => ['description' => '切换模式。', 'type' => 'string', 'required' => true, 'example' => '常规切换：switch_over'."\n" .'强制切换：fail_over'], ], [ 'name' => 'TaskTimeout', 'in' => 'query', 'schema' => ['description' => '切换任务超时时间（秒）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], [ 'name' => 'IsModifyEndpoint', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['type' => 'string'], ], [ 'name' => 'SrcMainConnectString', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['type' => 'string'], ], [ 'name' => 'DstMainConnectString', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['type' => 'string'], ], [ 'name' => 'SrcMainPort', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['type' => 'string'], ], [ 'name' => 'DstMainPort', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['type' => 'string'], ], ], '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' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], 'Message' => ['description' => '接口额外返回信息，成功返回success，错误返回对应错误码。', 'type' => 'string', 'example' => 'success'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '数据结构体。', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '2209883'], ], ], ], ], ], ], 'title' => 'GDN主从切换', 'changeSet' => [ ['createdAt' => '2025-02-18T11:58:37.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2025-02-18T11:58:37.000Z', 'description' => '请求参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchGdnMemberRole'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]', ], 'TagResources' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '115494', 'abilityTreeNodes' => ['FEATUREdrdsJGJ3OD'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '地域', 'description' => '地域', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['title' => '资源类型', 'description' => '资源类型,必须为：PolarDBXInstance', 'type' => 'string', 'required' => true, 'example' => 'PolarDBXInstance'], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '资源ID,最多 50个子项', 'description' => '资源ID,最多 50个子项', 'type' => 'array', 'items' => ['description' => '实例ID', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxxxx'], 'required' => true, 'maxItems' => 51, ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '标签列表，最多包含20个子项', 'description' => '标签列表，最多包含20个子项', 'type' => 'array', 'items' => [ 'description' => '标签', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '标签键', 'description' => '标签键', 'type' => 'string', 'required' => false, 'example' => '12'], 'Value' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'required' => false, 'example' => '22'], ], 'required' => false, ], 'required' => true, 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'requestId', 'type' => 'string', 'example' => 'xxxx-xxxx'], ], 'description' => '', ], ], ], 'title' => '为资源打标签', 'summary' => '调用TagResources接口为资源打标签。', 'changeSet' => [ ['createdAt' => '2022-01-12T02:49:34.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2022-01-12T02:49:34.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2022-01-12T02:38:57.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2021-12-28T11:48:03.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxxx\\"\\n}","type":"json"}]', ], 'UntagResources' => [ 'summary' => '资源删除标签。', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '115497', 'abilityTreeNodes' => ['FEATUREdrdsJGJ3OD'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '地域', 'description' => '地域', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['title' => '资源类型', 'description' => '资源类型,必须为：PolarDBXInstance', 'type' => 'string', 'required' => true, 'example' => 'PolarDBXInstance'], ], [ 'name' => 'All', 'in' => 'query', 'schema' => ['title' => '是否全部删除，只针对TagKey.N为空时有效。 取值范围： true false True False 默认是 false', 'description' => '是否全部删除，只针对TagKey.N为空时有效。 取值范围： true false True False 默认是 false', 'type' => 'boolean', 'required' => false, 'example' => '是否全部删除'], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '资源ID，最多50个子项', 'description' => '资源ID，最多50个子项', 'type' => 'array', 'items' => ['description' => '实例ID', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxxxx'], 'required' => true, 'maxItems' => 51, ], ], [ 'name' => 'TagKey', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '标签键，最多20个子项', 'description' => '标签键，最多20个子项', 'type' => 'array', 'items' => ['description' => '标签KEY', 'type' => 'string', 'required' => false, 'example' => '1'], 'required' => false, 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'RequestId', 'type' => 'string', 'example' => 'xxxxxx'], ], 'description' => '', ], ], ], 'title' => '资源删除标签', 'changeSet' => [ ['createdAt' => '2022-01-12T02:49:34.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2022-01-12T02:49:34.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2022-01-12T02:38:57.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2021-12-28T11:48:03.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxxx\\"\\n}","type":"json"}]', ], 'UpdateBackupPolicy' => [ 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '86292', 'abilityTreeNodes' => ['FEATUREdrds8KEOBF'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasdyuoo'], ], [ 'name' => 'BackupPeriod', 'in' => 'query', 'schema' => ['description' => '备份周期。至少需要指定2天，7位数数值，从左到右每一位数值代表周一到周日是否开启备份。取值0代表不备份，取值1代表备份：'."\n" ."\n" .'- 第一位数值：周一'."\n" .'- 第二位数值：周二'."\n" .'- 第三位数值：周三'."\n" .'- 第四位数值：周四'."\n" .'- 第五位数值：周五'."\n" .'- 第六位数值：周六'."\n" .'- 第七位数值：周日'."\n", 'type' => 'string', 'required' => false, 'example' => '1001000'], ], [ 'name' => 'BackupPlanBegin', 'in' => 'query', 'schema' => ['description' => '每天备份开启时间，UTC时间。', 'type' => 'string', 'required' => false, 'example' => '03:00Z'], ], [ 'name' => 'BackupSetRetention', 'in' => 'query', 'schema' => ['description' => '备份集保留时间，单位天。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ 'name' => 'BackupType', 'in' => 'query', 'schema' => ['description' => '备份种类，目前只支持“0”，表示快速备份。', 'type' => 'string', 'required' => false, 'example' => '0'], ], [ 'name' => 'BackupWay', 'in' => 'query', 'schema' => ['description' => '备份手段，枚举值'."\n" ."\n" .'- **P**：物理备份'."\n" .'- **L**：逻辑备份', 'type' => 'string', 'required' => false, 'example' => 'P'], ], [ 'name' => 'ForceCleanOnHighSpaceUsage', 'in' => 'query', 'schema' => ['description' => '当实例总空间使用率超过80%或剩余空间不足50 GB时，是否强制清理Binlog。从最早的开始清理，直到总空间使用率降到80%以下且剩余空间大于50 GB。取值如下：'."\n" ."\n" .'- **1**：是'."\n" .'- **0**：否', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'IsEnabled', 'in' => 'query', 'schema' => ['description' => '是否开启备份，固定值1，表示开启。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'LocalLogRetention', 'in' => 'query', 'schema' => ['description' => '日志备份本地保留小时数， 范围为0到7×24小时， 0表示不保留，默认7小时。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7'], ], [ 'name' => 'RemoveLogRetention', 'in' => 'query', 'schema' => ['description' => '日志备份远程保留天数（ 7~730） 单位天， 默认7天。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7'], ], [ 'name' => 'LogLocalRetentionSpace', 'in' => 'query', 'schema' => ['description' => '本地日志最大空间使用率，参数大小为0~50，此为循环空间，默认为30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ 'name' => 'ColdDataBackupInterval', 'in' => 'query', 'schema' => ['description' => '冷数据备份间隔天数，取值范围为1~59。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ 'name' => 'ColdDataBackupRetention', 'in' => 'query', 'schema' => ['description' => '冷数据备份保留天数，取值范围为30~730。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ 'name' => 'LocalLogRetentionNumber', 'in' => 'query', 'schema' => ['description' => '本地Binlog保留个数，默认为60，取值范围为6~100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60'], ], [ 'name' => 'IsCrossRegionDataBackupEnabled', 'in' => 'query', 'schema' => ['description' => '是否开启跨地域数据备份，默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'IsCrossRegionLogBackupEnabled', 'in' => 'query', 'schema' => ['description' => '是否开启跨地域日志备份，默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'DestCrossRegion', 'in' => 'query', 'schema' => ['description' => '跨地域备份的目标地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'], ], [ 'name' => 'CrossRegionDataBackupRetention', 'in' => 'query', 'schema' => ['description' => '跨地域数据备份的保存时间，单位：天。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ 'name' => 'CrossRegionLogBackupRetention', 'in' => 'query', 'schema' => ['description' => '跨地域日志备份的保存时间，单位：天。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ 'name' => 'CrossRegionFilterValue', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => '返回信息，成功返回success，错误返回对应错误码。', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '返回的策略详情。', 'type' => 'object', 'properties' => [ 'LogLocalRetentionSpace' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'DBInstanceName' => ['type' => 'string', 'description' => ''], 'BackupWay' => ['type' => 'string', 'description' => ''], 'BackupPeriod' => ['type' => 'string', 'description' => ''], 'ForceCleanOnHighSpaceUsage' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'BackupType' => ['type' => 'string', 'description' => ''], 'LocalLogRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'RemoveLogRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'BackupPlanBegin' => ['type' => 'string', 'description' => ''], 'BackupSetRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'IsEnabled' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'ColdDataBackupInterval' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'ColdDataBackupRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'LocalLogRetentionNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'IsCrossRegionDataBackupEnabled' => ['type' => 'boolean', 'description' => ''], 'IsCrossRegionLogBackupEnabled' => ['type' => 'boolean', 'description' => ''], 'DestCrossRegion' => ['type' => 'string', 'description' => ''], 'CrossRegionDataBackupRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'CrossRegionLogBackupRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'CrossRegionFilterValue' => ['type' => 'string'], ], ], ], 'description' => '', ], ], ], 'title' => '修改实例备份策略', 'summary' => '调用UpdateBackupPolicy接口修改实例备份策略。', 'changeSet' => [ ['createdAt' => '2024-06-19T01:48:19.000Z', 'description' => '响应参数发生变更'], ['createdAt' => '2023-09-01T08:17:05.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ['createdAt' => '2023-07-05T08:43:45.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ['createdAt' => '2022-07-28T08:28:30.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateBackupPolicy'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LogLocalRetentionSpace\\": 0,\\n \\"DBInstanceName\\": \\"\\",\\n \\"BackupWay\\": \\"\\",\\n \\"BackupPeriod\\": \\"\\",\\n \\"ForceCleanOnHighSpaceUsage\\": 0,\\n \\"BackupType\\": \\"\\",\\n \\"LocalLogRetention\\": 0,\\n \\"RemoveLogRetention\\": 0,\\n \\"BackupPlanBegin\\": \\"\\",\\n \\"BackupSetRetention\\": 0,\\n \\"IsEnabled\\": 0,\\n \\"ColdDataBackupInterval\\": 0,\\n \\"ColdDataBackupRetention\\": 0,\\n \\"LocalLogRetentionNumber\\": 0,\\n \\"IsCrossRegionDataBackupEnabled\\": true,\\n \\"IsCrossRegionLogBackupEnabled\\": true,\\n \\"DestCrossRegion\\": \\"\\",\\n \\"CrossRegionDataBackupRetention\\": 0,\\n \\"CrossRegionLogBackupRetention\\": 0,\\n \\"CrossRegionFilterValue\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n true\\n \\n 30\\n pxc-hzjasdyuoo\\n P\\n 1001000\\n 1\\n 0\\n 7\\n 7\\n 03:00Z\\n 30\\n 1\\n 30\\n 30\\n 60\\n false\\n false\\n cn-shanghai\\n 30\\n 30\\n \\n","errorExample":""}]', ], 'UpdateCustinsParam' => [ 'summary' => '修改实例标签', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '162467', 'abilityTreeNodes' => ['FEATUREdrdsDBGOD6'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域id。>您可以调用[describeregions](~~196841~~)接口查看polardb-x支持的地域详情，包括地域id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-zhangjiakou'], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => '名称。', 'type' => 'string', 'required' => true, 'example' => '数仓抽数地址'], ], [ 'name' => 'Value', 'in' => 'query', 'schema' => ['description' => '标签值。', 'type' => 'string', 'required' => true, 'example' => 'load_test_4009266'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '******'], ], ], 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '73559800-3c8c-****-bd40-99cfcff3fe1e'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '修改实例标签', 'description' => '更多关于实例账号的信息，请参见[账号管理](https://help.aliyun.com/document_detail/172163.html)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TaskId\\": 0\\n },\\n \\"RequestId\\": \\"73559800-3c8c-****-bd40-99cfcff3fe1e\\"\\n}","type":"json"}]', ], 'UpdateDBInstanceSSL' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86293', 'abilityTreeNodes' => ['FEATUREdrdsUULYZA'], ], 'parameters' => [ [ 'name' => 'EnableSSL', 'in' => 'query', 'schema' => ['description' => '是否开启SSL。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'], ], [ 'name' => 'CertCommonName', 'in' => 'query', 'schema' => ['description' => '证书绑定域名。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pxc-hzrqjarxdocd4t.polarx.rds.aliyuncs.com'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], 'Data' => [ 'description' => '请求返回数据。', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => '后端任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2209883'], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => '数据库实例不存在'], ], ], 'title' => '更新实例SSL配置', 'summary' => '更新实例SSL配置。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDBInstanceSSL'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n \\n 2209883\\n \\n","errorExample":""}]', ], 'UpdateDBInstanceTDE' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86295', 'abilityTreeNodes' => ['FEATUREdrds9HBOA5'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****'], ], [ 'name' => 'TDEStatus', 'in' => 'query', 'schema' => ['description' => '开启，固定取值1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'EncryptionKey', 'in' => 'query', 'schema' => ['description' => '自定义密钥ID时传入。也可以不传入使用后端自动生成。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******'], ], [ 'name' => 'RoleArn', 'in' => 'query', 'schema' => ['description' => '角色的全局资源描述符，用来指定具体角色。详情请参见RAM角色概览。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'acs:ram::1406926****:role/aliyunrdsinstanceencryptiondefaultrole'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], 'Data' => [ 'description' => '返回信息。', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => '后端任务ID。', 'type' => 'string', 'example' => '42292****'], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'The current engine version does not support the operation.', 'description' => '当前引擎版本不支持操作。'], ], ], 'title' => '开启实例TDE', 'summary' => '调用UpdateDBInstanceTDE接口开启实例TDE。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDBInstanceTDE'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"42292****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n \\n 42292****\\n \\n","errorExample":""}]', ], 'UpdatePolarDBXInstanceNode' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREdrdsDBGOD6', 'FEATUREdrds0SX279'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasdyuoo'], ], [ 'name' => 'DbInstanceNodeCount', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '实例目标节点数，取值范围：0-99。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '99', 'minimum' => '0', 'example' => '3'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => '客户端token，任意随机字符串。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], ], [ 'name' => 'CNNodeCount', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '计算节点个数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '99', 'minimum' => '0', 'example' => '2'], ], [ 'name' => 'DNNodeCount', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '存储节点个数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '99', 'minimum' => '0', 'example' => '2'], ], [ 'name' => 'StoragePoolName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], [ 'name' => 'DeleteDNIds', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], [ 'name' => 'AddDNSpec', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'OrderId' => ['description' => '变更实例节点数时产生的订单ID。', 'type' => 'string', 'example' => '20211103105558'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], ], 'description' => '', ], ], ], 'title' => '更新节点', 'summary' => '调用UpdatePolarDBXInstanceNode接口变更实例节点数，包括扩容和缩容。该请求会产生交易订单。', 'changeSet' => [ ['createdAt' => '2025-03-17T11:34:33.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2025-03-17T11:34:33.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2025-03-12T14:38:16.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2022-05-30T11:01:37.000Z', 'description' => '请求参数发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePolarDBXInstanceNode'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"20211103105558\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 20211103105558\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]', ], 'UpgradeCDCVersion' => [ 'summary' => '升级PolarDB-X CDC 节点版本', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '134914', 'abilityTreeNodes' => ['FEATUREdrdsV6IT1E'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => '实例id。>您可以调用[describedbinstances](~~196830~~)接口查看目标地域下所有实例的详情，包括实例id。', 'type' => 'string', 'required' => false, 'example' => 'pxc-hzrp****3p72fi'], ], [ 'name' => 'CdcMinorVersion', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '需要升级的目标版本号', 'type' => 'string', 'required' => false, 'example' => 'polarx-cdc-kernel-5.4.19-20240928_17274884'], ], [ 'name' => 'CdcDbVersion', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '需要升级的目标数据库版本。>您可以调用[describedbclusterversion](~~196830~~)接口查看目标地域下所有数据库版本的升级说明。', 'type' => 'string', 'required' => false, 'example' => '2.343', 'default' => '2.343'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。>您可以调用[describeregions](~~196841~~)接口查看polardb-x支持的地域详情，包括地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => '实例名', 'type' => 'string', 'required' => false, 'example' => 'pxc-shrvdc****wtf5uk-cdc'], ], [ 'name' => 'SwitchMode', 'in' => 'query', 'schema' => ['description' => '切换模式。取值：'."\n" ."\n" .'- 0：立即切换。'."\n" .'- 1：在可运维时间段内切换。', 'type' => 'string', 'required' => false, 'example' => '0'], ], ], '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' => 'CB4307F5-3D04-51E8-ABAD-49E0B3F962FC'], 'Message' => ['description' => '请求返回消息', 'type' => 'string', 'example' => 'success'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'MinorVersion' => ['description' => '目标版本号。', 'type' => 'string', 'example' => 'polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213'], 'TaskList' => [ 'description' => '升级任务列表。', 'type' => 'array', 'items' => [ 'description' => '升级任务列表。', 'type' => 'object', 'properties' => [ 'DbInstanceName' => ['description' => '实例id。', 'type' => 'string', 'example' => 'rm-uf68f345****88zf8'], 'TaskId' => ['description' => '目标任务id。', 'type' => 'integer', 'format' => 'int32', 'example' => '1861190497624654848'], ], ], ], ], ], ], ], ], ], 'title' => '升级 CDC 版本', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeCDCVersion'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB4307F5-3D04-51E8-ABAD-49E0B3F962FC\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MinorVersion\\": \\"polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213\\",\\n \\"TaskList\\": [\\n {\\n \\"DbInstanceName\\": \\"rm-uf68f345****88zf8\\",\\n \\"TaskId\\": 1861190497624654800\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'UpgradeColumnarVersion' => [ 'summary' => '更新列存版本', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '198143', 'abilityTreeNodes' => ['FEATUREdrdsV6IT1E'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => '实例名。', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxx'], ], [ 'name' => 'ColumnarVersion', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => '列存版本', 'type' => 'string', 'required' => false, 'example' => 'polarx-col-kernel-5.4.20-20250819_17555906'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '实例所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => '实例名', 'type' => 'string', 'required' => false, 'example' => 'pxc-hzrh51fze****pon-cdc'], ], [ 'name' => 'SwitchMode', 'in' => 'query', 'schema' => ['description' => '切换模式', 'type' => 'string', 'required' => false, 'example' => '0'], ], ], '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' => 'AE4F6C34-****-45AA-B5DC-4B8D816F6305'], 'Message' => ['description' => '请求返回消息', 'type' => 'string', 'example' => 'success'], 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'MinorVersion' => ['description' => '目标版本号。', 'type' => 'string', 'example' => 'polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213'], 'TaskList' => [ 'description' => '升级任务列表。', 'type' => 'array', 'items' => [ 'description' => '升级任务列表。', 'type' => 'object', 'properties' => [ 'DbInstanceName' => ['description' => '实例id。', 'type' => 'string', 'example' => 'rm-uf68f345****88zf8'], 'TaskId' => ['description' => '目标任务id。', 'type' => 'integer', 'format' => 'int32', 'example' => '1861190497624654848'], ], ], ], ], ], ], ], ], ], 'title' => '更新列存版本', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeColumnarVersion'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AE4F6C34-****-45AA-B5DC-4B8D816F6305\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MinorVersion\\": \\"polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213\\",\\n \\"TaskList\\": [\\n {\\n \\"DbInstanceName\\": \\"rm-uf68f345****88zf8\\",\\n \\"TaskId\\": 1861190497624654800\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'UpgradeDBInstanceKernelVersion' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => ['description' => '实例名称ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****'], ], [ 'name' => 'SwitchMode', 'in' => 'query', 'schema' => ['title' => '切换模式： 0:立刻执行，1：运维时间执行', 'description' => '切换模式。取值：'."\n" ."\n" .'- 0：立即切换。'."\n" .'- 1：在可运维时间段内切换。', 'type' => 'string', 'required' => false, 'example' => '0'], ], [ 'name' => 'MinorVersion', 'in' => 'query', 'schema' => ['description' => '内核版本。', 'type' => 'string', 'required' => false, 'example' => 'polarx-kernel_5.4.12-16349923_xcluster-20210926'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBInstanceName' => ['description' => '实例名称ID。', 'type' => 'string', 'example' => 'pxc-hzjasd****'], 'TargetMinorVersion' => ['description' => '目标版本号。', 'type' => 'string', 'example' => 'polarx-kernel_5.4.7-16001481_xcluster-20200910'], 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], 'TaskId' => ['description' => '后端任务ID。', 'type' => 'string', 'example' => '422922413'], ], 'description' => '', ], ], ], 'title' => '升级数据库实例内核版本', 'summary' => '调用UpgradeDBInstanceKernelVersion接口更新实例内核版本。', 'changeSet' => [ ['createdAt' => '2022-12-19T11:36:37.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2022-03-01T02:04:06.000Z', 'description' => '请求参数发生变更'], ['createdAt' => '2021-10-18T08:29:23.000Z', 'description' => '请求参数发生变更、错误码发生变更'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBInstanceKernelVersion'], ], ], 'ramActions' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceName\\": \\"pxc-hzjasd****\\",\\n \\"TargetMinorVersion\\": \\"polarx-kernel_5.4.7-16001481_xcluster-20200910\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"TaskId\\": \\"422922413\\"\\n}","errorExample":""},{"type":"xml","example":"\\n pxc-hzjasd****\\n polarx-kernel_5.4.7-16001481_xcluster-20200910\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n 422922413\\n","errorExample":""}]', ], ], 'endpoints' => [ ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-wulanchabu.aliyuncs.com'], ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardbx.cn-beijing.aliyuncs.com', 'endpoint' => 'polardbx.cn-beijing.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-beijing.aliyuncs.com'], ['regionId' => 'cn-qingdao', 'regionName' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardbx.cn-qingdao.aliyuncs.com', 'endpoint' => 'polardbx.cn-qingdao.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-qingdao.aliyuncs.com'], ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardbx.cn-shanghai.aliyuncs.com', 'endpoint' => 'polardbx.cn-shanghai.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-shanghai.aliyuncs.com'], ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardbx.cn-hongkong.aliyuncs.com', 'endpoint' => 'polardbx.cn-hongkong.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-hongkong.aliyuncs.com'], ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardbx.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'polardbx.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-zhangjiakou.aliyuncs.com'], ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardbx.cn-shenzhen.aliyuncs.com', 'endpoint' => 'polardbx.cn-shenzhen.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-shenzhen.aliyuncs.com'], ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.ap-northeast-1.aliyuncs.com'], ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardbx.cn-chengdu.aliyuncs.com', 'endpoint' => 'polardbx.cn-chengdu.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-chengdu.aliyuncs.com'], ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardbx.ap-southeast-1.aliyuncs.com', 'endpoint' => 'polardbx.ap-southeast-1.aliyuncs.com', 'vpc' => 'polardbx-vpc.ap-southeast-1.aliyuncs.com'], ['regionId' => 'ap-southeast-2', 'regionName' => '澳大利亚（悉尼）已关停', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.ap-southeast-2.aliyuncs.com'], ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.ap-southeast-3.aliyuncs.com'], ['regionId' => 'cn-huhehaote', 'regionName' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardbx.cn-huhehaote.aliyuncs.com', 'endpoint' => 'polardbx.cn-huhehaote.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-huhehaote.aliyuncs.com'], ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.ap-southeast-5.aliyuncs.com'], ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardbx.cn-hangzhou.aliyuncs.com', 'endpoint' => 'polardbx.cn-hangzhou.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-hangzhou.aliyuncs.com'], ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'polardbx.us-east-1.aliyuncs.com', 'endpoint' => 'polardbx.us-east-1.aliyuncs.com', 'vpc' => 'polardbx-vpc.us-east-1.aliyuncs.com'], ['regionId' => 'eu-west-1', 'regionName' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.eu-west-1.aliyuncs.com'], ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'polardbx.us-west-1.aliyuncs.com', 'endpoint' => 'polardbx.us-west-1.aliyuncs.com', 'vpc' => 'polardbx-vpc.us-west-1.aliyuncs.com'], ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.eu-central-1.aliyuncs.com'], ['regionId' => 'me-east-1', 'regionName' => '阿联酋（迪拜）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.me-east-1.aliyuncs.com'], ['regionId' => 'ap-south-1', 'regionName' => '印度（孟买）已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.ap-south-1.aliyuncs.com'], ['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'polardbx.cn-hangzhou.aliyuncs.com', 'endpoint' => 'polardbx.cn-hangzhou.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-hangzhou-finance.aliyuncs.com'], ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-shenzhen-finance-1.aliyuncs.com'], ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-shanghai-finance-1.aliyuncs.com'], ['regionId' => 'cn-north-2-gov-1', 'regionName' => '北京政务云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-north-2-gov-1.aliyuncs.com'], ['regionId' => 'cn-beijing-finance-1', 'regionName' => '华北2 金融云（邀测）', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => ''], ], 'errorCodes' => [ ['code' => 'CustomEndpoint.ExceedLimit', 'message' => 'the count of custom endpoints can not exceed limiting value.', 'http_code' => 400, 'description' => '自定义连接的数量超过限制'], ['code' => 'IdempotentParameterMismatch', 'message' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'http_code' => 400, 'description' => '该请求使用与先前相同但不相同的请求相同的客户端令牌。 除非请求相同，否则请勿将客户端令牌与其他请求重用。'], ['code' => 'IncorrectDBInstance', 'message' => 'Current DB instance does not support this operation.', 'http_code' => 400, 'description' => '当前实例不支持这个操作'], ['code' => 'IncorrectDBInstanceState', 'message' => 'Current DB instance state does not support this operation.', 'http_code' => 400, 'description' => '当前的实例状态不支持此操作'], ['code' => 'IncorrectEngineVersion', 'message' => 'The current engine version does not support the operation.', 'http_code' => 403, 'description' => '当前引擎版本不支持操作。'], ['code' => 'InspectJob.NotFound', 'message' => 'The inspection job is not found.', 'http_code' => 404, 'description' => '巡检任务不存在'], ['code' => 'InternalError', 'message' => 'An error occurred while processing your request.', 'http_code' => 500, 'description' => '接口暂时不可用'], ['code' => 'InvalidAccessKeyId.NotFound', 'message' => 'The specified Access Key ID does not exist.', 'http_code' => 400, 'description' => '提供的访问密钥ID记录中不存在。'], ['code' => 'InvalidAction', 'message' => 'The specified Action is invalid.', 'http_code' => 400, 'description' => '指定的Action无效。'], ['code' => 'InvalidDBInstance.NotFound', 'message' => 'The specified DB instance does not exist.', 'http_code' => 404, 'description' => '数据库实例不存在'], ['code' => 'InvalidDBInstance.NotFound', 'message' => 'The specified DB instance does not exist or is not supported.', 'http_code' => 400, 'description' => '指定实例不存在'], ['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'The specified DBInstanceId does not exist.', 'http_code' => 404, 'description' => '实例ID不存在'], ['code' => 'InvalidEndTime.Malformed', 'message' => 'The specified parameter EndTime is invalid.', 'http_code' => 400, 'description' => '结束时间格式非法'], ['code' => 'InvalidPageSize.Malformed', 'message' => 'The specified parameter PageSize is not valid.', 'http_code' => 400, 'description' => '分页格式非法'], ['code' => 'InvalidParam', 'message' => 'Invalid Parameter.', 'http_code' => 400, 'description' => '参数有误'], ['code' => 'InvalidParameter.DbInstanceIds', 'message' => 'The parameter DbInstanceIds is invalid or empty.', 'http_code' => 400, 'description' => '参数 DbInstanceIds 非法或为空'], ['code' => 'InvalidParameter.Frequency', 'message' => 'The parameter Frequency is invalid or missing.', 'http_code' => 400, 'description' => '参数 Frequency 非法或缺失'], ['code' => 'InvalidParameter.JobId', 'message' => 'The parameter JobId is invalid.', 'http_code' => 400, 'description' => '参数 JobId 非法'], ['code' => 'InvalidParameter.JobName', 'message' => 'The parameter JobName exceeds the maximum length of 64 characters.', 'http_code' => 400, 'description' => '参数 JobName 长度超过 64 字符限制'], ['code' => 'InvalidParameter.Operation', 'message' => 'Operation is illegal.', 'http_code' => 400, 'description' => '不允许该操作'], ['code' => 'InvalidParameter.RegionId', 'message' => 'The parameter RegionId is invalid.', 'http_code' => 400, 'description' => '参数 RegionId 非法'], ['code' => 'InvalidParameter.StartTime', 'message' => 'The parameter StartTime is invalid or missing.', 'http_code' => 400, 'description' => '参数 StartTime 非法或缺失'], ['code' => 'InvalidParameter.TimeRange', 'message' => 'The parameter TimeRange is invalid.', 'http_code' => 400, 'description' => '参数 TimeRange 非法'], ['code' => 'InvalidStartTime.Malformed', 'message' => 'The specified parameter StartTime is not valid.', 'http_code' => 400, 'description' => '开始时间格式非法'], ['code' => 'InvalidStartTimeAndEndTime.Malformed', 'message' => 'The end time must be later than the start time.', 'http_code' => 400, 'description' => '结束时间必须大于开始时间'], ['code' => 'NoPermission', 'message' => 'You are not authorized to do this Action.', 'http_code' => 403, 'description' => '您无权操作此接口'], ['code' => 'NoPermission', 'message' => 'no permission.', 'http_code' => 403, 'description' => '无权限'], ['code' => 'OperationDenied.DBInstanceEngine', 'message' => 'You cannot operate the DB instance engine.', 'http_code' => 403, 'description' => '拒绝操作该db存储引擎'], ['code' => 'OperationDenied.DBInstanceType', 'message' => 'The Child instance does not support this operation.', 'http_code' => 400, 'description' => '子实例不支持该操作'], ['code' => 'RAM.Permission.Denied', 'message' => 'RAM authentication failed.', 'http_code' => 403, 'description' => 'RAM鉴权失败'], ['code' => 'Runtime.NotResponse', 'message' => 'The server failed to respond.', 'http_code' => 400, 'description' => '服务返回错误'], ['code' => 'Transform.IncorrectEngineVersion', 'message' => 'The current engine version is not the latest. Please upgrade to the latest version.', 'http_code' => 403, 'description' => '当前实例版本不是最新版本，请升级到最新版本。'], ['code' => 'Transform.UnSupportedDbVersion', 'message' => 'Only database engine version 5.7 is supported.', 'http_code' => 400, 'description' => '只有数据库引擎版本为5.7的是支持的。'], ], 'changeSet' => [ [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstances'], ], 'createdAt' => '2025-12-18T16:07:30.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstances'], ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstances'], ], 'createdAt' => '2025-12-18T14:58:51.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '错误码发生变更', 'api' => 'AllocateInstancePublicConnection'], ], 'createdAt' => '2025-12-17T04:01:29.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'DescribeComponentPropeties'], ], 'createdAt' => '2025-11-25T08:39:08.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstances'], ['description' => '请求参数发生变更', 'api' => 'DescribeDBInstances'], ], 'createdAt' => '2025-11-24T06:09:31.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeGdnInstances'], ['description' => '请求参数发生变更', 'api' => 'SwitchGdnMemberRole'], ], 'createdAt' => '2025-02-18T11:58:54.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], ], 'createdAt' => '2024-12-13T12:19:07.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstances'], ], 'createdAt' => '2024-12-13T12:13:22.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'ModifyDBInstanceClass'], ], 'createdAt' => '2024-12-11T17:48:04.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], ], 'createdAt' => '2024-12-03T15:33:42.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'DescribeDBInstanceTopology'], ], 'createdAt' => '2024-10-17T06:55:04.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'ModifyParameter'], ], 'createdAt' => '2024-09-29T02:19:13.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeParameters'], ], 'createdAt' => '2024-09-26T14:21:28.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'DescribeParameterTemplates'], ], 'createdAt' => '2024-09-26T14:17:19.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'DescribeDBInstances'], ], 'createdAt' => '2024-09-26T11:06:47.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], ], 'createdAt' => '2024-06-27T07:25:27.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'CreateBackup'], ['description' => '响应参数发生变更', 'api' => 'DescribeBackupPolicy'], ['description' => '响应参数发生变更', 'api' => 'DescribeBackupSetList'], ['description' => '响应参数发生变更', 'api' => 'UpdateBackupPolicy'], ], 'createdAt' => '2024-06-19T01:48:33.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], ], 'createdAt' => '2024-06-13T13:55:25.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], ], 'createdAt' => '2024-05-23T13:51:29.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'DescribeScaleOutMigrateTaskList'], ], 'createdAt' => '2024-05-23T01:31:09.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstances'], ], 'createdAt' => '2024-05-22T03:24:02.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceTopology'], ], 'createdAt' => '2024-04-28T09:08:11.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], ], 'createdAt' => '2024-04-24T07:43:29.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'DescribeDBInstances'], ], 'createdAt' => '2024-03-21T02:48:16.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '错误码发生变更', 'api' => 'AllocateInstancePublicConnection'], ], 'createdAt' => '2024-01-04T11:30:00.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], ], 'createdAt' => '2023-12-14T09:10:04.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], ], 'createdAt' => '2023-11-14T01:41:12.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstances'], ], 'createdAt' => '2023-11-03T07:24:20.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstances'], ], 'createdAt' => '2023-09-14T06:50:55.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], ], 'createdAt' => '2023-09-08T09:40:22.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], ], 'createdAt' => '2023-09-01T08:57:36.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeBackupPolicy'], ['description' => '请求参数发生变更', 'api' => 'DescribeBackupSet'], ['description' => '请求参数发生变更', 'api' => 'DescribeBackupSetList'], ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'UpdateBackupPolicy'], ], 'createdAt' => '2023-09-01T08:18:01.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'DescribeDBInstanceViaEndpoint'], ], 'createdAt' => '2023-08-14T06:52:17.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceTopology'], ], 'createdAt' => '2023-08-02T02:58:21.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceTopology'], ], 'createdAt' => '2023-07-26T06:31:15.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更', 'api' => 'DescribeDBInstanceTopology'], ], 'createdAt' => '2023-07-19T05:56:49.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'UpdateBackupPolicy'], ], 'createdAt' => '2023-07-05T08:44:22.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'DescribeDBInstances'], ], 'createdAt' => '2023-06-20T07:57:37.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeBackupPolicy'], ], 'createdAt' => '2023-06-14T05:41:58.000Z', 'description' => '', ], [ 'apis' => [ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDBInstances'], ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDBInstances'], ], 'createdAt' => '2023-02-23T09:13:21.000Z', 'description' => 'polarx 新功能api发布', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'UpgradeDBInstanceKernelVersion'], ], 'createdAt' => '2022-12-19T11:37:31.000Z', 'description' => '升级内核版本接口增加可选入参 MinorVersion，用于指定内核版本升级', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], ], 'createdAt' => '2022-12-15T06:21:09.000Z', 'description' => 'DescribeDBInstanceAttribute 新增字段LTSVersions', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], ['description' => '请求参数发生变更', 'api' => 'DescribeBackupSet'], ['description' => '请求参数发生变更', 'api' => 'DescribeTasks'], ['description' => '请求参数发生变更', 'api' => 'ModifyActiveOperationMaintainConf'], ['description' => '请求参数发生变更', 'api' => 'ModifyActiveOperationTasks'], ['description' => '请求参数发生变更', 'api' => 'ModifyDatabaseDescription'], ], 'createdAt' => '2022-12-07T03:45:09.000Z', 'description' => '修改一批参数为必填', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], ], 'createdAt' => '2022-09-28T08:48:38.000Z', 'description' => '增加vpcInstanceId字段', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstances'], ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstances'], ], 'createdAt' => '2022-09-13T11:19:03.000Z', 'description' => '新增标准版返回字段', ], [ 'apis' => [ ['description' => 'OpenAPI 下线', 'api' => 'AllocateColdDataVolume'], ['description' => 'OpenAPI 下线', 'api' => 'DescribeArchiveTableList'], ['description' => '响应参数发生变更', 'api' => 'DescribeBackupPolicy'], ['description' => 'OpenAPI 下线', 'api' => 'DescribeColdDataBasicInfo'], ['description' => 'OpenAPI 下线', 'api' => 'ReleaseColdDataVolume'], ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'UpdateBackupPolicy'], ], 'createdAt' => '2022-07-28T08:29:06.000Z', 'description' => '支持冷数据OSS存储', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceTopology'], ], 'createdAt' => '2022-05-31T05:38:43.000Z', 'description' => 'DescribeDBInstanceTopology will return rds class code now', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstances'], ['description' => '请求参数发生变更', 'api' => 'ModifyDBInstanceClass'], ['description' => '请求参数发生变更', 'api' => 'UpdatePolarDBXInstanceNode'], ], 'createdAt' => '2022-05-30T11:06:13.000Z', 'description' => 'OpenApi支持弹性实例（计算层和存储层比例弹性，各自管理规格和节点数）', ], [ 'apis' => [ ['description' => 'OpenAPI 下线', 'api' => 'AlignStoragePrimaryAzone'], ['description' => 'OpenAPI 下线', 'api' => 'DescribeDBInstanceHA'], ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceTopology'], ['description' => 'OpenAPI 下线', 'api' => 'SwitchDBInstanceHA'], ], 'createdAt' => '2022-05-13T03:11:12.000Z', 'description' => '新增：DescribeDBInstanceHA 获取实例HA状态（部署拓扑与主可用区信息）SwitchDBInstanceHA 切换实例主可用区AlignStoragePrimaryAzone 对齐存储实例主可用区修改：DescribeDBInstanceTopology 新增展示存储实例状态', ], [ 'apis' => [ ['description' => '错误码发生变更', 'api' => 'DescribeBinaryLogList'], ], 'createdAt' => '2022-04-22T02:44:51.000Z', 'description' => '修改查看Binlog列表接口错误提示信息', ], [ 'apis' => [ ['description' => 'OpenAPI 下线', 'api' => 'DescribeBackupSet'], ], 'createdAt' => '2022-04-19T03:33:18.000Z', 'description' => '新增备份集详情接口', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'CreateDB'], ], 'createdAt' => '2022-03-24T11:18:52.000Z', 'description' => '新增建库模式选择', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'UpgradeDBInstanceKernelVersion'], ], 'createdAt' => '2022-03-01T16:03:00.000Z', 'description' => '升级内核版本增加切换模式选择', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'ModifyDBInstanceConfig'], ], 'createdAt' => '2022-01-20T05:16:07.000Z', 'description' => '增加resoureceGroupId', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'CreateDBInstance'], ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceTopology'], ], 'createdAt' => '2022-01-12T13:03:25.000Z', 'description' => 'CreateInstance支持三可用区实例创建；DescribeLogicDBInstanceTopology更新返回示例拓扑详情，支持三可用区拓扑展示', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'ListTagResources'], ['description' => '请求参数发生变更', 'api' => 'TagResources'], ['description' => '请求参数发生变更', 'api' => 'UntagResources'], ], 'createdAt' => '2022-01-12T03:14:12.000Z', 'description' => 'bugfix', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'ListTagResources'], ['description' => '请求参数发生变更', 'api' => 'TagResources'], ['description' => '请求参数发生变更', 'api' => 'UntagResources'], ], 'createdAt' => '2022-01-12T02:50:24.000Z', 'description' => 'fix：param mapping error', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'ListTagResources'], ['description' => '请求参数发生变更', 'api' => 'TagResources'], ['description' => '请求参数发生变更', 'api' => 'UntagResources'], ], 'createdAt' => '2022-01-12T02:39:39.000Z', 'description' => '修复参数映射问题', ], [ 'apis' => [ ['description' => 'OpenAPI 下线', 'api' => 'ChangeResourceGroup'], ['description' => 'OpenAPI 下线', 'api' => 'DescribeTags'], ['description' => 'OpenAPI 下线', 'api' => 'ListTagResources'], ['description' => 'OpenAPI 下线', 'api' => 'TagResources'], ['description' => 'OpenAPI 下线', 'api' => 'UntagResources'], ], 'createdAt' => '2021-12-29T07:28:32.000Z', 'description' => '标签和资源组', ], [ 'apis' => [ ['description' => 'OpenAPI 下线', 'api' => 'ModifyDBInstanceConnectionString'], ], 'createdAt' => '2021-12-21T13:27:31.000Z', 'description' => '新增接口：ModifyDBInstanceConnectionString 修改实例链接串', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstances'], ], 'createdAt' => '2021-12-09T02:05:46.000Z', 'description' => '列表增加数据库名称', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'DescribeDBInstances'], ], 'createdAt' => '2021-12-09T01:59:33.000Z', 'description' => '开放资源组', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDBInstances'], ], 'createdAt' => '2021-12-08T09:23:25.000Z', 'description' => '增加资源组标签', ], [ 'apis' => [ ['description' => 'OpenAPI 下线', 'api' => 'DescribeActiveOperationTasks'], ], 'createdAt' => '2021-11-24T08:08:46.000Z', 'description' => 'aop 服务发布', ], [ 'apis' => [ ['description' => 'OpenAPI 下线', 'api' => 'CancelActiveOperationTasks'], ['description' => 'OpenAPI 下线', 'api' => 'DescribeActiveOperationMaintainConf'], ['description' => 'OpenAPI 下线', 'api' => 'DescribeActiveOperationTaskCount'], ['description' => 'OpenAPI 下线', 'api' => 'DescribeEvents'], ['description' => 'OpenAPI 下线', 'api' => 'ModifyActiveOperationMaintainConf'], ['description' => 'OpenAPI 下线', 'api' => 'ModifyActiveOperationTasks'], ], 'createdAt' => '2021-11-18T05:40:04.000Z', 'description' => '主动运维相关文档发布', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'DescribeTasks'], ], 'createdAt' => '2021-11-04T06:09:10.000Z', 'description' => 'DescribeTasks Api需要去除俩个不需要的入参', ], [ 'apis' => [ ['description' => '请求参数发生变更、错误码发生变更', 'api' => 'UpgradeDBInstanceKernelVersion'], ], 'createdAt' => '2021-11-04T06:02:44.000Z', 'description' => '删除UpgradeDBInstanceKernelVersion不支持入参', ], [ 'apis' => [ ['description' => '请求参数发生变更', 'api' => 'DescribeDBNodePerformance'], ], 'createdAt' => '2021-11-04T05:19:58.000Z', 'description' => 'DescribeDBNodePerformance接口开放DBNodeRole参数', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], ], 'createdAt' => '2021-11-04T02:51:44.000Z', 'description' => '1. 隐藏功能重复的接口CreatePolarxInstance（与CreateDBInstance重复）2. 隐藏无用字段：DescribeDBInstance.ConnAddrs.VPCInstance', ], [ 'apis' => [ ['description' => '响应参数发生变更', 'api' => 'DescribeDBInstanceAttribute'], ], 'createdAt' => '2021-10-29T09:28:15.000Z', 'description' => '订正返回值中 Port 字段类型为 整数型', ], [ 'apis' => [ ['description' => 'OpenAPI 下线', 'api' => 'DescribeDBNodePerformance'], ], 'createdAt' => '2021-10-26T07:03:44.000Z', 'description' => '新增DescribeDBNodePerformance接口', ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBNodePerformance'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckCloudResourceAuthorized'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBinaryLogList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountDescription'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConfig'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePolarxDataNodes'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyParameter'], ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeColdDataBasicInfo'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeShowStorageInfo'], ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeArchiveTableList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConnectionString'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartDBInstance'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTags'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupSetList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveOperationTaskCount'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccount'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSuperAccount'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PreCheckSqlFlashbackTask'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeColumnarVersionList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyColumnarClass'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDistributeTableList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePolarDBXInstanceNode'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCdcVersionList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameters'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDBInstanceSSL'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDbList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableSqlAudit'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachColumnarInstance'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDB'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAccountPasswordRestrict'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeColumnarInfo'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceViaEndpoint'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRplInspectionTask'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceTopology'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTasks'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AllocateInstancePublicConnection'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SkipCurrentStep'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceAttribute'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountPrivilege'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDataImportTaskInfo'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterGroups'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataImportTask'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveOperationMaintainConf'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCdcInfo'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsVpcs'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceConfig'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBInstance'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConfirmNoConnection'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDataImportTask'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceHA'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupSet'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshImportMeta'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyEngineMigration'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySecurityIps'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStructureImportTaskInfo'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEvaluateAndImportTask'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCdcClass'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'], ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeCDCVersion'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOpenBackupSet'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEvaluateAndImportTasks'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDatabaseDescription'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsVswitches'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTransformStatus'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableRightsSeparation'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstances'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEvaluateAndImportTask'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGdnInstances'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseColdDataVolume'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartDataImportTask'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterTemplates'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStructureImportTask'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRplInspectionTask'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateDBInstance'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBInstance'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceTDE'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnabledCrossRegions'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentPropeties'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSecurityIps'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AlignStoragePrimaryAzone'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCustomEndpoint'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyActiveOperationTasks'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomEndpoint'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartSwitchDatabase'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCdcClassList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableRightsSeparation'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseInstancePublicConnection'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlFlashbackTaskList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGdnInstance'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveOperationTasks'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomEndpoint'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceClass'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBackup'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDB'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceDescription'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceMaintainTime'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCharacterSet'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomEndpointList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGdnInstance'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableCrossRegions'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSqlFlashbackTask'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckSqlAuditSlsStatus'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTransformOperation'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSQLEvaluateTask'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDBInstanceTDE'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableSqlAudit'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBInstanceKernelVersion'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccount'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelActiveOperationTasks'], ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUserEncryptionKeyList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AllocateColdDataVolume'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAccountPassword'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateBackupPolicy'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyActiveOperationMaintainConf'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeColumnarVersion'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeColumnarClassList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCustomEndpointNet'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchGdnMemberRole'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlAuditInfo'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStoragePoolInfo'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceSSL'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloseEngineMigration'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEvents'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStoragePool'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccountList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupPolicy'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceVip'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeScaleOutMigrateTaskList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchDBInstanceHA'], ], ], 'ram' => [ 'productCode' => 'DRDS', 'productName' => '云原生分布式数据库 PolarDB-X', 'ramCodes' => ['drds', 'polardbx'], 'ramLevel' => '资源级', 'ramConditions' => [], 'ramActions' => [ [ 'apiName' => 'DeleteCustomEndpoint', 'description' => '删除用户端域名', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardbx:DeleteCustomEndpoint', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], ], ], ], [ 'apiName' => 'DescribeParameters', 'description' => '获取参数列表', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeParameters', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyCdcClass', 'description' => '修改CDC配置', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:ModifyCdcClass', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDBInstanceSSL', 'description' => '查看SSL信息', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeDBInstanceSSL', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ResetMem0AccountPassword', 'description' => '重置记忆引擎 API KEY', 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardbx:ResetMem0AccountPassword', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'SwitchGdnMemberRole', 'description' => 'GDN主从切换', 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardbx:SwitchGdnMemberRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeGdnInstances', 'description' => '获取GDN实例列表信息', 'operationType' => 'list', 'ramAction' => [ 'action' => 'polardbx:DescribeGdnInstances', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyDBInstanceConfig', 'description' => '修改实例配置项', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:ModifyDBInstanceConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'AllocateInstancePublicConnection', 'description' => '申请外网连接地址', 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardbx:AllocateInstancePublicConnection', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDataImportTaskInfo', 'description' => '获取数据导入任务信息', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeDataImportTaskInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListTagResources', 'description' => '标签列表获取', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:ListTagResources', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyColumnarClass', 'description' => '修改列存规格', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:ModifyColumnarClass', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyAccountDescription', 'description' => '修改实例的账号描述信息', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:ModifyAccountDescription', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'StopDataImportTask', 'description' => '停止数据导入任务', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:StopDataImportTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeOpenBackupSet', 'description' => '获取用于线下恢复的备份集信息', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeOpenBackupSet', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], ], ], ], [ 'apiName' => 'CreateStructureImportTask', 'description' => '创建数据结构导入任务', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:CreateStructureImportTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'CheckSqlAuditSlsStatus', 'description' => '校验审计状态', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:CheckSqlAuditSlsStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeParameterTemplates', 'description' => '查看参数模版详情', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeParameterTemplates', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeEnabledCrossRegions', 'description' => '查询已启用的跨可用区', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeEnabledCrossRegions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeTags', 'description' => '获取标签信息', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeTags', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyCustomEndpointNet', 'description' => '修改自定义网络端点', 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardbx:ModifyCustomEndpointNet', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], ], ], ], [ 'apiName' => 'ModifyDBInstanceMaintainTime', 'description' => '修改实例可维护时间', 'operationType' => '', 'ramAction' => [ 'action' => 'polardbx:ModifyDBInstanceMaintainTime', 'authLevel' => '', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeEvents', 'description' => '获取历史事件', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeEvents', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeSqlAuditInfo', 'description' => '查看SQL审计信息', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeSqlAuditInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'MigrateDBInstance', 'description' => '实例可用区迁移', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:MigrateDBInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeCdcVersionList', 'description' => 'CDC版本获取', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeCdcVersionList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'RestartDataImportTask', 'description' => '重启数据导入任务', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:RestartDataImportTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyDBInstanceClass', 'description' => ' ModifyDBInstanceClass', 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardbx:ModifyDBInstanceClass', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'CancelActiveOperationTasks', 'description' => '取消运维事件任务', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:CancelActiveOperationTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeSupabaseInstanceAttribute', 'description' => '查询 Supabase 实例详情', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeSupabaseInstanceAttribute', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyParameter', 'description' => '修改实例参数', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:ModifyParameter', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'TagResources', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:TagResources', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeColumnarVersionList', 'description' => '查询列存版本信息', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeColumnarVersionList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteGdnInstance', 'description' => '删除GDN实例', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardbx:DeleteGdnInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateBackupPolicy', 'description' => 'UpdateBackupPolicy', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:UpdateBackupPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeParameterGroups', 'description' => '查询参数组信息', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeParameterGroups', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeAvailableCrossRegions', 'description' => '查询夸可用区', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeAvailableCrossRegions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDBInstances', 'description' => '查询数据库实例列表', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeDBInstances', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeSqlFlashbackTaskList', 'description' => '查看SQL闪回任务的列表', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeSqlFlashbackTaskList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeCdcClassList', 'description' => '规格列表', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeCdcClassList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribePolarxDataNodes', 'description' => '查看数据节点信息', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribePolarxDataNodes', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteSupabaseNetType', 'description' => '关闭 Supabase 公网', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardbx:DeleteSupabaseNetType', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyAccountPrivilege', 'description' => 'ModifyAccountPrivilege', 'operationType' => '', 'ramAction' => [ 'action' => 'polardbx:ModifyAccountPrivilege', 'authLevel' => '', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeBackupPolicy', 'description' => 'DescribeBackupPolicy', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeBackupPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeActiveOperationTasks', 'description' => '获取运维事件', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeActiveOperationTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'AlignStoragePrimaryAzone', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:AlignStoragePrimaryAzone', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeMem0Info', 'description' => '查看记忆引擎信息', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeMem0Info', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateDBInstance', 'description' => '创建实例', 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardbx:CreateDBInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeColumnarInfo', 'description' => '查询列存信息', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeColumnarInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDistributeTableList', 'description' => '获取数据库表列表', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeDistributeTableList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DisableSqlAudit', 'description' => '关闭SQL审计', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DisableSqlAudit', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteAccount', 'description' => '删除实例账号', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DeleteAccount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateRplInspectionTask', 'description' => '复制链路健康检查', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:CreateRplInspectionTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'AttachColumnarInstance', 'description' => '挂载列存', 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardbx:AttachColumnarInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpgradeColumnarVersion', 'description' => '更新列存版本', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:UpgradeColumnarVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpgradeCDCVersion', 'description' => '升级 CDC 版本', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:UpgradeCDCVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeActiveOperationTaskCount', 'description' => '获取运维事件总数', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeActiveOperationTaskCount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeUserEncryptionKeyList', 'description' => '获取用户TDE秘钥列表', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeUserEncryptionKeyList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeComponentPropeties', 'description' => '查询组件属性', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeComponentPropeties', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeBackupSet', 'description' => 'DescribeBackupSet', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeBackupSet', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeCdcInfo', 'description' => '查询CDC实例信息', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeCdcInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeRplInspectionTask', 'description' => '获取实例巡检任务', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeRplInspectionTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDBInstanceTDE', 'description' => '获取实例TDE的详细信息', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeDBInstanceTDE', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDBInstanceTopology', 'description' => 'DescribeDBInstanceTopology', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeDBInstanceTopology', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeSlowLogRecords', 'description' => 'DescribeSlowLogRecords', 'operationType' => 'list', 'ramAction' => [ 'action' => 'polardbx:DescribeSlowLogRecords', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteDBInstance', 'description' => '删除实例', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardbx:DeleteDBInstance', 'authLevel' => '', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'EnableSqlAudit', 'description' => '开启SQL审计', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:EnableSqlAudit', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeCustomEndpointList', 'description' => '查询自用户定义域名列表', 'operationType' => 'list', 'ramAction' => [ 'action' => 'polardbx:DescribeCustomEndpointList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], ], ], ], [ 'apiName' => 'DescribeShowStorageInfo', 'description' => '查询存储空间信息', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeShowStorageInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeEvaluateAndImportTasks', 'description' => '查询评估导入任务列表', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeEvaluateAndImportTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDBInstanceConfig', 'description' => '查询实例配置参数', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeDBInstanceConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyCustomEndpoint', 'description' => '修改自定义端地址', 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardbx:ModifyCustomEndpoint', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], ], ], ], [ 'apiName' => 'DescribeEvaluateAndImportTask', 'description' => '查询评估导入任务列表', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeEvaluateAndImportTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'UntagResources', 'description' => '资源删除标签', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:UntagResources', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeArchiveTableList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeArchiveTableList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateDBInstanceTDE', 'description' => '开启实例TDE', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:UpdateDBInstanceTDE', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateMem0', 'description' => '开通记忆引擎', 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardbx:CreateMem0', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteMem0', 'description' => '关闭记忆引擎', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardbx:DeleteMem0', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeAccountList', 'description' => '查询实例账号信息', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeAccountList', 'authLevel' => '', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyDBInstanceVip', 'description' => '修改实例虚拟IP', 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardbx:ModifyDBInstanceVip', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ReleaseInstancePublicConnection', 'description' => '释放实例的外网连接地址', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:ReleaseInstancePublicConnection', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyDBInstanceDescription', 'description' => '修改实例描述', 'operationType' => '', 'ramAction' => [ 'action' => 'polardbx:ModifyDBInstanceDescription', 'authLevel' => '', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'CheckCloudResourceAuthorized', 'description' => 'KMS秘钥授权校验', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:CheckCloudResourceAuthorized', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateStoragePool', 'description' => '创建存储池', 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardbx:CreateStoragePool', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeTransformStatus', 'description' => '查询实例升级状态', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeTransformStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateSubCNInstance', 'description' => '创建自定义地址', 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardbx:CreateSubCNInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateCustomEndpoint', 'description' => '创建自定义终端', 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardbx:CreateCustomEndpoint', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], ], ], ], [ 'apiName' => 'ModifyDBInstanceConnectionString', 'description' => '修改实例地址链接串', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:ModifyDBInstanceConnectionString', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'EnableRightsSeparation', 'description' => 'EnableRightsSeparation', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:EnableRightsSeparation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeScaleOutMigrateTaskList', 'description' => '展示数据迁移任务进度', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeScaleOutMigrateTaskList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDBInstanceViaEndpoint', 'description' => '通过连接地址获取实例信息', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeDBInstanceViaEndpoint', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeSecurityIps', 'description' => '查看实例白名单信息', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeSecurityIps', 'authLevel' => '', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateSQLEvaluateTask', 'description' => 'SQL评估', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:CreateSQLEvaluateTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'PreCheckSqlFlashbackTask', 'description' => 'SQL闪回恢复检查', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:PreCheckSqlFlashbackTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeStoragePoolInfo', 'description' => '查询存储池信息', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeStoragePoolInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDBInstanceEndpoint', 'description' => '查看自定义地址', 'operationType' => 'list', 'ramAction' => [ 'action' => 'polardbx:DescribeDBInstanceEndpoint', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], ], ], ], [ 'apiName' => 'UpdatePolarDBXInstanceNode', 'description' => '更新节点', 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardbx:UpdatePolarDBXInstanceNode', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'RestartDBInstance', 'description' => '重启实例', 'operationType' => '', 'ramAction' => [ 'action' => 'polardbx:RestartDBInstance', 'authLevel' => '', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'SwitchDBInstanceHA', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:SwitchDBInstanceHA', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ConfirmNoConnection', 'description' => '回滚切换时确认无连接', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:ConfirmNoConnection', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ResetAccountPassword', 'description' => 'ResetAccountPassword', 'operationType' => '', 'ramAction' => [ 'action' => 'polardbx:ResetAccountPassword', 'authLevel' => '', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyActiveOperationMaintainConf', 'description' => '修改运维事件时间配置', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:ModifyActiveOperationMaintainConf', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeStructureImportTaskInfo', 'description' => '查询数据导入任务信息', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeStructureImportTaskInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeRdsVpcs', 'description' => '查询VPC列表', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeRdsVpcs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitSqlFlashbackTask', 'description' => '创建 SQL 闪回任务', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:SubmitSqlFlashbackTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeBinaryLogList', 'description' => '查询Binlog日志', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeBinaryLogList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeSupabaseInstances', 'description' => '查询 Supabase 实例列表', 'operationType' => 'list', 'ramAction' => [ 'action' => 'polardbx:DescribeSupabaseInstances', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'RestoreDBInstance', 'description' => '恢复实例', 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardbx:RestoreDBInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ReleaseColdDataVolume', 'description' => 'ReleaseColdDataVolume', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:ReleaseColdDataVolume', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeTasks', 'description' => '获取实例任务列表', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeTasks', 'authLevel' => '', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DisableRightsSeparation', 'description' => 'DisableRightsSeparation', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DisableRightsSeparation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDbList', 'description' => '查询获取实例下的数据库信息', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeDbList', 'authLevel' => '', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeColumnarClassList', 'description' => '查询列存规格列表', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeColumnarClassList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ChangeResourceGroup', 'description' => '修改实例资源组', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:ChangeResourceGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyActiveOperationTasks', 'description' => '修改运维事件执行时间', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:ModifyActiveOperationTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteEvaluateAndImportTask', 'description' => '删除评估导入任务', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DeleteEvaluateAndImportTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeCharacterSet', 'description' => '查询字符集', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeCharacterSet', 'authLevel' => '', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateDBInstanceSSL', 'description' => '更新实例SSL配置', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:UpdateDBInstanceSSL', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ResetAccountPasswordRestrict', 'description' => '重置账号密码', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:ResetAccountPasswordRestrict', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'StartSwitchDatabase', 'description' => '开启数据库切换', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:StartSwitchDatabase', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyDatabaseDescription', 'description' => '修改数据库描述', 'operationType' => '', 'ramAction' => [ 'action' => 'polardbx:ModifyDatabaseDescription', 'authLevel' => '', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifySecurityIps', 'description' => '修改实例白名单', 'operationType' => '', 'ramAction' => [ 'action' => 'polardbx:ModifySecurityIps', 'authLevel' => '', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'SkipCurrentStep', 'description' => '跳过当前步骤', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:SkipCurrentStep', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateSuperAccount', 'description' => '创建高权限账号', 'operationType' => '', 'ramAction' => [ 'action' => 'polardbx:CreateSuperAccount', 'authLevel' => '', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateAccount', 'description' => '创建普通账号', 'operationType' => '', 'ramAction' => [ 'action' => 'polardbx:CreateAccount', 'authLevel' => '', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpgradeDBInstanceKernelVersion', 'description' => '升级数据库实例内核版本', 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardbx:UpgradeDBInstanceKernelVersion', 'authLevel' => '', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDBNodePerformance', 'description' => '查询实例性能数据', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeDBNodePerformance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateGatewayConsumerForPolarDBX', 'description' => '开启实例AI能力', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:CreateGatewayConsumerForPolarDBX', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDBInstanceAttribute', 'description' => '查询实例属性', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeDBInstanceAttribute', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'CloseEngineMigration', 'description' => '关闭引擎迁移', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:CloseEngineMigration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDBInstanceHA', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeDBInstanceHA', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateTransformOperation', 'description' => '创建转换任务', 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardbx:CreateTransformOperation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeActiveOperationMaintainConf', 'description' => '展示运维时间配置', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeActiveOperationMaintainConf', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateGdnInstance', 'description' => '创建GDN实例', 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardbx:CreateGdnInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateDataImportTask', 'description' => '创建数据导入任务', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:CreateDataImportTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyEngineMigration', 'description' => '修改引擎迁移', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:ModifyEngineMigration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateBackup', 'description' => '创建备份', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:CreateBackup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeBackupSetList', 'description' => 'DescribeBackupSetList', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:DescribeBackupSetList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteDB', 'description' => '删除数据库', 'operationType' => '', 'ramAction' => [ 'action' => 'polardbx:DeleteDB', 'authLevel' => '', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeColdDataBasicInfo', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardbx:DescribeColdDataBasicInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'AllocateColdDataVolume', 'description' => 'AllocateColdDataVolume', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:AllocateColdDataVolume', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'RefreshImportMeta', 'description' => '刷新导入元数据', 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardbx:RefreshImportMeta', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateDB', 'description' => '创建数据库', 'operationType' => '', 'ramAction' => [ 'action' => 'polardbx:CreateDB', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], 'resourceTypes' => [ ['validationType' => 'always', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], ['validationType' => 'always', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:polardbxinstance/{#DBInstanceId}'], ], ], ];