'1.0',
'info' => ['style' => 'RPC', 'product' => 'Drds', 'version' => '2019-01-23'],
'directories' => [
[
'children' => ['CreateDrdsInstance', 'CreateOrderForRds', 'ModifyDrdsInstanceDescription', 'UpdateResourceGroupAttribute', 'DescribeDrdsInstances', 'DescribeDrdsDbInstance', 'DescribeDrdsInstance', 'DescribeDrdsParams', 'DescribeDrdsTasks', 'DescribeHotDbList', 'DescribeInstanceSwitchAzone', 'DescribeInstanceSwitchNetwork', 'DescribeInstDbLogInfo', 'DescribePreCheckResult', 'DescribeRdsCommodity', 'RemoveDrdsInstance'],
'type' => 'directory',
'title' => 'Instance management',
],
[
'children' => ['CreateDrdsDB', 'DescribeDrdsDBs', 'DescribeDrdsDB', 'DescribeDrdsDbInstances', 'DescribeDrdsDbRdsNameList', 'DescribeDrdsShardingDbs', 'CheckDrdsDbName', 'RemoveDrdsDbFailedRecord', 'RemoveDrdsDb'],
'type' => 'directory',
'title' => 'Database management',
],
[
'children' => ['ModifyRdsReadWeight', 'DescribeRdsPerformanceSummary', 'DescribeRdsSuperAccountInstances', 'DescribeDrdsDBCluster', 'DescribeRDSPerformance', 'DescribeDbInstanceDbs'],
'type' => 'directory',
'title' => 'Storage management',
],
[
'children' => ['CreateInstanceAccount', 'RemoveInstanceAccount'],
'type' => 'directory',
'title' => 'Account management',
],
[
'children' => ['EnableSqlAudit', 'DisableSqlAudit', 'DescribeDrdsSqlAuditStatus', 'DescribeInstDbSlsInfo', 'DescribeDrdsSlowSqls', 'CheckSqlAuditEnableStatus'],
'type' => 'directory',
'title' => 'SQL audit',
],
[
'children' => ['StartRestore', 'SetBackupPolicy', 'EnableSqlFlashbackMatchSwitch', 'DescribeBackMenu', 'DescribeRestoreOrder', 'DescribeBackupDbs', 'DescribeBackupSets', 'DescribeBackupTimes', 'RemoveBackupsSet', 'PutStartBackup'],
'type' => 'directory',
'title' => 'Backup and recovery',
],
[
'children' => ['CreateInstanceInternetAddress', 'UpdateInstanceNetwork', 'ReleaseInstanceInternetAddress'],
'type' => 'directory',
'title' => 'Network and connection',
],
[
'children' => ['ModifyDrdsIpWhiteList', 'DescribeDrdsDBIpWhiteList'],
'type' => 'directory',
'title' => 'Security',
],
[
'children' => ['SubmitCleanTask', 'SubmitSmoothExpandPreCheck', 'CheckExpandStatus', 'SubmitHotExpandTask', 'SubmitHotExpandPreCheckTask'],
'type' => 'directory',
'title' => 'Scaling management',
],
[
'children' => ['DescribeSqlFlashbakTask', 'SubmitSqlFlashbackTask'],
'type' => 'directory',
'title' => 'Task management',
],
[
'children' => ['CreateShardTask', 'DescribeInstanceAccounts', 'DescribeExpandLogicTableInfoList', 'DescribeTableListByType', 'DescribeShardTaskInfo', 'ValidateShardTask'],
'type' => 'directory',
'title' => 'Table sharding',
],
[
'children' => ['SetupBroadcastTables', 'DescribeBroadcastTables', 'SwitchGlobalBroadcastType'],
'type' => 'directory',
'title' => 'Broadcast table',
],
[
'children' => ['SetupTable', 'DescribeTables'],
'type' => 'directory',
'title' => 'Data table management',
],
[
'children' => ['SetupDrdsParams'],
'type' => 'directory',
'title' => 'Tag and parameter settings',
],
[
'children' => ['DescribeDrdsInstanceVersion', 'DescribeDrdsInstanceLevelTasks', 'UpgradeInstanceVersion'],
'type' => 'directory',
'title' => 'Instance version',
],
[
'children' => ['DescribeDrdsInstanceMonitor', 'DescribeDrdsInstanceDbMonitor'],
'type' => 'directory',
'title' => 'Performance monitoring',
],
[
'children' => [
'ChangeAccountPassword', 'ChangeInstanceAzone', 'DescribeBackupLocal', 'DescribeDrdsRdsInstances', 'DescribeRecycleBinStatus', 'DescribeRecycleBinTables', 'EnableInstanceIpv6Address', 'FlashbackRecycleBinTable', 'GetDrdsDbRdsRelationInfo', 'ManagePrivateRds', 'ModifyAccountPrivilege', 'ModifyPolarDbReadWeight', 'RefreshDrdsAtomUrl', 'RemoveRecycleBinTable', 'RestartDrdsInstance', 'RollbackInstanceVersion', 'SetBackupLocal', 'SetupRecycleBinStatus', 'SubmitSmoothExpandPreCheckTask', 'UpdatePrivateRdsClass',
'UpgradeHiStoreInstance', 'DescribeBackupPolicy', 'DescribeDbInstances', 'DescribeTable', 'ListTagResources', 'ModifyAccountDescription', 'TagResources', 'UntagResources',
],
'type' => 'directory',
'title' => 'Others',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'ChangeAccountPassword' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds********', 'title' => ''],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => ['description' => 'The account name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['description' => 'The new password.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DSSDF-SEWE-*****', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Reset DRDS database password',
'summary' => 'Resets the password of a DRDS database by calling the ChangeAccountPassword operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeAccountPassword'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:ChangeAccountPassword',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\"\\n}","type":"json"}]',
],
'ChangeInstanceAzone' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '75934',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdsjiii1b49****', 'title' => ''],
],
[
'name' => 'OriginAzoneId',
'in' => 'query',
'schema' => ['description' => 'The original zone ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-B', 'title' => ''],
],
[
'name' => 'TargetAzoneId',
'in' => 'query',
'schema' => ['description' => 'The target zone ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-A', 'title' => ''],
],
[
'name' => 'DrdsRegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ChangeVSwitch',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => 'Specifies whether to update the vSwitch. Valid values:'."\n"
."\n"
.'- **true**: Yes.'."\n"
.'- **false**: No.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'NewVSwitch',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => 'The ID of the new vSwitch.', 'type' => 'string', 'required' => false, 'example' => 'vsw-wz9ckkba51zrh********', 'title' => ''],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2F7F8080-9132-4279-85D0-B7E5C4305162', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ERR_INSTANCE_NOT_RUNNING_STATUS', 'errorMessage' => 'The instance status is not running', 'description' => ''],
['errorCode' => 'ERR_OTHER_MULTI_AZONE_SWITCH', 'errorMessage' => 'Change to multiple azone should have even number of nodes', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"2F7F8080-9132-4279-85D0-B7E5C4305162\\"\\n}","type":"json"}]',
'title' => 'Switch instance zone',
'summary' => 'Switches the zone of a DRDS instance.',
'changeSet' => [
['createdAt' => '2023-03-02T06:22:55.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeInstanceAzone'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:ChangeInstanceAzone',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CheckDrdsDbName' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds********', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the DRDS database.', 'type' => 'string', 'required' => true, 'example' => 'drds_test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CF38538C-68BD-4278-B58F-EDE96F******', 'title' => ''],
'Result' => ['description' => 'The check result. A value of true indicates that the database name is valid. A value of false indicates that the database name is invalid.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDbName.Empty', 'errorMessage' => 'DbName can not be empty', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidDbName.Keyword', 'errorMessage' => 'Current DbName is the keyword', 'description' => ''],
['errorCode' => 'InvalidDbName.DuplicatedInPublic', 'errorMessage' => 'Current DbName is duplicated in public instance', 'description' => ''],
['errorCode' => 'InvalidDbName.Duplicated', 'errorMessage' => 'Current DbName provided has already existed in our records.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Check whether a DRDS database name is valid',
'summary' => 'Checks whether a DRDS database name is valid.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckDrdsDbName'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'drds:CheckDrdsDbName',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CF38538C-68BD-4278-B58F-EDE96F******\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
],
'CheckExpandStatus' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The DRDS instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds***********', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7CDBA7D5-8D62-4D24-9C65-510D62******', 'title' => ''],
'Data' => [
'description' => 'The check result.',
'type' => 'object',
'properties' => [
'Msg' => ['description' => 'The additional description.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'IsActive' => ['description' => 'Indicates whether scaling operations can be performed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Check whether a database supports scaling operations',
'summary' => 'Checks whether a DRDS database supports scaling operations such as smooth scale-out.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckExpandStatus'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'drds:CheckExpandStatus',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"7CDBA7D5-8D62-4D24-9C65-510D62******\\",\\n \\"Data\\": {\\n \\"Msg\\": \\"success\\",\\n \\"IsActive\\": true\\n }\\n}","type":"json"}]',
],
'CheckSqlAuditEnableStatus' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '75944',
'abilityTreeNodes' => ['FEATUREdrdsB0CUNV'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The DRDS instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The enabling status of the SQL audit feature. Valid values:'."\n"
."\n"
.'* enabled: SQL audit is enabled.'."\n"
.'* disabled: SQL audit is disabled.', 'type' => 'string', 'example' => 'enabled', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FF13E47D-4E38-4A5A-BA68-32A554******', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Check whether SQL audit is enabled for a DRDS logical database',
'summary' => 'Checks whether SQL audit is enabled for a DRDS logical database by calling the CheckSqlAuditEnableStatus operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckSqlAuditEnableStatus'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:CheckSqlAuditEnableStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"enabled\\",\\n \\"RequestId\\": \\"FF13E47D-4E38-4A5A-BA68-32A554******\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'CreateDrdsDB' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drdshbgal154****', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'testdb', 'title' => ''],
],
[
'name' => 'Encode',
'in' => 'query',
'schema' => ['description' => 'The encoding used by the database.', 'type' => 'string', 'required' => false, 'default' => 'utf8mb4', 'example' => 'utf8', 'title' => ''],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['description' => 'The password used to access the database.', 'type' => 'string', 'required' => false, 'example' => 'drds_sample_password', 'title' => ''],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['description' => 'The sharding method of the database. Valid values:'."\n"
."\n"
.'- **HORIZONTAL**: horizontal sharding, which is commonly known as table and database sharding.'."\n"
.'- **VERTICAL**: vertical partitioning.', 'type' => 'string', 'required' => false, 'default' => 'HORIZONTAL', 'example' => 'HORIZONTAL', 'title' => ''],
],
[
'name' => 'DbInstType',
'in' => 'query',
'schema' => ['description' => 'The type of the attached storage. Currently, only RDS is supported.', 'type' => 'string', 'required' => false, 'default' => 'RDS', 'example' => 'RDS', 'title' => ''],
],
[
'name' => 'DbInstanceIsCreating',
'in' => 'query',
'schema' => ['description' => 'Specifies whether the RDS instances involved in database creation are being created.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => ['description' => 'This parameter is used only for vertical partitioning. It specifies the name of an account that has access permissions on the corresponding databases across all RDS instances in a vertical partitioning scenario.', 'type' => 'string', 'required' => false, 'example' => 'drds_sample_account', 'title' => ''],
],
[
'name' => 'RdsInstance',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of RDS instances.',
'type' => 'array',
'items' => ['description' => 'This parameter is required only for horizontal sharding. The value is a string in JSON array format.', 'type' => 'string', 'required' => false, 'example' => '["drds_sample_rds_id1", "drds_sample_rds_id2"]', 'title' => ''],
'required' => false,
'example' => '["drds_sample_rds_id1", "drds_sample_rds_id2"]',
'maxItems' => 1000,
'title' => '',
],
],
[
'name' => 'RdsSuperAccount',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of RDS superuser account information.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Password' => ['description' => 'The password of the RDS superuser account.', 'type' => 'string', 'required' => false, 'example' => 'drds_sample_rds_super_password', 'title' => ''],
'DbInstanceId' => ['description' => 'The RDS instance ID.', 'type' => 'string', 'required' => false, 'example' => 'drds_sample_rds_id', 'title' => ''],
'AccountName' => ['description' => 'The name of the RDS superuser account.', 'type' => 'string', 'required' => false, 'example' => 'drds_sample_rds_super_account', 'title' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 1000,
'title' => '',
'example' => '',
],
],
[
'name' => 'InstDbName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of databases.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DbInstanceId' => ['description' => 'The ID of the RDS instance to be vertically partitioned. This parameter is used only for vertical partitioning.', 'type' => 'string', 'required' => false, 'example' => 'drds_sample_rds_id', 'title' => ''],
'ShardDbName' => [
'description' => 'The list of sharded databases.',
'type' => 'array',
'items' => ['description' => 'The list of databases on the corresponding RDS instance that need to be vertically partitioned. The value is a string in JSON array format. This parameter is used only for vertical partitioning.', 'type' => 'string', 'required' => false, 'example' => '["db1", "db2"]', 'title' => ''],
'required' => false,
'example' => '["drds_sample_db1", "drds_sample_db2"]',
'maxItems' => 30,
'title' => '',
],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'The request result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FF13E47D-4E38-4A5A-BA68-32A554AD45T6', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidInstance.CreateDbForSlave', 'errorMessage' => 'Db Creation in slave drds instance not support.', 'description' => ''],
['errorCode' => 'InvalidParameter.InstDbName', 'errorMessage' => 'The parameter InstDbName is empty', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Create a database instance',
'summary' => 'Creates a DRDS database.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDrdsDB'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'drds:CreateDrdsDB',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"FF13E47D-4E38-4A5A-BA68-32A554AD45T6\\"\\n}","type":"json"}]',
],
'CreateDrdsInstance' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the instance. The description must meet the following requirements:'."\n"
."\n"
.'- It cannot start with http:// or https://.'."\n"
.'- It must start with a letter or a Chinese character and can contain uppercase letters, lowercase letters, Chinese characters, digits, underscores (_), or hyphens (-).'."\n"
.'- It must be 2 to 256 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-e', 'title' => ''],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => 'The instance type. Only PRIVATE is supported, which indicates a dedicated instance.'."\n"
."\n"
.'> You can also set this parameter to 1 to indicate a dedicated instance.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enum' => ['PRIVATE', 'PUBLIC', '1', '0'],
'example' => 'PRIVATE',
'title' => '',
],
],
[
'name' => 'Quantity',
'in' => 'query',
'schema' => ['description' => 'The number of instances to create. Only the value 1 is supported, which indicates that only one instance can be created at a time.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'InstanceSeries',
'in' => 'query',
'schema' => ['description' => 'The instance edition parameter. Valid values:'."\n"
."\n"
.'- **drds.sn2.4c16g**: Starter Edition'."\n"
.'- **drds.sn2.8c32g**: Standard Edition'."\n"
.'- **drds.sn2.16c64g**: Enterprise Edition.', 'type' => 'string', 'required' => true, 'example' => 'drds.sn2.4c16g', 'title' => ''],
],
[
'name' => 'Specification',
'in' => 'query',
'schema' => ['description' => 'The instance specification code. The value consists of the instance edition and the specific instance specification. Example: drds.sn2.4c16g.8c32g.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds.sn2.4c16g.8C32g', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request and prevent repeated submissions. The value is generated by the client and must be unique among different requests. The value can be up to 64 ASCII characters in length and cannot contain non-ASCII characters.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c1dd299c-10c6-11ea-bbbb-************', 'title' => ''],
],
[
'name' => 'PayType',
'in' => 'query',
'schema' => ['description' => 'The billing method. Valid values:'."\n"
."\n"
.'- **drdsPre**: subscription.'."\n"
.'- **drdsPost**: pay-as-you-go.'."\n"
.'- **drdsRo**: When you create a read-only instance, the pay-as-you-go billing method is used by default.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdsPost', 'title' => ''],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => 'The VPC ID.', 'type' => 'string', 'required' => false, 'example' => 'vpc-**********', 'title' => ''],
],
[
'name' => 'VswitchId',
'in' => 'query',
'schema' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-**********', 'title' => ''],
],
[
'name' => 'isHa',
'in' => 'query',
'schema' => ['description' => 'Specifies whether the instance is a high-availability instance.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'PricingCycle',
'in' => 'query',
'schema' => [
'description' => 'Specifies the billing cycle of the subscription instance. Valid values:'."\n"
."\n"
.'- **year**: yearly subscription'."\n"
.'- **month**: monthly subscription'."\n"
."\n"
.'> This parameter is required if PayType is set to drdsPre.',
'type' => 'string',
'required' => false,
'enum' => ['year', 'month'],
'example' => 'month',
'title' => '',
],
],
[
'name' => 'Duration',
'in' => 'query',
'schema' => ['description' => 'The subscription duration of the instance.'."\n"
."\n"
.'- If PricingCycle is set to year, valid values are 1 to 3.'."\n"
.'- If PricingCycle is set to month, valid values are 1 to 9.'."\n"
."\n"
.'> This parameter takes effect only when PayType is set to drdsPre.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'IsAutoRenew',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n"
."\n"
.'- **true**: Auto-renewal is enabled. If the instance is purchased on a monthly basis, the instance is automatically renewed for one month. If the instance is purchased on a yearly basis, the instance is automatically renewed for one year.'."\n"
.'- **false**: Auto-renewal is disabled.'."\n"
."\n"
.'> This parameter takes effect only when PayType is set to drdsPre.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''],
],
[
'name' => 'MasterInstId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the primary instance. Specify this parameter only when you create a read-only instance.', 'type' => 'string', 'required' => false, 'example' => 'drds***********', 'title' => ''],
],
[
'name' => 'MySQLVersion',
'in' => 'query',
'schema' => ['description' => 'The MySQL version supported by the instance. Valid values:'."\n"
."\n"
.'- **5**: fully compatible with MySQL 5.x (default)'."\n"
.'- **8**: fully compatible with MySQL 8.0'."\n"
."\n"
.'> This parameter takes effect only when you create a primary instance. The MySQL version of a read-only instance is the same as that of the primary instance by default.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D99D4644-A70D-49A3-B8B4-767ACC50SE2R', 'title' => ''],
'Data' => [
'description' => 'The result details.',
'type' => 'object',
'properties' => [
'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '111111111111111', 'title' => ''],
'DrdsInstanceIdList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'drdsInstanceIdList' => [
'description' => 'The instance information.',
'type' => 'array',
'items' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'drds************', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterError', 'errorMessage' => 'Parameter error', 'description' => ''],
['errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', 'description' => ''],
['errorCode' => 'ServiceUnable', 'errorMessage' => 'The service is not available now, please try again later', 'description' => ''],
['errorCode' => 'OperationDenied', 'errorMessage' => 'drds service is not enable for you', 'description' => ''],
['errorCode' => 'QuotaExceeded.DRDSInstance', 'errorMessage' => 'The quota of create instance exceeds.', 'description' => ''],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The RegionId provided does not exist in our records.', 'description' => ''],
['errorCode' => 'InvalidDescription.MalFormed', 'errorMessage' => 'The specified parameter description is not valid.', 'description' => ''],
['errorCode' => 'CommunicateWithManager.Error', 'errorMessage' => 'Internal Error. Communicate with drds manager error', 'description' => ''],
['errorCode' => 'InvalidVSwitchId', 'errorMessage' => 'Invalid vswitchId', 'description' => ''],
['errorCode' => 'InvalidVpcId', 'errorMessage' => 'Invalid vpcId, or the region of vpc does not match', 'description' => ''],
['errorCode' => 'InvalidZoneId.Mismatch', 'errorMessage' => 'zone is illegal in this order', 'description' => ''],
['errorCode' => 'LowInventory.ServerError', 'errorMessage' => 'low inventory error', 'description' => ''],
['errorCode' => 'publicInstanceAlreadExist.Error', 'errorMessage' => 'a public Drds instance is exist', 'description' => ''],
['errorCode' => 'CreateDRDSInstanceId.Error', 'errorMessage' => 'create Drds instance id error', 'description' => ''],
['errorCode' => 'ResourceInsufficient', 'errorMessage' => 'resource is Insufficient', 'description' => ''],
['errorCode' => 'AnotherOrderExist.Error', 'errorMessage' => 'there is another order', 'description' => ''],
['errorCode' => 'InstanceExceedLimit.Error', 'errorMessage' => 'instance number has exceeded', 'description' => ''],
['errorCode' => 'InvalidParameter.Quantity', 'errorMessage' => 'Invalid parameter of quantity', 'description' => ''],
['errorCode' => 'InvalidParameter.RegionId', 'errorMessage' => 'Invalid parameter of region id', 'description' => ''],
['errorCode' => 'InvalidParameter.ZoneId', 'errorMessage' => 'Invalid parameter of zone id', 'description' => ''],
['errorCode' => 'InvalidParameter.PayType', 'errorMessage' => 'Invalid parameter of pay type', 'description' => ''],
['errorCode' => 'InvalidParameter.Spection', 'errorMessage' => 'Invalid parameter of specification', 'description' => ''],
['errorCode' => 'InvalidParameter.Series', 'errorMessage' => 'Invalid parameter of series', 'description' => ''],
['errorCode' => 'InvalidParameter.duration_pricingCycle', 'errorMessage' => 'when payType=drdsPre, duration and pricingCycle is required', 'description' => ''],
['errorCode' => 'InvalidParameter.year.duration', 'errorMessage' => 'when pricingCycle=year, duration must between 1 to 3', 'description' => ''],
['errorCode' => 'InvalidParameter.month.duration', 'errorMessage' => 'when pricingCycle=month, duration must between 1 to 9', 'description' => ''],
['errorCode' => 'InvalidDRDSInstanceType.Error', 'errorMessage' => 'Invalid parameter of Type, public is not supported', 'description' => ''],
['errorCode' => 'QueryVSwitchFailed.InvalidVpcIdOrServerError', 'errorMessage' => 'Query VSwitch failed, please check vpcId', 'description' => ''],
['errorCode' => 'RegionNotSupportVPC.Error', 'errorMessage' => 'This region does not support vpc instance', 'description' => ''],
['errorCode' => 'UserAccountVerify.Failed', 'errorMessage' => 'User account verify failed. Please verify first', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Create an instance',
'summary' => 'Creates an instance.',
'changeSet' => [
['createdAt' => '2021-12-06T03:20:38.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDrdsInstance'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'drds:CreateDrdsInstance',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"D99D4644-A70D-49A3-B8B4-767ACC50SE2R\\",\\n \\"Data\\": {\\n \\"OrderId\\": 111111111111111,\\n \\"DrdsInstanceIdList\\": {\\n \\"drdsInstanceIdList\\": [\\n \\"drds************\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
],
'CreateInstanceAccount' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drdsjiii1b49****', 'title' => ''],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => ['description' => 'The account name.', 'type' => 'string', 'required' => true, 'example' => 'drds_sample_account', 'title' => ''],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['description' => 'The account password.', 'type' => 'string', 'required' => true, 'example' => 'drds_sample_password', 'title' => ''],
],
[
'name' => 'DbPrivilege',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of database access permissions.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DbName' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'test123', 'title' => ''],
'Privilege' => ['description' => 'The access permissions on the database for the account to be created.', 'type' => 'string', 'required' => false, 'example' => 'DDL', 'title' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 1000,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FF13E47D-4E38-4A5A-BA68-4E610EVF56DC', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'OperationFailed.CreateAccount', 'errorMessage' => 'Create account failed.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Create a DRDS instance-level account',
'summary' => 'Creates an instance-level account for a DRDS instance by calling the CreateInstanceAccount operation.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstanceAccount'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'drds:CreateInstanceAccount',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"FF13E47D-4E38-4A5A-BA68-4E610EVF56DC\\"\\n}","type":"json"}]',
],
'CreateInstanceInternetAddress' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds****************', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region in which the DRDS instance resides.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The error code.'."\n"
.'> This parameter is returned only when the API call fails.', 'type' => 'integer', 'format' => 'int32', 'example' => '404', 'title' => ''],
'Data' => ['description' => 'Indicates whether the public IP address was created.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1DF6052F-15E2-4E69-9628-D6BCC3******', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. 默认错误码', 'description' => ''],
],
],
'title' => 'Create a public IP address for a DRDS instance',
'summary' => 'Creates a public IP address for a Distributed Relational Database Service (DRDS) instance by calling the CreateInstanceInternetAddress operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstanceInternetAddress'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'drds:CreateInstanceInternetAddress',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 404,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"1DF6052F-15E2-4E69-9628-D6BCC3******\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'CreateOrderForRds' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '75962',
'abilityTreeNodes' => ['FEATUREdrdsHFP8VD'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'Params',
'in' => 'query',
'schema' => ['description' => 'The JSON-formatted parameters for placing the ApsaraDB RDS order. For more information, see [CreateDBInstance](~~26228~~).', 'type' => 'string', 'required' => true, 'example' => '{"key":"value"}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'The instance ID of the ApsaraDB RDS instance that was purchased.', 'type' => 'string', 'example' => '[rm-***********]', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9819BC51-D33D-4EB1-B80F-A89A20******', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Create an order to purchase an apsaraDB RDS instance',
'summary' => 'Creates an order to purchase an ApsaraDB RDS instance by calling the CreateOrderForRds operation.',
'description' => 'Before using this operation, make sure that you fully understand the billing method and [pricing](https://www.aliyun.com/price/product#/rds/detail) of this service.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrderForRds'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'drds:CreateOrderForRds',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"[rm-***********]\\",\\n \\"RequestId\\": \\"9819BC51-D33D-4EB1-B80F-A89A20******\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'CreateShardTask' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '75963',
'abilityTreeNodes' => ['FEATUREdrdsD6TUSC'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'SourceTableName',
'in' => 'query',
'schema' => ['description' => 'The name of the source table.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_tb1', 'title' => ''],
],
[
'name' => 'TargetTableName',
'in' => 'query',
'schema' => ['description' => 'The name of the target table.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 100, 'minLength' => 1, 'example' => 'test_tb2', 'title' => ''],
],
[
'name' => 'TaskType',
'in' => 'query',
'schema' => ['description' => 'The task type. Valid values: `SHARD_TO_SINGLE`, `SINGLE_TO_SHARD`, and `SHARD_TO_SHARD`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SINGLE_TO_SHARD', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'The result of the task creation.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F8997D95-94AD-416A-AE70-E24D08******', 'title' => ''],
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"F8997D95-94AD-416A-AE70-E24D08******\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'Create a sharding task',
'summary' => 'Calls the CreateShardTask operation to create a sharding task.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateShardTask'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'drds:CreateShardTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeBackMenu' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds***********', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '60C21BE4-EDFE-454C-95ED-3A5C74******', 'title' => ''],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'list' => [
'description' => 'The list of backup information.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Support' => ['description' => 'Indicates whether backup and recovery is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'MenuName' => ['description' => 'The backup method. Valid values:'."\n"
.'* **logic**: logical backup.'."\n"
.'* **phy**: physical backup.', 'type' => 'string', 'example' => 'phy', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"60C21BE4-EDFE-454C-95ED-3A5C74******\\",\\n \\"List\\": {\\n \\"list\\": [\\n {\\n \\"Support\\": true,\\n \\"MenuName\\": \\"phy\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => 'Query whether an instance supports backup and recovery',
'summary' => 'Queries whether an instance supports backup and recovery by calling the DescribeBackMenu operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackMenu'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeBackMenu',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
],
'DescribeBackupDbs' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The DRDS instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'PreferredRestoreTime',
'in' => 'query',
'schema' => ['description' => 'The restore point in time used to query restorable databases.', 'type' => 'string', 'required' => false, 'example' => '1568632541236', 'title' => ''],
],
[
'name' => 'BackupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the backup set used to query restorable databases.', 'type' => 'string', 'required' => false, 'example' => '201908367', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '842DFA7F-B09B-42A2-B115-E684AE******', 'title' => ''],
'DbNames' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'dbName' => [
'type' => 'array',
'items' => ['description' => 'The list of databases.', 'type' => 'string', 'example' => '["db1","db2"]', 'title' => ''],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query restorable databases',
'summary' => 'Queries the list of databases that can be restored by calling the DescribeBackupDbs operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupDbs'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeBackupDbs',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"842DFA7F-B09B-42A2-B115-E684AE******\\",\\n \\"DbNames\\": {\\n \\"dbName\\": [\\n \\"[\\\\\\"db1\\\\\\",\\\\\\"db2\\\\\\"]\\"\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeBackupLocal' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds************', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FDC9CFD5-306D-4A23-9D8C-057274C6****', 'title' => ''],
'BackupPolicyDO' => [
'description' => 'The details of the backup policy settings.',
'type' => 'object',
'properties' => [
'BackupDbName' => ['description' => 'This parameter is not returned for this API operation.', 'type' => 'string', 'example' => 'null', 'title' => ''],
'LogBackupRetentionPeriod' => ['description' => 'This parameter is not returned for this API operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'DataBackupRetentionPeriod' => ['description' => 'This parameter is not returned for this API operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'BackupType' => ['description' => 'This parameter is not returned for this API operation.', 'type' => 'string', 'example' => 'null', 'title' => ''],
'BackupLevel' => ['description' => 'This parameter is not returned for this API operation.', 'type' => 'string', 'example' => 'null', 'title' => ''],
'LocalLogRetentionHours' => ['description' => 'The number of hours for which log backups are retained locally. Valid values: 0 to 168. A value of **0** indicates that log backups are not retained. Default value: **18**.', 'type' => 'integer', 'format' => 'int64', 'example' => '18', 'title' => ''],
'HighSpaceUsageProtection' => ['description' => 'Specifies whether to unconditionally clean up binary logs when the instance storage usage exceeds 90% or the remaining storage is less than 5 GB. Valid values:'."\n"
."\n"
.'* 1: enabled.'."\n"
.'* 0: disabled.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'GmtModified' => ['description' => 'This parameter is not returned for this API operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'BackupRetentionPeriod' => ['description' => 'This parameter is not returned for this API operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'BackupPolicyMode' => ['description' => 'This parameter is not returned for this API operation.', 'type' => 'string', 'example' => 'null', 'title' => ''],
'PreferredBackupPeriod' => ['description' => 'This parameter is not returned for this API operation.', 'type' => 'string', 'example' => 'null', 'title' => ''],
'LocalLogRetentionSpace' => ['description' => 'The maximum storage usage of binary logs, in percentage. Valid values: 0 to 50. This is a circular space. Default value: **30**.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
'BackupAppName' => ['description' => 'This parameter is not returned for this API operation.', 'type' => 'string', 'example' => 'null', 'title' => ''],
'PreferredBackupTime' => ['description' => 'This parameter is not returned for this API operation.', 'type' => 'string', 'example' => 'null', 'title' => ''],
'GmtCreate' => ['description' => 'This parameter is not returned for this API operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'BackupMode' => ['description' => 'This parameter is not returned for this API operation.', 'type' => 'string', 'example' => 'null', 'title' => ''],
'BackupLog' => ['description' => 'This parameter is not returned for this API operation.', 'type' => 'string', 'example' => 'null', 'title' => ''],
'NextBackupActuallyTime' => ['description' => 'This parameter is not returned for this API operation.', 'type' => 'string', 'example' => 'null', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query local backup sets',
'summary' => 'Calls the DescribeBackupLocal operation to query binary log settings.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupLocal'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'drds:DescribeBackupLocal',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"FDC9CFD5-306D-4A23-9D8C-057274C6****\\",\\n \\"BackupPolicyDO\\": {\\n \\"BackupDbName\\": \\"null\\",\\n \\"LogBackupRetentionPeriod\\": 0,\\n \\"DataBackupRetentionPeriod\\": 0,\\n \\"BackupType\\": \\"null\\",\\n \\"BackupLevel\\": \\"null\\",\\n \\"LocalLogRetentionHours\\": 18,\\n \\"HighSpaceUsageProtection\\": 1,\\n \\"GmtModified\\": 0,\\n \\"BackupRetentionPeriod\\": 0,\\n \\"BackupPolicyMode\\": \\"null\\",\\n \\"PreferredBackupPeriod\\": \\"null\\",\\n \\"LocalLogRetentionSpace\\": 30,\\n \\"BackupAppName\\": \\"null\\",\\n \\"PreferredBackupTime\\": \\"null\\",\\n \\"GmtCreate\\": 0,\\n \\"BackupMode\\": \\"null\\",\\n \\"BackupLog\\": \\"null\\",\\n \\"NextBackupActuallyTime\\": \\"null\\"\\n }\\n}","type":"json"}]',
],
'DescribeBackupPolicy' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drdshbga71nn****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the operation is successful. Valid values: true: The operation is successful. false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8FAF3989-79CD-4A67-8FFD-97899B64SD5T', 'title' => ''],
'BackupPolicyDO' => [
'description' => 'The details of the backup policy.',
'type' => 'object',
'properties' => [
'BackupDbName' => [
'description' => 'This API does not return a value.',
'enumValueTitles' => [],
'type' => 'string',
'example' => 'null',
'title' => '',
],
'LogBackupRetentionPeriod' => ['description' => 'The number of days for which log backups are retained.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'DataBackupRetentionPeriod' => ['description' => 'The retention period of data backups. Unit: days.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'BackupType' => ['description' => 'The backup type. Valid values:'."\n"
."\n"
.'- manual: manual backup.'."\n"
.'- auto: automatic backup.', 'type' => 'string', 'example' => 'auto', 'title' => ''],
'BackupLevel' => ['description' => 'The backup level. Valid values:'."\n"
."\n"
.'- db: database level.'."\n"
.'- instance: instance level.', 'type' => 'string', 'example' => 'db', 'title' => ''],
'LocalLogRetentionHours' => ['description' => 'This API does not return a value.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'HighSpaceUsageProtection' => ['description' => 'This API does not return a value.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
'GmtModified' => ['description' => 'This API does not return a value.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'BackupRetentionPeriod' => ['description' => 'The number of days for which backups are retained.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''],
'BackupPolicyMode' => ['description' => 'The backup policy mode. Valid values:'."\n"
."\n"
.'- DataBackupPolicy: data backup policy.'."\n"
.'- LogBackupPolicy: log backup policy.', 'type' => 'string', 'example' => 'DataBackupPolicy', 'title' => ''],
'PreferredBackupPeriod' => ['description' => 'The backup cycle. You can specify multiple backup cycles separated by commas (,). Valid values:'."\n"
.'- 1: Sunday'."\n"
.'- 2: Monday'."\n"
.'- 3: Tuesday'."\n"
.'- 4: Wednesday'."\n"
.'- 5: Thursday'."\n"
.'- 6: Friday'."\n"
.'- 7: Saturday', 'type' => 'string', 'example' => '2', 'title' => ''],
'LocalLogRetentionSpace' => ['description' => 'This API does not return a value.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'BackupAppName' => ['description' => 'This API does not return a value.', 'type' => 'string', 'example' => 'null', 'title' => ''],
'PreferredBackupTime' => ['description' => 'The backup time range in UTC.', 'type' => 'string', 'example' => '22:00:00-23:00:00', 'title' => ''],
'GmtCreate' => ['description' => 'This API does not return a value.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'BackupMode' => ['description' => 'The backup method. Valid values:'."\n"
.'* **logic**: logical backup.'."\n"
.'* **phy**: fast backup.', 'type' => 'string', 'example' => 'phy', 'title' => ''],
'BackupLog' => ['description' => 'Indicates whether backup logging is enabled. Valid values:'."\n"
.'* **1**: enabled.'."\n"
.'* **0**: disabled.', 'type' => 'string', 'example' => '1', 'title' => ''],
'NextBackupActuallyTime' => ['description' => 'This API does not return a value.', 'type' => 'string', 'example' => 'null', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query the Automatic Backup Policy of a Cluster',
'summary' => 'Queries the details of a backup policy by calling the DescribeBackupPolicy operation.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupPolicy'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeBackupPolicy',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"8FAF3989-79CD-4A67-8FFD-97899B64SD5T\\",\\n \\"BackupPolicyDO\\": {\\n \\"BackupDbName\\": \\"null\\",\\n \\"LogBackupRetentionPeriod\\": 10,\\n \\"DataBackupRetentionPeriod\\": 10,\\n \\"BackupType\\": \\"auto\\",\\n \\"BackupLevel\\": \\"db\\",\\n \\"LocalLogRetentionHours\\": 0,\\n \\"HighSpaceUsageProtection\\": 0,\\n \\"GmtModified\\": 0,\\n \\"BackupRetentionPeriod\\": 8,\\n \\"BackupPolicyMode\\": \\"DataBackupPolicy\\",\\n \\"PreferredBackupPeriod\\": \\"2\\",\\n \\"LocalLogRetentionSpace\\": 0,\\n \\"BackupAppName\\": \\"null\\",\\n \\"PreferredBackupTime\\": \\"22:00:00-23:00:00\\",\\n \\"GmtCreate\\": 0,\\n \\"BackupMode\\": \\"phy\\",\\n \\"BackupLog\\": \\"1\\",\\n \\"NextBackupActuallyTime\\": \\"null\\"\\n }\\n}","type":"json"}]',
],
'DescribeBackupSets' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds***********', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The start time of the query. Specify a timestamp in milliseconds.', 'type' => 'string', 'required' => true, 'example' => '1591327800000', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end time of the query. Specify a timestamp in milliseconds.'."\n"
.'> The end time must be later than the start time.', 'type' => 'string', 'required' => true, 'example' => '1591326000000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7103AEE3-9025-442F-B82B-BABD0A******', 'title' => ''],
'BackupSets' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'backupSet' => [
'description' => 'The list of backup sets.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EnableRecovery' => ['description' => 'Indicates whether the backup set can be restored.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'Status' => ['description' => 'The backup status. Valid values:'."\n"
.'* -1: failed'."\n"
.'* 0: not started'."\n"
.'* 1: running'."\n"
.'* 2: succeeded.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
'BackupConsitentTime' => ['description' => 'The duration of the backup restoration.', 'type' => 'string', 'example' => '2020-06-05 11:31:38', 'title' => ''],
'BackupType' => ['description' => 'The backup type. Valid values:'."\n"
.'* manual: manual backup'."\n"
.'* auto: automatic backup.', 'type' => 'string', 'example' => 'manual', 'title' => ''],
'BackupStartTime' => ['description' => 'The start time of the backup. The value is a timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1591327754000', 'title' => ''],
'BackupLevel' => ['description' => 'The backup level. Valid values:'."\n"
.'* db: database level'."\n"
.'* instance: instance level.', 'type' => 'string', 'example' => 'instance', 'title' => ''],
'BackupMode' => ['description' => 'The backup mode. Valid values:'."\n"
.'* logic: logical backup'."\n"
.'* phy: fast backup.', 'type' => 'string', 'example' => 'logic', 'title' => ''],
'BackupEndTime' => ['description' => 'The end time of the backup. The value is a timestamp in milliseconds.'."\n"
.'> A value of 0 indicates that the backup has not ended.', 'type' => 'integer', 'format' => 'int64', 'example' => '1591327899000', 'title' => ''],
'Id' => ['description' => 'The ID of the backup set.', 'type' => 'string', 'example' => 'ba30d5c4-a6dc-11ea-bd40-************', 'title' => ''],
'BackupTotalSize' => ['description' => 'The size of the backup set. Unit: MB.', 'type' => 'string', 'example' => '93.24', 'title' => ''],
'BackupDbs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'backupDb' => [
'type' => 'array',
'items' => ['description' => 'The list of backed-up databases.', 'type' => 'string', 'example' => '["dts********"]', 'title' => ''],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query backup set information',
'summary' => 'Calls the DescribeBackupSets operation to query backup set information.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupSets'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeBackupSets',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"7103AEE3-9025-442F-B82B-BABD0A******\\",\\n \\"BackupSets\\": {\\n \\"backupSet\\": [\\n {\\n \\"EnableRecovery\\": false,\\n \\"Status\\": 2,\\n \\"BackupConsitentTime\\": \\"2020-06-05 11:31:38\\",\\n \\"BackupType\\": \\"manual\\",\\n \\"BackupStartTime\\": 1591327754000,\\n \\"BackupLevel\\": \\"instance\\",\\n \\"BackupMode\\": \\"logic\\",\\n \\"BackupEndTime\\": 1591327899000,\\n \\"Id\\": \\"ba30d5c4-a6dc-11ea-bd40-************\\",\\n \\"BackupTotalSize\\": \\"93.24\\",\\n \\"BackupDbs\\": {\\n \\"backupDb\\": [\\n \\"[\\\\\\"dts********\\\\\\"]\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeBackupTimes' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drdshbga71nn****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'The request result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4780A19F-5ECB-4C56-AD20-966A3FF9DE5R', 'title' => ''],
'RestoreTime' => [
'description' => 'The details of the restorable time.',
'type' => 'object',
'properties' => [
'EndTime' => ['description' => 'The end time. The value is a UNIX timestamp (UTC) in milliseconds.', 'type' => 'string', 'example' => '1568636922671', 'title' => ''],
'StartTime' => ['description' => 'The start time. The value is a UNIX timestamp (UTC) in milliseconds.', 'type' => 'string', 'example' => '1568632853000', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"4780A19F-5ECB-4C56-AD20-966A3FF9DE5R\\",\\n \\"RestoreTime\\": {\\n \\"EndTime\\": \\"1568636922671\\",\\n \\"StartTime\\": \\"1568632853000\\"\\n }\\n}","type":"json"}]',
'title' => 'Query restorable time of an instance',
'summary' => 'Queries the target time to which an instance can be restored by calling the DescribeBackupTimes operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupTimes'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeBackupTimes',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
],
'DescribeBroadcastTables' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '75974',
'abilityTreeNodes' => ['FEATUREdrdsTIBR6Q'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_db', 'title' => ''],
],
[
'name' => 'Query',
'in' => 'query',
'schema' => ['description' => 'The query content.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'tb1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '86E420ED-43F2-4788-A58C-921849******', 'title' => ''],
'Success' => ['description' => 'The request result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'IsShard' => ['description' => 'Indicates whether sharding is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''],
'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'List' => [
'description' => 'The list of broadcast tables.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The activation status of the broadcast table. Valid values:'."\n"
.'* **1**: activated'."\n"
.'* **2**: being activated'."\n"
.'* **3**: activation exception.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'IsShard' => ['description' => 'Indicates whether the table is a sharding table.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'Broadcast' => ['description' => 'Indicates whether the table is a broadcast table.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Table' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'nation', 'title' => ''],
'DbInstType' => ['description' => 'The database storage type. Valid values:'."\n"
.'* **0**: RDS'."\n"
.'* **4**: PolarDB.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'BroadcastType' => ['description' => 'The broadcast table type. Valid values:'."\n"
.'* **1**: multi-write pattern'."\n"
.'* **2**: synchronization mode.', 'type' => 'string', 'example' => '1', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query broadcast tables',
'summary' => 'Queries broadcast tables by calling the DescribeBroadcastTables operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBroadcastTables'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeBroadcastTables',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86E420ED-43F2-4788-A58C-921849******\\",\\n \\"Success\\": true,\\n \\"IsShard\\": true,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 40,\\n \\"Total\\": 2,\\n \\"List\\": [\\n {\\n \\"Status\\": 1,\\n \\"IsShard\\": false,\\n \\"Broadcast\\": true,\\n \\"Table\\": \\"nation\\",\\n \\"DbInstType\\": 0,\\n \\"BroadcastType\\": \\"1\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeDbInstanceDbs' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '75985',
'abilityTreeNodes' => ['FEATUREdrds8KEOBF'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance to which the storage-layer database belongs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************', 'title' => ''],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => ['description' => 'The name of the PolarDB-X privileged account. If no privileged account exists, leave this parameter empty. For more information about privileged accounts, see [Account management](https://help.aliyun.com/document_detail/98664.html).'."\n"
."\n"
.'The name of the DRDS privileged account. If no privileged account exists, leave this parameter empty..', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['description' => 'The password of the PolarDB-X privileged account. If no privileged account exists, leave this parameter empty. For more information about privileged accounts, see [Account management](https://help.aliyun.com/document_detail/98664.html).'."\n"
."\n"
.'The password of the DRDS privileged account. If no privileged account exists, leave this parameter empty..', 'type' => 'string', 'required' => false, 'example' => 'pwd_111111', 'title' => ''],
],
[
'name' => 'DbInstType',
'in' => 'query',
'schema' => ['description' => 'The database storage type. Valid values: **POLARDB** and **RDS**.', 'type' => 'string', 'required' => false, 'example' => 'POLARDB', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E9F3D991-08DE-4B74-BE0E-06B809******', 'title' => ''],
'Success' => ['description' => 'The request result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Total' => ['description' => 'The total number of databases.', 'type' => 'string', 'example' => '1', 'title' => ''],
'Databases' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Database' => [
'description' => 'The list of database details.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The database status. Valid values:'."\n"
.'* **0**: Being created.'."\n"
.'* **1**: Available.'."\n"
.'* **3**: Being deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'DbName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'db_test', 'title' => ''],
'Description' => ['description' => 'The database description.', 'type' => 'string', 'example' => 'test', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query databases under a target storage instance',
'summary' => 'Queries the list of databases under a target storage instance by calling the DescribeDbInstanceDbs operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDbInstanceDbs'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDbInstanceDbs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E9F3D991-08DE-4B74-BE0E-06B809******\\",\\n \\"Success\\": true,\\n \\"Total\\": \\"1\\",\\n \\"Databases\\": {\\n \\"Database\\": [\\n {\\n \\"Status\\": 1,\\n \\"DbName\\": \\"db_test\\",\\n \\"Description\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeDbInstances' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '75986',
'abilityTreeNodes' => ['FEATUREdrdsD0NTUP'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'Search',
'in' => 'query',
'schema' => ['description' => 'The instance ID or cluster ID of the storage layer instance.', 'type' => 'string', 'required' => false, 'example' => 'pc-***************', 'title' => ''],
],
[
'name' => 'DbInstType',
'in' => 'query',
'schema' => ['description' => 'The storage-layer type. Valid values: POLARDB and RDS.', 'type' => 'string', 'required' => false, 'default' => 'RDS', 'example' => 'POLARDB', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'example' => '10', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '293275B3-8FC0-4619-A26E-6F062FASD56R', 'title' => ''],
'Items' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DBInstance' => [
'description' => 'The list of instance details.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceNetworkType' => ['description' => 'The network type of the storage-layer instance. Valid values:'."\n"
."\n"
.'- **VPC**: virtual private cloud'."\n"
.'- **CLASSIC**: classic network.', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
'DBInstanceType' => ['description' => 'The type of the storage-layer instance.', 'type' => 'string', 'example' => 'Primary', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-a', 'title' => ''],
'DBInstanceStatus' => ['description' => 'The instance status of the storage layer instance. Valid values:'."\n"
."\n"
.'- **0**: Being created.'."\n"
.'- **1**: Running.'."\n"
.'- **3**: Being deleted.'."\n"
.'- **5**: Restarting.'."\n"
.'- **6**: Upgrading or downgrading.'."\n"
.'- **7**: Recovering.'."\n"
.'- **8**: Switching between internal and external networks.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID of the storage layer instance.', 'type' => 'string', 'example' => 'rm-****************', 'title' => ''],
'Engine' => ['description' => 'The engine of the storage-layer instance.', 'type' => 'string', 'example' => '存储层实例内核。', 'title' => ''],
'DBInstanceDescription' => ['description' => 'The description of the storage-layer instance.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'EngineVersion' => ['description' => 'The Milvus version of the storage layer instance kernel.', 'type' => 'string', 'example' => '5.7', 'title' => ''],
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'ReadOnlyDBInstanceId' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ReadOnlyDBInstanceId' => [
'description' => 'The read-only instances associated with the storage-layer instance.',
'type' => 'array',
'items' => ['description' => 'The read-only instances associated with the storage-layer instance.', 'type' => 'string', 'example' => '[]', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'AllowAllCategory' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', 'description' => ''],
['errorCode' => 'InvalidDbName.NotFound', 'errorMessage' => 'The Drds DbName provided does not exist in our records.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"293275B3-8FC0-4619-A26E-6F062FASD56R\\",\\n \\"Items\\": {\\n \\"DBInstance\\": [\\n {\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"DBInstanceType\\": \\"Primary\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"DBInstanceStatus\\": 0,\\n \\"DBInstanceId\\": \\"rm-****************\\",\\n \\"Engine\\": \\"存储层实例内核。\\",\\n \\"DBInstanceDescription\\": \\"test\\",\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ReadOnlyDBInstanceId\\": {\\n \\"ReadOnlyDBInstanceId\\": [\\n \\"[]\\"\\n ]\\n },\\n \\"AllowAllCategory\\": false\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => 'View storage-layer instance list',
'summary' => 'Queries the list of storage-layer instances, such as ApsaraDB RDS or PolarDB instances.',
'changeSet' => [
['createdAt' => '2024-04-24T14:28:57.000Z', 'description' => 'Response parameters changed, Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDbInstances'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDbInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId1}/*'],
],
],
],
],
],
'DescribeDrdsDB' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*********', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'db_test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '58FB0EC7-CF71-4E48-92FB-CF070D******', 'title' => ''],
'Data' => [
'description' => 'The database details.',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The database status. Valid values:'."\n"
.'* **TO_BE_INIT**: Being created.'."\n"
.'* **NORMAL**: Running.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''],
'DbName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'db_test', 'title' => ''],
'Schema' => ['description' => 'The physical name of the database.', 'type' => 'string', 'example' => 'db_test*******************', 'title' => ''],
'CreateTime' => ['description' => 'The time when the database was created. The value is a UNIX timestamp in milliseconds (ms).', 'type' => 'string', 'example' => '1602050276000', 'title' => ''],
'Mode' => ['description' => 'The partitioning mode of the database. Valid values:'."\n"
.'* **HORIZONTAL**: horizontal partitioning'."\n"
.'* **VERTICAL**: vertical partitioning.', 'type' => 'string', 'example' => 'HORIZONTAL', 'title' => ''],
'DbInstType' => ['description' => 'The storage type of the database.', 'type' => 'string', 'example' => 'RDS', 'title' => ''],
'InstRole' => ['description' => 'The type of the instance to which the database belongs. Valid values:'."\n"
.'* **MASTER**: primary instance'."\n"
.'* **SLAVE**: read-only instance.', 'type' => 'string', 'example' => 'MASTER', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidDbName.NotFound', 'errorMessage' => 'The Drds DbName provided does not exist in our records.', 'description' => ''],
],
],
'title' => 'View database details of an instance',
'summary' => 'Queries the details of a database in an instance by calling the DescribeDrdsDB operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsDB'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsDB',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"58FB0EC7-CF71-4E48-92FB-CF070D******\\",\\n \\"Data\\": {\\n \\"Status\\": \\"NORMAL\\",\\n \\"DbName\\": \\"db_test\\",\\n \\"Schema\\": \\"db_test*******************\\",\\n \\"CreateTime\\": \\"1602050276000\\",\\n \\"Mode\\": \\"HORIZONTAL\\",\\n \\"DbInstType\\": \\"RDS\\",\\n \\"InstRole\\": \\"MASTER\\"\\n }\\n}","type":"json"}]',
],
'DescribeDrdsDBCluster' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '75988',
'abilityTreeNodes' => ['FEATUREdrdsDBGOD6'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds*********', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the DRDS database.', 'type' => 'string', 'required' => true, 'example' => 'drds_test', 'title' => ''],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the PolarDB cluster.', 'type' => 'string', 'required' => true, 'example' => 'pc-*****************', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '60A77FD6-0DE4-4A34-B6FB-9C2673******', 'title' => ''],
'DbInstance' => [
'description' => 'The information about the PolarDB instance.',
'type' => 'object',
'properties' => [
'ExpireTime' => ['description' => 'The expiration time of the PolarDB instance.', 'type' => 'string', 'example' => '2019-09-27 11:22:33', 'title' => ''],
'PayType' => ['description' => 'The billing method of the PolarDB instance.', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''],
'DBInstanceStatus' => ['description' => 'The instance status of the PolarDB instance.', 'type' => 'string', 'example' => '1', 'title' => ''],
'NetworkType' => ['description' => 'The network type of the PolarDB instance.', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
'Port' => ['description' => 'The access port of the PolarDB instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '3306', 'title' => ''],
'EngineVersion' => ['description' => 'The database engine version of the DRDS database storage DPI engine.', 'type' => 'string', 'example' => '8.0', 'title' => ''],
'RdsInstType' => ['description' => 'The RDS instance type. This parameter is not supported for PolarDB clusters.', 'type' => 'string', 'example' => 'ignore', 'title' => ''],
'RemainDays' => ['description' => 'The remaining days of the PolarDB instance.', 'type' => 'string', 'example' => '0', 'title' => ''],
'DBInstanceId' => ['description' => 'The ID of the PolarDB cluster.', 'type' => 'string', 'example' => 'pc-*****************', 'title' => ''],
'DbInstType' => ['description' => 'The storage type of the DRDS database.', 'type' => 'string', 'example' => 'POLARDB', 'title' => ''],
'Engine' => ['description' => 'The storage engine type of the DRDS database.', 'type' => 'string', 'example' => 'POLARDB', 'title' => ''],
'ReadMode' => ['description' => 'The read traffic configuration mode of DRDS when the database storage type is PolarDB.'."\n"
."\n"
.'Valid values:'."\n"
.'* **DEFAULT**: Default mode. All read traffic is sent to the PolarDB read/write node.'."\n"
.'* **CUSTOM**: Custom mode. You can customize the traffic ratio between the read/write node and read-only nodes.'."\n"
.'* **BALANCE**: Read balancing mode. Read traffic is automatically distributed by the read load balancing module of the PolarDB cluster, which means read traffic is evenly distributed across all nodes.', 'type' => 'string', 'example' => 'CUSTOM', 'title' => ''],
'Endpoints' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Endpoint' => [
'description' => 'The read/write splitting connection endpoint of the PolarDB instance managed by DRDS.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ReadWeight' => ['description' => 'The read weight of the endpoint managed by the DRDS database.', 'type' => 'integer', 'format' => 'int32', 'example' => '85', 'title' => ''],
'EndpointId' => ['description' => 'The ID of the PolarDB endpoint.', 'type' => 'string', 'example' => 'pe-*****************', 'title' => ''],
'NodeIds' => ['description' => 'The list of node IDs associated with the PolarDB endpoint. Multiple node IDs are separated by commas (,).', 'type' => 'string', 'example' => 'pi-*****************,pi-*****************', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'DBNodes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DBNode' => [
'description' => 'The node information in the PolarDB cluster.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DBNodeRole' => ['description' => 'The role of the node in the PolarDB cluster. Valid values:'."\n"
.'* **Reader**'."\n"
.'* **Writer**.', 'type' => 'string', 'example' => 'Reader', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID of the PolarDB cluster node.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''],
'DBNodeId' => ['description' => 'The ID of the node in the PolarDB cluster.', 'type' => 'string', 'example' => 'pi-***************', 'title' => ''],
'DBNodeStatus' => ['description' => 'The status of the PolarDB cluster node.', 'type' => 'string', 'example' => 'Running', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter.MasterDbInstanceRelease', 'errorMessage' => 'The master db instance has been released', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query polarDB cluster details in a logical database',
'summary' => 'Queries the details of a PolarDB cluster in a DRDS logical database.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsDBCluster'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsDBCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"60A77FD6-0DE4-4A34-B6FB-9C2673******\\",\\n \\"DbInstance\\": {\\n \\"ExpireTime\\": \\"2019-09-27 11:22:33\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"DBInstanceStatus\\": \\"1\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"Port\\": 3306,\\n \\"EngineVersion\\": \\"8.0\\",\\n \\"RdsInstType\\": \\"ignore\\",\\n \\"RemainDays\\": \\"0\\",\\n \\"DBInstanceId\\": \\"pc-*****************\\",\\n \\"DbInstType\\": \\"POLARDB\\",\\n \\"Engine\\": \\"POLARDB\\",\\n \\"ReadMode\\": \\"CUSTOM\\",\\n \\"Endpoints\\": {\\n \\"Endpoint\\": [\\n {\\n \\"ReadWeight\\": 85,\\n \\"EndpointId\\": \\"pe-*****************\\",\\n \\"NodeIds\\": \\"pi-*****************,pi-*****************\\"\\n }\\n ]\\n },\\n \\"DBNodes\\": {\\n \\"DBNode\\": [\\n {\\n \\"DBNodeRole\\": \\"Reader\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"DBNodeId\\": \\"pi-***************\\",\\n \\"DBNodeStatus\\": \\"Running\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
],
'DescribeDrdsDBIpWhiteList' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds********', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'test_db', 'title' => ''],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => 'The name of the whitelist group.', 'type' => 'string', 'required' => false, 'example' => 'group1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '017453B9-0001-4745-87BF-DD612D850ED0', 'title' => ''],
'IpWhiteList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Ip' => [
'type' => 'array',
'items' => ['description' => 'The IP whitelist.', 'type' => 'string', 'example' => '10.23.***.***,10.23.***.***/24', 'title' => ''],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', 'description' => ''],
['errorCode' => 'InvalidDbName.NotFound', 'errorMessage' => 'The Drds DbName provided does not exist in our records.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query IP whitelist',
'summary' => 'Queries the IP whitelist of a specified database.',
'changeSet' => [
['createdAt' => '2022-09-16T07:08:49.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-09-16T07:08:49.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsDBIpWhiteList'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsDBIpWhiteList',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"017453B9-0001-4745-87BF-DD612D850ED0\\",\\n \\"IpWhiteList\\": {\\n \\"Ip\\": [\\n \\"10.23.***.***,10.23.***.***/24\\"\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeDrdsDBs' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdshbga1138****', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page. Valid values: **30**, **50**, and **100**.'."\n"
."\n"
.'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1000', 'example' => '30', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'string', 'example' => '30', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '006B7D19-8CDB-4AA6-AAE7-23C107GS3W2T', 'title' => ''],
'Total' => ['description' => 'The total number of databases.', 'type' => 'string', 'example' => '1', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Db' => [
'description' => 'The list of databases.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The database status.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''],
'DbName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'drds_test', 'title' => ''],
'Schema' => ['description' => 'The schema ID assigned by the system to the database after sharding.', 'type' => 'string', 'example' => 'drds_test_1563773871118kxqd', 'title' => ''],
'CreateTime' => ['description' => 'The time when the database was created. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'string', 'example' => '1563773824000', 'title' => ''],
'Mode' => ['description' => 'The sharding mode of the database. Valid values:'."\n"
.'* **HORIZONTAL**: horizontal partitioning'."\n"
.'* **VERTICAL**: vertical partitioning.', 'type' => 'string', 'example' => 'HORIZONTAL', 'title' => ''],
'DbInstType' => ['description' => 'The database type. Valid values: **RDS** and **POLARDB**.', 'type' => 'string', 'example' => 'RDS', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query databases in an instance',
'summary' => 'Queries the details of databases in a specified instance by calling the DescribeDrdsDBs operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-04-07T07:54:00.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-12-07T03:49:24.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsDBs'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsDBs',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": \\"30\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"RequestId\\": \\"006B7D19-8CDB-4AA6-AAE7-23C107GS3W2T\\",\\n \\"Total\\": \\"1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Db\\": [\\n {\\n \\"Status\\": \\"NORMAL\\",\\n \\"DbName\\": \\"drds_test\\",\\n \\"Schema\\": \\"drds_test_1563773871118kxqd\\",\\n \\"CreateTime\\": \\"1563773824000\\",\\n \\"Mode\\": \\"HORIZONTAL\\",\\n \\"DbInstType\\": \\"RDS\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeDrdsDbInstance' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '75989',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => true, 'example' => 'drdshbga1138****', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'drds_test', 'title' => ''],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the custom ApsaraDB RDS instance.', 'type' => 'string', 'required' => true, 'example' => 'rm-bp1t1mk5a5bdj****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4FE09970-CA69-4144-88CA-67FB4BTY56G3', 'title' => ''],
'DbInstance' => [
'description' => 'The details of the custom ApsaraDB RDS instance.',
'type' => 'object',
'properties' => [
'ExpireTime' => ['description' => 'The expiration time of the instance. The value is a UNIX timestamp. Unit: seconds.'."\n"
.'>This parameter is supported only for subscription instances.', 'type' => 'string', 'example' => '12341434315', 'title' => ''],
'PayType' => ['description' => 'The billing method of the instance. Valid values:'."\n"
."\n"
.'- **Prepaid**: subscription.'."\n"
.'- **Postaid**: pay-as-you-go.', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''],
'DBInstanceStatus' => ['description' => 'The instance status.', 'type' => 'string', 'example' => '1', 'title' => ''],
'NetworkType' => ['description' => 'The network type of the instance. Currently, only **VPC** is supported.', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
'Port' => ['description' => 'The port used to access the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '3306', 'title' => ''],
'EngineVersion' => ['description' => 'The database engine version of the instance. Currently, only version **5.7** is supported.', 'type' => 'string', 'example' => '5.7', 'title' => ''],
'DmInstanceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'dm-*************', 'title' => ''],
'ConnectUrl' => ['description' => 'The endpoint of the custom ApsaraDB RDS instance.', 'type' => 'string', 'example' => 'rm-***************.mysql.rds.aliyuncs.com', 'title' => ''],
'ReadWeight' => ['description' => 'The read ratio of the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '70', 'title' => ''],
'RdsInstType' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'RDS', 'title' => ''],
'RemainDays' => ['description' => 'The number of remaining days before the instance expires.', 'type' => 'string', 'example' => '0', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID of the custom ApsaraDB RDS instance.', 'type' => 'string', 'example' => 'rm-***************', 'title' => ''],
'DbInstType' => ['description' => 'The instance type. Valid values:'."\n"
."\n"
.'- **Primary**: primary instance.'."\n"
.'- **ReadOnly**: read-only instance.', 'type' => 'string', 'example' => 'Primary', 'title' => ''],
'Engine' => ['description' => 'The database engine. Currently, only **MySQL** is supported.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'ReadOnlyInstances' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ReadOnlyInstance' => [
'description' => 'The list of read-only instances.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ExpireTime' => ['description' => 'The expiration timestamp of the instance.', 'type' => 'string', 'example' => '1823487328173', 'title' => ''],
'PayType' => ['description' => 'The billing method of the instance.', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''],
'VersionAction' => ['description' => 'An invalid field.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'DBInstanceStatus' => ['description' => 'The instance status.', 'type' => 'string', 'example' => '1', 'title' => ''],
'NetworkType' => ['description' => 'The network type of the instance.', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
'Port' => ['description' => 'The port used to access the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '3306', 'title' => ''],
'EngineVersion' => ['description' => 'The database engine version of the instance.', 'type' => 'string', 'example' => '5.7', 'title' => ''],
'DmInstanceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'dm-*************', 'title' => ''],
'ConnectUrl' => ['description' => 'The endpoint of the read-only instance.', 'type' => 'string', 'example' => 'rm-bp1ub71ct9skc3yxx.mysql.rds.aliyuncs.com', 'title' => ''],
'ReadWeight' => ['description' => 'The read ratio of the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'RdsInstType' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'RDS', 'title' => ''],
'RemainDays' => ['description' => 'The number of remaining days before the instance expires.', 'type' => 'string', 'example' => '0', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID of the read-only instance.', 'type' => 'string', 'example' => 'rm-bp1ub71ct9skc****', 'title' => ''],
'DbInstType' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'RDS', 'title' => ''],
'Engine' => ['description' => 'The database engine of the instance.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter.MasterDbInstanceRelease', 'errorMessage' => 'The master db instance has been released', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query RDS storage instance details',
'summary' => 'Queries the details of an ApsaraDB RDS storage instance for a DRDS instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsDbInstance'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsDbInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"4FE09970-CA69-4144-88CA-67FB4BTY56G3\\",\\n \\"DbInstance\\": {\\n \\"ExpireTime\\": \\"12341434315\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"DBInstanceStatus\\": \\"1\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"Port\\": 3306,\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"DmInstanceId\\": \\"dm-*************\\",\\n \\"ConnectUrl\\": \\"rm-***************.mysql.rds.aliyuncs.com\\",\\n \\"ReadWeight\\": 70,\\n \\"RdsInstType\\": \\"RDS\\",\\n \\"RemainDays\\": \\"0\\",\\n \\"DBInstanceId\\": \\"rm-***************\\",\\n \\"DbInstType\\": \\"Primary\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"ReadOnlyInstances\\": {\\n \\"ReadOnlyInstance\\": [\\n {\\n \\"ExpireTime\\": \\"1823487328173\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"VersionAction\\": 0,\\n \\"DBInstanceStatus\\": \\"1\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"Port\\": 3306,\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"DmInstanceId\\": \\"dm-*************\\",\\n \\"ConnectUrl\\": \\"rm-bp1ub71ct9skc3yxx.mysql.rds.aliyuncs.com\\",\\n \\"ReadWeight\\": 30,\\n \\"RdsInstType\\": \\"RDS\\",\\n \\"RemainDays\\": \\"0\\",\\n \\"DBInstanceId\\": \\"rm-bp1ub71ct9skc****\\",\\n \\"DbInstType\\": \\"RDS\\",\\n \\"Engine\\": \\"MySQL\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
],
'DescribeDrdsDbInstances' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drdshbga1138****', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'dbname', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '20', 'example' => '30', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => ['description' => 'The page size.', 'type' => 'string', 'example' => '10', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2F7F8080-9132-4279-85D0-B7E5C4305162', 'title' => ''],
'Total' => ['description' => 'The total number of primary RDS instances.', 'type' => 'string', 'example' => '1', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'DbInstances' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DbInstance' => [
'description' => 'The list of storage instances associated with the database.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ExpireTime' => ['description' => 'The expiration time of the storage instance.', 'type' => 'string', 'example' => '1237486127634', 'title' => ''],
'PayType' => ['description' => 'The billing method.', 'type' => 'string', 'example' => 'PostPaid', 'title' => ''],
'DBInstanceStatus' => ['description' => '- 0: Creating.'."\n"
.'- 1: Running.'."\n"
.'- 3: Being deleted.'."\n"
.'- 5: Restarting.'."\n"
.'- 6: Upgrading or downgrading.'."\n"
.'- 7: Backup in progress.'."\n"
.'- 8: Switching between internal and external networks.'."\n"
.'- 9: Instance migration in progress.'."\n"
.'- 11: Migrating data.'."\n"
.'- 12: Creating a disaster recovery instance.'."\n"
.'- 13: Data import in progress.'."\n"
.'- 14: Importing data from another RDS instance.'."\n"
.'- 15: Performing a disaster recovery switchover.'."\n"
.'- 16: Creating a temporary instance.'."\n"
.'- 17: Creating a network.'."\n"
.'- 18: Cloning an instance.'."\n"
.'- 19: Switching links.'."\n"
.'- 20: Read-only instance migration in progress.', 'type' => 'string', 'example' => '1', 'title' => ''],
'NetworkType' => ['description' => 'The network type.', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
'Port' => ['description' => 'The port.', 'type' => 'integer', 'format' => 'int32', 'example' => '3306', 'title' => ''],
'EngineVersion' => ['description' => 'The storage engine version, such as 5.7, 5.6, or 5.5 for RDS for MySQL.', 'type' => 'string', 'example' => '5.7', 'title' => ''],
'DmInstanceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'dm-hbgau1zp****', 'title' => ''],
'ConnectUrl' => ['description' => 'The connection URL of the storage instance, which is the connection address returned by the corresponding storage service (such as RDS).', 'type' => 'string', 'example' => 'rm-bp1t1mk5a5b******.mysql.rds.aliyuncs.com', 'title' => ''],
'ReadWeight' => ['description' => 'The read weight of the instance in the database.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'RdsInstType' => ['description' => 'The type of the RDS instance, which indicates whether it is a primary instance or a read-only instance.', 'type' => 'string', 'example' => 'Primary', 'title' => ''],
'RemainDays' => ['description' => 'The number of remaining days before the subscription instance expires.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'DBInstanceId' => ['description' => 'The storage instance ID.', 'type' => 'string', 'example' => 'rm-bp1t1mk5a5bdj****', 'title' => ''],
'DbInstType' => ['description' => 'The storage instance type. Only RDS is supported.', 'type' => 'string', 'example' => 'RDS', 'title' => ''],
'Engine' => ['description' => 'The storage engine, such as MySQL for RDS.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'ReadOnlyInstances' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ReadOnlyInstance' => [
'description' => 'The list of read-only instances associated with the storage instance.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ExpireTime' => ['description' => 'The expiration timestamp of the storage instance.', 'type' => 'string', 'example' => '123421352351234', 'title' => ''],
'PayType' => ['description' => 'The billing method.', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''],
'DBInstanceStatus' => ['description' => 'The instance status.', 'type' => 'string', 'example' => '1', 'title' => ''],
'NetworkType' => ['description' => 'The network type of the instance.', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
'Port' => ['description' => 'The access port of the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '3306', 'title' => ''],
'EngineVersion' => ['description' => 'The storage engine version of the instance.', 'type' => 'string', 'example' => '5.7', 'title' => ''],
'DmInstanceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'dm-hbgau1zp****', 'title' => ''],
'ConnectUrl' => ['description' => 'The connection URL of the storage instance, which is the connection address returned by the corresponding storage service (such as RDS).', 'type' => 'string', 'example' => 'rm-bp1t1mk5a5b******.mysql.rds.aliyuncs.com', 'title' => ''],
'ReadWeight' => ['description' => 'The read weight of the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '70', 'title' => ''],
'RdsInstType' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'RDS', 'title' => ''],
'InstanceName' => ['description' => 'A reserved field.', 'type' => 'string', 'example' => '**', 'title' => ''],
'RemainDays' => ['description' => 'The number of remaining days before the instance expires.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'DbInstType' => ['description' => 'The storage instance type.', 'type' => 'string', 'example' => 'RDS', 'title' => ''],
'Engine' => ['description' => 'The storage engine of the instance.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query RDS instances of a database',
'summary' => 'Queries the list of ApsaraDB RDS instances associated with a DRDS database.',
'description' => 'Queries the list of primary ApsaraDB RDS instances associated with a DRDS database. The ReadOnlyInstances property of each primary RDS instance contains the list of read-only instances used by the current database.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsDbInstances'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsDbInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"RequestId\\": \\"2F7F8080-9132-4279-85D0-B7E5C4305162\\",\\n \\"Total\\": \\"1\\",\\n \\"Success\\": true,\\n \\"DbInstances\\": {\\n \\"DbInstance\\": [\\n {\\n \\"ExpireTime\\": \\"1237486127634\\",\\n \\"PayType\\": \\"PostPaid\\",\\n \\"DBInstanceStatus\\": \\"1\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"Port\\": 3306,\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"DmInstanceId\\": \\"dm-hbgau1zp****\\",\\n \\"ConnectUrl\\": \\"rm-bp1t1mk5a5b******.mysql.rds.aliyuncs.com\\",\\n \\"ReadWeight\\": 30,\\n \\"RdsInstType\\": \\"Primary\\",\\n \\"RemainDays\\": 0,\\n \\"DBInstanceId\\": \\"rm-bp1t1mk5a5bdj****\\",\\n \\"DbInstType\\": \\"RDS\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"ReadOnlyInstances\\": {\\n \\"ReadOnlyInstance\\": [\\n {\\n \\"ExpireTime\\": \\"123421352351234\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"DBInstanceStatus\\": \\"1\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"Port\\": 3306,\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"DmInstanceId\\": \\"dm-hbgau1zp****\\",\\n \\"ConnectUrl\\": \\"rm-bp1t1mk5a5b******.mysql.rds.aliyuncs.com\\",\\n \\"ReadWeight\\": 70,\\n \\"RdsInstType\\": \\"RDS\\",\\n \\"InstanceName\\": \\"**\\",\\n \\"RemainDays\\": 0,\\n \\"DbInstType\\": \\"RDS\\",\\n \\"Engine\\": \\"MySQL\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeDrdsDbRdsNameList' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true, 'default' => 'center', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drdsxxxxxxxxxxx', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'drds_test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7E6FA2BF-05F2-44DD-95C0-D1B5B8xxxxxx', 'title' => ''],
'InstanceNameList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'InstanceName' => [
'type' => 'array',
'items' => ['description' => 'The list of storage instance IDs.', 'type' => 'string', 'example' => 'rm-bpxxxxxxxxxxxxxxx', 'title' => ''],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query DRDS database storage instance list',
'summary' => 'Queries the list of storage instances by calling the DescribeDrdsDbRdsNameList operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-09-09T09:17:04.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsDbRdsNameList'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsDbRdsNameList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"7E6FA2BF-05F2-44DD-95C0-D1B5B8xxxxxx\\",\\n \\"InstanceNameList\\": {\\n \\"InstanceName\\": [\\n \\"rm-bpxxxxxxxxxxxxxxx\\"\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeDrdsInstance' => [
'summary' => 'Queries the details of a DRDS instance.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '76000',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdshbga1138****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B4F76641-BA45-4320-BE7C-9C62CFDAC9B2', 'title' => ''],
'Data' => [
'description' => 'The instance details.',
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The instance type. Valid values: PRIVATE (dedicated instance) and PUBLIC (shared instance).', 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''],
'Status' => ['description' => 'The instance status.', 'type' => 'string', 'example' => 'RUN', 'title' => ''],
'CreateTime' => ['description' => 'The timestamp when the instance was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1568620311000', 'title' => ''],
'VersionAction' => ['description' => 'The available action for the instance version.', 'type' => 'string', 'example' => 'Upgradeable', 'title' => ''],
'StorageType' => ['description' => 'The storage type of the instance.', 'type' => 'string', 'example' => 'RDS', 'title' => ''],
'NetworkType' => ['description' => 'The network type. Valid values: CLASSIC (classic network) and VPC (VPC network).', 'type' => 'string', 'example' => 'CLASSIC', 'title' => ''],
'Label' => ['description' => 'The instance label. Valid values:'."\n"
."\n"
.'- **NORMAL**: standard instance.'."\n"
."\n"
.'- **HA**: high-availability instance.'."\n"
."\n"
.'- **VPC**: VPC instance.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''],
'MysqlVersion' => ['description' => 'The MySQL version supported by the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'InstanceSpec' => ['description' => 'The instance specification.', 'type' => 'string', 'example' => 'drds.sn2.4c16g.8C32G', 'title' => ''],
'VpcCloudInstanceId' => ['description' => 'The instance ID in the VPC cluster.', 'type' => 'string', 'example' => 'drdssen12****', 'title' => ''],
'Description' => ['description' => 'The instance description.', 'type' => 'string', 'example' => 'drds_test', 'title' => ''],
'Version' => ['description' => 'The instance version. The value is empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'ExpireDate' => ['description' => 'The timestamp when the instance expires.', 'type' => 'integer', 'format' => 'int64', 'example' => '4724323200000', 'title' => ''],
'MasterInstanceId' => ['description' => 'The primary instance ID.'."\n"
."\n"
.'> This parameter is returned only when the instance is a read-only instance.', 'type' => 'string', 'example' => 'drdssen1243as', 'title' => ''],
'CommodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'drdsPost', 'title' => ''],
'MachineType' => ['description' => 'The machine type of the instance. The value is fixed as **ecs**.', 'type' => 'string', 'example' => 'ecs', 'title' => ''],
'InstanceSeries' => ['description' => 'The instance specification series.', 'type' => 'string', 'example' => 'drds.sn2.4c16g', 'title' => ''],
'ProductVersion' => ['description' => 'The product version.', 'type' => 'string', 'example' => '5.3.*', 'title' => ''],
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'ResourceGroupId' => ['description' => 'The resource group ID. The value can be empty.', 'type' => 'string', 'example' => 'NULL', 'title' => ''],
'DrdsInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'drdssen1243as', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-e', 'title' => ''],
'InstRole' => ['description' => 'The instance role. Valid values:'."\n"
."\n"
.'- MASTER: primary instance.'."\n"
.'- SLAVE: analytical read-only instance.'."\n"
.'- SLAVE_FLOW: concurrent read-only instance.', 'type' => 'string', 'example' => 'MASTER', 'title' => ''],
'OrderInstanceId' => ['description' => 'The ID of the purchased instance.', 'type' => 'string', 'example' => 'drdssen12****', 'title' => ''],
'Vips' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Vip' => [
'description' => 'The VIP list.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The VIP type. Valid values: intranet (internal network) and internet (public network).', 'type' => 'string', 'example' => 'intranet', 'title' => ''],
'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp**********', 'title' => ''],
'VswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp***********', 'title' => ''],
'Dns' => ['description' => 'The domain name bound to the VIP.', 'type' => 'string', 'example' => 'drdssen1243as.drds.aliyuncs.com', 'title' => ''],
'Port' => ['description' => 'The port opened by the VIP.', 'type' => 'string', 'example' => '3306', 'title' => ''],
'ExpireDays' => ['description' => 'The remaining days before the VIP expires.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'RemoveWeight' => ['type' => 'boolean', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'ReadOnlyDBInstanceIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ReadOnlyDBInstanceId' => [
'description' => 'The list of read-only instance IDs.',
'type' => 'array',
'items' => ['description' => 'The list of read-only instance IDs.', 'type' => 'string', 'example' => 'drdssen12****', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', 'description' => ''],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', 'description' => ''],
['errorCode' => 'DrdsInstance.NotExists', 'errorMessage' => 'The DRDS instance does not exist.', 'description' => 'The DRDS instance does not exist.'],
],
],
'title' => 'Query DRDS instance details',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-06-10T03:11:23.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-02-26T03:00:36.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsInstance'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B4F76641-BA45-4320-BE7C-9C62CFDAC9B2\\",\\n \\"Data\\": {\\n \\"Type\\": \\"PRIVATE\\",\\n \\"Status\\": \\"RUN\\",\\n \\"CreateTime\\": 1568620311000,\\n \\"VersionAction\\": \\"Upgradeable\\",\\n \\"StorageType\\": \\"RDS\\",\\n \\"NetworkType\\": \\"CLASSIC\\",\\n \\"Label\\": \\"NORMAL\\",\\n \\"MysqlVersion\\": 5,\\n \\"InstanceSpec\\": \\"drds.sn2.4c16g.8C32G\\",\\n \\"VpcCloudInstanceId\\": \\"drdssen12****\\",\\n \\"Description\\": \\"drds_test\\",\\n \\"Version\\": 0,\\n \\"ExpireDate\\": 4724323200000,\\n \\"MasterInstanceId\\": \\"drdssen1243as\\",\\n \\"CommodityCode\\": \\"drdsPost\\",\\n \\"MachineType\\": \\"ecs\\",\\n \\"InstanceSeries\\": \\"drds.sn2.4c16g\\",\\n \\"ProductVersion\\": \\"5.3.*\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceGroupId\\": \\"NULL\\",\\n \\"DrdsInstanceId\\": \\"drdssen1243as\\",\\n \\"ZoneId\\": \\"cn-hangzhou-e\\",\\n \\"InstRole\\": \\"MASTER\\",\\n \\"OrderInstanceId\\": \\"drdssen12****\\",\\n \\"Vips\\": {\\n \\"Vip\\": [\\n {\\n \\"Type\\": \\"intranet\\",\\n \\"VpcId\\": \\"vpc-bp**********\\",\\n \\"VswitchId\\": \\"vsw-bp***********\\",\\n \\"Dns\\": \\"drdssen1243as.drds.aliyuncs.com\\",\\n \\"Port\\": \\"3306\\",\\n \\"ExpireDays\\": 0,\\n \\"RemoveWeight\\": false\\n }\\n ]\\n },\\n \\"ReadOnlyDBInstanceIds\\": {\\n \\"ReadOnlyDBInstanceId\\": [\\n \\"drdssen12****\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
],
'DescribeDrdsInstanceDbMonitor' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'Instance ID of the PolarDB-X instance.'."\n"
."\n"
.'Instance ID of the DRDS instance..', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*************', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds_test', 'title' => ''],
],
[
'name' => 'Key',
'in' => 'query',
'schema' => ['description' => 'The performance monitoring metrics. You can specify multiple metrics in a single request. Separate multiple metrics with commas (,).'."\n"
.'>For more information about performance monitoring metrics, see [Database monitoring](~~186704~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'qps', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The start time. Specify a UNIX timestamp in UTC. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1603162800000', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end time. Specify a UNIX timestamp in UTC. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1603166400000', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2F7F8080-9132-4279-85D0-B7E5C4******', 'title' => ''],
'Data' => [
'description' => 'The list of monitoring data.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The name of the monitoring metrics.', 'type' => 'string', 'example' => 'qps', 'title' => ''],
'Unit' => ['description' => 'The unit of the monitoring metrics.', 'type' => 'string', 'example' => 'qps', 'title' => ''],
'Values' => [
'description' => 'The details of the monitoring data values.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Date' => ['description' => 'The point in time when the monitoring data value was collected. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1603162805000', 'title' => ''],
'Value' => ['description' => 'The data value.', 'type' => 'string', 'example' => '0', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', 'description' => ''],
['errorCode' => 'InvalidParameter.Mismatch', 'errorMessage' => 'Invalid parameter of key', 'description' => ''],
['errorCode' => 'InvalidParameter.time', 'errorMessage' => 'The startTime and endTime must in one week', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidDbName.NotFound', 'errorMessage' => 'The DrdsInstanceId or DbName provided does not exist in our records.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query performance monitoring data of a database',
'summary' => 'Calls the DescribeDrdsInstanceDbMonitor operation to query performance monitoring data of a database.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsInstanceDbMonitor'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsInstanceDbMonitor',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"2F7F8080-9132-4279-85D0-B7E5C4******\\",\\n \\"Data\\": [\\n {\\n \\"Key\\": \\"qps\\",\\n \\"Unit\\": \\"qps\\",\\n \\"Values\\": [\\n {\\n \\"Date\\": 1603162805000,\\n \\"Value\\": \\"0\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeDrdsInstanceLevelTasks' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drdssen12****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2F7F8080-9132-4279-85D0-B7E5C4305162', 'title' => ''],
'Tasks' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Task' => [
'description' => 'The list of incomplete tasks.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TaskType' => ['description' => 'The task type.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''],
'TaskPhase' => ['description' => 'The task phase.', 'type' => 'string', 'example' => '1', 'title' => ''],
'Progress' => ['description' => 'The task progress. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '99', 'title' => ''],
'AllowCancel' => ['description' => 'Indicates whether the task can be canceled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'TaskStatus' => ['description' => 'The task status. Valid values:'."\n"
.'- 0: running.'."\n"
.'- 1: succeeded.'."\n"
.'- 2: failed.'."\n"
.'- 3: canceled.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'ShowProgress' => ['description' => 'Indicates whether the progress is displayed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'TaskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'upgrade_instance', 'title' => ''],
'ProgressDescription' => ['description' => 'The progress description.', 'type' => 'string', 'example' => '正在执行', 'title' => ''],
'GmtCreate' => ['description' => 'The timestamp when the task was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1568705520000', 'title' => ''],
'TargetId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12312', 'title' => ''],
'ErrMsg' => ['description' => 'The error message of the task.', 'type' => 'string', 'example' => '实例状态异常', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query incomplete tasks of a DRDS instance',
'summary' => 'Queries incomplete tasks in a DRDS instance by calling the DescribeDrdsInstanceLevelTasks operation.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsInstanceLevelTasks'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsInstanceLevelTasks',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"2F7F8080-9132-4279-85D0-B7E5C4305162\\",\\n \\"Tasks\\": {\\n \\"Task\\": [\\n {\\n \\"TaskType\\": 11,\\n \\"TaskPhase\\": \\"1\\",\\n \\"Progress\\": 99,\\n \\"AllowCancel\\": false,\\n \\"TaskStatus\\": 0,\\n \\"ShowProgress\\": true,\\n \\"TaskName\\": \\"upgrade_instance\\",\\n \\"ProgressDescription\\": \\"正在执行\\",\\n \\"GmtCreate\\": 1568705520000,\\n \\"TargetId\\": 12312,\\n \\"ErrMsg\\": \\"实例状态异常\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeDrdsInstanceMonitor' => [
'summary' => 'Invokes the DescribeDrdsInstanceMonitor operation to query the details of instance monitoring data.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdrdsD0NTUP'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*********', 'title' => ''],
],
[
'name' => 'Key',
'in' => 'query',
'schema' => ['description' => 'The performance monitoring metrics. You can specify multiple metrics in a single request. Separate multiple metrics with commas (,).'."\n"
.'> For more information about performance monitoring metrics, see [Instance monitoring](~~186703~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cpu', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The start time of the query. Specify a UNIX timestamp in UTC. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1603123290000', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end time of the query. Specify a UNIX timestamp in UTC. Unit: milliseconds.'."\n"
."\n"
.'> If the query time range is less than 1 hour, the data within 1 hour before the end time is returned.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1603209690000', 'title' => ''],
],
[
'name' => 'PeriodMultiple',
'in' => 'query',
'schema' => ['description' => 'The multiplier for the monitoring data collection period. For example, the default data collection period for each resource monitoring metric is 1 minute. If you set the period multiplier to 2, the data collection period for the current resource monitoring metric is 2 minutes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '1', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2F7F8080-9132-4279-85D0-B7E5C4', 'title' => ''],
'Data' => [
'description' => 'The query result set.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The name of the monitoring metrics.', 'type' => 'string', 'example' => 'cpu', 'title' => ''],
'Unit' => ['description' => 'The unit of the monitoring metrics.', 'type' => 'string', 'example' => '%', 'title' => ''],
'NodeNum' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Values' => [
'description' => 'The details of the monitoring metrics data.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Date' => ['description' => 'The point in time when the monitoring metrics value was collected. The value is in the format of a UNIX timestamp in UTC. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1603163400000', 'title' => ''],
'Value' => ['description' => 'The value of the monitoring metrics.', 'type' => 'string', 'example' => '1.40', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', 'description' => ''],
['errorCode' => 'InvalidParameter.Mismatch', 'errorMessage' => 'Invalid parameter of key', 'description' => ''],
['errorCode' => 'InvalidParameter.time', 'errorMessage' => 'The startTime and endTime must in one week', 'description' => ''],
['errorCode' => 'InvalidParameter.periodMultiple', 'errorMessage' => 'The periodMultiple is too larger than the time between startTime and endTime', 'description' => ''],
['errorCode' => 'DrdsInstance.NotExists', 'errorMessage' => 'The drds instance does not exist.', 'description' => ''],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'invalid parameter.', 'description' => 'Parameter exception'],
],
404 => [
['errorCode' => 'Monitor.QueryRdsFailure', 'errorMessage' => 'Failed to query RDS monitor info.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query instance monitoring data',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-04-24T03:47:11.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsInstanceMonitor'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsInstanceMonitor',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2F7F8080-9132-4279-85D0-B7E5C4\\",\\n \\"Data\\": [\\n {\\n \\"Key\\": \\"cpu\\",\\n \\"Unit\\": \\"%\\",\\n \\"NodeNum\\": 1,\\n \\"Values\\": [\\n {\\n \\"Date\\": 1603163400000,\\n \\"Value\\": \\"1.40\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeDrdsInstanceVersion' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdshbga1138****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2F7F8080-9132-4279-85D0-B7E5C4305162', 'title' => ''],
'Data' => [
'description' => 'The instance version details.',
'type' => 'object',
'properties' => [
'NewestVersion' => ['description' => 'The latest instance version.', 'type' => 'string', 'example' => '5.4.12-16315258', 'title' => ''],
'InstanceVersion' => ['description' => 'The current instance version.', 'type' => 'string', 'example' => '5.3.12-15682777', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'View instance version',
'summary' => 'Queries the version of a DRDS instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsInstanceVersion'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsInstanceVersion',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"2F7F8080-9132-4279-85D0-B7E5C4305162\\",\\n \\"Data\\": {\\n \\"NewestVersion\\": \\"5.4.12-16315258\\",\\n \\"InstanceVersion\\": \\"5.3.12-15682777\\"\\n }\\n}","type":"json"}]',
],
'DescribeDrdsInstances' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '76004',
'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'],
],
'parameters' => [
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => 'The instance type. Valid values:'."\n"
.'- **0**: shared instance'."\n"
.'- **1**: dedicated instance.',
'type' => 'string',
'enum' => ['PRIVATE', 'PUBLIC', '1', '0'],
'required' => false,
'example' => '1',
'title' => '',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the instance.', 'type' => 'string', 'required' => false, 'example' => 'drds_test', 'title' => ''],
],
[
'name' => 'Expired',
'in' => 'query',
'schema' => ['description' => 'Specifies whether the instance has expired.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'default' => '20', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID. This parameter can be left empty.', 'type' => 'string', 'required' => false, 'example' => 'NULL', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => 'The region ID.',
'type' => 'string',
'required' => true,
'enum' => [
'cn-shenzhen', 'cn-beijing', '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', 'cn-huhehaote', 'us-east-1', 'cn-zhangjiakou', 'cn-hangzhou', 'us-west-1', 'cn-wulanchabu', 'eu-central-1', 'ap-southeast-5', 'cn-zhengzhou-jva', 'ap-northeast-1',
'cn-shanghai-cloudspe', 'ap-southeast-6', 'ap-southeast-7',
],
'example' => 'cn-hangzhou',
'title' => '',
],
],
[
'name' => 'Mix',
'in' => 'query',
'schema' => ['description' => 'Specifies whether hybrid queries are supported.', 'type' => 'boolean', 'required' => false, 'example' => 'FALSE', 'title' => ''],
],
[
'name' => 'ProductVersion',
'in' => 'query',
'schema' => ['description' => 'The Edition version number. Valid values: V1 and V2.', 'type' => 'string', 'required' => false, 'example' => 'V1', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of tag properties.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'acs:newretail:domain', 'title' => ''],
'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'NEW_RETAIL', 'title' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 50,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8734773E-7B21-4A22-9106-CBD245F8****', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'Total' => ['description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Instances' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Instance' => [
'description' => 'The list of instances.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'VpcId' => ['description' => 'The virtual private network ID.', 'type' => 'string', 'example' => 'vpc-bp**********', 'title' => ''],
'Status' => ['description' => 'The instance status.', 'type' => 'string', 'example' => 'RUN', 'title' => ''],
'Type' => ['description' => 'The instance type. Valid values:'."\n"
.'- **PUBLIC**: shared instance'."\n"
.'- **PRIVATE**: dedicated instance.', 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''],
'CommodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'drdsPost', 'title' => ''],
'MachineType' => ['description' => 'The machine type of the instance. Only ecs is supported.', 'type' => 'string', 'example' => 'ecs', 'title' => ''],
'CreateTime' => ['description' => 'The creation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1568620311000', 'title' => ''],
'VersionAction' => ['description' => 'The available actions for the instance version.', 'type' => 'string', 'example' => 'Upgradable', 'title' => ''],
'InstanceSeries' => ['description' => 'The instance specification series.', 'type' => 'string', 'example' => 'drds.sn2.4c16g', 'title' => ''],
'NetworkType' => ['description' => 'The network type. Valid values:'."\n"
.'- **CLASSIC**: classic network'."\n"
.'- **VPC**: VPC.', 'type' => 'string', 'example' => 'CLASSIC', 'title' => ''],
'Label' => ['description' => 'The instance label. Valid values:'."\n"
."\n"
.'- **NORMAL**: active instance'."\n"
."\n"
.'- **HA**: high availability (HA) instance'."\n"
."\n"
.'- **VPC**: VPC-connected instance.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''],
'ProductVersion' => ['description' => 'The Edition version number.', 'type' => 'string', 'example' => 'V1', 'title' => ''],
'InstanceSpec' => ['description' => 'The instance specifications.', 'type' => 'string', 'example' => 'drds.sn2.4c16g.8C32G', 'title' => ''],
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou-e', 'title' => ''],
'VpcCloudInstanceId' => ['description' => 'The instance ID in the VPC cluster.', 'type' => 'string', 'example' => 'drdssen12****', 'title' => ''],
'Description' => ['description' => 'The instance description.', 'type' => 'string', 'example' => 'drds_test', 'title' => ''],
'Version' => ['description' => 'The instance version.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-aek2ljh3ye4****', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'vsw-bpxxxxxxxxxxxxx96', 'title' => ''],
'DrdsInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'drdssen12****', 'title' => ''],
'ExpireDate' => ['description' => 'The expiration timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '4724323200000', 'title' => ''],
'MasterInstanceId' => ['description' => 'The primary instance ID.', 'type' => 'string', 'example' => 'drdssen12****', 'title' => ''],
'OrderInstanceId' => ['description' => 'The purchased instance ID.', 'type' => 'string', 'example' => 'drdssen12****', 'title' => ''],
'InstRole' => ['description' => 'The instance role. Valid values:'."\n"
.'- **MASTER**: primary instance'."\n"
.'- **SLAVE**: analytical read-only instance'."\n"
.'- **SLAVE_FLOW**: concurrent read-only instance.', 'type' => 'string', 'example' => 'MASTER', 'title' => ''],
'Vips' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Vip' => [
'description' => 'The list of VIPs.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'VpcId' => ['description' => 'The virtual private network ID.', 'type' => 'string', 'example' => 'vpc-bpxxxxxxxxxxxy', 'title' => ''],
'Type' => ['description' => 'The VIP type. Valid values:'."\n"
.'- **intranet**: internal network'."\n"
.'- **internet**: Internet.', 'type' => 'string', 'example' => 'intranet', 'title' => ''],
'VswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bpxxxxxxxxxxxxx96', 'title' => ''],
'Port' => ['description' => 'The open port of the VIP.', 'type' => 'string', 'example' => '3306', 'title' => ''],
'IP' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '10.23.***.***', 'title' => ''],
'dns' => ['description' => 'The domain name bound to the VIP.', 'type' => 'string', 'example' => 'drdssen1243as.drds.aliyuncs.com', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'ReadOnlyDBInstanceIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ReadOnlyDBInstanceId' => [
'type' => 'array',
'items' => ['description' => 'The list of read-only instance IDs.', 'type' => 'string', 'example' => 'drdssen12****', 'title' => ''],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'series' => ['description' => 'The instance edition. Valid values:'."\n"
."\n"
.'- **starter**: Starter Edition'."\n"
.'- **enterprise**: Enterprise Edition'."\n"
.'- **standard**: Standard Edition.', 'type' => 'string', 'example' => 'enterprise', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', 'description' => ''],
['errorCode' => 'ServiceUnable', 'errorMessage' => 'The service is not available now, please try again later', 'description' => ''],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The RegionId provided does not exist in our records.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query DRDS instances',
'summary' => 'Queries a list of DRDS instances by calling the DescribeDrdsInstances operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-11-24T17:16:12.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-12-25T02:26:57.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-12-24T13:37:06.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-04-10T08:05:27.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-04-10T07:51:08.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
['createdAt' => '2024-03-21T01:44:39.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-08-17T08:11:20.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2021-12-11T09:16:30.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsInstances'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8734773E-7B21-4A22-9106-CBD245F8****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 1,\\n \\"Instances\\": {\\n \\"Instance\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp**********\\",\\n \\"Status\\": \\"RUN\\",\\n \\"Type\\": \\"PRIVATE\\",\\n \\"CommodityCode\\": \\"drdsPost\\",\\n \\"MachineType\\": \\"ecs\\",\\n \\"CreateTime\\": 1568620311000,\\n \\"VersionAction\\": \\"Upgradable\\",\\n \\"InstanceSeries\\": \\"drds.sn2.4c16g\\",\\n \\"NetworkType\\": \\"CLASSIC\\",\\n \\"Label\\": \\"NORMAL\\",\\n \\"ProductVersion\\": \\"V1\\",\\n \\"InstanceSpec\\": \\"drds.sn2.4c16g.8C32G\\",\\n \\"RegionId\\": \\"cn-hangzhou-e\\",\\n \\"VpcCloudInstanceId\\": \\"drdssen12****\\",\\n \\"Description\\": \\"drds_test\\",\\n \\"Version\\": 0,\\n \\"ResourceGroupId\\": \\"rg-aek2ljh3ye4****\\",\\n \\"ZoneId\\": \\"vsw-bpxxxxxxxxxxxxx96\\",\\n \\"DrdsInstanceId\\": \\"drdssen12****\\",\\n \\"ExpireDate\\": 4724323200000,\\n \\"MasterInstanceId\\": \\"drdssen12****\\",\\n \\"OrderInstanceId\\": \\"drdssen12****\\",\\n \\"InstRole\\": \\"MASTER\\",\\n \\"Vips\\": {\\n \\"Vip\\": [\\n {\\n \\"VpcId\\": \\"vpc-bpxxxxxxxxxxxy\\",\\n \\"Type\\": \\"intranet\\",\\n \\"VswitchId\\": \\"vsw-bpxxxxxxxxxxxxx96\\",\\n \\"Port\\": \\"3306\\",\\n \\"IP\\": \\"10.23.***.***\\",\\n \\"dns\\": \\"drdssen1243as.drds.aliyuncs.com\\"\\n }\\n ]\\n },\\n \\"ReadOnlyDBInstanceIds\\": {\\n \\"ReadOnlyDBInstanceId\\": [\\n \\"drdssen12****\\"\\n ]\\n },\\n \\"series\\": \\"enterprise\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeDrdsParams' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '76006',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DescribeDrdsParams', 'title' => ''],
],
[
'name' => 'ParamLevel',
'in' => 'query',
'schema' => ['description' => 'The parameter level. Valid values:'."\n"
.'* **INSTANCE**: instance level'."\n"
.'* **DB**: database level.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'drds_test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the query was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2F7F8080-9132-4279-85D0-B7E5C4305162', 'title' => ''],
'List' => [
'description' => 'The parameter list.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ParamDefaultValue' => ['description' => 'The default value of the parameter.', 'type' => 'string', 'example' => '1000', 'title' => ''],
'ParamLevel' => ['description' => 'The parameter level.', 'type' => 'string', 'example' => 'INSTANCE', 'title' => ''],
'ParamName' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => '慢SQL阈值', 'title' => ''],
'ParamType' => ['description' => 'The parameter type.', 'type' => 'string', 'example' => 'CONFIG', 'title' => ''],
'ParamValue' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => '1000', 'title' => ''],
'NeedRestart' => ['description' => 'Indicates whether a restart is required.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ParamRanges' => ['description' => 'The valid value range of the parameter.', 'type' => 'string', 'example' => '[1000-900000]', 'title' => ''],
'DbName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'drds_test', 'title' => ''],
'ParamEnglishName' => ['description' => 'The English name of the parameter.', 'type' => 'string', 'example' => 'SLOW_SQL_TIME', 'title' => ''],
'ParamDesc' => ['description' => 'The parameter description.', 'type' => 'string', 'example' => '慢SQL阈值(单位:ms)', 'title' => ''],
'ParamVariableName' => ['description' => 'The variable name of the parameter.', 'type' => 'string', 'example' => 'slowSqlTime', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query DRDS parameter list',
'summary' => 'Invokes the DescribeDrdsParams operation to query the query parameter list.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsParams'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsParams',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"2F7F8080-9132-4279-85D0-B7E5C4305162\\",\\n \\"List\\": [\\n {\\n \\"ParamDefaultValue\\": \\"1000\\",\\n \\"ParamLevel\\": \\"INSTANCE\\",\\n \\"ParamName\\": \\"慢SQL阈值\\",\\n \\"ParamType\\": \\"CONFIG\\",\\n \\"ParamValue\\": \\"1000\\",\\n \\"NeedRestart\\": true,\\n \\"ParamRanges\\": \\"[1000-900000]\\",\\n \\"DbName\\": \\"drds_test\\",\\n \\"ParamEnglishName\\": \\"SLOW_SQL_TIME\\",\\n \\"ParamDesc\\": \\"慢SQL阈值(单位:ms)\\",\\n \\"ParamVariableName\\": \\"slowSqlTime\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeDrdsRdsInstances' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '76007',
'abilityTreeNodes' => ['FEATUREdrdsD0NTUP'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the PolarDB-X instance.'."\n"
.'The ID of the DRDS instance.'."\n"
.'> You can call [DescribeDrdsInstances](~~139284~~) to query the details of all instances under the target account, including instance IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*************', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '123DB16B-02F2-45F7-A571-843991******', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'DbInstances' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DbInstance' => [
'description' => 'The details of the private custom ApsaraDB RDS instances in the storage layer.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DBInstanceCPU' => ['description' => 'The number of CPU cores of the private custom ApsaraDB RDS instance in the storage layer.', 'type' => 'string', 'example' => '8', 'title' => ''],
'DBInstanceMemory' => ['description' => 'The memory size of the private custom ApsaraDB RDS instance in the storage layer. Unit: MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '8192', 'title' => ''],
'PayType' => ['description' => 'The billing method of the private custom ApsaraDB RDS instance in the storage layer. Valid values:'."\n"
."\n"
.'* Postpaid: pay-as-you-go'."\n"
.'* Prepaid: subscription.', 'type' => 'string', 'example' => 'PostPaid', 'title' => ''],
'DBInstanceStatus' => ['description' => 'The status of the private custom ApsaraDB RDS instance in the storage layer. Valid values:'."\n"
.'* 0: Being created.'."\n"
.'* 1: Running.'."\n"
.'* 3: Being deleted.'."\n"
.'* 5: Being restarted.'."\n"
.'* 6: Being upgraded or downgraded.'."\n"
.'* 7: Backup in progress.'."\n"
.'* 8: Switching between internal network and public network.'."\n"
.'* 9: Being migrated.'."\n"
.'* 11: Migrating data.'."\n"
.'* 12: Generating a disaster recovery instance.'."\n"
.'* 13: Data import in progress.'."\n"
.'* 14: Importing data from another ApsaraDB RDS instance.'."\n"
.'* 15: Performing a disaster recovery switchover.'."\n"
.'* 16: Creating a temporary instance.'."\n"
.'* 17: Creating a network.'."\n"
.'* 18: Cloning an instance.'."\n"
.'* 19: Switching links.'."\n"
.'* 20: Read-only instance migration in progress.', 'type' => 'string', 'example' => '1', 'title' => ''],
'NetworkType' => ['description' => 'The network type of the private custom ApsaraDB RDS instance in the storage layer. The value is fixed as VPC (virtual private cloud).', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
'Port' => ['description' => 'The internal network connection port.', 'type' => 'integer', 'format' => 'int32', 'example' => '3306', 'title' => ''],
'EngineVersion' => ['description' => 'The DPI engine version number of the private custom ApsaraDB RDS instance in the storage layer. The value is fixed as 8.0.', 'type' => 'string', 'example' => '8.0', 'title' => ''],
'DmInstanceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'dm-*************', 'title' => ''],
'DBInstanceStorage' => ['description' => 'The storage capacity of the private custom ApsaraDB RDS instance in the storage layer. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
'ConnectUrl' => ['description' => 'The internal endpoint of the private custom ApsaraDB RDS instance in the storage layer.', 'type' => 'string', 'example' => 'rm-***************.mysql.rds.aliyuncs.com', 'title' => ''],
'ReadWeight' => ['description' => 'The read and write weight of the private custom ApsaraDB RDS instance in the storage layer.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'RdsInstType' => ['description' => 'The type of the private custom ApsaraDB RDS instance in the storage layer. Valid values:'."\n"
."\n"
.'* Primary: primary instance'."\n"
.'* Readonly: read-only instance.', 'type' => 'string', 'example' => 'Primary', 'title' => ''],
'DBInstanceClassType' => ['description' => 'The instance family. Valid values:'."\n"
."\n"
.'* **x**: general-purpose'."\n"
.'* **d**: dedicated package'."\n"
.'* **h**: dedicated host.', 'type' => 'string', 'example' => 'x', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID of the private custom ApsaraDB RDS instance in the storage layer.', 'type' => 'string', 'example' => 'rm-*****************', 'title' => ''],
'Engine' => ['description' => 'The engine type of the private custom ApsaraDB RDS instance in the storage layer. The value is fixed as MySQL.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'DbInstType' => ['description' => 'The storage layer instance type. The value is fixed as RDS.', 'type' => 'string', 'example' => 'RDS', 'title' => ''],
'LockMode' => ['description' => 'The lock status of the ApsaraDB RDS instance. Valid values: 0|1|2|3|4|5'."\n"
."\n"
.' 0: Normal.'."\n"
."\n"
.'1: Manually locked.'."\n"
."\n"
.'2: Automatically locked due to instance expiration.'."\n"
."\n"
.'3: Automatically locked before instance rollback.'."\n"
."\n"
.'4: Automatically locked because the instance storage is full.'."\n"
."\n"
.'5: Automatically locked because the read-only instance storage is full.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'LockReason' => ['description' => 'The reason why the ApsaraDB RDS instance is locked.', 'type' => 'string', 'example' => '手动触发锁', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"123DB16B-02F2-45F7-A571-843991******\\",\\n \\"Success\\": true,\\n \\"DbInstances\\": {\\n \\"DbInstance\\": [\\n {\\n \\"DBInstanceCPU\\": \\"8\\",\\n \\"DBInstanceMemory\\": 8192,\\n \\"PayType\\": \\"PostPaid\\",\\n \\"DBInstanceStatus\\": \\"1\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"Port\\": 3306,\\n \\"EngineVersion\\": \\"8.0\\",\\n \\"DmInstanceId\\": \\"dm-*************\\",\\n \\"DBInstanceStorage\\": 20,\\n \\"ConnectUrl\\": \\"rm-***************.mysql.rds.aliyuncs.com\\",\\n \\"ReadWeight\\": 0,\\n \\"RdsInstType\\": \\"Primary\\",\\n \\"DBInstanceClassType\\": \\"x\\",\\n \\"DBInstanceId\\": \\"rm-*****************\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"DbInstType\\": \\"RDS\\",\\n \\"LockMode\\": 1,\\n \\"LockReason\\": \\"手动触发锁\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => 'Private custom RDS instance details',
'summary' => 'Queries the details of all private custom ApsaraDB RDS instances under a specified PolarDB-X instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-07-16T13:04:40.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsRdsInstances'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:DescribeDrdsRdsInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeDrdsShardingDbs' => [
'summary' => 'Queries horizontally sharded databases under a PolarDB-X instance by calling the DescribeDrdsShardingDbs operation.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the PolarDB-X instance.', 'type' => 'string', 'required' => true, 'example' => 'drdshbgaf3c63qbo', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the database on the PolarDB-X instance.', 'type' => 'string', 'required' => true, 'example' => 'drds_test', 'title' => ''],
],
[
'name' => 'DbNamePattern',
'in' => 'query',
'schema' => ['description' => 'The database name matching pattern.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '509BDE17-505A-4B3B-854D-30D3F092502F', 'title' => ''],
'ShardingDbs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ShardingDb' => [
'description' => 'The list of returned results.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'MinPoolSize' => ['description' => 'The minimum number of connections in the connection pool.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'MaxPoolSize' => ['description' => 'The maximum number of connections in the connection pool.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''],
'DbInstanceId' => ['description' => 'The instance ID of the ApsaraDB RDS instance.', 'type' => 'string', 'example' => 'rm-bp1hjzn0yv5j2****', 'title' => ''],
'ConnectUrl' => ['description' => 'The connection URL.', 'type' => 'string', 'example' => '100.100.64.100:11569', 'title' => ''],
'GroupName' => ['description' => 'The name of the physical shard.', 'type' => 'string', 'example' => 'TEMP1_1568171495522SABE_KUP4_0000', 'title' => ''],
'DbType' => ['description' => 'The database type.', 'type' => 'string', 'example' => 'mysql', 'title' => ''],
'IdleTimeOut' => ['description' => 'The idle timeout period.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'ShardingDbName' => ['description' => 'The name of the physical sharded database.', 'type' => 'string', 'example' => 'temp1_zhk1_0000', 'title' => ''],
'BlockingTimeout' => ['description' => 'The maximum duration that a transaction waits to acquire a lock.', 'type' => 'integer', 'format' => 'int32', 'example' => '5000', 'title' => ''],
'PreparedStatementCacheSize' => ['description' => 'The size of the prepared statement cache.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'ConnectionProperties' => ['description' => 'The connection string properties.', 'type' => 'string', 'example' => 'connectTimeout=3000;autoReconnect=true;failOverReadOnly=false;socketTimeout=900000;rewriteBatchedStatements=true;characterEncoding=utf8', 'title' => ''],
'UserName' => ['description' => 'The username used to connect to the ApsaraDB RDS instance.', 'type' => 'string', 'example' => 'pg284mi8', 'title' => ''],
'DbStatus' => ['description' => 'The database status.', 'type' => 'string', 'example' => 'running', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The current page number.', 'type' => 'string', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'string', 'example' => '20', 'title' => ''],
'Total' => ['description' => 'The total number of entries returned.', 'type' => 'string', 'example' => '1', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', 'description' => ''],
['errorCode' => 'ServiceUnable', 'errorMessage' => 'The service is not available now, please try again later', 'description' => ''],
['errorCode' => 'InvalidParameter.Mismatch', 'errorMessage' => 'The specified parameter does not match.', 'description' => ''],
['errorCode' => 'InvalidDbname.MalFormed', 'errorMessage' => 'The specified db name does not match.', 'description' => ''],
['errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records', 'description' => ''],
['errorCode' => 'InvalidDbName.NotFound', 'errorMessage' => 'The Drds DbName provided does not exist in our records', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', 'description' => ''],
['errorCode' => 'InvalidDbName.NotFound', 'errorMessage' => 'The Drds DbName provided does not exist in our records.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query horizontally sharded databases under DRDS',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsShardingDbs'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsShardingDbs',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"509BDE17-505A-4B3B-854D-30D3F092502F\\",\\n \\"ShardingDbs\\": {\\n \\"ShardingDb\\": [\\n {\\n \\"MinPoolSize\\": 5,\\n \\"MaxPoolSize\\": 60,\\n \\"DbInstanceId\\": \\"rm-bp1hjzn0yv5j2****\\",\\n \\"ConnectUrl\\": \\"100.100.64.100:11569\\",\\n \\"GroupName\\": \\"TEMP1_1568171495522SABE_KUP4_0000\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"IdleTimeOut\\": 30,\\n \\"ShardingDbName\\": \\"temp1_zhk1_0000\\",\\n \\"BlockingTimeout\\": 5000,\\n \\"PreparedStatementCacheSize\\": 0,\\n \\"ConnectionProperties\\": \\"connectTimeout=3000;autoReconnect=true;failOverReadOnly=false;socketTimeout=900000;rewriteBatchedStatements=true;characterEncoding=utf8\\",\\n \\"UserName\\": \\"pg284mi8\\",\\n \\"DbStatus\\": \\"running\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"20\\",\\n \\"Total\\": \\"1\\"\\n}","type":"json"}]',
],
'DescribeDrdsSlowSqls' => [
'summary' => 'Queries slow SQL statements of a DRDS instance.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '76009',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true, 'default' => 'center', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds***************', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'test_db', 'title' => ''],
],
[
'name' => 'ExeTime',
'in' => 'query',
'schema' => ['description' => 'The SQL execution time. Unit: milliseconds (ms).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1000', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The end time of the SQL query. Specify the value as a UNIX timestamp in milliseconds (UTC).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1568269711000', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The start time of the SQL query. Specify the value as a UNIX timestamp in milliseconds (UTC).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1568267711000', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'example' => '20', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '509BDE17-505A-4B3B-854D-30D3F0******', 'title' => ''],
'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Items' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Item' => [
'description' => 'The details of the slow SQL statement.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SendTime' => ['description' => 'The time when the slow SQL statement was sent. Unit: milliseconds (ms).', 'type' => 'integer', 'format' => 'int64', 'example' => '1568267711', 'title' => ''],
'Host' => ['description' => 'The IP address of the machine that executed the SQL statement.', 'type' => 'string', 'example' => '10.0.***.***', 'title' => ''],
'Sql' => ['description' => 'The content of the slow SQL statement.', 'type' => 'string', 'example' => 'SELECT count(1) from payment_order where order_status = \'08\';', 'title' => ''],
'ResponseTime' => ['description' => 'The response time. Unit: milliseconds (ms).', 'type' => 'integer', 'format' => 'int64', 'example' => '1568267711', 'title' => ''],
'Schema' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'user', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', 'description' => ''],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', 'description' => ''],
['errorCode' => 'InvalidDbName.NotFound', 'errorMessage' => 'The Drds DbName provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"509BDE17-505A-4B3B-854D-30D3F0******\\",\\n \\"Total\\": 1,\\n \\"Success\\": true,\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"SendTime\\": 1568267711,\\n \\"Host\\": \\"10.0.***.***\\",\\n \\"Sql\\": \\"SELECT count(1) from payment_order where order_status = \'08\';\\",\\n \\"ResponseTime\\": 1568267711,\\n \\"Schema\\": \\"user\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => 'View slow SQL statements',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-06-10T03:11:23.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-03-07T06:19:46.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsSlowSqls'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsSlowSqls',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeDrdsSqlAuditStatus' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds************', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DC3ABA3E-0F8A-4596-9104-F5155C******', 'title' => ''],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Data' => [
'description' => 'The result set.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ExtraSlsLogStore' => ['description' => 'The SLS LogStore for external delivery.'."\n"
.'>This parameter is displayed only when external delivery is enabled.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'DbName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'Detailed' => ['description' => 'Indicates whether full reports are supported. Valid values: true and false.', 'type' => 'string', 'example' => 'true', 'title' => ''],
'ExtraWriteEnabled' => ['description' => 'Indicates whether external delivery is enabled. Valid values: true and false.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'Enabled' => ['description' => 'Indicates whether the feature is available. Valid values: true and false.', 'type' => 'string', 'example' => 'true', 'title' => ''],
'ExtraAliUid' => ['description' => 'The UID for external delivery.'."\n"
.'>This parameter is displayed only when external delivery is enabled.', 'type' => 'integer', 'format' => 'int64', 'example' => '111', 'title' => ''],
'ExtraSlsProject' => ['description' => 'The SLS project for external delivery.'."\n"
.'>This parameter is displayed only when external delivery is enabled.', 'type' => 'string', 'example' => 'test', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query DRDS SQL audit information',
'summary' => 'Queries the SQL audit information of a DRDS instance by calling the DescribeDrdsSqlAuditStatus operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsSqlAuditStatus'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsSqlAuditStatus',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DC3ABA3E-0F8A-4596-9104-F5155C******\\",\\n \\"Data\\": {\\n \\"Data\\": [\\n {\\n \\"ExtraSlsLogStore\\": \\"test\\",\\n \\"DbName\\": \\"test\\",\\n \\"Detailed\\": \\"true\\",\\n \\"ExtraWriteEnabled\\": false,\\n \\"Enabled\\": \\"true\\",\\n \\"ExtraAliUid\\": 111,\\n \\"ExtraSlsProject\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeDrdsTasks' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drdsxxxxxxxxxxxx', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'TaskType',
'in' => 'query',
'schema' => ['description' => 'The task type.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CD412DF7-F21D-44CE-88FF-ED24917174A8', 'title' => ''],
'Tasks' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Task' => [
'description' => 'The task list.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'State' => ['description' => 'The task status.', 'type' => 'string', 'example' => 'FAILED', 'title' => ''],
'Content' => ['description' => 'The task content.', 'type' => 'string', 'example' => 'upgrade_instance', 'title' => ''],
'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '64148', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query instance change tasks',
'summary' => 'Queries the change tasks of an instance by calling the DescribeDrdsTasks operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsTasks'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsTasks',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"CD412DF7-F21D-44CE-88FF-ED24917174A8\\",\\n \\"Tasks\\": {\\n \\"Task\\": [\\n {\\n \\"State\\": \\"FAILED\\",\\n \\"Content\\": \\"upgrade_instance\\",\\n \\"Id\\": 64148\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeExpandLogicTableInfoList' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '76018',
'abilityTreeNodes' => ['FEATUREdrdsT4VUG1'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'drds_flashback', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0B6B7BDC-575D-4A77-A4F8-24B7EF******', 'title' => ''],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'data' => [
'description' => 'The result.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ShardTbKey' => ['description' => 'The table shard key.', 'type' => 'string', 'example' => 'address', 'title' => ''],
'TableName' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'employee_split2', 'title' => ''],
'ShardDbKey' => ['description' => 'The database shard key.', 'type' => 'string', 'example' => 'id', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query logical table shard keys',
'summary' => 'Calls the DescribeExpandLogicTableInfoList operation to query shard keys.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeExpandLogicTableInfoList'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeExpandLogicTableInfoList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0B6B7BDC-575D-4A77-A4F8-24B7EF******\\",\\n \\"Data\\": {\\n \\"data\\": [\\n {\\n \\"ShardTbKey\\": \\"address\\",\\n \\"TableName\\": \\"employee_split2\\",\\n \\"ShardDbKey\\": \\"id\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeHotDbList' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '76024',
'abilityTreeNodes' => ['FEATUREdrds7SC2V6'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds**********', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Msg' => ['description' => 'The message.', 'type' => 'string', 'example' => 'msg', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0B6B7BDC-575D-4A77-A4F8-24B7EF******', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The result.',
'type' => 'object',
'properties' => [
'RandomCode' => ['description' => 'The random code.', 'type' => 'string', 'example' => 'jzhz', 'title' => ''],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'InstanceDb' => [
'description' => 'The list.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'instanceName', 'title' => ''],
'HotDbList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'data' => [
'type' => 'array',
'items' => ['description' => 'The list of hot databases.', 'type' => 'string', 'example' => 'hot_dtstest0512_****_****', 'title' => ''],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query the list of hot-spot scale-out databases',
'summary' => 'Calls the DescribeHotDbList operation to query the list of databases for hot-spot scale-out.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHotDbList'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeHotDbList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Msg\\": \\"msg\\",\\n \\"RequestId\\": \\"0B6B7BDC-575D-4A77-A4F8-24B7EF******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RandomCode\\": \\"jzhz\\",\\n \\"List\\": {\\n \\"InstanceDb\\": [\\n {\\n \\"InstanceName\\": \\"instanceName\\",\\n \\"HotDbList\\": {\\n \\"data\\": [\\n \\"hot_dtstest0512_****_****\\"\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
],
'DescribeInstDbLogInfo' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '76028',
'abilityTreeNodes' => ['FEATUREdrdsAS582G'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds*********', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'drds_test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A5438952-70EE-4FA5-87A9-080DB0ASD45F', 'title' => ''],
'LogTimeRange' => [
'description' => 'The queryable time range.',
'type' => 'object',
'properties' => [
'SupportOldestTime' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1568367711', 'title' => ''],
'SupportLatestTime' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1568267711', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query time range for importing historical SQL data',
'summary' => 'Queries the time range supported for importing historical SQL data into a database.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstDbLogInfo'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeInstDbLogInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"A5438952-70EE-4FA5-87A9-080DB0ASD45F\\",\\n \\"LogTimeRange\\": {\\n \\"SupportOldestTime\\": 1568367711,\\n \\"SupportLatestTime\\": 1568267711\\n }\\n}","type":"json"}]',
],
'DescribeInstDbSlsInfo' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds***********', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DC3ABA3E-0F8A-4596-9104-F5155C******', 'title' => ''],
'AuditInfo' => [
'description' => 'The SQL audit details.',
'type' => 'object',
'properties' => [
'LogStore' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'Project' => ['description' => 'The name of the SLS project.', 'type' => 'string', 'example' => 'test', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query SLS project and logstore names',
'summary' => 'Queries the names of the SLS project and Logstore used for SQL audit.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstDbSlsInfo'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeInstDbSlsInfo',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DC3ABA3E-0F8A-4596-9104-F5155C******\\",\\n \\"AuditInfo\\": {\\n \\"LogStore\\": \\"test\\",\\n \\"Project\\": \\"test\\"\\n }\\n}","type":"json"}]',
],
'DescribeInstanceAccounts' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds*********', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E2E4056D-57EB-4353-8355-2E6284******', 'title' => ''],
'InstanceAccounts' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'InstanceAccount' => [
'description' => 'The list of instance accounts.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Host' => ['description' => 'The IP address that is allowed to access the database. **%** indicates that any IP address can access the database..', 'type' => 'string', 'example' => '%', 'title' => ''],
'Description' => ['description' => 'The account description. The default description for a privileged account is **Created by DRDS**. A standard account has no description. You can customize the description in account management.', 'type' => 'string', 'example' => 'Created by DRDS', 'title' => ''],
'AccountType' => ['description' => 'The account type. Valid values:'."\n"
.'- **0**: privileged account.'."\n"
.'- **1**: standard account.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'AccountName' => ['description' => 'The account name.', 'type' => 'string', 'example' => 'test_rds3', 'title' => ''],
'DbPrivileges' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DbPrivilege' => [
'description' => 'The database permission information.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DbName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'test_rds3', 'title' => ''],
'Privilege' => ['description' => 'The account permissions. Valid values:'."\n"
.'- **R**: read permission.'."\n"
.'- **W**: write permission.'."\n"
.'- **DDL**: permission to perform DDL operations.'."\n"
.'- **DML**: permission to perform DML operations.', 'type' => 'string', 'example' => 'R', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'staticInfo' => [],
'title' => 'View instance account information',
'summary' => 'Queries the account information of an instance by calling the DescribeInstanceAccounts operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceAccounts'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeInstanceAccounts',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"E2E4056D-57EB-4353-8355-2E6284******\\",\\n \\"InstanceAccounts\\": {\\n \\"InstanceAccount\\": [\\n {\\n \\"Host\\": \\"%\\",\\n \\"Description\\": \\"Created by DRDS\\",\\n \\"AccountType\\": 1,\\n \\"AccountName\\": \\"test_rds3\\",\\n \\"DbPrivileges\\": {\\n \\"DbPrivilege\\": [\\n {\\n \\"DbName\\": \\"test_rds3\\",\\n \\"Privilege\\": \\"R\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeInstanceSwitchAzone' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '76026',
'abilityTreeNodes' => ['FEATUREdrds7CT80F'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdsxxxxxxxxxxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DSSDF-SEWE-23ERW', 'title' => ''],
'Result' => [
'description' => 'The query result list.',
'type' => 'object',
'properties' => [
'OriginAzoneId' => ['description' => 'The source zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-a', 'title' => ''],
'SwitchAble' => ['description' => 'Indicates whether the zone can be switched.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'TargetAzones' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TargetAzone' => [
'type' => 'array',
'items' => ['description' => 'The target zone.', 'type' => 'string', 'example' => 'cn-hangzhou-a,cn-hangzhou-b', 'title' => ''],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DSSDF-SEWE-23ERW\\",\\n \\"Result\\": {\\n \\"OriginAzoneId\\": \\"cn-hangzhou-a\\",\\n \\"SwitchAble\\": true,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"TargetAzones\\": {\\n \\"TargetAzone\\": [\\n \\"cn-hangzhou-a,cn-hangzhou-b\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
'title' => 'Check whether zone switching is available',
'summary' => 'Queries whether the zone can be switched by calling the DescribeInstanceSwitchAzone operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceSwitchAzone'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeInstanceSwitchAzone',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeInstanceSwitchNetwork' => [
'summary' => 'Queries whether an instance supports network transition by calling DescribeInstanceSwitchNetwork.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '76027',
'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*********', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '03E12FE3-1638-483E-A9B6-1A9120SER56T', 'title' => ''],
'VpcInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'VpcInfo' => [
'description' => 'The details of the virtual private cloud (VPC).',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'VpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc_id', 'title' => ''],
'VpcName' => ['description' => 'The name of the VPC.', 'type' => 'string', 'example' => 'vpc_name', 'title' => ''],
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'VswitchInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'VswitchInfo' => [
'description' => 'The list of vSwitches.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'VpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc_id', 'title' => ''],
'DrdsSupported' => ['description' => 'Indicates whether the instance is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'VswitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vswitch_id', 'title' => ''],
'AzoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-a', 'title' => ''],
'VswitchName' => ['description' => 'The name of the vSwitch.', 'type' => 'string', 'example' => 'vswitch_name', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query whether an instance supports network transition',
'description' => '****.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceSwitchNetwork'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeInstanceSwitchNetwork',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"03E12FE3-1638-483E-A9B6-1A9120SER56T\\",\\n \\"VpcInfos\\": {\\n \\"VpcInfo\\": [\\n {\\n \\"VpcId\\": \\"vpc_id\\",\\n \\"VpcName\\": \\"vpc_name\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VswitchInfos\\": {\\n \\"VswitchInfo\\": [\\n {\\n \\"VpcId\\": \\"vpc_id\\",\\n \\"DrdsSupported\\": true,\\n \\"VswitchId\\": \\"vswitch_id\\",\\n \\"AzoneId\\": \\"cn-hangzhou-a\\",\\n \\"VswitchName\\": \\"vswitch_name\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribePreCheckResult' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdshbga76p6****', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4561', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DescribePreCheckResult', 'title' => ''],
'PreCheckResult' => [
'description' => 'The pre-check result.',
'type' => 'object',
'properties' => [
'PreCheckName' => ['description' => 'The name of the pre-check.', 'type' => 'string', 'example' => '是否有唯一键', 'title' => ''],
'State' => ['description' => 'The status.', 'type' => 'string', 'example' => 'FAIL', 'title' => ''],
'SubCheckItems' => [
'description' => 'The details of sub pre-check tasks.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ErrorMsgCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1004', 'title' => ''],
'PreCheckItemName' => ['description' => 'The name of the pre-check.', 'type' => 'string', 'example' => '唯一键', 'title' => ''],
'State' => ['description' => 'The task status.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'ErrorMsgParams' => [
'type' => 'array',
'items' => ['description' => 'The error parameters.', 'type' => 'string', 'example' => 'table1', 'title' => ''],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DescribePreCheckResult\\",\\n \\"PreCheckResult\\": {\\n \\"PreCheckName\\": \\"是否有唯一键\\",\\n \\"State\\": \\"FAIL\\",\\n \\"SubCheckItems\\": [\\n {\\n \\"ErrorMsgCode\\": \\"1004\\",\\n \\"PreCheckItemName\\": \\"唯一键\\",\\n \\"State\\": \\"成功\\",\\n \\"ErrorMsgParams\\": [\\n \\"table1\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => 'View pre-check result',
'summary' => 'Calls the DescribePreCheckResult operation to view the pre-check result.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePreCheckResult'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribePreCheckResult',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
],
'DescribeRDSPerformance' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'Instance ID of the PolarDB-X instance.'."\n"
."\n"
.'Instance ID of the DRDS instance..', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*********', 'title' => ''],
],
[
'name' => 'RdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the ApsaraDB RDS instance at the storage layer.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-************', 'title' => ''],
],
[
'name' => 'Keys',
'in' => 'query',
'schema' => ['description' => 'The performance monitoring metrics. You can specify multiple metrics in a single request. Separate multiple metrics with commas (,).'."\n"
.'> For more information about performance monitoring metrics, see [Storage monitoring](~~186705~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySQL_MemCpuUsage', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The start time of the query. Specify a UNIX timestamp in UTC. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1603123290000', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end time of the query. Specify a UNIX timestamp in UTC. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1603209690000', 'title' => ''],
],
[
'name' => 'DbInstType',
'in' => 'query',
'schema' => ['description' => 'The database engine type.', 'type' => 'string', 'required' => false, 'example' => 'mysql', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DB53EC68-463C-4187-8D2B-C2AD8C******', 'title' => ''],
'Data' => [
'description' => 'The query result set.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The name of the monitoring metrics.', 'type' => 'string', 'example' => 'cpuusage', 'title' => ''],
'NodeName' => ['description' => 'The node name.'."\n"
.'> This parameter is returned only when the database storage type is PolarDB for MySQL. This parameter is not returned for ApsaraDB RDS for MySQL.', 'type' => 'string', 'example' => 'pi-*************', 'title' => ''],
'Unit' => ['description' => 'The unit of the monitoring metrics.', 'type' => 'string', 'example' => '%', 'title' => ''],
'NodeNum' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Values' => [
'description' => 'The details of the monitoring metrics data.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Date' => ['description' => 'The point in time when the monitoring metrics value was collected. The value is in the format of a UNIX timestamp in UTC. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1603209660000', 'title' => ''],
'Value' => ['description' => 'The value of the monitoring metrics.', 'type' => 'string', 'example' => '0.58', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'Monitor.QueryRdsFailure', 'errorMessage' => 'Failed to query RDS monitor info.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query storage-layer RDS performance data',
'summary' => 'Queries the performance data of an ApsaraDB RDS instance at the storage layer by calling the DescribeRDSPerformance operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRDSPerformance'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeRDSPerformance',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DB53EC68-463C-4187-8D2B-C2AD8C******\\",\\n \\"Data\\": [\\n {\\n \\"Key\\": \\"cpuusage\\",\\n \\"NodeName\\": \\"pi-*************\\",\\n \\"Unit\\": \\"%\\",\\n \\"NodeNum\\": 1,\\n \\"Values\\": [\\n {\\n \\"Date\\": 1603209660000,\\n \\"Value\\": \\"0.58\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeRdsCommodity' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds***********', 'title' => ''],
],
[
'name' => 'CommodityCode',
'in' => 'query',
'schema' => ['description' => 'The commodity code.', 'type' => 'string', 'required' => true, 'example' => 'drdsPost', 'title' => ''],
],
[
'name' => 'OrderType',
'in' => 'query',
'schema' => ['description' => 'The order type.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'The result.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DC3ABA3E-0F8A-4596-9104-F5155C34315B', 'title' => ''],
'Success' => ['description' => 'The request result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query RDS sale-related data',
'summary' => 'Queries the sale-related data of the storage layer by calling the DescribeRdsCommodity operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsCommodity'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeRdsCommodity',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"test\\",\\n \\"RequestId\\": \\"DC3ABA3E-0F8A-4596-9104-F5155C34315B\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DescribeRdsPerformanceSummary' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The DRDS instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'RdsInstanceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of ApsaraDB RDS instances.',
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'required' => true,
'example' => 'rm-*****************',
'maxItems' => 100,
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the API request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B6876277-ECFD-4658-AC1E-A7FAD8******', 'title' => ''],
'RdsPerformanceInfos' => [
'description' => 'The collection of objects.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Cpu' => ['description' => 'The CPU usage of the ApsaraDB RDS instance.', 'type' => 'number', 'format' => 'float', 'example' => '0.26', 'title' => ''],
'ActiveSessions' => ['description' => 'The number of active sessions on the current ApsaraDB RDS instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'TotalSessions' => ['description' => 'The total number of sessions on the current ApsaraDB RDS instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '162', 'title' => ''],
'RdsId' => ['description' => 'The ApsaraDB RDS instance ID.', 'type' => 'string', 'example' => 'rm-**************', 'title' => ''],
'Iops' => ['description' => 'The IOPS data of the ApsaraDB RDS instance.', 'type' => 'number', 'format' => 'float', 'example' => '17.62', 'title' => ''],
'SpaceUsage' => ['description' => 'The disk usage of the ApsaraDB RDS instance. Unit: MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '4145144777', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query RDS performance details such as CPU',
'summary' => 'Queries the performance details (such as CPU) of ApsaraDB RDS instances by calling the DescribeRdsPerformanceSummary operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsPerformanceSummary'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeRdsPerformanceSummary',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B6876277-ECFD-4658-AC1E-A7FAD8******\\",\\n \\"RdsPerformanceInfos\\": [\\n {\\n \\"Cpu\\": 0.26,\\n \\"ActiveSessions\\": 0,\\n \\"TotalSessions\\": 162,\\n \\"RdsId\\": \\"rm-**************\\",\\n \\"Iops\\": 17.62,\\n \\"SpaceUsage\\": 4145144777\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeRdsSuperAccountInstances' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'DbInstType',
'in' => 'query',
'schema' => ['description' => 'The type of the database instance. Default value: **RDS**.', 'type' => 'string', 'required' => false, 'default' => 'RDS', 'example' => 'RDS', 'title' => ''],
],
[
'name' => 'RdsInstance',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of ApsaraDB RDS instance IDs.',
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'required' => true,
'example' => '[\'rm-*****************\',\'rm-*****************\']',
'maxItems' => 30,
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5D64DE5944A1E541E0******', 'title' => ''],
'DbInstances' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DbInstance' => [
'type' => 'array',
'items' => ['description' => 'The collection of privileged accounts.', 'type' => 'string', 'example' => 'rm-*****************', 'title' => ''],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Retrieve RDS privileged accounts',
'summary' => 'Calls DescribeRdsSuperAccountInstances to retrieve the privileged accounts of ApsaraDB RDS instances.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsSuperAccountInstances'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeRdsSuperAccountInstances',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5D64DE5944A1E541E0******\\",\\n \\"DbInstances\\": {\\n \\"DbInstance\\": [\\n \\"rm-*****************\\"\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeRecycleBinStatus' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the database created on the DRDS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The status of the table recycle bin. Valid values:'."\n"
.'* disable: The table recycle bin is disabled.'."\n"
.'* enable: The table recycle bin is enabled.', 'type' => 'string', 'example' => 'disable', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ACB5258F-25AF-4D7C-8FAA-B6FE60******', 'title' => ''],
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"disable\\",\\n \\"RequestId\\": \\"ACB5258F-25AF-4D7C-8FAA-B6FE60******\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'Query table recycle bin status',
'summary' => 'Queries the status of the table recycle bin by calling the DescribeRecycleBinStatus operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRecycleBinStatus'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'drds:DescribeRecycleBinStatus',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
],
'DescribeRecycleBinTables' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '76046',
'abilityTreeNodes' => ['FEATUREdrdsZVW4NQ'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds***********', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds_test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'The request result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5D64DE5944A1E541E0CB908A', 'title' => ''],
'Data' => [
'description' => 'The returned data object.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OriginalTableName' => ['description' => 'The original table name.', 'type' => 'string', 'example' => 'BIN_T4AG3CY5WWXPKHITCHJY', 'title' => ''],
'TableName' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2019-09-16 14:42:06', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query recyclable tables',
'summary' => 'Queries the recyclable tables.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRecycleBinTables'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:DescribeRecycleBinTables',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"5D64DE5944A1E541E0CB908A\\",\\n \\"Data\\": [\\n {\\n \\"OriginalTableName\\": \\"BIN_T4AG3CY5WWXPKHITCHJY\\",\\n \\"TableName\\": \\"test\\",\\n \\"CreateTime\\": \\"2019-09-16 14:42:06\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeRestoreOrder' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'PreferredBackupTime',
'in' => 'query',
'schema' => ['description' => 'The backup time.', 'type' => 'string', 'required' => false, 'example' => '2019-09-16 15:12:53', 'title' => ''],
],
[
'name' => 'BackupMode',
'in' => 'query',
'schema' => ['description' => 'The backup mode. Valid values:'."\n"
.'- **logic**: logical backup'."\n"
.'- **phy**: physical backup.', 'type' => 'string', 'required' => false, 'example' => 'phy', 'title' => ''],
],
[
'name' => 'BackupLevel',
'in' => 'query',
'schema' => ['description' => 'The backup level. Valid values:'."\n"
.'* **db**: database level'."\n"
.'* **instance**: instance level.', 'type' => 'string', 'required' => false, 'example' => 'db', 'title' => ''],
],
[
'name' => 'BackupDbNames',
'in' => 'query',
'schema' => ['description' => 'The name of the database involved in the backup.', 'type' => 'string', 'required' => false, 'example' => 'drds_flashback', 'title' => ''],
],
[
'name' => 'BackupId',
'in' => 'query',
'schema' => ['description' => 'The backup ID.', 'type' => 'string', 'required' => false, 'example' => '1918df27-4563-11e9-8403-af4fbe******', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the API request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0AD2DE5D-B86B-40B5-9678-487D37******', 'title' => ''],
'RestoreOrderDO' => [
'description' => 'The returned data object.',
'type' => 'object',
'properties' => [
'DrdsOrderDOList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DrdsOrderDOList' => [
'description' => 'The restoration order information.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-*******************', 'title' => ''],
'Network' => ['description' => 'The network type. Valid values:'."\n"
.'* **classic**: classic network'."\n"
.'* **vpc**: VPC.', 'type' => 'string', 'example' => 'vpc', 'title' => ''],
'VSwtichId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-*******************', 'title' => ''],
'InstSpec' => ['description' => 'The instance specifications.', 'type' => 'string', 'example' => '4C8G * 2', 'title' => ''],
'AzoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-e', 'title' => ''],
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RdsOrderDOList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RdsOrderDOList' => [
'description' => 'The restoration order information for ApsaraDB RDS.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Network' => ['description' => 'The network type. Valid values:'."\n"
.'* **classic**: classic network'."\n"
.'* **vpc**: VPC.', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
'Version' => ['description' => 'The version number.', 'type' => 'string', 'example' => '5.6', 'title' => ''],
'InstanceClass' => ['description' => 'The instance specifications.', 'type' => 'string', 'example' => 'rds.mysql.s2.large', 'title' => ''],
'DbInstanceStorage' => ['description' => 'The disk capacity.', 'type' => 'string', 'example' => '10240', 'title' => ''],
'Num' => ['description' => 'The quantity.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'Engine' => ['description' => 'The storage engine.', 'type' => 'string', 'example' => 'MYSQL', 'title' => ''],
'AzoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-g', 'title' => ''],
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PolarOrderDOList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PolarOrderDOList' => [
'description' => 'The restoration order information for PolarDB.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Network' => ['description' => 'The network type. Valid values:'."\n"
.'* **classic**: classic network'."\n"
.'* **vpc**: VPC.', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
'Version' => ['description' => 'The version number.', 'type' => 'string', 'example' => '5.6', 'title' => ''],
'InstanceClass' => ['description' => 'The instance specifications.', 'type' => 'string', 'example' => 'polar.mysql.x4.large', 'title' => ''],
'DbInstanceStorage' => ['description' => 'The disk capacity.', 'type' => 'string', 'example' => '10240', 'title' => ''],
'Num' => ['description' => 'The quantity.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'Engine' => ['description' => 'The PolarDB storage engine.', 'type' => 'string', 'example' => 'POLARDB', 'title' => ''],
'AzoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-g', 'title' => ''],
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'View restoration purchase order details',
'summary' => 'Queries the order details of the current restoration purchase.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRestoreOrder'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeRestoreOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0AD2DE5D-B86B-40B5-9678-487D37******\\",\\n \\"RestoreOrderDO\\": {\\n \\"DrdsOrderDOList\\": {\\n \\"DrdsOrderDOList\\": [\\n {\\n \\"VpcId\\": \\"vpc-*******************\\",\\n \\"Network\\": \\"vpc\\",\\n \\"VSwtichId\\": \\"vsw-*******************\\",\\n \\"InstSpec\\": \\"4C8G * 2\\",\\n \\"AzoneId\\": \\"cn-hangzhou-e\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"RdsOrderDOList\\": {\\n \\"RdsOrderDOList\\": [\\n {\\n \\"Network\\": \\"VPC\\",\\n \\"Version\\": \\"5.6\\",\\n \\"InstanceClass\\": \\"rds.mysql.s2.large\\",\\n \\"DbInstanceStorage\\": \\"10240\\",\\n \\"Num\\": 1,\\n \\"Engine\\": \\"MYSQL\\",\\n \\"AzoneId\\": \\"cn-hangzhou-g\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"PolarOrderDOList\\": {\\n \\"PolarOrderDOList\\": [\\n {\\n \\"Network\\": \\"VPC\\",\\n \\"Version\\": \\"5.6\\",\\n \\"InstanceClass\\": \\"polar.mysql.x4.large\\",\\n \\"DbInstanceStorage\\": \\"10240\\",\\n \\"Num\\": 1,\\n \\"Engine\\": \\"POLARDB\\",\\n \\"AzoneId\\": \\"cn-hangzhou-g\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
],
'DescribeShardTaskInfo' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '76048',
'abilityTreeNodes' => ['FEATUREdrdsD6TUSC'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*********', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'jjjjjj_ppppp', 'title' => ''],
],
[
'name' => 'SourceTableName',
'in' => 'query',
'schema' => ['description' => 'The source table name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a1', 'title' => ''],
],
[
'name' => 'TargetTableName',
'in' => 'query',
'schema' => ['description' => 'The target table name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 100, 'minLength' => 1, 'example' => 'a2', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The unique request ID. If you encounter an issue, provide this request ID for troubleshooting.', 'type' => 'string', 'example' => '5D64DE5944A1E541E0CB908A', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => '增量追平', 'title' => ''],
'Stage' => ['description' => 'The current stage.', 'type' => 'string', 'example' => '2', 'title' => ''],
'Progress' => ['description' => 'The progress.', 'type' => 'string', 'example' => '70', 'title' => ''],
'Expired' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '0', 'title' => ''],
'TargetTableName' => ['description' => 'The target table name.', 'type' => 'string', 'example' => 'a2', 'title' => ''],
'SourceTableName' => ['description' => 'The source table name.', 'type' => 'string', 'example' => 'a1', 'title' => ''],
'Full' => [
'description' => 'The full migration information.',
'type' => 'object',
'properties' => [
'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2019-09-16 15:11:53', 'title' => ''],
'Progress' => ['description' => 'The current progress.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'Tps' => ['description' => 'The number of transactions processed per second by the database.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Total' => ['description' => 'The number of tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'Expired' => ['description' => 'The task expiration time.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
],
'title' => '',
'example' => '',
],
'FullCheck' => [
'description' => 'The full check information.',
'type' => 'object',
'properties' => [
'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2019-09-16 15:12:53', 'title' => ''],
'Progress' => ['description' => 'The current progress.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Tps' => ['description' => 'The number of transactions processed per second by the database.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Total' => ['description' => 'The total number of tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Expired' => ['description' => 'The expiration time.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
],
'title' => '',
'example' => '',
],
'FullRevise' => [
'description' => 'The full revision information.',
'type' => 'object',
'properties' => [
'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2019-09-16 15:12:53', 'title' => ''],
'Progress' => ['description' => 'The current progress.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Tps' => ['description' => 'The number of transactions processed per second by the database.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Total' => ['description' => 'The number of tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Expired' => ['description' => 'The expiration time.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Review' => [
'description' => 'The review information.',
'type' => 'object',
'properties' => [
'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2019-09-16 15:12:53', 'title' => ''],
'Progress' => ['description' => 'The progress.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Tps' => ['description' => 'The number of transactions processed per second by the database.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'Total' => ['description' => 'The number of tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'Expired' => ['description' => 'The expiration time.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Increment' => [
'description' => 'The incremental migration information.',
'type' => 'object',
'properties' => [
'Delay' => ['description' => 'The delay.', 'type' => 'integer', 'format' => 'int32', 'example' => '1568617906', 'title' => ''],
'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2019-09-16 15:12:53', 'title' => ''],
'Tps' => ['description' => 'The number of transactions processed per second by the database.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"5D64DE5944A1E541E0CB908A\\",\\n \\"Data\\": {\\n \\"Status\\": \\"增量追平\\",\\n \\"Stage\\": \\"2\\",\\n \\"Progress\\": \\"70\\",\\n \\"Expired\\": \\"0\\",\\n \\"TargetTableName\\": \\"a2\\",\\n \\"SourceTableName\\": \\"a1\\",\\n \\"Full\\": {\\n \\"StartTime\\": \\"2019-09-16 15:11:53\\",\\n \\"Progress\\": 100,\\n \\"Tps\\": 0,\\n \\"Total\\": 2,\\n \\"Expired\\": 0\\n },\\n \\"FullCheck\\": {\\n \\"StartTime\\": \\"2019-09-16 15:12:53\\",\\n \\"Progress\\": 0,\\n \\"Tps\\": 0,\\n \\"Total\\": 0,\\n \\"Expired\\": 0\\n },\\n \\"FullRevise\\": {\\n \\"StartTime\\": \\"2019-09-16 15:12:53\\",\\n \\"Progress\\": 0,\\n \\"Tps\\": 0,\\n \\"Total\\": 0,\\n \\"Expired\\": 0\\n },\\n \\"Review\\": {\\n \\"StartTime\\": \\"2019-09-16 15:12:53\\",\\n \\"Progress\\": 0,\\n \\"Tps\\": 10,\\n \\"Total\\": 5,\\n \\"Expired\\": 0\\n },\\n \\"Increment\\": {\\n \\"Delay\\": 1568617906,\\n \\"StartTime\\": \\"2019-09-16 15:12:53\\",\\n \\"Tps\\": 10\\n }\\n }\\n}","type":"json"}]',
'title' => 'Query shard change tool details',
'summary' => 'Queries the details of the shard change tool by calling DescribeShardTaskInfo.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeShardTaskInfo'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeShardTaskInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeSqlFlashbakTask' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds****c6vxxyzd', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5D64DE59-44A1-E541-E0CB-B7E5C4305162', 'title' => ''],
'SqlFlashbackTasks' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SqlFlashbackTask' => [
'description' => 'The flashback task object.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TableName' => ['description' => 'The name of the table to which the data belongs.', 'type' => 'string', 'example' => 'drds_params', 'title' => ''],
'SearchEndTime' => ['description' => 'The end time of the search.', 'type' => 'integer', 'format' => 'int64', 'example' => '1568509597000', 'title' => ''],
'ExpireTime' => ['description' => 'The expiration time of the download URL.', 'type' => 'integer', 'format' => 'int64', 'example' => '1569216270000', 'title' => ''],
'DownloadUrl' => ['description' => 'The download URL.', 'type' => 'string', 'example' => 'http://...', 'title' => ''],
'RecallProgress' => ['description' => 'The progress of the reverse recall.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'SqlPk' => ['description' => 'The primary key value associated with the SQL statement.', 'type' => 'string', 'example' => 'id', 'title' => ''],
'InstId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'drdshbga76p6****', 'title' => ''],
'RecallType' => ['description' => 'The recall type. Valid values:'."\n"
."\n"
.'- **0**: exact search'."\n"
.'- **1**: fuzzy match.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'SearchStartTime' => ['description' => 'The start time of the search.', 'type' => 'integer', 'format' => 'int64', 'example' => '1568609597000', 'title' => ''],
'GmtModified' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1568611469000', 'title' => ''],
'SqlCounter' => ['description' => 'The number of recovered data rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'DbName' => ['description' => 'The database name of the flashback task.', 'type' => 'string', 'example' => 'drds_flashback', 'title' => ''],
'RecallRestoreType' => ['description' => 'The restore type. Valid values:'."\n"
."\n"
.'- **1**: image-based restore'."\n"
.'- **2**: reverse restore.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'GmtCreate' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1568611408000', 'title' => ''],
'TraceId' => ['description' => 'The trace_id of the SQL statement.', 'type' => 'string', 'example' => 'trace', 'title' => ''],
'Id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '238', 'title' => ''],
'RecallStatus' => ['description' => 'The status of the data recall task.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'SqlType' => ['description' => 'The type of the SQL statement.', 'type' => 'string', 'example' => 'Insert,Update,Delete', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query flashback tasks',
'summary' => 'Queries the list of flashback tasks.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlFlashbakTask'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeSqlFlashbakTask',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"5D64DE59-44A1-E541-E0CB-B7E5C4305162\\",\\n \\"SqlFlashbackTasks\\": {\\n \\"SqlFlashbackTask\\": [\\n {\\n \\"TableName\\": \\"drds_params\\",\\n \\"SearchEndTime\\": 1568509597000,\\n \\"ExpireTime\\": 1569216270000,\\n \\"DownloadUrl\\": \\"http://...\\",\\n \\"RecallProgress\\": 10,\\n \\"SqlPk\\": \\"id\\",\\n \\"InstId\\": \\"drdshbga76p6****\\",\\n \\"RecallType\\": 1,\\n \\"SearchStartTime\\": 1568609597000,\\n \\"GmtModified\\": 1568611469000,\\n \\"SqlCounter\\": 0,\\n \\"DbName\\": \\"drds_flashback\\",\\n \\"RecallRestoreType\\": 1,\\n \\"GmtCreate\\": 1568611408000,\\n \\"TraceId\\": \\"trace\\",\\n \\"Id\\": 238,\\n \\"RecallStatus\\": 1,\\n \\"SqlType\\": \\"Insert,Update,Delete\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeTable' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '76053',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*********', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds_flashback', 'title' => ''],
],
[
'name' => 'TableName',
'in' => 'query',
'schema' => ['description' => 'The table name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'employee_split', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the API request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The unique request ID. If an issue occurs, provide this ID to support engineers for troubleshooting.', 'type' => 'string', 'example' => 'B5644ABB-559A-4A1C-83F2-9E7209******', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'List' => [
'description' => 'The collection of returned data.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Index' => ['description' => 'The primary key.', 'type' => 'string', 'example' => 'PRI', 'title' => ''],
'IsAllowNull' => ['description' => 'Indicates whether the column allows null values.', 'type' => 'string', 'example' => 'NO', 'title' => ''],
'ColumnName' => ['description' => 'The column name.', 'type' => 'string', 'example' => 'Id', 'title' => ''],
'IsPk' => ['description' => 'Indicates whether the column is a primary key.', 'type' => 'string', 'example' => 'YES', 'title' => ''],
'ColumnType' => ['description' => 'The column type.', 'type' => 'string', 'example' => 'bigint(20)', 'title' => ''],
'Extra' => ['description' => 'Extra', 'type' => 'string', 'example' => 'auto_increment', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Retrieve table schema information',
'summary' => 'Queries table schema information by calling the DescribeTable operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTable'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeTable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B5644ABB-559A-4A1C-83F2-9E7209******\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"Index\\": \\"PRI\\",\\n \\"IsAllowNull\\": \\"NO\\",\\n \\"ColumnName\\": \\"Id\\",\\n \\"IsPk\\": \\"YES\\",\\n \\"ColumnType\\": \\"bigint(20)\\",\\n \\"Extra\\": \\"auto_increment\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeTableListByType' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '76054',
'abilityTreeNodes' => ['FEATUREdrdsTIBR6Q'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdshbga76p6****', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds_flash****', 'title' => ''],
],
[
'name' => 'Query',
'in' => 'query',
'schema' => ['description' => 'The search field.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'drdshbga76p61861', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'TableType',
'in' => 'query',
'schema' => [
'description' => 'The table type.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enum' => ['SINGLE', 'SHARD'],
'example' => 'SINGLE',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'RequestId' => ['description' => 'The unique request ID. If an issue occurs, provide this ID to help troubleshoot the problem.', 'type' => 'string', 'example' => 'B360F47B-59E3-4D1C-BA03-6BFB1C993F88', 'title' => ''],
'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'List' => [
'description' => 'The returned collection.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Property' => ['description' => 'The property.', 'type' => 'string', 'example' => 'single', 'title' => ''],
'TableName' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'employee_split', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query tables by type',
'summary' => 'Queries a collection of tables by type by calling the DescribeTableListByType operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTableListByType'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeTableListByType',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"B360F47B-59E3-4D1C-BA03-6BFB1C993F88\\",\\n \\"Total\\": 1,\\n \\"Success\\": true,\\n \\"List\\": [\\n {\\n \\"Property\\": \\"single\\",\\n \\"TableName\\": \\"employee_split\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeTables' => [
'summary' => 'Calls the DescribeTables operation to retrieve a list of table information.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'Query',
'in' => 'query',
'schema' => ['description' => 'The query condition. Set this parameter to the instance ID of the target instance.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '83AC3D7E-461C-4D87-8ACD-6CC295******', 'title' => ''],
'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'List' => [
'description' => 'The list of table information returned.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The status of the split task. Valid values:'."\n"
."\n"
.'- 0: Normal. No task is running.'."\n"
.'- 1: Changing. A split task is running.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'IsLocked' => ['description' => 'Indicates whether the table is locked.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'ShardKey' => ['description' => 'The shard key.', 'type' => 'string', 'example' => 'null', 'title' => ''],
'IsShard' => ['description' => 'Indicates whether the table is sharded.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'Broadcast' => ['description' => 'Indicates whether the table is a broadcast table.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'AllowFullTableScan' => ['description' => 'Indicates whether full table scan is allowed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'Table' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'DbInstType' => ['description' => 'The instance type. Valid values:'."\n"
."\n"
.'- 0: dedicated'."\n"
.'- 1: shared.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Retrieve table information list',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTables'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeTables',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"83AC3D7E-461C-4D87-8ACD-6CC295******\\",\\n \\"Total\\": 1,\\n \\"Success\\": true,\\n \\"List\\": [\\n {\\n \\"Status\\": 0,\\n \\"IsLocked\\": false,\\n \\"ShardKey\\": \\"null\\",\\n \\"IsShard\\": false,\\n \\"Broadcast\\": false,\\n \\"AllowFullTableScan\\": false,\\n \\"Table\\": \\"test\\",\\n \\"DbInstType\\": 0\\n }\\n ]\\n}","type":"json"}]',
],
'DisableSqlAudit' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds***********', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the DRDS database.', 'type' => 'string', 'required' => true, 'example' => 'drds_test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E273749A-9A33-44CF-ABE7-0CB19C******', 'title' => ''],
'Result' => ['description' => 'The returned result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Success' => ['description' => 'Indicates whether the API request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Cancel SQL audit',
'summary' => 'Calls the DisableSqlAudit operation to cancel SQL audit.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableSqlAudit'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:DisableSqlAudit',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E273749A-9A33-44CF-ABE7-0CB19C******\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
],
'EnableInstanceIpv6Address' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '76059',
'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region where the instance resides.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'The request result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7E9F7F16-05B5-42DA-94D6-E36402******', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. 默认错误码', 'description' => ''],
],
],
'title' => 'Create an iPv6 address',
'summary' => 'Calls the EnableInstanceIpv6Address operation to create an IPv6 address.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableInstanceIpv6Address'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:EnableInstanceIpv6Address',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"7E9F7F16-05B5-42DA-94D6-E36402******\\"\\n}","type":"json"}]',
],
'EnableSqlAudit' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds***********', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the database for which to enable SQL audit.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'IsRecall',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to recall historical SQL statements for auditing.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'RecallStartTimestamp',
'in' => 'query',
'schema' => ['description' => 'The start time of the recall period. The value is a UNIX timestamp in milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1568875132000', 'title' => ''],
],
[
'name' => 'RecallEndTimestamp',
'in' => 'query',
'schema' => ['description' => 'The end time of the recall period. The value is a UNIX timestamp in milliseconds.'."\n"
.'>The end time must be later than the start time.', 'type' => 'string', 'required' => false, 'example' => '1568875132000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '463A5F0F-12AD-4544-A902-B2B983******', 'title' => ''],
'Result' => ['description' => 'Indicates whether the SQL audit feature is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Enable SQL audit',
'summary' => 'Enables the SQL audit feature by calling the EnableSqlAudit operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableSqlAudit'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:EnableSqlAudit',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"463A5F0F-12AD-4544-A902-B2B983******\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
],
'EnableSqlFlashbackMatchSwitch' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '76062',
'abilityTreeNodes' => ['FEATUREdrds73QXOU'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds***********', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the target database.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '463A5F0F-12AD-4544-A902-B2B983******', 'title' => ''],
'Result' => ['description' => 'The result of the enabling operation.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"463A5F0F-12AD-4544-A902-B2B983******\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'Precisely restore data with SQL flashback',
'summary' => 'At this point, the BINLOG of the ApsaraDB RDS instance used by the DRDS database includes the information about executed queries.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableSqlFlashbackMatchSwitch'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:EnableSqlFlashbackMatchSwitch',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'FlashbackRecycleBinTable' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '76063',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance where the table is located.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the database where the table is located.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'TableName',
'in' => 'query',
'schema' => ['description' => 'The name of the logical table that you want to restore.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'Indicates whether the deleted logical table is restored.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '463A5F0F-12AD-4544-A902-B2B983******', 'title' => ''],
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'FlashbackRecycleBinTable',
'summary' => 'Restores a deleted logical table.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FlashbackRecycleBinTable'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:FlashbackRecycleBinTable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"463A5F0F-12AD-4544-A902-B2B983******\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'GetDrdsDbRdsRelationInfo' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '76066',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdshbga948vbpd2', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testDb', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the query was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '82FD0D9B-9A65-40D3-B1D9-8851B1D4AF75', 'title' => ''],
'Data' => [
'description' => 'The list of storage instance structures. Each item corresponds to a primary storage instance.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RdsInstanceId' => ['description' => 'The storage instance ID.', 'type' => 'string', 'example' => 'rm-bp16ad920ndxxxx02', 'title' => ''],
'UsedInstanceType' => ['description' => 'The type of the storage instance in use.', 'type' => 'string', 'example' => 'RDS', 'title' => ''],
'UsedInstanceId' => ['description' => 'The instance ID of the storage instance in use. For a primary DRDS instance, this is the primary storage instance. For a read-only DRDS instance, this is the selected storage instance.', 'type' => 'string', 'example' => 'rm-bp1l8xi1dd9xxxxbj', 'title' => ''],
'ReadOnlyInstanceInfo' => [
'type' => 'array',
'items' => ['description' => 'The list of read-only storage instance IDs.', 'type' => 'string', 'example' => '[]', 'title' => ''],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query database storage instance structure',
'summary' => 'Calls the GetDrdsDbRdsRelationInfo operation to query the storage instance structure of a database.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDrdsDbRdsRelationInfo'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:GetDrdsDbRdsRelationInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"82FD0D9B-9A65-40D3-B1D9-8851B1D4AF75\\",\\n \\"Data\\": [\\n {\\n \\"RdsInstanceId\\": \\"rm-bp16ad920ndxxxx02\\",\\n \\"UsedInstanceType\\": \\"RDS\\",\\n \\"UsedInstanceId\\": \\"rm-bp1l8xi1dd9xxxxbj\\",\\n \\"ReadOnlyInstanceInfo\\": [\\n \\"[]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'ListTagResources' => [
'summary' => 'Queries the labels bound to resources by calling ListTagResources.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdrdsD0NTUP'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => 'The resource type. Set this parameter to INSTANCE.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enum' => ['INSTANCE'],
'example' => 'INSTANCE',
'title' => '',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The pagination token.', 'type' => 'string', 'required' => false, 'example' => '6ab4640a-479b-41d0-ad3c-c6e888bc3d8f', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of labels.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The key of the label.', 'type' => 'string', 'required' => false, 'example' => 'color', 'title' => ''],
'Value' => ['description' => 'The value of the label.', 'type' => 'string', 'required' => false, 'example' => 'red', 'title' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 21,
'title' => '',
'example' => '',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of resources.',
'type' => 'array',
'items' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => 'dm-hbgau1zp****', 'title' => ''],
'required' => false,
'maxItems' => 51,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => 'The pagination token.', 'type' => 'string', 'example' => '6ab4640a-479b-41d0-ad3c-c6e888bc3d8f', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '58CE1CB0-F0F4-4BA3-B876-135DC47DF52F', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'TagResources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagResource' => [
'description' => 'The list of label resources.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ResourceType' => ['description' => 'The resource type. Set this parameter to INSTANCE.', 'type' => 'string', 'example' => 'INSTANCE', 'title' => ''],
'TagValue' => ['description' => 'The value of the label.', 'type' => 'string', 'example' => '1', 'title' => ''],
'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'drdshzsd11****', 'title' => ''],
'TagKey' => ['description' => 'The key of the label.', 'type' => 'string', 'example' => 'test', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter.tagKey', 'errorMessage' => 'Check the parameter tagKey %s', 'description' => ''],
['errorCode' => 'InvalidParameter.tagValue', 'errorMessage' => 'Check the parameter tagValue %s', 'description' => ''],
['errorCode' => 'InvalidParameter.tags.exceed', 'errorMessage' => 'Tags num exceed 10', 'description' => ''],
['errorCode' => 'InvalidParameter.instanceId.and.tags', 'errorMessage' => 'you must have one of Tags and InstanceId', 'description' => ''],
['errorCode' => 'InvalidParameter.tags.json.error', 'errorMessage' => 'The parameter tags is not a JsonArray', 'description' => ''],
['errorCode' => 'TagService.%s', 'errorMessage' => 'TagService return errorMsg: %s', 'description' => ''],
['errorCode' => 'TagApi.InvalidParameter.resourceId.exceed', 'errorMessage' => 'ResourceId num exceed 50', 'description' => ''],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Query labels bound to resources',
'changeSet' => [
['createdAt' => '2025-06-10T03:11:23.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:ListTagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"6ab4640a-479b-41d0-ad3c-c6e888bc3d8f\\",\\n \\"RequestId\\": \\"58CE1CB0-F0F4-4BA3-B876-135DC47DF52F\\",\\n \\"Success\\": true,\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"INSTANCE\\",\\n \\"TagValue\\": \\"1\\",\\n \\"ResourceId\\": \\"drdshzsd11****\\",\\n \\"TagKey\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ManagePrivateRds' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the PolarDB-X instance.'."\n"
.'The region ID of the DRDS instance.'."\n"
.'> You can call [DescribeDrdsInstances](~~139284~~) to query the details of all instances in the target account, including the region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hanzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the PolarDB-X instance.'."\n"
.'The ID of the DRDS instance.'."\n"
.'> You can call [DescribeDrdsInstances](~~139284~~) to query the details of all instances in the target account, including the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*************', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the private custom RDS instance in the storage layer.'."\n"
."\n"
.'> You can call [DescribeDrdsRdsInstances](~~215526~~) to query the details of all private custom RDS instances in the storage layer, including the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-***************', 'title' => ''],
],
[
'name' => 'RdsAction',
'in' => 'query',
'schema' => ['description' => 'The following management operations are supported for private custom RDS instances:'."\n"
.'* **DescribeDBInstanceAttribute**: Queries the details of a private custom RDS instance.'."\n"
.'* **DescribeAvailableClasses**: Queries the available instance types of a private custom RDS instance, including the instance type code and storage capacity.'."\n"
.'* **DescribeSQLCollectorPolicy**: Queries the SQL Explorer (SQL audit) status of a private custom RDS instance.'."\n"
.'* **ModifySQLCollectorPolicy**: Enables or disables the SQL Explorer (SQL audit) feature for a private custom RDS instance.'."\n"
.'* **DescribeParameters**: Queries the current parameter settings of a private custom RDS instance.'."\n"
.'* **ModifyParameter**: Modifies the parameters of a private custom RDS instance.'."\n"
.'* **DescribeDBInstanceHAConfig**: Queries the high-availability mode and data replication mode of a private custom RDS instance.'."\n"
.'* **SwitchDBInstanceHA**: Switches over the primary and secondary instances of a private custom RDS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SwitchDBInstanceHA', 'title' => ''],
],
[
'name' => 'Params',
'in' => 'query',
'schema' => ['description' => 'A JSON string that contains the request parameters and their values to be forwarded to the private custom RDS API operation. All parameter values must be of the STRING type. Example: `{NodeId:"1797****"}`.'."\n"
."\n"
.'For the request parameters and valid values of each private custom RDS API operation, see the request parameters section in the following topics:'."\n"
.'* [DescribeDBInstanceAttribute](~~26231~~)'."\n"
.'* [DescribeAvailableClasses](~~196546~~)'."\n"
.'* [DescribeSQLCollectorPolicy](~~26292~~)'."\n"
.'* [ModifySQLCollectorPolicy](~~26293~~)'."\n"
.'* [DescribeParameters](~~26285~~)'."\n"
.'* [ModifyParameter](~~26286~~)'."\n"
.'* [DescribeDBInstanceHAConfig](~~26244~~)'."\n"
.'* [SwitchDBInstanceHA](~~26251~~)'."\n"
."\n"
.'> For the required request parameters of the preceding API operations, you do not need to specify the Action and DBInstanceId parameters. All other required request parameters must be specified.', 'type' => 'string', 'required' => false, 'default' => '{}', 'example' => '{NodeId:"1797****"}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'The result set returned by the forwarded private custom RDS API operation.', 'type' => 'string', 'example' => '{"requestId":"E63C810A-4A13-47B6-BA67-C0E23A******"}', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0237BCD2-2C7A-4F86-A766-657AF6******', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'RDSAPI.ERROR', 'errorMessage' => 'Failed to call the RDS API operation.', 'description' => ''],
],
],
'title' => 'Manage private RDS instances',
'summary' => 'Calls the ManagePrivateRds operation to manage private custom RDS instances in the storage layer.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ManagePrivateRds'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'drds:ManagePrivateRds',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\\\\\\"requestId\\\\\\":\\\\\\"E63C810A-4A13-47B6-BA67-C0E23A******\\\\\\"}\\",\\n \\"RequestId\\": \\"0237BCD2-2C7A-4F86-A766-657AF6******\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'ModifyAccountDescription' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => ['description' => 'The account name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The account description.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'The request result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2F93CCD5-806F-4470-BBC7-20476A******', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OperationFailed.ModifyAccountDescription', 'errorMessage' => 'Modify account description failed.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Modify account description',
'summary' => 'Calls the ModifyAccountDescription operation to modify the description of an account.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountDescription'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'drds:ModifyAccountDescription',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"2F93CCD5-806F-4470-BBC7-20476A******\\"\\n}","type":"json"}]',
],
'ModifyAccountPrivilege' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdshbgaen89****', 'title' => ''],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => ['description' => 'The account name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'account_sec', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DbPrivilege',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of database permissions.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DbName' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'test123', 'title' => ''],
'Privilege' => ['description' => 'The account permission.', 'type' => 'string', 'required' => false, 'example' => 'ReadWrite', 'title' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 1000,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OperationFailed.ModifyAccountPrivilege', 'errorMessage' => 'Modify account privilege failed.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Modify account permissions',
'summary' => 'Modifies the permissions of an account.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountPrivilege'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'drds:ModifyAccountPrivilege',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"73559800-3c8c-11ec-bd40-99cfcff3fe1e\\"\\n}","type":"json"}]',
],
'ModifyDrdsInstanceDescription' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the instance.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C44CA24C-C7C4-4C0F-8AC9-1343F2******', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [],
'title' => 'Modify instance description',
'summary' => 'Modifies the description of a Distributed Relational Database Service (DRDS) instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDrdsInstanceDescription'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:ModifyDrdsInstanceDescription',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"C44CA24C-C7C4-4C0F-8AC9-1343F2******\\"\\n}","type":"json"}]',
],
'ModifyDrdsIpWhiteList' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '76084',
'abilityTreeNodes' => ['FEATUREdrdsJOW4UL'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds****c6vxxyzd', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'IpWhiteList',
'in' => 'query',
'schema' => ['description' => 'The modified IP whitelist. Separate multiple IP addresses with commas (,).', 'type' => 'string', 'required' => true, 'example' => '127.***.***.***,10.***.***.***', 'title' => ''],
],
[
'name' => 'Mode',
'in' => 'query',
'schema' => ['description' => 'The modification mode. Valid values:'."\n"
.'* `true`: append mode '."\n"
.'* `false`: overwrite mode.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => 'The whitelist group name.', 'type' => 'string', 'required' => false, 'example' => 'drds_******', 'title' => ''],
],
[
'name' => 'GroupAttribute',
'in' => 'query',
'schema' => ['description' => 'The description of the whitelist group.', 'type' => 'string', 'required' => false, 'example' => '分组1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the API request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '933A1EC2-8260-4D4F-A56A-73BA27******', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Modify database IP whitelist',
'summary' => 'Calls the ModifyDrdsIpWhiteList operation to modify the IP whitelist of a database.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-04-08T10:36:53.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-03-27T10:45:49.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDrdsIpWhiteList'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:ModifyDrdsIpWhiteList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"933A1EC2-8260-4D4F-A56A-73BA27******\\"\\n}","type":"json"}]',
],
'ModifyPolarDbReadWeight' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'DbNodeIds',
'in' => 'query',
'schema' => ['description' => 'The list of nodes in the target PolarDB cluster. Nodes from different clusters are separated by commas (,), and nodes within the same cluster are separated by colons (:).', 'type' => 'string', 'required' => true, 'example' => 'pi-****************,pi-****************:pi-****************', 'title' => ''],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the PolarDB cluster.', 'type' => 'string', 'required' => true, 'example' => 'pc-****************', 'title' => ''],
],
[
'name' => 'Weights',
'in' => 'query',
'schema' => ['description' => 'The weights corresponding to PolarDB groups. Separate multiple weights with commas (,).', 'type' => 'string', 'required' => true, 'example' => '14,86', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B12FC174-D5CE-4A6E-83C1-0F8F86******', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter.InvalidDbName', 'errorMessage' => 'The dbName does not exist in this drds instance', 'description' => ''],
['errorCode' => 'InvalidParameter.ReadWeighAndRdsNotMapping', 'errorMessage' => 'The parameter read weight and rds instance not mapping', 'description' => ''],
['errorCode' => 'InvalidParameter.InvalidReadWeight', 'errorMessage' => 'The parameter read weight is invalid', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Modify read and write weights of polarDB',
'summary' => 'Modifies the read and write weights of a PolarDB cluster by calling the ModifyPolarDbReadWeight operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPolarDbReadWeight'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:ModifyPolarDbReadWeight',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B12FC174-D5CE-4A6E-83C1-0F8F86******\\"\\n}","type":"json"}]',
],
'ModifyRdsReadWeight' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'InstanceNames',
'in' => 'query',
'schema' => ['description' => 'The list of ApsaraDB RDS instances. Separate multiple instances with commas (,).', 'type' => 'string', 'required' => true, 'example' => 'rm-****************,rm-****************', 'title' => ''],
],
[
'name' => 'Weights',
'in' => 'query',
'schema' => ['description' => 'The weight values corresponding to each ApsaraDB RDS instance. Separate multiple weight values with commas (,).', 'type' => 'string', 'required' => true, 'example' => '14,86', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B12FC174-D5CE-4A6E-83C1-0F8F86******', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter.InvalidDbName', 'errorMessage' => 'The dbName does not exist in this drds instance', 'description' => ''],
['errorCode' => 'InvalidParameter.ReadWeighAndRdsNotMapping', 'errorMessage' => 'The parameter read weight and rds instance not mapping', 'description' => ''],
['errorCode' => 'InvalidParameter.InvalidReadWeight', 'errorMessage' => 'The parameter read weight is invalid', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Modify read and write weights of an apsaraDB RDS instance',
'summary' => 'Modifies the read and write weights of an ApsaraDB RDS instance by calling the ModifyRdsReadWeight operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyRdsReadWeight'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:ModifyRdsReadWeight',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B12FC174-D5CE-4A6E-83C1-0F8F86******\\"\\n}","type":"json"}]',
],
'PutStartBackup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '76095',
'abilityTreeNodes' => ['FEATUREdrds8KEOBF'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds****c6vxxyzd', 'title' => ''],
],
[
'name' => 'BackupMode',
'in' => 'query',
'schema' => ['description' => 'The backup mode. For more information, see [Backup modes](~~108631~~). Valid values:'."\n"
."\n"
.'* phy: fast backup'."\n"
.'* logic: consistent backup.', 'type' => 'string', 'required' => false, 'example' => 'phy', 'title' => ''],
],
[
'name' => 'BackupLevel',
'in' => 'query',
'schema' => ['description' => 'The backup level. Valid values: '."\n"
.'* instance: instance-level backup '."\n"
.'* db: database-level backup.', 'type' => 'string', 'required' => false, 'example' => 'db', 'title' => ''],
],
[
'name' => 'BackupDbNames',
'in' => 'query',
'schema' => ['description' => 'The list of databases to back up if you perform a database-level backup. Separate multiple database names with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'db_1, db_2', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5D64DE5944A1E541E0******', 'title' => ''],
'Result' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the API request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Submit a data backup task',
'summary' => 'Submits a data backup task by calling the PutStartBackup operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutStartBackup'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:PutStartBackup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5D64DE5944A1E541E0******\\",\\n \\"Result\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'RefreshDrdsAtomUrl' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B12FC174-D5CE-4A6E-83C1-0F8F86******', 'title' => ''],
'Result' => ['description' => 'The result of refreshing the shard connections.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Success' => ['description' => 'Indicates whether the API request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Refresh DRDS shard connections',
'summary' => 'After an RDS connection changes, refreshes the DRDS shard connections to ensure connectivity to RDS.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshDrdsAtomUrl'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:RefreshDrdsAtomUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B12FC174-D5CE-4A6E-83C1-0F8F86******\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
],
'ReleaseInstanceInternetAddress' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-beijing', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'The result returned by the current API operation.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FD17CD3C-3355-49E8-9231-FE2DB0******', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. 默认错误码', 'description' => ''],
],
],
'title' => 'Release the public endpoint of an instance',
'summary' => 'Ensures instance security.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseInstanceInternetAddress'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'drds:ReleaseInstanceInternetAddress',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"FD17CD3C-3355-49E8-9231-FE2DB0******\\"\\n}","type":"json"}]',
],
'RemoveBackupsSet' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '76103',
'abilityTreeNodes' => ['FEATUREdrdsE1M93A'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'BackupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the backup set. You can call the [DescribeBackupSets](~~139331~~) operation to query the backup set ID.', 'type' => 'string', 'required' => true, 'example' => 'ba30d5c4-a6dc-11ea-bd40-************', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '70FED5BE-4DDC-4556-AD35-5A6D27******', 'title' => ''],
'Result' => ['description' => 'The returned result.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the API request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Delete a backup set',
'summary' => 'Calls the RemoveBackupsSet operation to delete a backup set.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveBackupsSet'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:RemoveBackupsSet',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"70FED5BE-4DDC-4556-AD35-5A6D27******\\",\\n \\"Result\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'RemoveDrdsDb' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance to which the target database belongs.', 'type' => 'string', 'required' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the target database.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the API request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B12FC174-D5CE-4A6E-83C1-0F8F86******', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Delete a database',
'summary' => 'Deletes a database from a DRDS instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveDrdsDb'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'drds:RemoveDrdsDb',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B12FC174-D5CE-4A6E-83C1-0F8F86******\\"\\n}","type":"json"}]',
],
'RemoveDrdsDbFailedRecord' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '76107',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D98BC610-5A91-453A-BC44-5873EF******', 'title' => ''],
'Result' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDbName.Empty', 'errorMessage' => 'DbName can not be empty', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Delete a failed database creation record',
'summary' => 'Calls the RemoveDrdsDbFailedRecord operation to delete a failed database creation record.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveDrdsDbFailedRecord'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:RemoveDrdsDbFailedRecord',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D98BC610-5A91-453A-BC44-5873EF******\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
],
'RemoveDrdsInstance' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ReleasePrepayInstance', 'errorMessage' => 'The pay type of this drds instance is prepay', 'description' => ''],
['errorCode' => 'RemoveDrdsDBFirst', 'errorMessage' => 'There are Drds DB exist in this instance. Please delete drds db first', 'description' => ''],
],
500 => [
['errorCode' => 'ERR_INSTANCE_RELEASE_ALREADY', 'errorMessage' => '实例已释放', 'description' => ''],
['errorCode' => 'ERR_INSTANCE_CAN_NOT_RELEASE', 'errorMessage' => '实例暂时无法释放', 'description' => ''],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\"\\n}","type":"json"}]',
'title' => 'Release a target instance',
'summary' => 'Calls the RemoveDrdsInstance operation to release a target instance.',
'description' => '> * Only pay-as-you-go (postpaid) instances can be released.'."\n"
.'* You cannot call this operation to release an instance that is undergoing a specification change or is associated with databases.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveDrdsInstance'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'drds:RemoveDrdsInstance',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
],
'RemoveInstanceAccount' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds***********', 'title' => ''],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => ['description' => 'The name of the account.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OperationFailed.RemoveInstanceAccount', 'errorMessage' => 'Remove instance account failed', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Delete an Instance Management Account',
'summary' => 'Calls the RemoveInstanceAccount operation to delete an instance management account.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveInstanceAccount'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'drds:RemoveInstanceAccount',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\"\\n}","type":"json"}]',
],
'RemoveRecycleBinTable' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '76111',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the DRDS database.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'TableName',
'in' => 'query',
'schema' => ['description' => 'The name of the DRDS logical table.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'Indicates whether the table was purged from the recycle bin.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', 'title' => ''],
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Purge a table from the recycle bin',
'summary' => 'Purges a table from the recycle bin.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveRecycleBinTable'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:RemoveRecycleBinTable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'RestartDrdsInstance' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '76113',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds************', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', 'title' => ''],
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'TaskId' => ['description' => 'The asynchronous task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\",\\n \\"Success\\": true,\\n \\"TaskId\\": 1\\n}","type":"json"}]',
'title' => 'Restart an instance',
'summary' => 'Restarts a Distributed Relational Database Service (DRDS) instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartDrdsInstance'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:RestartDrdsInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'RollbackInstanceVersion' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '76115',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'Indicates whether the instance version is rolled back.', 'type' => 'string', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DSSDF-SEWE-*****', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. 默认错误码', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\"\\n}","type":"json"}]',
'title' => 'Roll back the version of a DRDS instance',
'summary' => 'Rolls back the version of a DRDS instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RollbackInstanceVersion'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:RollbackInstanceVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'SetBackupLocal' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The DRDS instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drdshbgag23d13fds', 'title' => ''],
],
[
'name' => 'LocalLogRetentionHours',
'in' => 'query',
'schema' => ['description' => 'The number of hours for which log backups are retained locally. Valid values: 0 to 168 (7 × 24). A value of 0 indicates that log backups are not retained. Default value: 18.', 'type' => 'string', 'required' => false, 'example' => '12', 'title' => ''],
],
[
'name' => 'LocalLogRetentionSpace',
'in' => 'query',
'schema' => ['description' => 'The maximum space usage of binary logs, in percentage. Valid values: 0 to 50. This is a loop space. Default value: 30.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''],
],
[
'name' => 'HighSpaceUsageProtection',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to unconditionally clean up binary logs when the instance storage usage is 90% or higher, or the remaining storage is less than 5 GB. Valid values:'."\n"
.'- 1: enabled.'."\n"
.'- 0: disabled.', 'type' => 'string', 'required' => false, 'example' => '80', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F70CE62-5077-4B7B-95BC-4DAC45614DBE', 'title' => ''],
'Result' => ['description' => 'The result of the operation.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Success' => ['description' => 'The result of the API call.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Set local backup set policy',
'summary' => 'Modifies the backup policy.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetBackupLocal'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'drds:SetBackupLocal',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F70CE62-5077-4B7B-95BC-4DAC45614DBE\\",\\n \\"Result\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'SetBackupPolicy' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'PreferredBackupPeriod',
'in' => 'query',
'schema' => ['description' => 'The backup cycle. Valid values:'."\n"
.'* 0: Monday'."\n"
.'* 1: Tuesday'."\n"
.'* 2: Wednesday'."\n"
.'* 3: Thursday'."\n"
.'* 4: Friday'."\n"
.'* 5: Saturday'."\n"
.'* 6: Sunday', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'PreferredBackupStartTime',
'in' => 'query',
'schema' => ['description' => 'The start time of the backup.', 'type' => 'string', 'required' => false, 'example' => '11:30:30', 'title' => ''],
],
[
'name' => 'PreferredBackupEndTime',
'in' => 'query',
'schema' => ['description' => 'The end time of the backup.', 'type' => 'string', 'required' => false, 'example' => '12:30:30', 'title' => ''],
],
[
'name' => 'BackupMode',
'in' => 'query',
'schema' => ['description' => 'The backup mode. Valid values:'."\n"
.'* **logic**: logical backup'."\n"
.'* **phy**: physical backup', 'type' => 'string', 'required' => false, 'example' => 'phy', 'title' => ''],
],
[
'name' => 'BackupLevel',
'in' => 'query',
'schema' => ['description' => 'The backup level. Valid values:'."\n"
.'* db: database level'."\n"
.'* instance: instance level', 'type' => 'string', 'required' => false, 'example' => 'db', 'title' => ''],
],
[
'name' => 'BackupDbNames',
'in' => 'query',
'schema' => ['description' => 'The databases to back up. Separate multiple databases with commas (,).'."\n"
.'> This parameter takes effect only when the backup level is set to database level.', 'type' => 'string', 'required' => false, 'example' => 'test1,test2', 'title' => ''],
],
[
'name' => 'BackupLog',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable backup logging. Valid values:'."\n"
.'* 1: enabled'."\n"
.'* 0: disabled', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'DataBackupRetentionPeriod',
'in' => 'query',
'schema' => ['description' => 'The number of days for which data backups are retained. Valid values: 7 to 730.', 'type' => 'string', 'required' => false, 'example' => '7', 'title' => ''],
],
[
'name' => 'LogBackupRetentionPeriod',
'in' => 'query',
'schema' => ['description' => 'The number of days for which log backups are retained. Valid values: 7 to 730. The value must be less than or equal to the data backup retention period.', 'type' => 'string', 'required' => false, 'example' => '7', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', 'title' => ''],
'Result' => ['description' => 'Indicates whether the backup policy is set.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Set backup policy',
'summary' => 'Sets a backup policy.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetBackupPolicy'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:SetBackupPolicy',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\",\\n \\"Result\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'SetupBroadcastTables' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '76118',
'abilityTreeNodes' => ['FEATUREdrds6IJXJ3'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the DRDS database.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'Active',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to activate the broadcast table feature.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''],
],
[
'name' => 'TableName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The name of the DRDS table.',
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'required' => true,
'example' => 'test',
'maxItems' => 20,
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'Indicates whether the broadcast table was set up successfully.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', 'title' => ''],
'Success' => ['description' => 'Indicates whether the API request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'Set up broadcast tables',
'summary' => 'Calls the SetupBroadcastTables operation to set up broadcast tables.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetupBroadcastTables'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:SetupBroadcastTables',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
],
'SetupDrdsParams' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '76119',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdsjiii1b49****', 'title' => ''],
],
[
'name' => 'ParamLevel',
'in' => 'query',
'schema' => ['description' => 'The level at which the parameters are configured. Valid values:'."\n"
."\n"
.'- **NSTANCE**: instance level'."\n"
.'- **DB**: database level.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DB', 'title' => ''],
],
[
'name' => 'Data',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of parameters.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DbName' => ['description' => 'The name of the database to which the parameter applies.', 'type' => 'string', 'required' => false, 'example' => 'test_db', 'title' => ''],
'ParamType' => ['description' => 'The parameter type. Valid values:'."\n"
."\n"
.'- **ATOM**: a configuration item in the Layer 3 data source.'."\n"
.'- **CONFIG**: a configuration item in Server Config.'."\n"
.'- **DIAMOND**: a configuration item in Diamond.', 'type' => 'string', 'required' => false, 'example' => 'ATOM', 'title' => ''],
'ParamValue' => ['description' => 'The parameter value.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''],
'ParamVariableName' => ['description' => 'The parameter name.', 'type' => 'string', 'required' => false, 'example' => 'FORBID_EXECUTE_DML_ALL', 'title' => ''],
'ParamRanges' => ['description' => 'The valid value range of the parameter.', 'type' => 'string', 'required' => false, 'example' => '[true|false]', 'title' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 20,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'The returned result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Configure instance parameters',
'summary' => 'Configures the parameters of an instance by calling the SetupDrdsParams operation.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetupDrdsParams'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:SetupDrdsParams',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'SetupRecycleBinStatus' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The DRDS instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'StatusAction',
'in' => 'query',
'schema' => ['description' => 'The enabling status of the table recycle bin. Valid values:'."\n"
."\n"
.'* enable'."\n"
.'* disable.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'enable', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'Indicates whether the table recycle bin is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', 'title' => ''],
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Enable table recycle bin',
'summary' => 'Calls the SetupRecycleBinStatus operation to enable the table recycle bin.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetupRecycleBinStatus'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'drds:SetupRecycleBinStatus',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'SetupTable' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '76121',
'abilityTreeNodes' => ['FEATUREdrdsTIBR6Q'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds************', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the database to which the table belongs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'AllowFullTableScan',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to allow full table scan.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''],
],
[
'name' => 'TableName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The names of the associated tables.',
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'required' => true,
'example' => 'test',
'maxItems' => 20,
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'Indicates whether the full table scan is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'Enable full table scan',
'summary' => 'Calls the SetupTable operation to enable full table scan.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetupTable'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:SetupTable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'StartRestore' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'rds********', 'title' => ''],
],
[
'name' => 'PreferredBackupTime',
'in' => 'query',
'schema' => ['description' => 'The restoration time of the instance. The value is in the `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'required' => false, 'example' => '2019-09-10 20:18:18', 'title' => ''],
],
[
'name' => 'BackupMode',
'in' => 'query',
'schema' => ['description' => 'The backup mode. Valid values:'."\n"
."\n"
.'* logic: logical backup'."\n"
.'* phy: fast backup.', 'type' => 'string', 'required' => false, 'example' => 'phy', 'title' => ''],
],
[
'name' => 'BackupLevel',
'in' => 'query',
'schema' => ['description' => 'The backup level. Valid values:'."\n"
."\n"
.'* db: database level'."\n"
.'* instance: instance level.', 'type' => 'string', 'required' => false, 'example' => 'db', 'title' => ''],
],
[
'name' => 'BackupDbNames',
'in' => 'query',
'schema' => ['description' => 'The list of database names to restore. Separate multiple database names with commas (,).'."\n"
.'> If you do not specify any database names, all databases in the instance are restored by default.', 'type' => 'string', 'required' => false, 'example' => 'test1,test2', 'title' => ''],
],
[
'name' => 'BackupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the DRDS backup set.'."\n"
.'> If you do not specify this parameter, the restoration is performed based on the point in time specified by PreferredBackupTime.', 'type' => 'string', 'required' => false, 'example' => '23***', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '721C71DD-D3D0-4327-BFDD-678326******', 'title' => ''],
'Result' => ['description' => 'The returned result.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Success' => ['description' => 'The request result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Start a backup-based restoration task',
'summary' => 'Starts a backup-based restoration task by calling the StartRestore operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartRestore'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:StartRestore',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"721C71DD-D3D0-4327-BFDD-678326******\\",\\n \\"Result\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'SubmitCleanTask' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds*********', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the database to be scaled.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'ParentJobId',
'in' => 'query',
'schema' => ['description' => 'The task ID of the scaling task. This ID is returned when you submit the scaling task request.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => 'The job ID of the scaling task. The value is the same as that of ParentJobId.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''],
],
[
'name' => 'ExpandType',
'in' => 'query',
'schema' => ['description' => 'The scaling type. Valid values:'."\n"
."\n"
.'* **smooth_expand**: smooth scale-out'."\n"
.'* **hot_expand**: hotspot update.', 'type' => 'string', 'required' => true, 'example' => 'smooth_expand', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DSSDF-SEWE-*****', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Submit a cleanup task for a scaling operation',
'summary' => 'Submits a cleanup task for a scaling operation by calling the SubmitCleanTask operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitCleanTask'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'drds:SubmitCleanTask',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\"\\n}","type":"json"}]',
],
'SubmitHotExpandPreCheckTask' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '76134',
'abilityTreeNodes' => ['FEATUREdrdsR9AYAV'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drd*********', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the DRDS database.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'DbInstType',
'in' => 'query',
'schema' => ['description' => 'The type of the database. Valid values:'."\n"
.'* RDS'."\n"
.'* POLARDB.', 'type' => 'string', 'required' => true, 'example' => 'RDS', 'title' => ''],
],
[
'name' => 'TableList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The table name.',
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => 'test',
'maxItems' => 30,
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Msg' => ['description' => 'The result of the task submission.', 'type' => 'string', 'example' => 'scucess', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FE104D26-AC19-49B5-AC67-947F69*****', 'title' => ''],
'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11111', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Msg\\": \\"scucess\\",\\n \\"RequestId\\": \\"FE104D26-AC19-49B5-AC67-947F69*****\\",\\n \\"TaskId\\": 11111,\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'Submit a hotspot scaling dry run task',
'summary' => 'Performs checks that mainly include checking for table without primary key.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitHotExpandPreCheckTask'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:SubmitHotExpandPreCheckTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'SubmitHotExpandTask' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '76135',
'abilityTreeNodes' => ['FEATUREdrdsR9AYAV'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drdshbga1138****', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'TaskName',
'in' => 'query',
'schema' => ['description' => 'The task name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'TaskDesc',
'in' => 'query',
'schema' => ['description' => 'The task description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'InstanceDbMapping',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of target instance data.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DbList' => ['description' => 'The target hotspot sharded databases.', 'type' => 'string', 'required' => true, 'example' => 'hot_test_****_****', 'title' => ''],
'InstanceName' => ['description' => 'The name of the ApsaraDB RDS instance where the target hotspot database resides.', 'type' => 'string', 'required' => false, 'example' => 'rm-bp1t1mk5a5bdj****', 'title' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 30,
'title' => '',
'example' => '',
],
],
[
'name' => 'Mapping',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of target database data.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'HotDbName' => ['description' => 'The name of the hotspot database.', 'type' => 'string', 'required' => false, 'example' => 'hot_test_****_****', 'title' => ''],
'ShardTbValue' => ['description' => 'The table-level shard key value.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
'HotTableName' => ['description' => 'The name of the hotspot sharded table. The name must use the logical table name as a prefix.', 'type' => 'string', 'required' => false, 'example' => 'test_table_*****', 'title' => ''],
'ShardDbValue' => ['description' => 'The database-level shard key value.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
'TbShardColumn' => ['description' => 'The table shard key of the associated table.', 'type' => 'string', 'required' => false, 'example' => 'platform', 'title' => ''],
'DbShardColumn' => ['description' => 'The database shard key of the associated table.', 'type' => 'string', 'required' => false, 'example' => 'platform', 'title' => ''],
'LogicTable' => ['description' => 'The name of the logical table for hotspot scale-out.', 'type' => 'string', 'required' => false, 'example' => 'test_table', 'title' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 30,
'title' => '',
'example' => '',
],
],
[
'name' => 'SupperAccountMapping',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of privileged account data.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceName' => ['description' => 'The instance ID of the ApsaraDB RDS instance that has a privileged account.', 'type' => 'string', 'required' => false, 'example' => 'rm-bp1t1mk5a5bdj****', 'title' => ''],
'SupperAccount' => ['description' => 'The name of the privileged account for the ApsaraDB RDS instance.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
'SupperPassword' => ['description' => 'The password of the privileged account for the ApsaraDB RDS instance.', 'type' => 'string', 'required' => false, 'example' => '11111111', 'title' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 1000,
'title' => '',
'example' => '',
],
],
[
'name' => 'ExtendedMapping',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of scale-out data.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SrcDb' => ['description' => 'The name of the source physical sharded database.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
'SrcInstanceId' => ['description' => 'The instance ID of the ApsaraDB RDS instance where the source physical database sharding resides.', 'type' => 'string', 'required' => false, 'example' => 'rm-bp1t1mk5a5bdj****', 'title' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 30,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0B6B7BDC-575D-4A77-A4F8-24B7EFERV45Y', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Submit a hotspot scale-out task',
'summary' => 'Calls the SubmitHotExpandTask operation to submit a hotspot scale-out task.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitHotExpandTask'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:SubmitHotExpandTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0B6B7BDC-575D-4A77-A4F8-24B7EFERV45Y\\"\\n}","type":"json"}]',
],
'SubmitSmoothExpandPreCheck' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The DRDS instance ID.', 'type' => 'string', 'required' => true, 'example' => 'drds*******', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the DRDS database.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'DbInstType',
'in' => 'query',
'schema' => ['description' => 'The type of the database. Valid values:'."\n"
.'* RDS'."\n"
.'* POLARDB.', 'type' => 'string', 'required' => true, 'example' => 'RDS', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Msg' => ['description' => 'The result of the task submission.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FE104D26-AC19-49B5-AC67-947F69******', 'title' => ''],
'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11111', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Submit a smooth scale-out precheck task',
'summary' => 'Submits a smooth scale-out precheck task by calling the SubmitSmoothExpandPreCheck operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSmoothExpandPreCheck'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'drds:SubmitSmoothExpandPreCheck',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"RequestId\\": \\"FE104D26-AC19-49B5-AC67-947F69******\\",\\n \\"TaskId\\": 11111,\\n \\"Success\\": true\\n}","type":"json"}]',
],
'SubmitSmoothExpandPreCheckTask' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '76140',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds823s4esd', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the DRDS database.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Msg' => ['description' => 'The result information of the submitted task.', 'type' => 'string', 'example' => 'scucess', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DSSDF-SEWE-23ERW', 'title' => ''],
'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2321', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Submit a smooth scale-out dry run task',
'summary' => 'Submits a dry run task for smooth scale-out.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSmoothExpandPreCheckTask'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:SubmitSmoothExpandPreCheckTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Msg\\": \\"scucess\\",\\n \\"RequestId\\": \\"DSSDF-SEWE-23ERW\\",\\n \\"TaskId\\": 2321,\\n \\"Success\\": true\\n}","type":"json"}]',
],
'SubmitSqlFlashbackTask' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'example' => 'drds*********', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the DRDS database.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The start time for executing the flashback SQL.', 'type' => 'string', 'required' => true, 'example' => '2019-09-10 20:23:23', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end time for executing the flashback SQL.', 'type' => 'string', 'required' => true, 'example' => '2019-09-10 23:23:23', 'title' => ''],
],
[
'name' => 'TraceId',
'in' => 'query',
'schema' => ['description' => 'The trace ID of the flashback SQL.', 'type' => 'string', 'required' => false, 'example' => 'ase*****', 'title' => ''],
],
[
'name' => 'TableName',
'in' => 'query',
'schema' => ['description' => 'The name of the table on which the flashback SQL operation is performed.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'SqlType',
'in' => 'query',
'schema' => ['description' => 'The type of SQL statement. Valid values: INSERT, UPDATE, and DELETE. Separate multiple values with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'INSERT,UPDATE', 'title' => ''],
],
[
'name' => 'SqlPk',
'in' => 'query',
'schema' => ['description' => 'The primary key of the flashback SQL.', 'type' => 'string', 'required' => false, 'example' => '11111', 'title' => ''],
],
[
'name' => 'RecallType',
'in' => 'query',
'schema' => ['description' => 'The match type. Valid values:'."\n"
.'* 0: exact match.'."\n"
.'* 1: fuzzy match.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'RecallRestoreType',
'in' => 'query',
'schema' => ['description' => 'The restore type. Valid values:'."\n"
.'* 1: image restore.'."\n"
.'* 0: reverse restore.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DSSDF-SEWE-*****', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1111', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Submit an SQL flashback task',
'summary' => 'Calls the SubmitSqlFlashbackTask operation to submit an SQL flashback task.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSqlFlashbackTask'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'drds:SubmitSqlFlashbackTask',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\",\\n \\"Success\\": true,\\n \\"TaskId\\": 1111\\n}","type":"json"}]',
],
'SwitchGlobalBroadcastType' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '76146',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the DRDS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds********', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The name of the DRDS database.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'Indicates whether the broadcast table is successfully switched from multi-write mode to asynchronous link mode.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DSSDF-SEWE-*****', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Switch a broadcast table from multi-write to asynchronous link mode',
'summary' => 'Switches a broadcast table from multi-write mode to asynchronous link mode by calling the SwitchGlobalBroadcastType operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchGlobalBroadcastType'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:SwitchGlobalBroadcastType',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'TagResources' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '76147',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => 'The resource type. Set this parameter to INSTANCE.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enum' => ['INSTANCE'],
'example' => 'INSTANCE',
'title' => '',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The labels.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The key of the label.', 'type' => 'string', 'required' => false, 'example' => 'color', 'title' => ''],
'Value' => ['description' => 'The value of the label.', 'type' => 'string', 'required' => false, 'example' => 'red', 'title' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 21,
'title' => '',
'example' => '',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The resources.',
'type' => 'array',
'items' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => 'dm-hbgau1zp****', 'title' => ''],
'required' => true,
'maxItems' => 51,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FE5D94E3-3C93-3594-95D9-AAED2A980915', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter.tagKey', 'errorMessage' => 'Check the parameter tagKey %s', 'description' => ''],
['errorCode' => 'InvalidParameter.tagValue', 'errorMessage' => 'Check the parameter tagValue %s', 'description' => ''],
['errorCode' => 'InvalidParameter.tags.exceed', 'errorMessage' => 'Tags num exceed 10', 'description' => ''],
['errorCode' => 'InvalidParameter.tags.notFound', 'errorMessage' => 'Tags connot be empty', 'description' => ''],
['errorCode' => 'TagService.%s', 'errorMessage' => 'TagService return errorMsg: %s', 'description' => ''],
['errorCode' => 'TagApi.InvalidParameter.resourceId.exceed', 'errorMessage' => 'ResourceId num exceed 50', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Add labels to resources',
'summary' => 'Calls the TagResources operation to add labels to resources.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:TagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"FE5D94E3-3C93-3594-95D9-AAED2A980915\\"\\n}","type":"json"}]',
],
'UntagResources' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '76148',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => 'The resource type. Set this parameter to INSTANCE.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enum' => ['INSTANCE'],
'example' => 'INSTANCE',
'title' => '',
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to remove all tags from the resources.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The resource ID.',
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'required' => true,
'example' => 'drds********',
'maxItems' => 51,
'title' => '',
],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The key of the tag.'."\n"
.'> N specifies the sequence number of the tag key. For example: * Tag.1.Key specifies the key of the first tag. * Tag.2.Key specifies the key of the second tag.',
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => 'color',
'maxItems' => 21,
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'The request result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DSSDF-SEWE-*****', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter.tagKey', 'errorMessage' => 'Check the parameter tagKey %s', 'description' => ''],
['errorCode' => 'InvalidParameter.tagValue', 'errorMessage' => 'Check the parameter tagValue %s', 'description' => ''],
['errorCode' => 'InvalidParameter.tags.exceed', 'errorMessage' => 'Tags num exceed 10', 'description' => ''],
['errorCode' => 'InvalidParameter.tags.notFound', 'errorMessage' => 'Tags connot be empty', 'description' => ''],
['errorCode' => 'InvalidParameter.tags.json.error', 'errorMessage' => 'Thr parameter tags is not a JsonArray', 'description' => ''],
['errorCode' => 'TagService.%s', 'errorMessage' => 'TagService return errorMsg: %s', 'description' => ''],
['errorCode' => 'TagApi.InvalidParameter.resourceId.exceed', 'errorMessage' => 'ResourceId num exceed 50', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Remove tags from resources',
'summary' => 'Calls the UntagResources operation to remove tags from resources.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'drds:UntagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\"\\n}","type":"json"}]',
],
'UpdateInstanceNetwork' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '76149',
'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The DRDS instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds******', 'title' => ''],
],
[
'name' => 'SrcInstanceNetworkType',
'in' => 'query',
'schema' => ['description' => 'The current network type of the DRDS instance. Valid values:'."\n"
.'* vpc: virtual private cloud (VPC)'."\n"
.'* classic: classic network.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'classic', 'title' => ''],
],
[
'name' => 'RetainClassic',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to retain the classic network endpoint.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'ClassicExpiredDays',
'in' => 'query',
'schema' => ['description' => 'The number of days for classic network address reservation.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'The result of the request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DSSDF-SEWE-*****', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ERR_INSTANCE_CANNOT_SWITCH_NETWORK_FOR_PUBLIC', 'errorMessage' => 'Public instance cannot switch network to VPC', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Switch the network type of a DRDS instance',
'summary' => 'Switches the network type of a DRDS instance by calling the UpdateInstanceNetwork operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceNetwork'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:UpdateInstanceNetwork',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\"\\n}","type":"json"}]',
],
'UpdatePrivateRdsClass' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '76150',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'RdsClass',
'in' => 'query',
'schema' => ['description' => 'The specification code of the storage-layer custom ApsaraDB RDS instance after the update.'."\n"
."\n"
.'> You can call the [DescribeAvailableClasses](~~196546~~) operation to query the available specifications of storage-layer custom ApsaraDB RDS instances, including specification codes and storage capacity ranges.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'rds.mysql.c1.xlarge', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The PolarDB-X instance ID.'."\n"
.'The DRDS instance ID.'."\n"
.'> You can call the [DescribeDrdsInstances](~~139284~~) operation to query the details of all instances under the target account, including instance IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds*************', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the storage-layer custom ApsaraDB RDS instance.'."\n"
."\n"
.'> You can call the [DescribeDrdsRdsInstances](~~xxxx~~) operation to query the details of all storage-layer custom ApsaraDB RDS instances under the target PolarDB-X instance, including instance IDs.'."\n"
."\n"
.'> You can call the [DescribeDrdsRdsInstances](~~xxxx~~) operation to query the details of all storage-layer ApsaraDB RDS instances under the target DRDS instance, including instance IDs..', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-***************', 'title' => ''],
],
[
'name' => 'Storage',
'in' => 'query',
'schema' => ['description' => 'The storage capacity of the storage-layer custom ApsaraDB RDS instance after the update.'."\n"
."\n"
.'> You can call the [DescribeAvailableClasses](~~196546~~) operation to query the available specifications of storage-layer custom ApsaraDB RDS instances, including specification codes and storage capacity ranges.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '50', 'title' => ''],
],
[
'name' => 'AutoUseCoupon',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to use vouchers to offset the purchase cost. Valid values: **true** and **false** (default).'."\n"
."\n"
.'> After vouchers are used, if you need to downgrade the specifications, the amount offset by vouchers will not be refunded.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'PrePayDuration',
'in' => 'query',
'schema' => ['description' => 'Invalid field.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '{ "orderId": "209136011******" }', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '57D86AB4-8703-4DF4-BAB6-F7DE44******', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'ModifyRdsClassApiError', 'errorMessage' => 'Failed to modify the class of the RDS instance.', 'description' => ''],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'title' => 'Upgrade or downgrade a storage-layer custom RDS instance',
'summary' => 'Upgrades or downgrades the specifications of a storage-layer custom ApsaraDB RDS instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrivateRdsClass'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:UpdatePrivateRdsClass',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{ \\\\\\"orderId\\\\\\": \\\\\\"209136011******\\\\\\" }\\",\\n \\"RequestId\\": \\"57D86AB4-8703-4DF4-BAB6-F7DE44******\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'UpdateResourceGroupAttribute' => [
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '53946',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the target instance.'."\n"
.'> You can call the [DescribeDrdsInstances](~~139284~~) operation to query the details of instances under your account, including the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the target instance.'."\n"
.'> You can call the [DescribeDrdsInstances](~~139284~~) operation to query the details of instances under your account, including the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds***********', 'title' => ''],
],
[
'name' => 'NewResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the target resource group.'."\n"
.'> You can call the [ListResourceGroups](~~158855~~) operation to query the details of resource groups, including the resource group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rg-***************', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '91C7CAB5-3B2E-4FB6-893C-0162C0******', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'DRDSDB.NotExist', 'errorMessage' => 'The database does not exist.', 'description' => 'The database does not exist.'],
],
],
'title' => 'Transfer an instance to a new resource group',
'summary' => 'Calls the UpdateResourceGroupAttribute operation to transfer an instance to a new resource group.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateResourceGroupAttribute'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:UpdateResourceGroupAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"91C7CAB5-3B2E-4FB6-893C-0162C0******\\"\\n}","type":"json"}]',
],
'UpgradeHiStoreInstance' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '76151',
'abilityTreeNodes' => ['FEATUREdrds25BO3L'],
],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The DRDS instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdssad23sdfc', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'HistoreInstanceId',
'in' => 'query',
'schema' => ['description' => 'The DRDS column-oriented calculation instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hi-sesex2e', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'Indicates whether the version upgrade request is successful. The value true is returned if the request is successful. An error message is returned if the request fails.', 'type' => 'string', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DSSDF-SEWE-23ERW', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. 默认错误码', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"DSSDF-SEWE-23ERW\\"\\n}","type":"json"}]',
'title' => 'Upgrade a histore instance',
'summary' => 'Upgrades the version of a DRDS column-oriented calculation instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeHiStoreInstance'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:UpgradeHiStoreInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'UpgradeInstanceVersion' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdshbgaen89****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'Rpm',
'in' => 'query',
'schema' => ['description' => 'The version number. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 't-drds-server-5.4.12-16348095.noarch.rpm', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'The request result.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2F7F8080-9132-4279-85D0-B7E5C4305162', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. 默认错误码', 'description' => ''],
],
],
'title' => 'Upgrade the version of a DRDS instance',
'summary' => 'Upgrades the version of a DRDS instance.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeInstanceVersion'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'drds:UpgradeInstanceVersion',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"success\\",\\n \\"RequestId\\": \\"2F7F8080-9132-4279-85D0-B7E5C4305162\\"\\n}","type":"json"}]',
],
'ValidateShardTask' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '76153',
'abilityTreeNodes' => ['FEATUREdrdsTIBR6Q'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'default' => 'center', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DrdsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds23ds****', 'title' => ''],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'SourceTableName',
'in' => 'query',
'schema' => ['description' => 'The source table name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'buyer', 'title' => ''],
],
[
'name' => 'TargetTableName',
'in' => 'query',
'schema' => ['description' => 'The target table name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 100, 'minLength' => 1, 'example' => 'buyer_new', 'title' => ''],
],
[
'name' => 'TaskType',
'in' => 'query',
'schema' => ['description' => 'The task type. Valid values:'."\n"
.'* **SINGLE\\_TO\\_SHARD**: converts a single table to a sharded table.'."\n"
.'* **SHARD\\_TO\\_SINGLE**: converts a sharded table to a single table.'."\n"
.'* **SHARD\\_TO\\_SHARD**: converts a sharded table to another sharded table.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'minLength' => 1, 'example' => 'SINGLE_TO_SHARD', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0B6B7BDC-575D-4A77-A4F8-24B7EFAS45FG', 'title' => ''],
'List' => [
'description' => 'The list of check results.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Result' => ['description' => 'The check result. Valid values:'."\n"
.'* **0**: passed.'."\n"
.'* **1**: failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Item' => ['description' => 'The check item.', 'type' => 'string', 'example' => 'same_schema', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0B6B7BDC-575D-4A77-A4F8-24B7EFAS45FG\\",\\n \\"List\\": [\\n {\\n \\"Result\\": 0,\\n \\"Item\\": \\"same_schema\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Check whether a sharding change task is valid',
'summary' => 'Calls the ValidateShardTask operation to check whether a sharding change task is valid.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateShardTask'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:ValidateShardTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
],
],
],
'endpoints' => [
['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'drds.cn-beijing.aliyuncs.com', 'endpoint' => 'drds.cn-beijing.aliyuncs.com', 'vpc' => 'drds-vpc.cn-beijing.aliyuncs.com'],
['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'drds.cn-qingdao.aliyuncs.com', 'endpoint' => 'drds.cn-qingdao.aliyuncs.com', 'vpc' => 'drds-vpc.cn-qingdao.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'drds.cn-shanghai.aliyuncs.com', 'endpoint' => 'drds.cn-shanghai.aliyuncs.com', 'vpc' => 'drds-vpc.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'drds.cn-hongkong.aliyuncs.com', 'endpoint' => 'drds.cn-hongkong.aliyuncs.com', 'vpc' => 'drds-vpc.cn-hongkong.aliyuncs.com'],
['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'drds.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'drds.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'drds-vpc.cn-zhangjiakou.aliyuncs.com'],
['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'drds.cn-shenzhen.aliyuncs.com', 'endpoint' => 'drds.cn-shenzhen.aliyuncs.com', 'vpc' => 'drds-vpc.cn-shenzhen.aliyuncs.com'],
['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'drds.ap-southeast-1.aliyuncs.com', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', 'vpc' => 'drds-vpc.ap-northeast-1.aliyuncs.com'],
['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'drds.aliyuncs.com', 'endpoint' => 'drds.aliyuncs.com', 'vpc' => 'drds-vpc.cn-chengdu.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'drds.ap-southeast-1.aliyuncs.com', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', 'vpc' => 'drds-vpc.ap-southeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'drds.ap-southeast-1.aliyuncs.com', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', 'vpc' => 'drds-vpc.ap-southeast-2.aliyuncs.com'],
['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'drds.ap-southeast-1.aliyuncs.com', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', 'vpc' => 'drds-vpc.ap-southeast-3.aliyuncs.com'],
['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'drds.cn-huhehaote.aliyuncs.com', 'endpoint' => 'drds.cn-huhehaote.aliyuncs.com', 'vpc' => 'drds-vpc.cn-huhehaote.aliyuncs.com'],
['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'drds.ap-southeast-1.aliyuncs.com', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', 'vpc' => 'drds-vpc.ap-southeast-5.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'drds.cn-hangzhou.aliyuncs.com', 'endpoint' => 'drds.cn-hangzhou.aliyuncs.com', 'vpc' => 'drds-vpc.cn-hangzhou.aliyuncs.com'],
['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'drds.us-east-1.aliyuncs.com', 'endpoint' => 'drds.us-east-1.aliyuncs.com', 'vpc' => 'drds-vpc.us-east-1.aliyuncs.com'],
['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'drds.ap-southeast-1.aliyuncs.com', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', 'vpc' => 'drds-vpc.eu-west-1.aliyuncs.com'],
['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'drds.ap-southeast-1.aliyuncs.com', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', 'vpc' => 'drds-vpc.us-west-1.aliyuncs.com'],
['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'drds.ap-southeast-1.aliyuncs.com', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', 'vpc' => 'drds-vpc.eu-central-1.aliyuncs.com'],
['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'drds.ap-southeast-1.aliyuncs.com', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', 'vpc' => 'drds-vpc.me-east-1.aliyuncs.com'],
['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'drds.ap-southeast-1.aliyuncs.com', 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', 'vpc' => 'drds-vpc.ap-south-1.aliyuncs.com'],
['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'drds.aliyuncs.com', 'endpoint' => 'drds.aliyuncs.com', 'vpc' => 'drds-vpc.cn-hangzhou-finance.aliyuncs.com'],
['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'drds.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'drds.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'drds-vpc.cn-shenzhen-finance-1.aliyuncs.com'],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'drds.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'drds.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'drds-vpc.cn-shanghai-finance-1.aliyuncs.com'],
['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'drds.cn-north-2-gov-1.aliyuncs.com', 'endpoint' => 'drds.cn-north-2-gov-1.aliyuncs.com', 'vpc' => 'drds-vpc.cn-north-2-gov-1.aliyuncs.com'],
['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'drds.aliyuncs.com', 'endpoint' => 'drds.aliyuncs.com', 'vpc' => ''],
],
'errorCodes' => [
['code' => 'DRDSDB.Creating', 'message' => 'The database is being created.', 'http_code' => 404, 'description' => 'The database is being created.'],
['code' => 'DRDSDB.NotExist', 'message' => 'The database does not exist.', 'http_code' => 404, 'description' => 'The database does not exist.'],
['code' => 'DrdsInstance.NotExists', 'message' => 'The DRDS instance does not exist.', 'http_code' => 404, 'description' => 'The DRDS instance does not exist.'],
['code' => 'IllegalTimestamp', 'message' => 'The input parameter “Timestamp” that is mandatory for processing this request is not supplied.', 'http_code' => null, 'description' => ''],
['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidAccessKeyId.NotFound', 'message' => 'The Access Key ID provided does not exist in our records.', 'http_code' => null, 'description' => 'The specified access key ID does not exist in our records.'],
['code' => 'InvalidAccountName.Duplicate', 'message' => 'The account already exists.', 'http_code' => 400, 'description' => 'The account already exists.'],
['code' => 'InvalidParameter', 'message' => 'invalid parameter.', 'http_code' => 400, 'description' => 'Parameter exception'],
['code' => 'InvalidParameter.time', 'message' => 'the start time and end time must be in one weak.', 'http_code' => 400, 'description' => 'Start time and end time must be within a week'],
['code' => 'ModifyRdsClassApiError', 'message' => 'Failed to modify the class of the RDS instance.', 'http_code' => 400, 'description' => 'Failed to modify the class of the RDS instance.'],
['code' => 'Monitor.QueryRdsFailure', 'message' => 'Failed to query RDS monitor info', 'http_code' => 404, 'description' => 'Failed to query RDS monitor information.'],
['code' => 'RDSAPI.ERROR', 'message' => 'Failed to call the RDS API operation.', 'http_code' => 400, 'description' => 'Failed to call the RDS API operation.'],
['code' => 'UpdatePrivateRdsClassError', 'message' => 'Failed to modify the class of the RDS instance. Caused by %s.', 'http_code' => 400, 'description' => 'Failed to modify the class of the RDS instance.'],
],
'changeSet' => [
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'DescribeDrdsInstances'],
],
'createdAt' => '2025-11-24T17:16:38.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'DescribeDrdsSlowSqls'],
],
'createdAt' => '2025-03-07T06:20:06.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'DescribeDrdsInstance'],
],
'createdAt' => '2025-02-26T03:01:50.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'DescribeDrdsInstances'],
],
'createdAt' => '2024-12-25T02:27:17.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'DescribeDrdsInstances'],
],
'createdAt' => '2024-12-24T13:37:25.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'DescribeDrdsRdsInstances'],
],
'createdAt' => '2024-07-16T13:05:00.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed, Response parameters changed', 'api' => 'DescribeDbInstances'],
],
'createdAt' => '2024-04-24T14:29:16.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'DescribeDrdsInstances'],
],
'createdAt' => '2024-04-10T08:05:43.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDrdsInstances'],
],
'createdAt' => '2024-04-10T07:51:22.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'ModifyDrdsIpWhiteList'],
],
'createdAt' => '2024-04-08T10:37:11.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'ModifyDrdsIpWhiteList'],
],
'createdAt' => '2024-03-27T10:46:03.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'DescribeDrdsInstances'],
],
'createdAt' => '2024-03-21T01:44:53.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'DescribeDrdsDBs'],
],
'createdAt' => '2023-04-07T07:54:17.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ChangeInstanceAzone'],
],
'createdAt' => '2023-03-24T08:25:30.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'DescribeDrdsDBs'],
],
'createdAt' => '2022-12-07T03:49:52.000Z',
'description' => '修改RegionId为必填',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'DescribeDrdsDBIpWhiteList'],
['description' => 'Request parameters changed', 'api' => 'DescribeDrdsDBIpWhiteList'],
],
'createdAt' => '2022-09-16T07:17:30.000Z',
'description' => 'DescribeDrdsDBIpWhiteList 增加RegionId必填用户参数',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'DescribeDrdsInstances'],
],
'createdAt' => '2022-08-17T08:11:52.000Z',
'description' => '增加vip.dns ',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'DescribeDrdsInstances'],
],
'createdAt' => '2021-12-14T04:01:17.000Z',
'description' => 'DescribeDrdsInstances 获取实例列表超时时间增加,解决部分用户获取列表超时报错的问题。',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'CreateDrdsInstance'],
],
'createdAt' => '2021-12-07T15:38:09.000Z',
'description' => '修复部分bug',
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDbInstanceDbs'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSmoothExpandPreCheck'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountDescription'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDrdsInstanceDescription'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackMenu'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetBackupLocal'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsInstanceMonitor'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetBackupPolicy'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitHotExpandTask'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupDbs'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RollbackInstanceVersion'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateShardTask'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsSuperAccountInstances'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsRdsInstances'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsCommodity'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveRecycleBinTable'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchGlobalBroadcastType'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsInstanceDbMonitor'],
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeShardTaskInfo'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsDBs'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsInstanceLevelTasks'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstDbSlsInfo'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableSqlAudit'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupTimes'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveDrdsInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeInstanceAzone'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountPrivilege'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupLocal'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyRdsReadWeight'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckDrdsDbName'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshDrdsAtomUrl'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsDBCluster'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckSqlAuditEnableStatus'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeAccountPassword'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsTasks'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseInstanceInternetAddress'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetupDrdsParams'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceNetwork'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupSets'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FlashbackRecycleBinTable'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeExpandLogicTableInfoList'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsPerformanceSummary'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceSwitchAzone'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeInstanceVersion'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsDB'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTable'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableInstanceIpv6Address'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeHiStoreInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDrdsIpWhiteList'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDrdsDB'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveDrdsDb'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetupTable'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPolarDbReadWeight'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDrdsInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutStartBackup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePreCheckResult'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsDBIpWhiteList'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsParams'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsShardingDbs'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveDrdsDbFailedRecord'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableSqlFlashbackMatchSwitch'],
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRDSPerformance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveBackupsSet'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTables'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrderForRds'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsSqlAuditStatus'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHotDbList'],
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRestoreOrder'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDbInstances'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ManagePrivateRds'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitCleanTask'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSqlFlashbackTask'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsDbInstances'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveInstanceAccount'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableSqlAudit'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartDrdsInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsInstanceVersion'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTableListByType'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSmoothExpandPreCheckTask'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRecycleBinStatus'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitHotExpandPreCheckTask'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetupBroadcastTables'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartRestore'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDrdsDbRdsRelationInfo'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBroadcastTables'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateShardTask'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstanceInternetAddress'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsInstances'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlFlashbakTask'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetupRecycleBinStatus'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckExpandStatus'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstDbLogInfo'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsDbRdsNameList'],
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRecycleBinTables'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceSwitchNetwork'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsDbInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateResourceGroupAttribute'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrivateRdsClass'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupPolicy'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstanceAccount'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDrdsSlowSqls'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceAccounts'],
],
],
'ram' => [
'productCode' => 'DRDS',
'productName' => 'PolarDB-X',
'ramCodes' => ['drds', 'polardbx'],
'ramLevel' => 'RESOURCE',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'DescribeDrdsDbRdsNameList',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsDbRdsNameList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'SubmitCleanTask',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'drds:SubmitCleanTask',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'RemoveDrdsDbFailedRecord',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:RemoveDrdsDbFailedRecord',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'EnableSqlAudit',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:EnableSqlAudit',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'ModifyDrdsInstanceDescription',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:ModifyDrdsInstanceDescription',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'GetDrdsDbRdsRelationInfo',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:GetDrdsDbRdsRelationInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDrdsDB',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'drds:CreateDrdsDB',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'DescribeDrdsRdsInstances',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:DescribeDrdsRdsInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RemoveInstanceAccount',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'drds:RemoveInstanceAccount',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'ModifyDrdsIpWhiteList',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:ModifyDrdsIpWhiteList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}'],
],
],
],
[
'apiName' => 'CreateInstanceInternetAddress',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'drds:CreateInstanceInternetAddress',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'ChangeInstanceAzone',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:ChangeInstanceAzone',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyRdsReadWeight',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:ModifyRdsReadWeight',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'DescribeInstDbSlsInfo',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeInstDbSlsInfo',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'CreateInstanceAccount',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'drds:CreateInstanceAccount',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'CheckSqlAuditEnableStatus',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:CheckSqlAuditEnableStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateShardTask',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'drds:CreateShardTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribePreCheckResult',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribePreCheckResult',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'DescribeBroadcastTables',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeBroadcastTables',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeTables',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeTables',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'RestartDrdsInstance',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:RestartDrdsInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'FlashbackRecycleBinTable',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:FlashbackRecycleBinTable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'PutStartBackup',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:PutStartBackup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDbInstanceDbs',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDbInstanceDbs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDrdsInstanceDbMonitor',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsInstanceDbMonitor',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'SubmitSmoothExpandPreCheck',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'drds:SubmitSmoothExpandPreCheck',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'DescribeRestoreOrder',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeRestoreOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetBackupPolicy',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:SetBackupPolicy',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'DescribeDrdsDbInstance',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsDbInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'DescribeDrdsInstanceLevelTasks',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsInstanceLevelTasks',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'DescribeShardTaskInfo',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeShardTaskInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDrdsDBIpWhiteList',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsDBIpWhiteList',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'CreateOrderForRds',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'drds:CreateOrderForRds',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDbInstances',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDbInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId1}/*'],
],
],
],
[
'apiName' => 'ModifyPolarDbReadWeight',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:ModifyPolarDbReadWeight',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetupBroadcastTables',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:SetupBroadcastTables',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'DescribeSqlFlashbakTask',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeSqlFlashbakTask',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'DescribeDrdsInstance',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeBackupPolicy',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeBackupPolicy',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'UntagResources',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'drds:UntagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeInstanceSwitchAzone',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeInstanceSwitchAzone',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RefreshDrdsAtomUrl',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:RefreshDrdsAtomUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDrdsDB',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsDB',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'SubmitSmoothExpandPreCheckTask',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:SubmitSmoothExpandPreCheckTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RemoveBackupsSet',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:RemoveBackupsSet',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateResourceGroupAttribute',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:UpdateResourceGroupAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CheckExpandStatus',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'drds:CheckExpandStatus',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'UpdatePrivateRdsClass',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:UpdatePrivateRdsClass',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeBackupTimes',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeBackupTimes',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'RemoveRecycleBinTable',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:RemoveRecycleBinTable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'StartRestore',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:StartRestore',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}'],
],
],
],
[
'apiName' => 'DescribeDrdsShardingDbs',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsShardingDbs',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'DescribeDrdsDBs',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsDBs',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'DescribeTable',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeTable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SubmitHotExpandTask',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:SubmitHotExpandTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SubmitSqlFlashbackTask',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'drds:SubmitSqlFlashbackTask',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'DescribeRecycleBinTables',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:DescribeRecycleBinTables',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyAccountPrivilege',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'drds:ModifyAccountPrivilege',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'CheckDrdsDbName',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'drds:CheckDrdsDbName',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'DescribeBackMenu',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeBackMenu',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'DescribeDrdsTasks',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsTasks',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'DescribeExpandLogicTableInfoList',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeExpandLogicTableInfoList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RemoveDrdsInstance',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'drds:RemoveDrdsInstance',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'DescribeDrdsInstanceVersion',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsInstanceVersion',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'DescribeRDSPerformance',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeRDSPerformance',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'DescribeBackupSets',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeBackupSets',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'DescribeDrdsSqlAuditStatus',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsSqlAuditStatus',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'DescribeInstanceAccounts',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeInstanceAccounts',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'DescribeDrdsSlowSqls',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsSlowSqls',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateInstanceNetwork',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:UpdateInstanceNetwork',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeBackupDbs',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeBackupDbs',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'EnableSqlFlashbackMatchSwitch',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:EnableSqlFlashbackMatchSwitch',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ValidateShardTask',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:ValidateShardTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'DescribeDrdsInstanceMonitor',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsInstanceMonitor',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDrdsInstance',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'drds:CreateDrdsInstance',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ReleaseInstanceInternetAddress',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'drds:ReleaseInstanceInternetAddress',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'SwitchGlobalBroadcastType',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:SwitchGlobalBroadcastType',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ManagePrivateRds',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'drds:ManagePrivateRds',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'EnableInstanceIpv6Address',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:EnableInstanceIpv6Address',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetupDrdsParams',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:SetupDrdsParams',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'TagResources',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:TagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTagResources',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:ListTagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetupRecycleBinStatus',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'drds:SetupRecycleBinStatus',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ChangeAccountPassword',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:ChangeAccountPassword',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeTableListByType',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeTableListByType',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SubmitHotExpandPreCheckTask',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:SubmitHotExpandPreCheckTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDrdsDBCluster',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsDBCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeRdsSuperAccountInstances',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeRdsSuperAccountInstances',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'RemoveDrdsDb',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'drds:RemoveDrdsDb',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'DescribeDrdsParams',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsParams',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'DescribeInstDbLogInfo',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeInstDbLogInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeRecycleBinStatus',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'drds:DescribeRecycleBinStatus',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'DescribeInstanceSwitchNetwork',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeInstanceSwitchNetwork',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RollbackInstanceVersion',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:RollbackInstanceVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpgradeHiStoreInstance',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'drds:UpgradeHiStoreInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDrdsDbInstances',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsDbInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'SetBackupLocal',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'drds:SetBackupLocal',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeRdsPerformanceSummary',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeRdsPerformanceSummary',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'DescribeDrdsInstances',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeDrdsInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyAccountDescription',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'drds:ModifyAccountDescription',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'SetupTable',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:SetupTable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DisableSqlAudit',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'drds:DisableSqlAudit',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
],
],
],
[
'apiName' => 'DescribeRdsCommodity',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeRdsCommodity',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'DescribeHotDbList',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'drds:DescribeHotDbList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpgradeInstanceVersion',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'drds:UpgradeInstanceVersion',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
[
'apiName' => 'DescribeBackupLocal',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'drds:DescribeBackupLocal',
'authLevel' => '',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
],
],
],
],
'resourceTypes' => [
['validationType' => 'always', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
['validationType' => 'always', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*'],
['validationType' => 'always', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}'],
['validationType' => 'always', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId1}/*'],
['validationType' => 'always', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}'],
['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/*'],
['validationType' => 'always', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}'],
['validationType' => 'always', 'resourceType' => 'instance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:instance/*'],
],
],
];