From 7347bac4ab7e136157fc94777e6cf87ef9e08599 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Fri, 13 Feb 2026 10:54:11 +0800 Subject: first commit --- data/en_us/drds/2019-01-23/api-docs.php | 15541 ++++++++++++++++++++++++++++++ 1 file changed, 15541 insertions(+) create mode 100644 data/en_us/drds/2019-01-23/api-docs.php (limited to 'data/en_us/drds/2019-01-23') diff --git a/data/en_us/drds/2019-01-23/api-docs.php b/data/en_us/drds/2019-01-23/api-docs.php new file mode 100644 index 0000000..b0f84da --- /dev/null +++ b/data/en_us/drds/2019-01-23/api-docs.php @@ -0,0 +1,15541 @@ + '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Drds', + 'version' => '2019-01-23', + ], + 'directories' => [ + [ + 'id' => 117683, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateDrdsInstance', + 'CreateOrderForRds', + 'ModifyDrdsInstanceDescription', + 'UpdateResourceGroupAttribute', + 'DescribeDrdsInstances', + 'DescribeDrdsDbInstance', + 'DescribeDrdsInstance', + 'DescribeDrdsParams', + 'DescribeDrdsTasks', + 'DescribeHotDbList', + 'DescribeInstanceSwitchAzone', + 'DescribeInstanceSwitchNetwork', + 'DescribeInstDbLogInfo', + 'DescribePreCheckResult', + 'DescribeRdsCommodity', + 'RemoveDrdsInstance', + ], + ], + [ + 'id' => 117700, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateDrdsDB', + 'DescribeDrdsDBs', + 'DescribeDrdsDB', + 'DescribeDrdsDbInstances', + 'DescribeDrdsDbRdsNameList', + 'DescribeDrdsShardingDbs', + 'CheckDrdsDbName', + 'RemoveDrdsDbFailedRecord', + 'RemoveDrdsDb', + ], + ], + [ + 'id' => 117711, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ModifyRdsReadWeight', + 'DescribeRdsPerformanceSummary', + 'DescribeRdsSuperAccountInstances', + 'DescribeDrdsDBCluster', + 'DescribeRDSPerformance', + 'DescribeDbInstances', + 'DescribeDbInstanceDbs', + ], + ], + [ + 'id' => 117719, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateInstanceAccount', + 'RemoveInstanceAccount', + ], + ], + [ + 'id' => 117722, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'EnableSqlAudit', + 'DisableSqlAudit', + 'DescribeDrdsSqlAuditStatus', + 'DescribeInstDbSlsInfo', + 'DescribeDrdsSlowSqls', + 'CheckSqlAuditEnableStatus', + ], + ], + [ + 'id' => 117729, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'StartRestore', + 'SetBackupPolicy', + 'EnableSqlFlashbackMatchSwitch', + 'DescribeBackMenu', + 'DescribeRestoreOrder', + 'DescribeBackupDbs', + 'DescribeBackupSets', + 'DescribeBackupPolicy', + 'DescribeBackupTimes', + 'RemoveBackupsSet', + 'PutStartBackup', + ], + ], + [ + 'id' => 117741, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateInstanceInternetAddress', + 'UpdateInstanceNetwork', + 'ReleaseInstanceInternetAddress', + ], + ], + [ + 'id' => 117745, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ModifyDrdsIpWhiteList', + 'DescribeDrdsDBIpWhiteList', + ], + ], + [ + 'id' => 117748, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'SubmitCleanTask', + 'SubmitSmoothExpandPreCheck', + 'CheckExpandStatus', + 'SubmitHotExpandTask', + 'SubmitHotExpandPreCheckTask', + ], + ], + [ + 'id' => 117756, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeSqlFlashbakTask', + 'SubmitSqlFlashbackTask', + ], + ], + [ + 'id' => 117759, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateShardTask', + 'DescribeInstanceAccounts', + 'DescribeExpandLogicTableInfoList', + 'DescribeTable', + 'DescribeTableListByType', + 'DescribeShardTaskInfo', + 'ValidateShardTask', + ], + ], + [ + 'id' => 117768, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'SetupBroadcastTables', + 'DescribeBroadcastTables', + 'SwitchGlobalBroadcastType', + ], + ], + [ + 'id' => 117772, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'SetupTable', + 'DescribeTables', + ], + ], + [ + 'id' => 117775, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'SetupDrdsParams', + 'ListTagResources', + 'TagResources', + 'UntagResources', + ], + ], + [ + 'id' => 117780, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeDrdsInstanceVersion', + 'DescribeDrdsInstanceLevelTasks', + 'UpgradeInstanceVersion', + ], + ], + [ + 'id' => 117784, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeDrdsInstanceMonitor', + 'DescribeDrdsInstanceDbMonitor', + ], + ], + [ + 'id' => 169169, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ChangeAccountPassword', + 'ChangeInstanceAzone', + 'DescribeBackupLocal', + 'DescribeDrdsRdsInstances', + 'DescribeRecycleBinStatus', + 'DescribeRecycleBinTables', + 'EnableInstanceIpv6Address', + 'FlashbackRecycleBinTable', + 'GetDrdsDbRdsRelationInfo', + 'ManagePrivateRds', + 'ModifyAccountDescription', + 'ModifyAccountPrivilege', + 'ModifyPolarDbReadWeight', + 'RefreshDrdsAtomUrl', + 'RemoveRecycleBinTable', + 'RestartDrdsInstance', + 'RollbackInstanceVersion', + 'SetBackupLocal', + 'SetupRecycleBinStatus', + 'SubmitSmoothExpandPreCheckTask', + 'UpdatePrivateRdsClass', + 'UpgradeHiStoreInstance', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateDrdsInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the description of the instance. The description must meet the following requirements:'."\n" + ."\n" + .'* The description cannot contain the prefix http:// or https://.'."\n" + .'* The description must start with a letter or a Chinese character, and can contain uppercase and lowercase letters, Chinese characters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* The description must be 2 to 256 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the region ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the zone ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou-e', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the type of the instance. Set the value to PRIVATE. The value PRIVATE specifies that the instance is a dedicated instance.'."\n" + ."\n" + .'> You can also set the value to 1 to specify that the instance is a dedicated instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PRIVATE', + 'enum' => [ + 'PRIVATE', + 'PUBLIC', + '1', + '0', + ], + ], + ], + [ + 'name' => 'Quantity', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the number of instances to be created. You can set the value only to 1. The value specifies that you can create one instance each time.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceSeries', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the instance type of the instance. Valid values:'."\n" + ."\n" + .'* **drds.sn2.4c16g**: The instance is of the Starter Edition.'."\n" + .'* **drds.sn2.8c32g**: The instance is of the Standard Edition'."\n" + .'* **drds.sn2.16c64g**: The instance is of the Enterprise Edition.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds.sn2.4c16g', + ], + ], + [ + 'name' => 'Specification', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the specification code of the instance. The value consists of the instance type and the specified instance specification. For example, you can set the value to drds.sn2.4c16g.8c32g.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds.sn2.4c16g.8C32g', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c1dd299c-10c6-11ea-bbbb-************', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the billing method of the instance. Valid values:'."\n" + ."\n" + .'* **drdsPre**: The instance uses the subscription billing method.'."\n" + .'* **drdsPost**: The instance uses the pay-as-you-go billing method.'."\n" + .'* **drdsRo**: By default, the pay-as-you-go billing method is used when you create read-only instances.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drdsPost', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the ID of the VPC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-**********', + ], + ], + [ + 'name' => 'VswitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the ID of the vSwitch.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-**********', + ], + ], + [ + 'name' => 'isHa', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the instance is a high-availability instance.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the unit of the subscription duration of the subscription instance. Valid values:'."\n" + ."\n" + .'* **year**: The unit of the subscription duration is year.'."\n" + .'* **month**: The unit of the subscription duration is month.'."\n" + ."\n" + .'> This parameter is required if you set the PayType parameter to drdsPre.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'month', + 'enum' => [ + 'year', + 'month', + ], + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the purchase duration of the subscription instance.'."\n" + ."\n" + .'* If the PricingCycle parameter is set to year, the value range of the Duration parameter is 1 to 3.'."\n" + .'* If the PricingCycle parameter is set to month, the value range of the Duration parameter is 1 to 9.'."\n" + ."\n" + .'> This parameter only takes effect when the PayType parameter is set to drdsPre.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'IsAutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic renewal. Valid values:'."\n" + ."\n" + .'* **true**: If the PricingCycle parameter is set to month, the subscription is automatically renewed for one month. If the PricingCycle parameter is set to year, the subscription is automatically renewed for one year.'."\n" + .'* **false**: The auto-renewal feature is disabled for the instance.'."\n" + ."\n" + .'> This parameter only takes effect when the PayType parameter is set to drdsPre.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'MasterInstId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the ID of the primary instance. This parameter is only required when you create a read-only instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'drds***********', + ], + ], + [ + 'name' => 'MySQLVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the MySQL version that is supported by the instance. Valid values:'."\n" + ."\n" + .'* **5**: The instance is fully compatible with MySQL 5.x. This value is the default value.'."\n" + .'* **8**: The instance is fully compatible with MySQL 8.0.'."\n" + ."\n" + .'> This parameter only takes effect when you create a primary instance. By default, the MySQL version of the read-only instance is the same as that of the primary instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'Indicates the ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D99D4644-A70D-49A3-B8B4-767ACC50SE2R', + ], + 'Data' => [ + 'description' => 'Indicates the details of the result.'."\n", + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => 'Indicates the ID of the order.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111111111111111', + ], + 'DrdsInstanceIdList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'drdsInstanceIdList' => [ + 'description' => 'Indicates the ID of the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'drds************', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => 'Parameter error', + ], + [ + 'errorCode' => 'ActionUnauthorized', + 'errorMessage' => 'The specified action is not available for you', + ], + [ + 'errorCode' => 'ServiceUnable', + 'errorMessage' => 'The service is not available now, please try again later', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'drds service is not enable for you', + ], + [ + 'errorCode' => 'QuotaExceeded.DRDSInstance', + 'errorMessage' => 'The quota of create instance exceeds.', + ], + [ + 'errorCode' => 'InvalidRegionId.NotFound', + 'errorMessage' => 'The RegionId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDescription.MalFormed', + 'errorMessage' => 'The specified parameter description is not valid.', + ], + [ + 'errorCode' => 'CommunicateWithManager.Error', + 'errorMessage' => 'Internal Error. Communicate with drds manager error', + ], + [ + 'errorCode' => 'InvalidVSwitchId', + 'errorMessage' => 'Invalid vswitchId', + ], + [ + 'errorCode' => 'InvalidVpcId', + 'errorMessage' => 'Invalid vpcId, or the region of vpc does not match', + ], + [ + 'errorCode' => 'InvalidZoneId.Mismatch', + 'errorMessage' => 'zone is illegal in this order', + ], + [ + 'errorCode' => 'LowInventory.ServerError', + 'errorMessage' => 'low inventory error', + ], + [ + 'errorCode' => 'publicInstanceAlreadExist.Error', + 'errorMessage' => 'a public Drds instance is exist', + ], + [ + 'errorCode' => 'CreateDRDSInstanceId.Error', + 'errorMessage' => 'create Drds instance id error', + ], + [ + 'errorCode' => 'ResourceInsufficient', + 'errorMessage' => 'resource is Insufficient', + ], + [ + 'errorCode' => 'AnotherOrderExist.Error', + 'errorMessage' => 'there is another order', + ], + [ + 'errorCode' => 'InstanceExceedLimit.Error', + 'errorMessage' => 'instance number has exceeded', + ], + [ + 'errorCode' => 'InvalidParameter.Quantity', + 'errorMessage' => 'Invalid parameter of quantity', + ], + [ + 'errorCode' => 'InvalidParameter.RegionId', + 'errorMessage' => 'Invalid parameter of region id', + ], + [ + 'errorCode' => 'InvalidParameter.ZoneId', + 'errorMessage' => 'Invalid parameter of zone id', + ], + [ + 'errorCode' => 'InvalidParameter.PayType', + 'errorMessage' => 'Invalid parameter of pay type', + ], + [ + 'errorCode' => 'InvalidParameter.Spection', + 'errorMessage' => 'Invalid parameter of specification', + ], + [ + 'errorCode' => 'InvalidParameter.Series', + 'errorMessage' => 'Invalid parameter of series', + ], + [ + 'errorCode' => 'InvalidParameter.duration_pricingCycle', + 'errorMessage' => 'when payType=drdsPre, duration and pricingCycle is required', + ], + [ + 'errorCode' => 'InvalidParameter.year.duration', + 'errorMessage' => 'when pricingCycle=year, duration must between 1 to 3', + ], + [ + 'errorCode' => 'InvalidParameter.month.duration', + 'errorMessage' => 'when pricingCycle=month, duration must between 1 to 9', + ], + [ + 'errorCode' => 'InvalidDRDSInstanceType.Error', + 'errorMessage' => 'Invalid parameter of Type, public is not supported', + ], + [ + 'errorCode' => 'QueryVSwitchFailed.InvalidVpcIdOrServerError', + 'errorMessage' => 'Query VSwitch failed, please check vpcId', + ], + [ + 'errorCode' => 'RegionNotSupportVPC.Error', + 'errorMessage' => 'This region does not support vpc instance', + ], + [ + 'errorCode' => 'UserAccountVerify.Failed', + 'errorMessage' => 'User account verify failed. Please verify first', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n true\\n D99D4644-A70D-49A3-B8B4-767ACC50SE2R\\n \\n 111111111111111\\n drds************\\n \\n","errorExample":""}]', + 'title' => 'CreateDrdsInstance', + ], + 'CreateOrderForRds' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '75962', + 'abilityTreeNodes' => [ + 'FEATUREdrdsHFP8VD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => 'The JSON string that contains the order details. For more information, see [CreateDBInstance](~~26228~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"key":"value"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The ID of the purchased RDS instance.'."\n", + 'type' => 'string', + 'example' => '[rm-***********]', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9819BC51-D33D-4EB1-B80F-A89A20******', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"[rm-***********]\\",\\n \\"RequestId\\": \\"9819BC51-D33D-4EB1-B80F-A89A20******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":" \\n [rm-***********]\\n\\t9819BC51-D33D-4EB1-B80F-A89A20******\\n\\ttrue\\n","errorExample":""}]', + 'title' => 'CreateOrderForRds', + 'summary' => 'Creates an order to purchase an ApsaraDB RDS for MySQL instance.', + 'description' => 'Before you call this operation, make sure that you understand the billing methods and pricing of PolarDB-X 1.0. For more information, visit the [pricing page](https://www.aliyun.com/price/product#/rds/detail).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDrdsInstanceDescription' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C44CA24C-C7C4-4C0F-8AC9-1343F2******', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"C44CA24C-C7C4-4C0F-8AC9-1343F2******\\"\\n}","errorExample":""},{"type":"xml","example":"C44CA24C-C7C4-4C0F-8AC9-1343F2******\\ntrue","errorExample":""}]', + 'title' => 'ModifyDrdsInstanceDescription', + 'summary' => 'You can call this operation to modify the instance description.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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 ID of the region where the instance you want to transfer is located.'."\n" + ."\n" + .'> You can call the [DescribeDrdsInstances](~~139284~~) operation to view the details of the instances under the account, including the region IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance that you want to transfer.'."\n" + ."\n" + .'> You can call the [DescribeDrdsInstances](~~139284~~) operation to view the details of the instances under the account, including the instance IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds***********', + ], + ], + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group that you want to specify.'."\n" + ."\n" + .'> You can call the [ListResourceGroups](~~158855~~) operation to view the details of the resource groups, including the resource group IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rg-***************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '91C7CAB5-3B2E-4FB6-893C-0162C0******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'DRDSDB.NotExist', + 'errorMessage' => 'The database does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"91C7CAB5-3B2E-4FB6-893C-0162C0******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n91C7CAB5-3B2E-4FB6-893C-0162C0******\\r\\n","errorExample":""}]', + 'title' => 'UpdateResourceGroupAttribute', + 'summary' => 'Transfers an instance to a new resource group.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDrdsInstances' => [ + 'summary' => 'Queries instances that meet the specified conditions.', + '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 type of the instances that you want to query. Valid values:'."\n" + ."\n" + .'* **0**: shared instances'."\n" + .'* **1**: dedicated instances'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'enum' => [ + 'PRIVATE', + 'PUBLIC', + '1', + '0', + ], + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the instances.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'drds_test', + ], + ], + [ + 'name' => 'Expired', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the instances that you want to query expire.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of instances returned on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the instances you want to query belong. The value of this parameter can be NULL.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NULL', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + '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', + ], + ], + ], + [ + 'name' => 'Mix', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether hybrid queries are supported.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'FALSE', + ], + ], + [ + 'name' => 'ProductVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'V1', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag configured for the instances you want to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'acs:newretail:domain', + ], + 'Value' => [ + 'description' => 'The value of the tag configured for the instances you want to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NEW_RETAIL', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8734773E-7B21-4A22-9106-CBD245F8****', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of instances returned on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Total' => [ + 'description' => 'The total number of instances returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Instances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Instance' => [ + 'description' => 'The list of returned instances.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The ID of the VPC to which the instance belongs.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp**********', + ], + 'Status' => [ + 'description' => 'The status of the instance.'."\n", + 'type' => 'string', + 'example' => 'RUN', + ], + 'Type' => [ + 'description' => 'The type of the instance. Valid values:'."\n" + ."\n" + .'* **PUBLIC**: The returned instance is a shared instance.'."\n" + .'* **PRIVATE**: The returned instance is a dedicated instance.'."\n", + 'type' => 'string', + 'example' => 'PRIVATE', + ], + 'CommodityCode' => [ + 'description' => 'The commodity code of the service.'."\n", + 'type' => 'string', + 'example' => 'drdsPost', + ], + 'MachineType' => [ + 'description' => 'The machine type of the instance. Valid value: ecs.'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'CreateTime' => [ + 'description' => 'The timestamp that indicates when the instance is created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1568620311000', + ], + 'VersionAction' => [ + 'description' => 'Indicates whether the version of the instance can be upgraded.'."\n", + 'type' => 'string', + 'example' => 'Upgradable', + ], + 'InstanceSeries' => [ + 'description' => 'The instance series.'."\n", + 'type' => 'string', + 'example' => 'drds.sn2.4c16g', + ], + 'NetworkType' => [ + 'description' => 'The network type of the instance. Valid values:'."\n" + ."\n" + .'* **CLASSIC**'."\n" + .'* **VPC**'."\n", + 'type' => 'string', + 'example' => 'CLASSIC', + ], + 'Label' => [ + 'description' => 'The tag of the instance. Valid values:'."\n" + ."\n" + .'* **NORMAL**: The instance is a standard instance.'."\n" + .'* **HA**: The instance is a high-availability (HA) instance.'."\n" + .'* **VPC**: The instance is a VPC-based instance.'."\n", + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'ProductVersion' => [ + 'description' => 'The version of the service.'."\n", + 'type' => 'string', + 'example' => 'V1', + ], + 'InstanceSpec' => [ + 'description' => 'The specification of the instance.'."\n", + 'type' => 'string', + 'example' => 'drds.sn2.4c16g.8C32G', + ], + 'RegionId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-e', + ], + 'VpcCloudInstanceId' => [ + 'description' => 'The ID of the instance that is deployed in the VPC.'."\n", + 'type' => 'string', + 'example' => 'drdssen12****', + ], + 'Description' => [ + 'description' => 'The description of the instance.'."\n", + 'type' => 'string', + 'example' => 'drds_test', + ], + 'Version' => [ + 'description' => 'The version of the instance.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group to which the instance belongs.'."\n", + 'type' => 'string', + 'example' => 'rg-aek2ljh3ye4****', + ], + 'ZoneId' => [ + 'description' => 'The ID of the zone in which the resource is located.'."\n", + 'type' => 'string', + 'example' => 'vsw-bpxxxxxxxxxxxxx96', + ], + 'DrdsInstanceId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'drdssen12****', + ], + 'ExpireDate' => [ + 'description' => 'The timestamp that indicates when the instance expires.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4724323200000', + ], + 'MasterInstanceId' => [ + 'description' => 'The ID of the primary instance.'."\n", + 'type' => 'string', + 'example' => 'drdssen12****', + ], + 'OrderInstanceId' => [ + 'description' => 'The ID of the purchased instance.'."\n", + 'type' => 'string', + 'example' => 'drdssen12****', + ], + 'InstRole' => [ + 'description' => 'The role of the instance. Valid values:'."\n" + ."\n" + .'* MASTER: The instance is a primary instance.'."\n" + .'* SLAVE: The instance is a read-only instance to analyze complex queries.'."\n" + .'* SLAVE_FLOW: The instance is a read-only instance for high-concurrency scenarios.'."\n", + 'type' => 'string', + 'example' => 'MASTER', + ], + 'Vips' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Vip' => [ + 'description' => 'The list of returned virtual IP addresses (VIPs).'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-bpxxxxxxxxxxxy', + ], + 'Type' => [ + 'description' => 'The type of the VIP. Valid values:'."\n" + ."\n" + .'* intranet: a private IP address'."\n" + .'* internet: a public IP address'."\n", + 'type' => 'string', + 'example' => 'intranet', + ], + 'VswitchId' => [ + 'description' => 'The ID of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'vsw-bpxxxxxxxxxxxxx96', + ], + 'Port' => [ + 'description' => 'The ports that are opened on the VIP.'."\n", + 'type' => 'string', + 'example' => '3306', + ], + 'IP' => [ + 'description' => 'The virtual IP address.'."\n", + 'type' => 'string', + 'example' => '10.23.***.***', + ], + 'dns' => [ + 'description' => 'The domain name that is mapped to the VIP.'."\n", + 'type' => 'string', + 'example' => 'drdssen1243as.drds.aliyuncs.com', + ], + ], + ], + ], + ], + ], + 'ReadOnlyDBInstanceIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ReadOnlyDBInstanceId' => [ + 'description' => 'The IDs of read-only instances that are associated with the instance.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'drdssen12****', + ], + ], + ], + ], + 'series' => [ + 'description' => 'The edition of the instance. Valid values:'."\n" + ."\n" + .'* **starter**: Starter Edition'."\n" + .'* **enterprise**: Enterprise Edition'."\n" + .'* **standard**: Standard Edition'."\n", + 'type' => 'string', + 'example' => 'enterprise', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ActionUnauthorized', + 'errorMessage' => 'The specified action is not available for you', + ], + [ + 'errorCode' => 'ServiceUnable', + 'errorMessage' => 'The service is not available now, please try again later', + ], + [ + 'errorCode' => 'InvalidRegionId.NotFound', + 'errorMessage' => 'The RegionId provided does not exist in our records.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n 8734773E-7B21-4A22-9106-CBD245F8****\\n 1\\n 20\\n 1\\n \\n vpc-bp**********\\n RUN\\n PRIVATE\\n drdsPost\\n ecs\\n 1568620311000\\n Upgradable\\n drds.sn2.4c16g\\n CLASSIC\\n \\n V1\\n drds.sn2.4c16g.8C32G\\n cn-hangzhou-e\\n drdssen12****\\n drds_test\\n 0\\n rg-aek2ljh3ye4****\\n vsw-bpxxxxxxxxxxxxx96\\n drdssen12****\\n 4724323200000\\n drdssen12****\\n drdssen12****\\n MASTER\\n \\n vpc-bpxxxxxxxxxxxy\\n intranet\\n vsw-bpxxxxxxxxxxxxx96\\n 3306\\n 10.23.***.***\\n drdssen1243as.drds.aliyuncs.com\\n \\n drdssen12****\\n enterprise\\n \\n","errorExample":""}]', + 'title' => 'DescribeDrdsInstances', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDrdsDbInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '75989', + 'abilityTreeNodes' => [ + 'FEATUREdrds25BO3L', + ], + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drdshbga1138****', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds_test', + ], + ], + [ + 'name' => 'DbInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the custom ApsaraDB RDS for MySQL instance that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rm-bp1t1mk5a5bdj****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '4FE09970-CA69-4144-88CA-67FB4BTY56G3', + ], + 'DbInstance' => [ + 'description' => 'The detailed information about the returned custom ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'ExpireTime' => [ + 'description' => 'The time when the custom ApsaraDB RDS for MySQL instance expires. The value of this parameter is a UNIX timestamp. Unit: seconds.'."\n" + ."\n" + .'> This parameter is returned only when the custom ApsaraDB RDS for MySQL instance is a subscription instance.'."\n", + 'type' => 'string', + 'example' => '12341434315', + ], + 'PayType' => [ + 'description' => 'The billing method of the custom ApsaraDB RDS for MySQL instance. Valid values:'."\n" + ."\n" + .'* **Prepaid**: subscription'."\n" + .'* **Postaid**: pay-as-you-go'."\n", + 'type' => 'string', + 'example' => 'Postpaid', + ], + 'DBInstanceStatus' => [ + 'description' => 'The state of the instance.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'NetworkType' => [ + 'description' => 'The type of the network. Valid values: **VPC**.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'Port' => [ + 'description' => 'The port used to connect to the custom ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3306', + ], + 'EngineVersion' => [ + 'description' => 'The engine version of the database that is run on the instance. Valid values: **5.7**.'."\n", + 'type' => 'string', + 'example' => '5.7', + ], + 'DmInstanceId' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'example' => 'dm-*************', + ], + 'ConnectUrl' => [ + 'description' => 'The URL used to connect to the custom ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'example' => 'rm-***************.mysql.rds.aliyuncs.com', + ], + 'ReadWeight' => [ + 'description' => 'The read ratio of the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '70', + ], + 'RdsInstType' => [ + 'description' => 'The type of the instance.'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + 'RemainDays' => [ + 'description' => 'The number of remaining days before the instance expires.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'DBInstanceId' => [ + 'description' => 'The ID of the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'example' => 'rm-***************', + ], + 'DbInstType' => [ + 'description' => 'The role of the instance. Valid values:'."\n" + ."\n" + .'* **Primary**: The instance is a primary instance.'."\n" + .'* **ReadOnly**: The instance is a read-only instance.'."\n", + 'type' => 'string', + 'example' => 'Primary', + ], + 'Engine' => [ + 'description' => 'The engine of the database that is run on the instance. Valid value: **MySQL**.'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'ReadOnlyInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ReadOnlyInstance' => [ + 'description' => 'The list of read-only ApsaraDB RDS for MySQL instances.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExpireTime' => [ + 'description' => 'The timestamp that indicates when the read-only instance expires.'."\n", + 'type' => 'string', + 'example' => '1823487328173', + ], + 'PayType' => [ + 'description' => 'The billing method of the read-only instance.'."\n", + 'type' => 'string', + 'example' => 'Postpaid', + ], + 'VersionAction' => [ + 'description' => 'This parameter is unavailable for read-only instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DBInstanceStatus' => [ + 'description' => 'The state of the read-only instance.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'NetworkType' => [ + 'description' => 'The network type of the read-only instance.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'Port' => [ + 'description' => 'The port used to connect to the read-only instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3306', + ], + 'EngineVersion' => [ + 'description' => 'The engine version of the database that is run on the read-only instance.'."\n", + 'type' => 'string', + 'example' => '5.7', + ], + 'DmInstanceId' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'example' => 'dm-*************', + ], + 'ConnectUrl' => [ + 'description' => 'The URL used to connect to the read-only instance.'."\n", + 'type' => 'string', + 'example' => 'rm-bp1ub71ct9skc3yxx.mysql.rds.aliyuncs.com', + ], + 'ReadWeight' => [ + 'description' => 'The read ratio of the read-only instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RdsInstType' => [ + 'description' => 'The type of the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + 'RemainDays' => [ + 'description' => 'The number of remaining days before the read-only instance expires.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'DBInstanceId' => [ + 'description' => 'The ID of the read-only instance.'."\n", + 'type' => 'string', + 'example' => 'rm-bp1ub71ct9skc****', + ], + 'DbInstType' => [ + 'description' => 'The role of the read-only instance.'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + 'Engine' => [ + 'description' => 'The engine of the database that is run on the read-only instance.'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.MasterDbInstanceRelease', + 'errorMessage' => 'The master db instance has been released', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n true\\n 4FE09970-CA69-4144-88CA-67FB4BTY56G3\\n \\n 12341434315\\n Postpaid\\n 1\\n VPC\\n 3306\\n 5.7\\n dm-*************\\n rm-***************.mysql.rds.aliyuncs.com\\n 70\\n RDS\\n 0\\n rm-***************\\n Primary\\n MySQL\\n \\n 1823487328173\\n Postpaid\\n 0\\n 1\\n VPC\\n 3306\\n 5.7\\n dm-*************\\n rm-bp1ub71ct9skc3yxx.mysql.rds.aliyuncs.com\\n 30\\n RDS\\n 0\\n rm-bp1ub71ct9skc****\\n RDS\\n MySQL\\n \\n \\n","errorExample":""}]', + 'title' => 'DescribeDrdsDbInstance', + 'summary' => 'Queries the details of a custom ApsaraDB RDS for MySQL instance used as the storage of PolarDB-X 1.0.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDrdsInstance' => [ + 'summary' => 'Queries the details of a PolarDB-X 1.0 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 ID of the instance that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drdshbga1138****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the instance is created.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B4F76641-BA45-4320-BE7C-9C62CFDAC9B2', + ], + 'Data' => [ + 'description' => 'The details of the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the instance. Valid values: PRIVATE and PUBLIC. The value of PRIVATE indicates that the instance is a dedicated instance. The value of PUBLIC indicates that the instance is a shared instance.'."\n", + 'type' => 'string', + 'example' => 'PRIVATE', + ], + 'Status' => [ + 'description' => 'The state of the instance.'."\n", + 'type' => 'string', + 'example' => 'RUN', + ], + 'CreateTime' => [ + 'description' => 'The timestamp that indicates when the instance is created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1568620311000', + ], + 'VersionAction' => [ + 'description' => 'Indicates whether the version of the instance can be upgraded.'."\n", + 'type' => 'string', + 'example' => 'Upgradeable', + ], + 'StorageType' => [ + 'description' => 'The type of the instance used for storage.'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + 'NetworkType' => [ + 'description' => 'The network type of the instance. Valid values: CLASSIC and VPC.'."\n", + 'type' => 'string', + 'example' => 'CLASSIC', + ], + 'Label' => [ + 'description' => 'The tag of the instance. Valid values:'."\n" + ."\n" + .'* **NORMAL**: The instance is a standard instance.'."\n" + .'* **HA**: The instance is a high-availability (HA) instance.'."\n" + .'* **VPC**: The instance is a VPC-based instance.'."\n", + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'MysqlVersion' => [ + 'description' => 'The MySQL version that is supported by the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'InstanceSpec' => [ + 'description' => 'The specification of the instance.'."\n", + 'type' => 'string', + 'example' => 'drds.sn2.4c16g.8C32G', + ], + 'VpcCloudInstanceId' => [ + 'description' => 'The ID of the instance that is deployed in the VPC.'."\n", + 'type' => 'string', + 'example' => 'drdssen12****', + ], + 'Description' => [ + 'description' => 'The description of the instance.'."\n", + 'type' => 'string', + 'example' => 'drds_test', + ], + 'Version' => [ + 'description' => 'The version of the instance. The value of this parameter is 0.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ExpireDate' => [ + 'description' => 'The timestamp that indicates when the instance expires.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4724323200000', + ], + 'MasterInstanceId' => [ + 'description' => 'The ID of the primary instance.'."\n" + ."\n" + .'> This parameter is returned only when the instance is a primary instance.'."\n", + 'type' => 'string', + 'example' => 'drdssen1243as', + ], + 'CommodityCode' => [ + 'description' => 'The commodity code of the instance.'."\n", + 'type' => 'string', + 'example' => 'drdsPost', + ], + 'MachineType' => [ + 'description' => 'The machine type of the instance. The value of this parameter is **ecs**.'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'InstanceSeries' => [ + 'description' => 'The instance series of the instance.'."\n", + 'type' => 'string', + 'example' => 'drds.sn2.4c16g', + ], + 'ProductVersion' => [ + 'description' => 'The version of .'."\n", + 'type' => 'string', + 'example' => '5.3.*', + ], + 'RegionId' => [ + 'description' => 'The ID of the region in which the instance is created.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group to which the instance belongs. The value of this parameter can be null.'."\n", + 'type' => 'string', + 'example' => 'NULL', + ], + 'DrdsInstanceId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'drdssen1243as', + ], + 'ZoneId' => [ + 'description' => 'The ID of the zone in which the instance is located.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-e', + ], + 'InstRole' => [ + 'description' => 'The role of the instance. Valid values:'."\n" + ."\n" + .'* **MASTER**: The instance is a primary instance.'."\n" + .'* **SLAVE**: The instance is a read-only instance to analyze complex queries'."\n" + .'* **SLAVE_FLOW**: The instance is a read-only instance for high-concurrency scenarios'."\n", + 'type' => 'string', + 'example' => 'MASTER', + ], + 'OrderInstanceId' => [ + 'description' => 'The ID of the purchased instance.'."\n", + 'type' => 'string', + 'example' => 'drdssen12****', + ], + 'Vips' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Vip' => [ + 'description' => 'The list of returned virtual IP addresses (VIPs).'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the VIP. Valid values: intranet and internet.'."\n", + 'type' => 'string', + 'example' => 'intranet', + ], + 'VpcId' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp**********', + ], + 'VswitchId' => [ + 'description' => 'The ID of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp***********', + ], + 'Dns' => [ + 'description' => 'The domain name that is mapped to the VIP.'."\n", + 'type' => 'string', + 'example' => 'drdssen1243as.drds.aliyuncs.com', + ], + 'Port' => [ + 'description' => 'The ports that are opened on the VIP.'."\n", + 'type' => 'string', + 'example' => '3306', + ], + 'ExpireDays' => [ + 'description' => 'The number of remaining days before the VIP expires.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RemoveWeight' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + ], + ], + ], + 'ReadOnlyDBInstanceIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ReadOnlyDBInstanceId' => [ + 'description' => 'The details about each read-only instance that is associated with the instance.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'drdssen12****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ActionUnauthorized', + 'errorMessage' => 'The specified action is not available for you', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDRDSInstanceId.NotFound', + 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', + ], + [ + 'errorCode' => 'DrdsInstance.NotExists', + 'errorMessage' => 'The DRDS instance does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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\\": true\\n }\\n ]\\n },\\n \\"ReadOnlyDBInstanceIds\\": {\\n \\"ReadOnlyDBInstanceId\\": [\\n \\"drdssen12****\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n B4F76641-BA45-4320-BE7C-9C62CFDAC9B2\\n \\n PRIVATE\\n RUN\\n 1568620311000\\n Upgradeable\\n RDS\\n CLASSIC\\n \\n 5\\n drds.sn2.4c16g.8C32G\\n drdssen12****\\n drds_test\\n 0\\n 4724323200000\\n drdssen1243as\\n drdsPost\\n ecs\\n drds.sn2.4c16g\\n 5.3.*\\n cn-hangzhou\\n NULL\\n drdssen1243as\\n cn-hangzhou-e\\n MASTER\\n drdssen12****\\n \\n intranet\\n vpc-bp**********\\n vsw-bp***********\\n drdssen1243as.drds.aliyuncs.com\\n 3306\\n 0\\n \\n drdssen12****\\n \\n","errorExample":""}]', + 'title' => 'DescribeDrdsInstance', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDrdsParams' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '76006', + 'abilityTreeNodes' => [ + 'FEATUREdrds25BO3L', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the PolarDB-X 1.0 instance is created.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DescribeDrdsParams', + ], + ], + [ + 'name' => 'ParamLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of nodes whose parameters you want to query. Valid values:'."\n" + ."\n" + .'* **INSTANCE: the instance level.**'."\n" + .'* **DB**: the database level.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'INSTANCE', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'drds_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'Indicates the ID of the request.'."\n", + 'type' => 'string', + 'example' => '2F7F8080-9132-4279-85D0-B7E5C4305162', + ], + 'List' => [ + 'description' => 'Indicates information about parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParamDefaultValue' => [ + 'description' => 'Indicates the default value of a parameter.'."\n", + 'type' => 'string', + 'example' => '1000', + ], + 'ParamLevel' => [ + 'description' => 'Indicates the parameter level.'."\n", + 'type' => 'string', + 'example' => 'INSTANCE', + ], + 'ParamName' => [ + 'description' => 'Indicates the name of the parameter.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'ParamType' => [ + 'description' => 'Indicates the type of the parameter.'."\n", + 'type' => 'string', + 'example' => 'CONFIG', + ], + 'ParamValue' => [ + 'description' => 'Indicates the value of the parameter.'."\n", + 'type' => 'string', + 'example' => '1000', + ], + 'NeedRestart' => [ + 'description' => 'Indicates whether a restart is required.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ParamRanges' => [ + 'description' => 'Indicates the value range of the parameter.'."\n", + 'type' => 'string', + 'example' => '[1000-900000]', + ], + 'DbName' => [ + 'description' => 'Indicates the name of the database.'."\n", + 'type' => 'string', + 'example' => 'drds_test', + ], + 'ParamEnglishName' => [ + 'description' => 'Indicates the name of the parameter.'."\n", + 'type' => 'string', + 'example' => 'SLOW_SQL_TIME', + ], + 'ParamDesc' => [ + 'description' => 'Indicates the description of the parameter.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'ParamVariableName' => [ + 'description' => 'Indicates the name of the variable.'."\n", + 'type' => 'string', + 'example' => 'slowSqlTime', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"2F7F8080-9132-4279-85D0-B7E5C4305162\\",\\n \\"List\\": [\\n {\\n \\"ParamDefaultValue\\": \\"1000\\",\\n \\"DbName\\": \\"drds_test\\",\\n \\"ParamLevel\\": \\"INSTANCE\\",\\n \\"ParamName\\": \\"慢SQL阈值\\",\\n \\"ParamEnglishName\\": \\"SLOW_SQL_TIME\\",\\n \\"ParamType\\": \\"CONFIG\\",\\n \\"ParamValue\\": \\"1000\\",\\n \\"ParamDesc\\": \\"慢SQL阈值（单位：ms）\\",\\n \\"NeedRestart\\": true,\\n \\"ParamVariableName\\": \\"slowSqlTime\\",\\n \\"ParamRanges\\": \\"[1000-900000]\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n2F7F8080-9132-4279-85D0-B7E5C4305162\\n\\n [1000-900000]\\n INSTANCE\\n slowSqlTime\\n SLOW_SQL_TIME\\n 1000\\n 1000\\n true\\n drds_test\\n 慢SQL阈值\\n CONFIG\\n 慢SQL阈值（单位：ms）\\n\\ntrue\\n","errorExample":""}]', + 'title' => 'DescribeDrdsParams', + 'summary' => 'Queries parameters that you configure for an instance or a database.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDrdsTasks' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drdsxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of tasks.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'Indicates the ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CD412DF7-F21D-44CE-88FF-ED24917174A8', + ], + 'Tasks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Task' => [ + 'description' => 'Indicates information about the tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'State' => [ + 'description' => 'Indicates the state of the task.'."\n", + 'type' => 'string', + 'example' => 'FAILED', + ], + 'Content' => [ + 'description' => 'Indicates the content of a task.'."\n", + 'type' => 'string', + 'example' => 'upgrade_instance', + ], + 'Id' => [ + 'description' => 'Indicates the ID of the task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '64148', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ActionUnauthorized', + 'errorMessage' => 'The specified action is not available for you', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDRDSInstanceId.NotFound', + 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n\\n \\n FAILED\\n upgrade_instance\\n 64148\\n \\n\\nCD412DF7-F21D-44CE-88FF-ED24917174A8\\ntrue\\n","errorExample":""}]', + 'title' => 'DescribeDrdsTasks', + 'summary' => 'Queries tasks that you perform to modify an instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeHotDbList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '76024', + 'abilityTreeNodes' => [ + 'FEATUREdrds7SC2V6', + ], + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds**********', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Msg' => [ + 'description' => 'The message that is returned.'."\n", + 'type' => 'string', + 'example' => 'msg', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0B6B7BDC-575D-4A77-A4F8-24B7EF******', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The result that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RandomCode' => [ + 'description' => 'The random number.'."\n", + 'type' => 'string', + 'example' => 'jzhz', + ], + 'List' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceDb' => [ + 'description' => 'The information about the databases on which hot-spot scale-out is performed.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'instanceName', + ], + 'HotDbList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'data' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'hot_dtstest0512_****_****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\nmsg\\n0B6B7BDC-575D-4A77-A4F8-24B7EF******\\n\\n \\n \\n instanceName\\n \\n \\n \\n hot_dtstest0512_****_****\\n \\n \\n \\n jzhz\\n\\ntrue\\n","errorExample":""}]', + 'title' => 'DescribeHotDbList', + 'summary' => 'Queries the information about databases on which hots-pot scale-out is performed.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeInstanceSwitchAzone' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '76026', + 'abilityTreeNodes' => [ + 'FEATUREdrds7CT80F', + ], + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drdsxxxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DSSDF-SEWE-23ERW', + ], + 'Result' => [ + 'description' => 'The result of the operation.'."\n", + 'type' => 'object', + 'properties' => [ + 'OriginAzoneId' => [ + 'description' => 'The ID of the source azoneId.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-a', + ], + 'SwitchAble' => [ + 'description' => 'Indicates whether the job can be switched.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RegionId' => [ + 'description' => 'regionId.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'TargetAzones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TargetAzone' => [ + 'description' => 'Target azones.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-a,cn-hangzhou-b', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\nDSSDF-SEWE-23ERW\\ntrue\\n\\n cn-hangzhou-a\\n \\n cn-hangzhou-a,cn-hangzhou-b\\n \\n cn-hangzhou\\n true\\n\\n","errorExample":""}]', + 'title' => 'DescribeInstanceSwitchAzone', + 'summary' => 'Check whether zone switching is enabled', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeInstanceSwitchNetwork' => [ + 'summary' => 'Queries whether you can change the network type of a PolarDB-X 1.0 instance.', + '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 ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds*********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'Indicates the ID of the request.'."\n", + 'type' => 'string', + 'example' => '03E12FE3-1638-483E-A9B6-1A9120SER56T', + ], + 'VpcInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VpcInfo' => [ + 'description' => 'Indicates the information about the virtual private cloud (VPC) in which the instance is deployed.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'Indicates the ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc_id', + ], + 'VpcName' => [ + 'description' => 'Indicates the name of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc_name', + ], + 'RegionId' => [ + 'description' => 'Indicates the ID of the region in which the instance is deployed.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VswitchInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VswitchInfo' => [ + 'description' => 'Indicates information about the vSwitch to which the instance is connected.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'Indicates the ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc_id', + ], + 'DrdsSupported' => [ + 'description' => 'Indicates whether you can change the network type of the instance.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'VswitchId' => [ + 'description' => 'Indicates the ID of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'vswitch_id', + ], + 'AzoneId' => [ + 'description' => 'Indicates the ID of the zone in which the instance is deployed.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-a', + ], + 'VswitchName' => [ + 'description' => 'Indicates the name of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'vswitch_name', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"03E12FE3-1638-483E-A9B6-1A9120SER56T\\n\\n \\n vpc_id\\n vpc_name\\n cn-hangzhou\\n \\n \\n true\\n vpc_id\\n vswitch_name\\n cn-hangzhou-a\\n vswitch_id\\n \\n \\n \\n\\ntrue","errorExample":""}]', + 'title' => 'DescribeInstanceSwitchNetwork', + 'description' => '****', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeInstDbLogInfo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '76028', + 'abilityTreeNodes' => [ + 'FEATUREdrdsAS582G', + ], + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds*********', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the DRDS database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A5438952-70EE-4FA5-87A9-080DB0ASD45F', + ], + 'LogTimeRange' => [ + 'description' => 'The time range for log query.'."\n", + 'type' => 'object', + 'properties' => [ + 'SupportOldestTime' => [ + 'description' => 'The end time of the task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1568367711', + ], + 'SupportLatestTime' => [ + 'description' => 'The start time of the query time range.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1568267711', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"A5438952-70EE-4FA5-87A9-080DB0ASD45F\\",\\n \\"LogTimeRange\\": {\\n \\"SupportOldestTime\\": 1568367711,\\n \\"SupportLatestTime\\": 1568267711\\n }\\n}","errorExample":""},{"type":"xml","example":"A5438952-70EE-4FA5-87A9-080DB0ASD45F\\n\\n 1568367711\\n 1568267711\\n\\ntrue","errorExample":""}]', + 'title' => 'DescribeInstDbLogInfo', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribePreCheckResult' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drdshbga76p6****', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the precheck task.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '4561', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EED1A59A-CFEA-5CF8-BB4A-090E75B3D05E', + ], + 'PreCheckResult' => [ + 'description' => 'Indicates the result of the precheck task.'."\n", + 'type' => 'object', + 'properties' => [ + 'PreCheckName' => [ + 'description' => 'Indicates the name of the precheck task.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'State' => [ + 'description' => 'Indicates the state of the precheck task.'."\n", + 'type' => 'string', + 'example' => 'FAIL', + ], + 'SubCheckItems' => [ + 'description' => 'Indicates the details about the subtasks of the precheck task.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMsgCode' => [ + 'description' => 'Indicates the error code that is returned by a subtask.'."\n", + 'type' => 'string', + 'example' => '1004', + ], + 'PreCheckItemName' => [ + 'description' => 'Indicates the name of the subtask.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'State' => [ + 'description' => 'Indicates the state of the subtask.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'ErrorMsgParams' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'table1', + ], + 'description' => 'Indicates an error message.'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n FAIL\\n 是否有唯一键\\n \\n 唯一键\\n 成功\\n 1004\\n table1\\n \\n\\nDescribePreCheckResult\\ntrue","errorExample":""}]', + 'title' => 'DescribePreCheckResult', + 'summary' => 'Queries the result of a precheck.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRdsCommodity' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds***********', + ], + ], + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The commodity code of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drdsPost', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the order.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'Indicates the returned result.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'RequestId' => [ + 'description' => 'Indicates the ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DC3ABA3E-0F8A-4596-9104-F5155C34315B', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"test\\",\\n \\"RequestId\\": \\"DC3ABA3E-0F8A-4596-9104-F5155C34315B\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"DC3ABA3E-0F8A-4596-9104-F5155C34315B\\ntest\\ntrue","errorExample":""}]', + 'title' => 'DescribeRdsCommodity', + 'summary' => 'Queries the data of ApsaraDB RDS for MySQL instances that are purchased for a PolarDB-X 1.0 instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveDrdsInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ReleasePrepayInstance', + 'errorMessage' => 'The pay type of this drds instance is prepay', + ], + [ + 'errorCode' => 'RemoveDrdsDBFirst', + 'errorMessage' => 'There are Drds DB exist in this instance. Please delete drds db first', + ], + ], + 500 => [ + [ + 'errorCode' => 'ERR_INSTANCE_RELEASE_ALREADY', + 'errorMessage' => '实例已释放', + ], + [ + 'errorCode' => 'ERR_INSTANCE_CAN_NOT_RELEASE', + 'errorMessage' => '实例暂时无法释放', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\"\\n}","errorExample":""},{"type":"xml","example":"\\nA3140FC7-B78B-4D8E-B0C8-926D28******\\ntrue\\n","errorExample":""}]', + 'title' => 'RemoveDrdsInstance', + 'summary' => 'Releases an instance.', + 'description' => '> * You can call this operation to release an instance that is charged based on only the pay-as-you-go billing method.'."\n" + .'>* If the specifications of the instance are being changed, or one or more databases exist in the instance, you cannot call this operation to release the instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateDrdsDB' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance on which you want to create the database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drdshbgal154****', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the PolarDB-X 1.0 database you want to create.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testdb', + ], + ], + [ + 'name' => 'Encode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encoding method that is used by the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'utf8', + 'default' => 'utf8mb4', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password that is used to log on to the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'drds_sample_password', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The partitioning mode of the database. Valid values:'."\n" + ."\n" + .'* **HORIZONTAL**: The database is horizontally partitioned (sharded).'."\n" + .'* **VERTICAL**: The database is vertically partitioned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HORIZONTAL', + 'default' => 'HORIZONTAL', + ], + ], + [ + 'name' => 'DbInstType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the storage instances that are used by the PolarDB-X 1.0 database. Set the value to RDS.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'RDS', + 'default' => 'RDS', + ], + ], + [ + 'name' => 'DbInstanceIsCreating', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the required ApsaraDB RDS for MySQL instance is being created.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the account that has permissions to access all databases on the ApsaraDB RDS for MySQL instance.'."\n" + ."\n" + .'This parameter is required only when the Type parameter is set to VERTICAL.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'drds_sample_account', + ], + ], + [ + 'name' => 'RdsInstance', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'This parameter is required only when the Type parameter is set to HORIZONTAL. The value of this parameter is a JSON array string.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["drds_sample_rds_id1", "drds_sample_rds_id2"]', + ], + 'required' => false, + 'example' => '["drds_sample_rds_id1", "drds_sample_rds_id2"]', + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'RdsSuperAccount', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Password' => [ + 'description' => 'The password of the super administrator account that is used to connect to the ApsaraDB RDS instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'drds_sample_rds_super_password', + ], + 'DbInstanceId' => [ + 'description' => 'The ID of ApsaraDB RDS instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'drds_sample_rds_id', + ], + 'AccountName' => [ + 'description' => 'The account name of the super administrator that is used to connect to the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'drds_sample_rds_super_account', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'InstDbName', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DbInstanceId' => [ + 'description' => 'The ID of the ApsaraDB RDS for MySQL instance on which the databases need to be vertically partitioned. This parameter is required only when the Type parameter is set to VERTICAL.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'drds_sample_rds_id', + ], + 'ShardDbName' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of databases that need to be vertically partitioned on the ApsaraDB RDS for MySQL instance. The value of this parameter is a JSON array string.'."\n" + ."\n" + .'This parameter is required only when the Type parameter is set to VERTICAL.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["db1", "db2"]', + ], + 'required' => false, + 'example' => '["drds_sample_db1", "drds_sample_db2"]', + 'maxItems' => 30, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'FF13E47D-4E38-4A5A-BA68-32A554AD45T6', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidInstance.CreateDbForSlave', + 'errorMessage' => 'Db Creation in slave drds instance not support.', + ], + [ + 'errorCode' => 'InvalidParameter.InstDbName', + 'errorMessage' => 'The parameter InstDbName is empty', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"FF13E47D-4E38-4A5A-BA68-32A554AD45T6\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n FF13E47D-4E38-4A5A-BA68-32A554AD45T6\\n","errorExample":""}]', + 'title' => 'CreateDrdsDB', + 'summary' => 'Creates a PolarDB-X 1.0 database.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDrdsDBs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drdshbga1138****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. The value of this parameter must be an integer that is greater than 0. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of databases to return on each page. Valid values: **30**, **50**, and **100**.'."\n" + ."\n" + .'Default value: **30**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '1000', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the PolarDB-X 1.0 instance is created.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of databases returned on each page.'."\n", + 'type' => 'string', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '006B7D19-8CDB-4AA6-AAE7-23C107GS3W2T', + ], + 'Total' => [ + 'description' => 'The number of returned databases.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Db' => [ + 'description' => 'The list of returned databases.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The state of the database.'."\n", + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'DbName' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'drds_test', + ], + 'Schema' => [ + 'description' => 'The schema ID that is assigned to the partitioned database.'."\n", + 'type' => 'string', + 'example' => 'drds_test_1563773871118kxqd', + ], + 'CreateTime' => [ + 'description' => 'The time when the database is created. The value of this parameter is a UNIX timestamp. Unit: ms.'."\n", + 'type' => 'string', + 'example' => '1563773824000', + ], + 'Mode' => [ + 'description' => 'The partitioning mode of the database. Valid values:'."\n" + ."\n" + .'* **HORIZONTAL**: The database is horizontally partitioned.'."\n" + .'* **VERTICAL**: The database is vertically partitioned.'."\n", + 'type' => 'string', + 'example' => 'HORIZONTAL', + ], + 'DbInstType' => [ + 'description' => 'The type of the database. Valid values: **RDS** and **POLARDB**.'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ActionUnauthorized', + 'errorMessage' => 'The specified action is not available for you', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDRDSInstanceId.NotFound', + 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n 30\\n 1\\n 006B7D19-8CDB-4AA6-AAE7-23C107GS3W2T\\n 1\\n true\\n \\n NORMAL\\n drds_test\\n drds_test_1563773871118kxqd\\n 1563773824000\\n HORIZONTAL\\n RDS\\n \\n","errorExample":""}]', + 'title' => 'DescribeDrdsDBs', + 'summary' => 'Queries the databases on a PolarDB-X 1.0 instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDrdsDB' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds*********', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'db_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'Indicates the ID of the request.'."\n", + 'type' => 'string', + 'example' => '58FB0EC7-CF71-4E48-92FB-CF070D******', + ], + 'Data' => [ + 'description' => 'Indicates the details about the database.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Indicates the state of the database. Valid values:'."\n" + ."\n" + .'* **TO_BE_INIT**: The database is being created.'."\n" + .'* **NORMAL**: The database is running.'."\n", + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'DbName' => [ + 'description' => 'Indicates the name of the database.'."\n", + 'type' => 'string', + 'example' => 'db_test', + ], + 'Schema' => [ + 'description' => 'Indicates the schema name of the database.'."\n", + 'type' => 'string', + 'example' => 'db_test*******************', + ], + 'CreateTime' => [ + 'description' => 'Indicates the time when the database was created. The value is in the UNIX timestamp format. Unit: ms.'."\n", + 'type' => 'string', + 'example' => '1602050276000', + ], + 'Mode' => [ + 'description' => 'Indicates the database sharding method.'."\n" + ."\n" + .'* **HORIZONTAL**: The database is horizontally sharded.'."\n" + .'* **VERTICAL**: The database is vertically sharded.'."\n", + 'type' => 'string', + 'example' => 'HORIZONTAL', + ], + 'DbInstType' => [ + 'description' => 'Indicates the storage type of the database.'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + 'InstRole' => [ + 'description' => 'Indicates the type of the instance in which the database is deployed. Valid values:'."\n" + ."\n" + .'* **MASTER**: The instance is a primary instance.'."\n" + .'* **SLAVE**: The instance is a read-only instance.'."\n", + 'type' => 'string', + 'example' => 'MASTER', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDbName.NotFound', + 'errorMessage' => 'The Drds DbName provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"58FB0EC7-CF71-4E48-92FB-CF070D******\\n\\n NORMAL\\n RDS\\n MASTER\\n db_test*******************\\n HORIZONTAL\\n 1602050276000\\n db_test\\n\\ntrue","errorExample":""}]', + 'title' => 'DescribeDrdsDB', + 'summary' => 'Queries details about a database that is deployed in a PolarDB-X 1.0 instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDrdsDbInstances' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drdshbga1138****', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dbname', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'Indicates the number of entries returned per page.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'Indicates the page number of the returned page.', + 'type' => 'string', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'Indicates the ID of the request.'."\n", + 'type' => 'string', + 'example' => '2F7F8080-9132-4279-85D0-B7E5C4305162', + ], + 'Total' => [ + 'description' => 'Indicates the number of primary ApsaraDB RDS for MySQL instances.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'DbInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DbInstance' => [ + 'description' => 'Indicates information about the ApsaraDB RDS for MySQL instances that are used to store the data of the specified database.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExpireTime' => [ + 'description' => 'Indicates the point in time when the ApsaraDB RDS for MySQL instance that is used to store the data of the specified database expires.'."\n", + 'type' => 'string', + 'example' => '1237486127634', + ], + 'PayType' => [ + 'description' => 'Indicates the billing method of the ApsaraDB RDS for MySQL instance that is used to store the data of the specified database. Valid values:'."\n" + ."\n" + .'* **drdsPre**: The instance uses the subscription billing method.'."\n" + .'* **drdsPost**: The instance uses the pay-as-you-go billing method.'."\n", + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'DBInstanceStatus' => [ + 'description' => 'Indicates the state of the ApsaraDB RDS for MySQL instance that is used to store the data of the specified database. Valid values:'."\n" + ."\n" + .'* **0**: The ApsaraDB RDS for MySQL instance is being created.'."\n" + .'* **1**: The ApsaraDB RDS for MySQL instance is running.'."\n" + .'* **3**: The ApsaraDB RDS for MySQL instance is being deleted.'."\n" + .'* **5**: The ApsaraDB RDS for MySQL instance is being restarted.'."\n" + .'* **6**: The ApsaraDB RDS for MySQL instance is being upgraded or downgraded.'."\n" + .'* **7**: The ApsaraDB RDS for MySQL instance is being backed up.'."\n" + .'* **8**: The network type of the ApsaraDB RDS for MySQL instance is being changed.'."\n" + .'* **9**: The ApsaraDB RDS for MySQL instance is being migrated.'."\n" + .'* **11**: The data of the ApsaraDB RDS for MySQL instance is being migrated.'."\n" + .'* **12**: A disaster-recovery instance is being generated.'."\n" + .'* **13**: Data is being imported to the ApsaraDB RDS for MySQL instance.'."\n" + .'* **14**: Data is being imported to the ApsaraDB RDS for MySQL instance from an another ApsaraDB RDS for MySQL instance.'."\n" + .'* **15**: A failover is being performed.'."\n" + .'* **16**: A temporary instance is being created.'."\n" + .'* **17**: A network is being created for the ApsaraDB RDS for MySQL instance.'."\n" + .'* **18**: The ApsaraDB RDS for MySQL instance is being cloned.'."\n" + .'* **19**: The link is being changed.'."\n" + .'* **20**: The read-only instances of the ApsaraDB RDS for MySQL instance are being migrated.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'NetworkType' => [ + 'description' => 'Indicates the network type of the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'Port' => [ + 'description' => 'Indicates the port that is used to connect to the ApsaraDB RDS for MySQL instance that is used to store the data of the specified database.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3306', + ], + 'EngineVersion' => [ + 'description' => 'Indicates the engine version of the ApsaraDB RDS for MySQL instance that is used to store the data of the specified database.'."\n", + 'type' => 'string', + 'example' => '5.7', + ], + 'DmInstanceId' => [ + 'description' => 'Indicates the ID of a resource.'."\n", + 'type' => 'string', + 'example' => 'dm-hbgau1zp****', + ], + 'ConnectUrl' => [ + 'description' => 'Indicates the endpoint that is used to connect to an ApsaraDB RDS for MySQL instance that is used to store the data of the specified database.'."\n", + 'type' => 'string', + 'example' => 'rm-bp1t1mk5a5b******.mysql.rds.aliyuncs.com', + ], + 'ReadWeight' => [ + 'description' => 'Indicates the read weight of the read-only instance.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RdsInstType' => [ + 'description' => 'Indicates whether the ApsaraDB RDS for MySQL instance that is used to store the data of the specified database is a primary instance or a read-only instance.'."\n" + ."\n" + .'* **Primary**: The instance is a primary instance.'."\n" + .'* **Readonly**: The instance is a read-only instance.'."\n", + 'type' => 'string', + 'example' => 'Primary', + ], + 'RemainDays' => [ + 'description' => 'Indicates the number of remaining days before a subscription instance expires.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DBInstanceId' => [ + 'description' => 'Indicates the ID of the ApsaraDB RDS for MySQL instance that is used to store the data of the specified database.'."\n", + 'type' => 'string', + 'example' => 'rm-bp1t1mk5a5bdj****', + ], + 'DbInstType' => [ + 'description' => 'Indicates the type of the ApsaraDB RDS for MySQL instance that is used to store the data of the specified database. The value is set to RDS.'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + 'Engine' => [ + 'description' => 'Indicates the engine of the ApsaraDB RDS for MySQL instance that is used to store the data of the specified database.'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'ReadOnlyInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ReadOnlyInstance' => [ + 'description' => 'Indicates information about the read-only instances of the ApsaraDB RDS for MySQL instance that is used to store the data of the specified database.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExpireTime' => [ + 'description' => 'Indicates the timestamp when the ApsaraDB RDS for MySQL instance that is used to store the data of the specified database expires.'."\n", + 'type' => 'string', + 'example' => '123421352351234', + ], + 'PayType' => [ + 'description' => 'Indicates the billing method of the read-only instance.'."\n" + ."\n" + .'* **drdsPre**: The instance uses the subscription billing method.'."\n" + .'* **drdsPost**: The instance uses the pay-as-you-go billing method.'."\n", + 'type' => 'string', + 'example' => 'Postpaid', + ], + 'DBInstanceStatus' => [ + 'description' => 'Indicates the state of the ApsaraDB RDS for MySQL instance that is used to store the data of the specified database. Valid values:'."\n" + ."\n" + .'* **0**: The ApsaraDB RDS for MySQL instance is being created.'."\n" + .'* **1**: The ApsaraDB RDS for MySQL instance is running.'."\n" + .'* **3**: The ApsaraDB RDS for MySQL instance is being deleted.'."\n" + .'* **5**: The ApsaraDB RDS for MySQL instance is being restarted.'."\n" + .'* **6**: The ApsaraDB RDS for MySQL instance is being upgraded or downgraded.'."\n" + .'* **7**: The ApsaraDB RDS for MySQL instance is being backed up.'."\n" + .'* **8**: The network type of the ApsaraDB RDS for MySQL instance is being changed.'."\n" + .'* **9**: The ApsaraDB RDS for MySQL instance is being migrated.'."\n" + .'* **11**: The data of the ApsaraDB RDS for MySQL instance is being migrated.'."\n" + .'* **12**: A disaster-recovery instance is being generated.'."\n" + .'* **13**: Data is being imported to the ApsaraDB RDS for MySQL instance.'."\n" + .'* **14**: Data is being imported to the ApsaraDB RDS for MySQL instance from an another ApsaraDB RDS for MySQL instance.'."\n" + .'* **15**: A failover is being performed.'."\n" + .'* **16**: A temporary instance is being created.'."\n" + .'* **17**: A network is being created for the ApsaraDB RDS for MySQL instance.'."\n" + .'* **18**: The ApsaraDB RDS for MySQL instance is being cloned.'."\n" + .'* **19**: The link is being changed.'."\n" + .'* **20**: The read-only instances of the ApsaraDB RDS for MySQL instance are being migrated.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'NetworkType' => [ + 'description' => 'Indicates the network type of the read-only instance.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'Port' => [ + 'description' => 'Indicates the port that is used to connect to the read-only instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3306', + ], + 'EngineVersion' => [ + 'description' => 'Indicates the engine version of the ApsaraDB RDS for MySQL instance that is used to store the data of the specified database.'."\n", + 'type' => 'string', + 'example' => '5.7', + ], + 'DmInstanceId' => [ + 'description' => 'Indicates the ID of a resource.'."\n", + 'type' => 'string', + 'example' => 'dm-hbgau1zp****', + ], + 'ConnectUrl' => [ + 'description' => 'Indicates the endpoint that is used to connect to the ApsaraDB RDS for MySQL instance that is used to store the data of the specified database.'."\n", + 'type' => 'string', + 'example' => 'rm-bp1t1mk5a5b******.mysql.rds.aliyuncs.com', + ], + 'ReadWeight' => [ + 'description' => 'Indicates the read weight of the read-only instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '70', + ], + 'RdsInstType' => [ + 'description' => 'Indicates the type of the read-only instance.'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + 'InstanceName' => [ + 'description' => 'Indicates the name of a read-only instance.'."\n", + 'type' => 'string', + 'example' => '**', + ], + 'RemainDays' => [ + 'description' => 'Indicates the number of remaining days before the read-only instance expires.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DbInstType' => [ + 'description' => 'Indicates the type of the ApsaraDB RDS for MySQL instance that is used to store the data of the specified database. The value is set to RDS.'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + 'Engine' => [ + 'description' => 'Indicates the engine of the ApsaraDB RDS for MySQL instance that is used to store the data of the specified database.'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n 10\\n 1\\n 2F7F8080-9132-4279-85D0-B7E5C4305162\\n 1\\n true\\n \\n 1237486127634\\n PostPaid\\n 1\\n VPC\\n 3306\\n 5.7\\n dm-hbgau1zp****\\n rm-bp1t1mk5a5b******.mysql.rds.aliyuncs.com\\n 30\\n Primary\\n 0\\n rm-bp1t1mk5a5bdj****\\n RDS\\n MySQL\\n \\n 123421352351234\\n Postpaid\\n 1\\n VPC\\n 3306\\n 5.7\\n dm-hbgau1zp****\\n rm-bp1t1mk5a5b******.mysql.rds.aliyuncs.com\\n 70\\n RDS\\n **\\n 0\\n RDS\\n MySQL\\n \\n \\n","errorExample":""}]', + 'title' => 'DescribeDrdsDbInstances', + 'summary' => 'Queries ApsaraDB RDS for MySQL instances that are used to store the data of a database.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDrdsDbRdsNameList' => [ + 'summary' => 'Queries instances that are used to store the data of a database.', + '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', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drdsxxxxxxxxxxx', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'Indicates the ID of the request.'."\n", + 'type' => 'string', + 'example' => '7E6FA2BF-05F2-44DD-95C0-D1B5B8xxxxxx', + ], + 'InstanceNameList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceName' => [ + 'description' => 'Indicates the instances that are used to store the data of a database.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rm-bpxxxxxxxxxxxxxxx', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"7E6FA2BF-05F2-44DD-95C0-D1B5B8xxxxxx\\",\\n \\"InstanceNameList\\": {\\n \\"InstanceName\\": [\\n \\"rm-bpxxxxxxxxxxxxxxx\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\t37537B38-A663-45CB-A81F-E3B202BB2415\\n\\t\\n\\t\\trm-m5xxxxxxxxx82\\n\\t\\n\\ttrue\\n\\t","errorExample":""}]', + 'title' => 'DescribeDrdsDbRdsNameList', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDrdsShardingDbs' => [ + 'summary' => 'Queries the database shards of an PolarDB-X 1.0 instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance whose database shards you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drdshbgaf3c63qbo', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database whose shards you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds_test', + ], + ], + [ + 'name' => 'DbNamePattern', + 'in' => 'query', + 'schema' => [ + 'description' => 'The matching pattern of the database name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of database shards returned on each page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '509BDE17-505A-4B3B-854D-30D3F092502F', + ], + 'ShardingDbs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ShardingDb' => [ + 'description' => 'The list of returned database shards.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MinPoolSize' => [ + 'description' => 'The minimum size of the connection pool.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'MaxPoolSize' => [ + 'description' => 'The maximum size of the connection pool.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'DbInstanceId' => [ + 'description' => 'The ID of the Apsara RDS for MySQL instance that is used as the storage of the database shard.'."\n", + 'type' => 'string', + 'example' => 'rm-bp1hjzn0yv5j2****', + ], + 'ConnectUrl' => [ + 'description' => 'The URL that is used to access the Apsara RDS for MySQL instance.'."\n", + 'type' => 'string', + 'example' => '100.100.64.100:11569', + ], + 'GroupName' => [ + 'description' => 'The name of group on which the database shard is stored.'."\n", + 'type' => 'string', + 'example' => 'TEMP1_1568171495522SABE_KUP4_0000', + ], + 'DbType' => [ + 'description' => 'The engine of the database.'."\n", + 'type' => 'string', + 'example' => 'mysql', + ], + 'IdleTimeOut' => [ + 'description' => 'The timeout period of an idle connection.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'ShardingDbName' => [ + 'description' => 'The name of the database shard.'."\n", + 'type' => 'string', + 'example' => 'temp1_zhk1_0000', + ], + 'BlockingTimeout' => [ + 'description' => 'The timeout period for a transaction to wait for the release of the data lock.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5000', + ], + 'PreparedStatementCacheSize' => [ + 'description' => 'The size of cache for the returned results.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ConnectionProperties' => [ + 'description' => 'The properties of the connection string.'."\n", + 'type' => 'string', + 'example' => 'connectTimeout=3000;autoReconnect=true;failOverReadOnly=false;socketTimeout=900000;rewriteBatchedStatements=true;characterEncoding=utf8', + ], + 'UserName' => [ + 'description' => 'The username that is used to connect to the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'example' => 'pg284mi8', + ], + 'DbStatus' => [ + 'description' => 'The status of the database.'."\n", + 'type' => 'string', + 'example' => 'running', + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of database shards returned per page.'."\n", + 'type' => 'string', + 'example' => '20', + ], + 'Total' => [ + 'description' => 'The number of returned database shards.'."\n", + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ActionUnauthorized', + 'errorMessage' => 'The specified action is not available for you', + ], + [ + 'errorCode' => 'ServiceUnable', + 'errorMessage' => 'The service is not available now, please try again later', + ], + [ + 'errorCode' => 'InvalidParameter.Mismatch', + 'errorMessage' => 'The specified parameter does not match.', + ], + [ + 'errorCode' => 'InvalidDbname.MalFormed', + 'errorMessage' => 'The specified db name does not match.', + ], + [ + 'errorCode' => 'InvalidDRDSInstanceId.NotFound', + 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records', + ], + [ + 'errorCode' => 'InvalidDbName.NotFound', + 'errorMessage' => 'The Drds DbName provided does not exist in our records', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDRDSInstanceId.NotFound', + 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDbName.NotFound', + 'errorMessage' => 'The Drds DbName provided does not exist in our records.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n true\\n 509BDE17-505A-4B3B-854D-30D3F092502F\\n \\n 5\\n 60\\n rm-bp1hjzn0yv5j2****\\n 100.100.64.100:11569\\n TEMP1_1568171495522SABE_KUP4_0000\\n mysql\\n 30\\n temp1_zhk1_0000\\n 5000\\n 0\\n connectTimeout=3000;autoReconnect=true;failOverReadOnly=false;socketTimeout=900000;rewriteBatchedStatements=true;characterEncoding=utf8\\n pg284mi8\\n running\\n \\n 1\\n 20\\n 1\\n","errorExample":""}]', + 'title' => ' DescribeDrdsShardingDbs', + ], + 'CheckDrdsDbName' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DRDS instance ID'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds********', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'DRDS database name'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CF38538C-68BD-4278-B58F-EDE96F******', + ], + 'Result' => [ + 'description' => 'Indicates whether the DRDS database name is valid. Valid values: true: The database name is valid. false: the database name is invalid.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => 'Indicates whether the call is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDbName.Empty', + 'errorMessage' => 'DbName can not be empty', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDbName.Keyword', + 'errorMessage' => 'Current DbName is the keyword', + ], + [ + 'errorCode' => 'InvalidDbName.DuplicatedInPublic', + 'errorMessage' => 'Current DbName is duplicated in public instance', + ], + [ + 'errorCode' => 'InvalidDbName.Duplicated', + 'errorMessage' => 'Current DbName provided has already existed in our records.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CF38538C-68BD-4278-B58F-EDE96F******\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"true\\nCF38538C-68BD-4278-B58F-EDE96F******\\ntrue","errorExample":""}]', + 'title' => 'CheckDrdsDbName', + 'summary' => 'Checks whether the name of the CheckDrdsDbName database is valid.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveDrdsDbFailedRecord' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '76107', + 'abilityTreeNodes' => [ + 'FEATUREdrds25BO3L', + ], + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraDB RDS for PostgreSQL instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the DRDS database.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D98BC610-5A91-453A-BC44-5873EF******', + ], + 'Result' => [ + 'description' => 'Indicates whether the database creation failure records were deleted from the DRDS instance.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDbName.Empty', + 'errorMessage' => 'DbName can not be empty', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D98BC610-5A91-453A-BC44-5873EF******\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"D98BC610-5A91-453A-BC44-5873EF******\\ntrue\\ntrue","errorExample":""}]', + 'title' => 'RemoveDrdsDbFailedRecord', + 'summary' => 'You can call this operation to delete the RemoveDrdsDbFailedRecord that failed to be created.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveDrdsDb' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the DRDS instance to which the destination database belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database you want to back up.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B12FC174-D5CE-4A6E-83C1-0F8F86******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B12FC174-D5CE-4A6E-83C1-0F8F86******\\"\\n}","errorExample":""},{"type":"xml","example":"B12FC174-D5CE-4A6E-83C1-0F8F86******\\ntrue","errorExample":""}]', + 'title' => 'RemoveDrdsDb', + 'summary' => 'Deletes a DRDS database.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyRdsReadWeight' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'InstanceNames', + 'in' => 'query', + 'schema' => [ + 'description' => 'The names of the ApsaraDB RDS for MySQL instances. Separate the names with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rm-****************,rm-****************', + ], + ], + [ + 'name' => 'Weights', + 'in' => 'query', + 'schema' => [ + 'description' => 'The weights of the ApsaraDB RDS for MySQL instances. Separate the weights with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '14,86', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'Indicates the ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B12FC174-D5CE-4A6E-83C1-0F8F86******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.InvalidDbName', + 'errorMessage' => 'The dbName does not exist in this drds instance', + ], + [ + 'errorCode' => 'InvalidParameter.ReadWeighAndRdsNotMapping', + 'errorMessage' => 'The parameter read weight and rds instance not mapping', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidReadWeight', + 'errorMessage' => 'The parameter read weight is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B12FC174-D5CE-4A6E-83C1-0F8F86******\\"\\n}","errorExample":""},{"type":"xml","example":"B12FC174-D5CE-4A6E-83C1-0F8F86******\\ntrue","errorExample":""}]', + 'title' => 'ModifyRdsReadWeight', + 'summary' => 'Modifies the weights of ApsaraDB RDS for MySQL instances. PolarDB-X distributes read and write requests to ApsaraDB RDS for MySQL instances based on the assigned weights.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRdsPerformanceSummary' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the streaming domain resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of a DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'RdsInstanceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The list of ApsaraDB RDS for MySQL instances.'."\n", + ], + 'required' => true, + 'example' => 'rm-*****************', + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the API request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B6876277-ECFD-4658-AC1E-A7FAD8******', + ], + 'RdsPerformanceInfos' => [ + 'description' => 'A collection of objects.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Cpu' => [ + 'description' => 'The CPU utilization of an RDS instance.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.26', + ], + 'ActiveSessions' => [ + 'description' => 'The number of active sessions of the RDS instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TotalSessions' => [ + 'description' => 'The total number of current RDS sessions.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '162', + ], + 'RdsId' => [ + 'description' => 'The ID of an RDS instance.'."\n", + 'type' => 'string', + 'example' => 'rm-**************', + ], + 'Iops' => [ + 'description' => 'The IOPS of the RDS instance.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '17.62', + ], + 'SpaceUsage' => [ + 'description' => 'The disk usage of apsaradb for RDS. Unit: MB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4145144777', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"B6876277-ECFD-4658-AC1E-A7FAD8******\\n\\n 162\\n 4145144777\\n 0.26\\n 17.62\\n rm-**************\\n 0\\n\\ntrue","errorExample":""}]', + 'title' => 'DescribeRdsPerformanceSummary', + 'summary' => 'You can call the interface DescribeRdsPerformanceSummary to query RDS instance\'s performance details, such as CPU.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRdsSuperAccountInstances' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'DbInstType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the ApsaraDB RDS for MySQL instances. Default value: **RDS**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'RDS', + 'default' => 'RDS', + ], + ], + [ + 'name' => 'RdsInstance', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The IDs of the ApsaraDB RDS for MySQL instances.'."\n", + ], + 'required' => true, + 'example' => '[\'rm-*****************\',\'rm-*****************\']', + 'maxItems' => 30, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5D64DE5944A1E541E0******', + ], + 'DbInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DbInstance' => [ + 'description' => 'The privileged accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rm-*****************', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ActionUnauthorized', + 'errorMessage' => 'The specified action is not available for you', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5D64DE5944A1E541E0******\\",\\n \\"DbInstances\\": {\\n \\"DbInstance\\": [\\n \\"rm-*****************\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"4DFD4978-FA5F-4C3C-A30D-AD4D164AD674\\n\\n","errorExample":""}]', + 'title' => 'DescribeRdsSuperAccountInstances', + 'summary' => 'Queries the privileged accounts of ApsaraDB RDS for MySQL instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDrdsDBCluster' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '75988', + 'abilityTreeNodes' => [ + 'FEATUREdrdsDBGOD6', + ], + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of a DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds*********', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the DRDS database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds_test', + ], + ], + [ + 'name' => 'DbInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '60A77FD6-0DE4-4A34-B6FB-9C2673******', + ], + 'DbInstance' => [ + 'description' => 'The details of each PolarDB cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'ExpireTime' => [ + 'description' => 'The time when the PolarDB cluster expires.'."\n", + 'type' => 'string', + 'example' => '2019-09-27 11:22:33', + ], + 'PayType' => [ + 'description' => 'The billing method of the PolarDB cluster.'."\n", + 'type' => 'string', + 'example' => 'Postpaid', + ], + 'DBInstanceStatus' => [ + 'description' => 'The status of the PolarDB instance.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'NetworkType' => [ + 'description' => 'The network type of the PolarDB cluster.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'Port' => [ + 'description' => 'The PolarDB access port.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3306', + ], + 'EngineVersion' => [ + 'description' => 'The version of the DRDS database storage engine.'."\n", + 'type' => 'string', + 'example' => '8.0', + ], + 'RdsInstType' => [ + 'description' => 'The type of RDS instance. PolarDB cluster does not support this parameter.'."\n", + 'type' => 'string', + 'example' => 'ignore', + ], + 'RemainDays' => [ + 'description' => 'The number of days remaining on the PolarDB for MySQL instance.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'DBInstanceId' => [ + 'description' => 'The ID of the PolarDB cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'DbInstType' => [ + 'description' => 'The type of storage used by the DRDS database.', + 'type' => 'string', + 'example' => 'POLARDB', + ], + 'Engine' => [ + 'description' => 'The type of the DRDS database storage engine.', + 'type' => 'string', + 'example' => 'POLARDB', + ], + 'ReadMode' => [ + 'description' => 'This parameter specifies the Read mode when the database storage type is PolarDB.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **DEFAULT**: the default mode (that is, all read traffic is sent to the PolarDB read /write node).'."\n" + .'* **CUSTOM**: Custom mode (you can customize the ratio of traffic sent to read /write nodes and read-only nodes).'."\n" + .'* **BALANCE**: read balancing mode (the read traffic is automatically distributed by the read load module of the PolarDB cluster, which can also be understood as the read traffic being evenly distributed to each node).'."\n", + 'type' => 'string', + 'example' => 'CUSTOM', + ], + 'Endpoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Endpoint' => [ + 'description' => 'The endpoint of the PolarDB read /write splitting endpoint'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReadWeight' => [ + 'description' => 'The read ratio of this connection address managed by the DRDS database.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '85', + ], + 'EndpointId' => [ + 'description' => 'The ID of the PolarDB connection address.'."\n", + 'type' => 'string', + 'example' => 'pe-*****************', + ], + 'NodeIds' => [ + 'description' => 'The ID list of the nodes in the PolarDB connection string. Separate multiple nodes with commas (,).'."\n", + 'type' => 'string', + 'example' => 'pi-*****************,pi-*****************', + ], + ], + ], + ], + ], + ], + 'DBNodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBNode' => [ + 'description' => 'The information about the nodes in the PolarDB Cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeRole' => [ + 'description' => 'The role of a node in the apsaradb for PolarDB cluster. Valid values:'."\n" + ."\n" + .'* **Reader**'."\n" + .'* **Writer**'."\n", + 'type' => 'string', + 'example' => 'Reader', + ], + 'ZoneId' => [ + 'description' => 'The ID of the zone where the node of the PolarDB cluster resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'DBNodeId' => [ + 'description' => 'The ID of the node in the apsaradb for PolarDB cluster.'."\n", + 'type' => 'string', + 'example' => 'pi-***************', + ], + 'DBNodeStatus' => [ + 'description' => 'The status of the nodes in the PolarDB cluster.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.MasterDbInstanceRelease', + 'errorMessage' => 'The master db instance has been released', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"60A77FD6-0DE4-4A34-B6FB-9C2673******\\n\\n POLARDB\\n 8.0\\n 1\\n 3306\\n Postpaid\\n \\n \\n 85\\n pi-*****************\\n pc-*****************\\n \\n \\n 15\\n pi-*****************,pi-*****************\\n pe-*****************\\n \\n \\n pc-*****************\\n \\n \\n Running\\n cn-hangzhou-i\\n Reader\\n pi-*****************\\n \\n \\n Running\\n cn-hangzhou-i\\n Writer\\n pi-*****************\\n \\n \\n Running\\n cn-hangzhou-i\\n Reader\\n pi-*****************\\n \\n \\n VPC\\n CUSTOM\\n \\n 0\\n POLARDB\\n\\ntrue","errorExample":""}]', + 'title' => 'DescribeDrdsDBCluster', + 'summary' => 'You can call this operation to query the information of the PolarDB cluster in the DRDS logical database.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRDSPerformance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Distributed Relational Database Service (DRDS) instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds*********', + ], + ], + [ + 'name' => 'RdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the storage-layer ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-************', + ], + ], + [ + 'name' => 'Keys', + 'in' => 'query', + 'schema' => [ + 'description' => 'The performance monitoring metrics. You can specify one or more metrics for a query at a time. Separate multiple metric parameters with commas (,).'."\n" + ."\n" + .'> For more information about the details of performance monitoring metrics, see [Storage monitoring](~~186705~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MySQL_MemCpuUsage', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the query. Specify the time in the UNIX timestamp format. The time must be in UTC. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1603123290000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the query. Specify the time in the UNIX timestamp format. The time must be in UTC. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1603209690000', + ], + ], + [ + 'name' => 'DbInstType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the database engine.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mysql', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DB53EC68-463C-4187-8D2B-C2AD8C******', + ], + 'Data' => [ + 'description' => 'The result set of the query.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The name of the monitoring metric.'."\n", + 'type' => 'string', + 'example' => 'cpuusage', + ], + 'NodeName' => [ + 'description' => 'The name of the node.'."\n" + ."\n" + .'> This parameter is returned only when the storage type of the database is PolarDB for MySQL. If the storage type of the database is ApsaraDB RDS for MySQL, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => 'pi-*************', + ], + 'Unit' => [ + 'description' => 'The unit of the monitoring metric.'."\n", + 'type' => 'string', + 'example' => '%', + ], + 'NodeNum' => [ + 'description' => 'The number of nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Values' => [ + 'description' => 'The details of the monitoring metric data.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Date' => [ + 'description' => 'The time point when the value of the monitoring metric was obtained. The value is in the UNIX timestamp format. The time is displayed in UTC. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1603209660000', + ], + 'Value' => [ + 'description' => 'The value of the monitoring metric.'."\n", + 'type' => 'string', + 'example' => '0.58', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'Monitor.QueryRdsFailure', + 'errorMessage' => 'Failed to query RDS monitor info.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\nDB53EC68-463C-4187-8D2B-C2AD8C******\\n\\n 1\\n \\n 0.58\\n 1603209660000\\n \\n %\\n cpuusage\\n\\n\\n 1\\n \\n 9.75\\n 1603209660000\\n \\n %\\n memusage\\n\\ntrue\\n","errorExample":""}]', + 'title' => 'DescribeRDSPerformance', + 'summary' => 'Queries the details about the performance data of storage-layer ApsaraDB RDS for MySQL.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDbInstances' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '75986', + 'abilityTreeNodes' => [ + 'FEATUREdrdsD0NTUP', + ], + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of a DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'Search', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the storage or cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'DbInstType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Storage layer type. Valid values: **POLARDB** or **RDS**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'POLARDB', + 'default' => 'RDS', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '30', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '293275B3-8FC0-4619-A26E-6F062FASD56R', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBInstance' => [ + 'description' => 'The details of the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceNetworkType' => [ + 'description' => 'The network type of the storage layer. Valid values:'."\n" + ."\n" + .'* **VPC**: VPC'."\n" + .'* **CLASSIC **: Classic Network'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'DBInstanceType' => [ + 'description' => 'The storage layer instance type.'."\n", + 'type' => 'string', + 'example' => 'Primary', + ], + 'ZoneId' => [ + 'description' => 'The ID of the zone where the storage instance resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-a', + ], + 'DBInstanceStatus' => [ + 'description' => 'Storage layer instance status. Valid values:'."\n" + ."\n" + .'* **0**: creating'."\n" + .'* **1**: In use'."\n" + .'* **3**: Deleting'."\n" + .'* **5**: restarting'."\n" + .'* **6**: upgrading /Downgrading'."\n" + .'* **7**: Recovering'."\n" + .'* **8**: switching the Internet and intranet'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DBInstanceId' => [ + 'description' => 'The ID of the storage instance.'."\n", + 'type' => 'string', + 'example' => 'rm-****************', + ], + 'Engine' => [ + 'description' => 'The engine of the storage instance.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'DBInstanceDescription' => [ + 'description' => 'The description of the storage instance.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'EngineVersion' => [ + 'description' => 'The version of the engine for the storage instance.'."\n", + 'type' => 'string', + 'example' => '5.7', + ], + 'RegionId' => [ + 'description' => 'The ID of the region where the storage instance resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ReadOnlyDBInstanceId' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ReadOnlyDBInstanceId' => [ + 'description' => 'The details about a read-only storage instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[]', + ], + ], + ], + ], + 'AllowAllCategory' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ActionUnauthorized', + 'errorMessage' => 'The specified action is not available for you', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDRDSInstanceId.NotFound', + 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDbName.NotFound', + 'errorMessage' => 'The Drds DbName provided does not exist in our records.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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\\": true\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 293275B3-8FC0-4619-A26E-6F062FASD56R\\n \\n VPC\\n Primary\\n cn-hangzhou-a\\n 0\\n rm-****************\\n 存储层实例内核。\\n test\\n 5.7\\n cn-hangzhou\\n []\\n \\n","errorExample":""}]', + 'title' => 'DescribeDbInstances', + 'summary' => 'Queries DescribeDbInstances of the storage layer, such as RDS or PolarDB.', + ], + '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 ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'DbInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance in which the storage-layer databases are deployed.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the privileged account of the PolarDB-X 1.0 instance. You do not need to specify this parameter if you have no privileged account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the privileged account. You do not need to specify this parameter if you have no privileged account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pwd_111111', + ], + ], + [ + 'name' => 'DbInstType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The engine type of the storage-layer databases. Valid values: **POLARDB** and **RDS**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'POLARDB', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E9F3D991-08DE-4B74-BE0E-06B809******', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Total' => [ + 'description' => 'Indicates the total number of storage-layer databases.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Databases' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Database' => [ + 'description' => 'Indicates the information about the storage-layer databases.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Indicates the state of the storage-layer database. Valid values:'."\n" + ."\n" + .'* **0**: The database is being created.'."\n" + .'* **1**: The database is available.'."\n" + .'* **3**: The database is being deleted.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DbName' => [ + 'description' => 'Indicates the name of a storage-layer database.'."\n", + 'type' => 'string', + 'example' => 'db_test', + ], + 'Description' => [ + 'description' => 'Indicates the description of the storage-layer database.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ActionUnauthorized', + 'errorMessage' => 'The specified action is not available for you', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDRDSInstanceId.NotFound', + 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n \\n 1\\n test\\n db_test\\n \\n\\n1\\nE9F3D991-08DE-4B74-BE0E-06B809******\\ntrue","errorExample":""}]', + 'title' => 'DescribeDbInstanceDbs', + 'summary' => 'Queries information about storage-layer databases in a specific storage instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateInstanceAccount' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance for which you want to create the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drdsjiii1b49****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username of the account you want to create.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds_sample_account', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the account you want to create.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds_sample_password', + ], + ], + [ + 'name' => 'DbPrivilege', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DbName' => [ + 'description' => 'The name of the database that you want to manage by using the account to create.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test123', + ], + 'Privilege' => [ + 'description' => 'The permissions that you want to grant to the account to manage the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DDL', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'FF13E47D-4E38-4A5A-BA68-4E610EVF56DC', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'OperationFailed.CreateAccount', + 'errorMessage' => 'Create account failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"FF13E47D-4E38-4A5A-BA68-4E610EVF56DC\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n FF13E47D-4E38-4A5A-BA68-4E610EVF56DC\\n","errorExample":""}]', + 'title' => 'CreateInstanceAccount', + 'summary' => 'Creates an account used to manage a PolarDB-X 1.0 instance.', + ], + 'RemoveInstanceAccount' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds***********', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the member account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationFailed.RemoveInstanceAccount', + 'errorMessage' => 'Remove instance account failed', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\"\\n}","errorExample":""},{"type":"xml","example":"A3140FC7-B78B-4D8E-B0C8-926D28******\\ntrue","errorExample":""}]', + 'title' => 'RemoveInstanceAccount', + 'summary' => 'You can call the interface RemoveInstanceAccount to delete an account.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EnableSqlAudit' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds***********', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database for which you want to enable the SQL audit feature.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'IsRecall', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to backtrack historical SQL statements for auditing.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RecallStartTimestamp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timestamp that indicates when the backtracking starts. Unit: milliseconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1568875132000', + ], + ], + [ + 'name' => 'RecallEndTimestamp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timestamp that indicates when the backtracking ends. Unit: milliseconds.'."\n" + ."\n" + .'> The end time of the backtracking must be later than the start time of the backtracking.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1568875132000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '463A5F0F-12AD-4544-A902-B2B983******', + ], + 'Result' => [ + 'description' => 'Indices whether the SQL audit feature is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"463A5F0F-12AD-4544-A902-B2B983******\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"true\\n463A5F0F-12AD-4544-A902-B2B983******\\ntrue","errorExample":""}]', + 'title' => 'EnableSqlAudit', + 'summary' => 'Enables the SQL audit feature for a database.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DisableSqlAudit' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds***********', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database for which you want to disable the SQL audit feature.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E273749A-9A33-44CF-ABE7-0CB19C******', + ], + 'Result' => [ + 'description' => 'The return result.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E273749A-9A33-44CF-ABE7-0CB19C******\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"E273749A-9A33-44CF-ABE7-0CB19C******\\ntrue\\ntrue","errorExample":""}]', + 'title' => 'DisableSqlAudit', + 'summary' => 'Disables the SQL audit feature for a database.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDrdsSqlAuditStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DC3ABA3E-0F8A-4596-9104-F5155C******', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Data' => [ + 'description' => 'The returned data set.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExtraSlsLogStore' => [ + 'description' => 'The Log Service Logstore from which logs are delivered.'."\n" + ."\n" + .'> This parameter is returned only if external log delivery is enabled.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'DbName' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Detailed' => [ + 'description' => 'Indicates whether the complete report of the SQL audit is supported. Valid values: true and false.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'ExtraWriteEnabled' => [ + 'description' => 'Indicates whether external log delivery is enabled. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Enabled' => [ + 'description' => 'Indicates whether the SQL audit feature is enabled for the database. Valid values: true and false.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'ExtraAliUid' => [ + 'description' => 'The UID of the external delivery.'."\n" + ."\n" + .'> This parameter is returned only if external log delivery is enabled.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111', + ], + 'ExtraSlsProject' => [ + 'description' => 'The Log Service project from which logs are delivered.'."\n" + ."\n" + .'> This parameter is returned only if external log delivery is enabled.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"DC3ABA3E-0F8A-4596-9104-F5155C******\\n\\n \\n 111\\n test\\n false\\n true\\n test\\n test\\n true\\n \\n\\ntrue","errorExample":""}]', + 'title' => 'DescribeDrdsSqlAuditStatus', + 'summary' => 'Queries the SQL audit details of a PolarDB-X 1.0 instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeInstDbSlsInfo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds***********', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DC3ABA3E-0F8A-4596-9104-F5155C******', + ], + 'AuditInfo' => [ + 'description' => 'The details of the SQL audit.'."\n", + 'type' => 'object', + 'properties' => [ + 'LogStore' => [ + 'description' => 'The name of the LogStore.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Project' => [ + 'description' => 'The name of the Log Service project.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DC3ABA3E-0F8A-4596-9104-F5155C******\\",\\n \\"AuditInfo\\": {\\n \\"LogStore\\": \\"test\\",\\n \\"Project\\": \\"test\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n test\\n test\\n \\n DC3ABA3E-0F8A-4596-9104-F5155C******\\n true\\n","errorExample":""}]', + 'title' => 'DescribeInstDbSlsInfo', + 'summary' => 'Queries the names of the Log Service project and the Logstore used by the SQL audit feature.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDrdsSlowSqls' => [ + 'summary' => 'Queries a slow SQL query.', + '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', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds***************', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'ExeTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The SQL execution time. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1000', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the SQL query. Specify the time in the UNIX timestamp format. The time must be in UTC. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1568269711000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the SQL query. Specify the time in the UNIX timestamp format. The time must be in UTC. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1568267711000', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'default' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'Indicates the number of entries returned on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PageNumber' => [ + 'description' => 'Indicates the page number of the returned page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'Indicates the ID of the request.'."\n", + 'type' => 'string', + 'example' => '509BDE17-505A-4B3B-854D-30D3F0******', + ], + 'Total' => [ + 'description' => 'Indicates the total number of entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => 'Indicates the details of the slow SQL query.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SendTime' => [ + 'description' => 'Indicates the time when the slow SQL query was sent. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1568267711', + ], + 'Host' => [ + 'description' => 'Indicates the IP address of the execution machine.'."\n", + 'type' => 'string', + 'example' => '10.0.***.***', + ], + 'Sql' => [ + 'description' => 'Indicates the content of the slow SQL query.'."\n", + 'type' => 'string', + 'example' => 'SELECT count(1) from payment_order where order_status = \'08\';', + ], + 'ResponseTime' => [ + 'description' => 'Indicates the response time. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1568267711', + ], + 'Schema' => [ + 'description' => 'Indicates the name of the database.'."\n", + 'type' => 'string', + 'example' => 'user', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ActionUnauthorized', + 'errorMessage' => 'The specified action is not available for you', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDRDSInstanceId.NotFound', + 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDbName.NotFound', + 'errorMessage' => 'The Drds DbName provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n509BDE17-505A-4B3B-854D-30D3F0******\\n20\\n1\\n1\\n\\n \\n 1568267711\\n user\\n 1568267711\\n 10.0.***.***\\n SELECT count(1) from payment_order where order_status = \'08\';\\n \\n\\ntrue\\n","errorExample":""}]', + 'title' => 'DescribeDrdsSlowSqls', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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 ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the SQL audit feature. Valid values:'."\n" + ."\n" + .'* enabled: The SQL audit feature is enabled.'."\n" + .'* disabled: The SQL audit feature is disabled.'."\n", + 'type' => 'string', + 'example' => 'enabled', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'FF13E47D-4E38-4A5A-BA68-32A554******', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"enabled\\",\\n \\"RequestId\\": \\"FF13E47D-4E38-4A5A-BA68-32A554******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\"disabled\\"\\nFF13E47D-4E38-4A5A-BA68-32A554******\\ntrue","errorExample":""}]', + 'title' => 'CheckSqlAuditEnableStatus', + 'summary' => 'Checks whether the SQL audit feature is enabled for the logical database of a PolarDB-X 1.0 instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StartRestore' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rds********', + ], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The restoration time of the instance, in the format of` yyyy-MM-dd HH:mm:ss `.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2019-09-10 20:18:18', + ], + ], + [ + 'name' => 'BackupMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup method. Valid values:'."\n" + ."\n" + .'* logic: the logical backup.'."\n" + .'* phy: fast backup'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'phy', + ], + ], + [ + 'name' => 'BackupLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The level of the backup. Valid values:'."\n" + ."\n" + .'* db: The database level.'."\n" + .'* instance: the instance level.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'db', + ], + ], + [ + 'name' => 'BackupDbNames', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database to be restored. Separate multiple databases with commas (,).'."\n" + ."\n" + .'> If you do not specify any database name, all databases in the instance are restored by default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test1,test2', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the DRDS backup set.'."\n" + ."\n" + .'> If you do not specify this parameter, the system restores data by time (PreferredBackupTime).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '23***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '721C71DD-D3D0-4327-BFDD-678326******', + ], + 'Result' => [ + 'description' => 'Indicates whether SQL audit was disabled for the DRDS database.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"721C71DD-D3D0-4327-BFDD-678326******\\",\\n \\"Result\\": \\"success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"success\\n721C71DD-D3D0-4327-BFDD-678326******\\ntrue","errorExample":""}]', + 'title' => 'StartRestore', + 'summary' => 'Starts a backup-based restoration task.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetBackupPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup cycle. Valid values:'."\n" + ."\n" + .'* 0: Monday'."\n" + .'* 1: Tuesday'."\n" + .'* 2: Wednesday'."\n" + .'* 3: Thursday'."\n" + .'* 4: Friday'."\n" + .'* 5: Saturday'."\n" + .'* 6: Sunday'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PreferredBackupStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the backup.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '11:30:30', + ], + ], + [ + 'name' => 'PreferredBackupEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the backup.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12:30:30', + ], + ], + [ + 'name' => 'BackupMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup mode. Valid values:'."\n" + ."\n" + .'* **Logic **: logical backup'."\n" + .'* **phy**: physical backup'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'phy', + ], + ], + [ + 'name' => 'BackupLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The level of the backup. Valid values:'."\n" + ."\n" + .'* db: The database type.'."\n" + .'* instance: instance'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'db', + ], + ], + [ + 'name' => 'BackupDbNames', + 'in' => 'query', + 'schema' => [ + 'description' => 'The databases to be backed up. Separate multiple databases with commas (,).'."\n" + ."\n" + .'> This parameter takes effect only when the backup level is database level.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test1,test2', + ], + ], + [ + 'name' => 'BackupLog', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable log Backup. Valid values:'."\n" + ."\n" + .'* 1: enabled.'."\n" + .'* 0: disabled.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DataBackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retention period of the backup data. Value range: 7 to 730.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'LogBackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The log retention period. Valid values: 7 to 730. This value must be less than or equal to the number of data backup days.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', + ], + 'Result' => [ + 'description' => 'Indicates whether the backup policy was successfully configured.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => 'Indicates whether the database creation failure records were removed from the DRDS instance.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\",\\n \\"Result\\": \\"success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"A3140FC7-B78B-4D8E-B0C8-926D28******\\nsuccess\\ntrue","errorExample":""}]', + 'title' => 'SetBackupPolicy', + 'summary' => 'You can call the SetBackupPolicy to set backup policy.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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 ID of the ApsaraDB RDS for PostgreSQL instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds***********', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database you want to back up.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '463A5F0F-12AD-4544-A902-B2B983******', + ], + 'Result' => [ + 'description' => 'Indicates whether SqlFlashbackMatchSwitch is enabled or not.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was sent successfully or not.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"463A5F0F-12AD-4544-A902-B2B983******\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"true\\n463A5F0F-12AD-4544-A902-B2B983******\\ntrue","errorExample":""}]', + 'title' => 'EnableSqlFlashbackMatchSwitch', + 'summary' => 'You can call this operation to implement precise data recovery during SQL flashback. In this case, the information about the execution QUERY is added to the RDS BINLOG used by the DRDS database.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackMenu' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds***********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'The result of request.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '60C21BE4-EDFE-454C-95ED-3A5C74******', + ], + 'List' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'list' => [ + 'description' => 'The backup information list.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Support' => [ + 'description' => 'Indicates whether backup recovery is supported.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'MenuName' => [ + 'description' => 'The backup method. Valid values:'."\n" + ."\n" + .'* **Logic **: logical backup'."\n" + .'* **phy**: physical backup'."\n", + 'type' => 'string', + 'example' => 'phy', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n phy\\n true\\n\\n\\n logic\\n true\\n\\n60C21BE4-EDFE-454C-95ED-3A5C74******\\ntrue","errorExample":""}]', + 'title' => 'DescribeBackMenu', + 'summary' => 'Call the interface DescribeBackMenu to check whether the DRDS instance supports restorate the backup.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRestoreOrder' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance for which to modify the backup policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The preferred backup time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2019-09-16 15:12:53', + ], + ], + [ + 'name' => 'BackupMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup mode. Valid values: **logic** or **phy**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'phy', + ], + ], + [ + 'name' => 'BackupLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The level of the backup. Valid values:'."\n" + ."\n" + .'* **DB**: The database Level'."\n" + .'* **instance **: instance level'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'db', + ], + ], + [ + 'name' => 'BackupDbNames', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database involved in the backup.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'drds_flashback', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup set.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1918df27-4563-11e9-8403-af4fbe******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0AD2DE5D-B86B-40B5-9678-487D37******', + ], + 'RestoreOrderDO' => [ + 'description' => 'The returned data object.'."\n", + 'type' => 'object', + 'properties' => [ + 'DrdsOrderDOList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DrdsOrderDOList' => [ + 'description' => 'The information of the restored order.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The ID of the VPC network.'."\n", + 'type' => 'string', + 'example' => 'vpc-*******************', + ], + 'Network' => [ + 'description' => 'The network type. Valid values:'."\n" + ."\n" + .'* **Classic **: Classic Network'."\n" + .'* **vpc**: VPC'."\n", + 'type' => 'string', + 'example' => 'vpc', + ], + 'VSwtichId' => [ + 'description' => 'The ID of the vSwitch in the VPC.'."\n", + 'type' => 'string', + 'example' => 'vsw-*******************', + ], + 'InstSpec' => [ + 'description' => 'The instance type of the instance.'."\n", + 'type' => 'string', + 'example' => '4C8G * 2', + ], + 'AzoneId' => [ + 'description' => 'The ID of the zone for which to query resources.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-e', + ], + 'RegionId' => [ + 'description' => 'The region ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + 'RdsOrderDOList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RdsOrderDOList' => [ + 'description' => 'The information of the restored RDS order.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Network' => [ + 'description' => 'The network type. Valid values: - **Classic **: Classic Network'."\n" + .'- **vpc**: VPC', + 'type' => 'string', + 'example' => 'VPC', + ], + 'Version' => [ + 'description' => 'The version of the operating system.', + 'type' => 'string', + 'example' => '5.6', + ], + 'InstanceClass' => [ + 'description' => 'The instance type of the instance.', + 'type' => 'string', + 'example' => 'rds.mysql.s2.large', + ], + 'DbInstanceStorage' => [ + 'description' => 'The capacity of disk.', + 'type' => 'string', + 'example' => '10240', + ], + 'Num' => [ + 'description' => 'The number of streams that were returned.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Engine' => [ + 'description' => 'The storage engine of the instance.', + 'type' => 'string', + 'example' => 'MYSQL', + ], + 'AzoneId' => [ + 'description' => 'The zone ID of the node.', + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + ], + 'RegionId' => [ + 'description' => 'The region ID of the instance.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + 'PolarOrderDOList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PolarOrderDOList' => [ + 'description' => 'The ID of the restored apsaradb for PolarDB cluster.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Network' => [ + 'description' => 'The network type. Valid values:'."\n" + ."\n" + .'* **Classic**: Classic Network'."\n" + .'* **vpc**: VPC', + 'type' => 'string', + 'example' => 'VPC', + ], + 'Version' => [ + 'description' => 'The version of the operating system.'."\n", + 'type' => 'string', + 'example' => '5.6', + ], + 'InstanceClass' => [ + 'description' => 'The type of the instance.'."\n", + 'type' => 'string', + 'example' => 'polar.mysql.x4.large', + ], + 'DbInstanceStorage' => [ + 'description' => 'The capacity of disk.'."\n", + 'type' => 'string', + 'example' => '10240', + ], + 'Num' => [ + 'description' => 'The number of streams that were returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Engine' => [ + 'description' => 'The storage engine of PolarDB.'."\n", + 'type' => 'string', + 'example' => 'POLARDB', + ], + 'AzoneId' => [ + 'description' => 'The zone ID of the node.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + ], + 'RegionId' => [ + 'description' => 'The region ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"0AD2DE5D-B86B-40B5-9678-487D37******\\n\\n \\n \\n \\n \\n 4C8G * 2\\n cn-hangzhou-e\\n vpc\\n cn-hangzhou\\n vpc-*******************\\n \\n \\n \\n \\n polar.mysql.x4.large\\n 1\\n cn-hangzhou-g\\n VPC\\n cn-hangzhou\\n 10240\\n 5.6\\n POLARDB\\n \\n \\n polar.mysql.x4.large\\n 1\\n cn-hangzhou-g\\n VPC\\n cn-hangzhou\\n 10240\\n 5.6\\n POLARDB\\n \\n \\n\\ntrue","errorExample":""}]', + 'title' => 'DescribeRestoreOrder', + 'summary' => 'You can call the DescribeRestoreOrder operation to view the details of the order.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackupDbs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of a DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'PreferredRestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'Query by restoration time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1568632541236', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Query by backup set ID'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '201908367', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'The result of request.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '842DFA7F-B09B-42A2-B115-E684AE******', + ], + 'DbNames' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'dbName' => [ + 'description' => 'The details about a database.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["db1","db2"]', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"842DFA7F-B09B-42A2-B115-E684AE******\\",\\n \\"DbNames\\": {\\n \\"dbName\\": [\\n \\"[\\\\\\"db1\\\\\\",\\\\\\"db2\\\\\\"]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\n842DFA7F-B09B-42A2-B115-E684AE******\\ntrue","errorExample":""}]', + 'title' => 'DescribeBackupDbs', + 'summary' => 'You can call this operation to query the list of databases that can be restored.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackupSets' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds***********', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the query time which is in timestamp format (measured in millisecond).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1591327800000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the query time which is in timestamp format (measured in millisecond) .'."\n" + ."\n" + .'> The end time must be later than the start time.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1591326000000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7103AEE3-9025-442F-B82B-BABD0A******', + ], + 'BackupSets' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'backupSet' => [ + 'description' => 'The list of backup sets.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EnableRecovery' => [ + 'description' => 'Indicates whether the backup set can be restored. Valid values:'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Status' => [ + 'description' => 'The status of the backup instance. Valid values:'."\n" + ."\n" + .'* \\-1: Failed'."\n" + .'* 0: Not started'."\n" + .'* 1: The storage instance is running.'."\n" + .'* 2: Success'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'BackupConsitentTime' => [ + 'description' => 'Backup Recovery duration.'."\n", + 'type' => 'string', + 'example' => '2020-06-05 11:31:38', + ], + 'BackupType' => [ + 'description' => 'The type of the backup. Valid values:'."\n" + ."\n" + .'* manual: indicates a manual backup.'."\n" + .'* auto: indicates an automatic backup.'."\n", + 'type' => 'string', + 'example' => 'manual', + ], + 'BackupStartTime' => [ + 'description' => 'The beginning of the backup time which is in timestamp format (measured in millisecond).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1591327754000', + ], + 'BackupLevel' => [ + 'description' => 'The level of the backup. Valid values:'."\n" + ."\n" + .'* db: The database level.'."\n" + .'* instance: the instance level.'."\n", + 'type' => 'string', + 'example' => 'instance', + ], + 'BackupMode' => [ + 'description' => 'The backup method. Valid values:'."\n" + ."\n" + .'* logic: the logical backup.'."\n" + .'* phy: fast backup'."\n", + 'type' => 'string', + 'example' => 'logic', + ], + 'BackupEndTime' => [ + 'description' => 'The end of the backup time which is in timestamp format (measured in millisecond).'."\n" + ."\n" + .'> 0 indicates not finished.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1591327899000', + ], + 'Id' => [ + 'description' => 'The ID of the data backup file you want to use.'."\n", + 'type' => 'string', + 'example' => 'ba30d5c4-a6dc-11ea-bd40-************', + ], + 'BackupTotalSize' => [ + 'description' => 'The size of the backup set. Unit: MB.'."\n", + 'type' => 'string', + 'example' => '93.24', + ], + 'BackupDbs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'backupDb' => [ + 'description' => 'The list of backup databases.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["dts********"]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"7103AEE3-9025-442F-B82B-BABD0A******\\n\\n \\n 2\\n 93.24\\n 2020-06-05 11:31:38\\n 1591327899000\\n logic\\n instance\\n 1591327754000\\n manual\\n \\n dts********\\n \\n ba30d5c4-a6dc-11ea-bd40-************\\n true\\n \\n\\ntrue","errorExample":""}]', + 'title' => 'DescribeBackupSets', + 'summary' => 'Queries DescribeBackupSets backup sets.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackupPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drdshbga71nn****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8FAF3989-79CD-4A67-8FFD-97899B64****', + ], + 'BackupPolicyDO' => [ + 'description' => 'The information about the backup policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'BackupDbName' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'LogBackupRetentionPeriod' => [ + 'description' => 'The retention period of log backup files. Unit: days.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'DataBackupRetentionPeriod' => [ + 'description' => 'The retention period of data backup files. Unit: days.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'BackupType' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'BackupLevel' => [ + 'description' => 'The backup level. Valid values:'."\n" + ."\n" + .'* **db**: database backup'."\n" + .'* **instance**: instance backup'."\n", + 'type' => 'string', + 'example' => 'instance', + ], + 'LocalLogRetentionHours' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'HighSpaceUsageProtection' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'GmtModified' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'BackupRetentionPeriod' => [ + 'description' => 'The retention period of backup files. Unit: days.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'BackupPolicyMode' => [ + 'description' => 'The type of the backup policy. Valid values:'."\n" + ."\n" + .'* **DataBackupPolicy**: a data backup policy'."\n" + .'* **LogBackupPolicy**: a log backup policy'."\n", + 'type' => 'string', + 'example' => 'DataBackupPolicy', + ], + 'PreferredBackupPeriod' => [ + 'description' => 'The backup cycle. You can specify multiple backup cycles. Separate multiple backup cycles with commas (,). Valid values:'."\n" + ."\n" + .'* **0**: every Monday'."\n" + .'* **1**: every Tuesday'."\n" + .'* **2**: every Wednesday'."\n" + .'* **3**: every Thursday'."\n" + .'* **4**: every Friday'."\n" + .'* **5**: every Saturday'."\n" + .'* **6**: every Sunday'."\n", + 'type' => 'string', + 'example' => '1,4', + ], + 'LocalLogRetentionSpace' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'BackupAppName' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'PreferredBackupTime' => [ + 'description' => 'The time range in which a backup is performed. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '22:00:00-23:00:00', + ], + 'GmtCreate' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'BackupMode' => [ + 'description' => 'The backup mode. Valid values:'."\n" + ."\n" + .'* **logic**: logical backup'."\n" + .'* **phy**: fast backup'."\n", + 'type' => 'string', + 'example' => 'phy', + ], + 'BackupLog' => [ + 'description' => 'Indicates whether the log backup feature is enabled. Valid values:'."\n" + ."\n" + .'* **1**: The log backup feature is enabled.'."\n" + .'* **0**: The log backup feature is disabled.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'NextBackupActuallyTime' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + '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"}]', + 'title' => 'DescribeBackupPolicy', + 'summary' => 'Queries the information about a backup policy.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackupTimes' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drdshbga71nn****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'Indicates the ID of the request.'."\n", + 'type' => 'string', + 'example' => '4780A19F-5ECB-4C56-AD20-966A3FF9DE5R', + ], + 'RestoreTime' => [ + 'description' => 'Indicates the information about the time range within which the data of the instance can be restored to a point in time.'."\n", + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'Indicates the end time. The time is in the UNIX timestamp format. The time is in UTC. Unit: ms.'."\n", + 'type' => 'string', + 'example' => '1568636922671', + ], + 'StartTime' => [ + 'description' => 'Indicates the start time. The time is in the UNIX timestamp format. The time must be in UTC. Unit: ms.'."\n", + 'type' => 'string', + 'example' => '1568632853000', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"4780A19F-5ECB-4C56-AD20-966A3FF9DE5R\\",\\n \\"RestoreTime\\": {\\n \\"EndTime\\": \\"1568636922671\\",\\n \\"StartTime\\": \\"1568632853000\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"4780A19F-5ECB-4C56-AD20-966A3FF9DE5R\\ntrue\\n\\n 1568636922671\\n 1568632853000\\n","errorExample":""}]', + 'title' => 'DescribeBackupTimes', + 'summary' => 'Queries the time range within which the data of an instance can be restored to a point in time.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveBackupsSet' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '76103', + 'abilityTreeNodes' => [ + 'FEATUREdrdsE1M93A', + ], + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup set. You can call the [DescribeBackupSets](~~139331~~) interface to query the ID of a backup set.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ba30d5c4-a6dc-11ea-bd40-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '70FED5BE-4DDC-4556-AD35-5A6D27******', + ], + 'Result' => [ + 'description' => 'Indicates whether SQL audit was disabled for the DRDS database.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"70FED5BE-4DDC-4556-AD35-5A6D27******\\",\\n \\"Result\\": \\"success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"70FED5BE-4DDC-4556-AD35-5A6D27******\\ntrue\\nsuccess","errorExample":""}]', + 'title' => 'RemoveBackupsSet', + 'summary' => 'Deletes a backup set.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutStartBackup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '76095', + 'abilityTreeNodes' => [ + 'FEATUREdrds8KEOBF', + ], + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds****c6vxxyzd', + ], + ], + [ + 'name' => 'BackupMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup mode. For more information, see [backup mode](~~108631~~) and the valid values are as follows:'."\n" + ."\n" + .'* phy: fast backup'."\n" + .'* logic: Consistent backup'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'phy', + ], + ], + [ + 'name' => 'BackupLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup level. Valid values:'."\n" + ."\n" + .'* instance: instance'."\n" + .'* db: The database type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'db', + ], + ], + [ + 'name' => 'BackupDbNames', + 'in' => 'query', + 'schema' => [ + 'description' => 'If you need to back up data at the database level, you must specify the list of databases to be backed up, and separate multiple databases with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'db_1, db_2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5D64DE5944A1E541E0******', + ], + 'Result' => [ + 'description' => 'Indicates whether the backup task was submitted.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5D64DE5944A1E541E0******\\",\\n \\"Result\\": \\"success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"200\\n\\n 07D9CC74-2707-4234-BC5A-1F11AE******\\n true\\n success\\n","errorExample":""}]', + 'title' => 'PutStartBackup', + 'summary' => 'You can call this operation to submit a data backup task.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateInstanceInternetAddress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds****************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region to which the DRDS instance belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The error code returned when the activity fails.'."\n" + ."\n" + .'> This parameter appears only when an error occurs during the API call.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '404', + ], + 'Data' => [ + 'description' => 'Indicates whether the public IP address was created.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1DF6052F-15E2-4E69-9628-D6BCC3******', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error. 默认错误码', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 404,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"1DF6052F-15E2-4E69-9628-D6BCC3******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"true\\n1DF6052F-15E2-4E69-9628-D6BCC3******\\ntrue","errorExample":""}]', + 'title' => 'CreateInstanceInternetAddress', + 'summary' => 'Creates CreateInstanceInternetAddress public IP address for a DRDS instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateInstanceNetwork' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '76149', + 'abilityTreeNodes' => [ + 'FEATUREdrdsBRC5LQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds******', + ], + ], + [ + 'name' => 'SrcInstanceNetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type of the PolarDB-X 1.0 instance. Valid values:'."\n" + ."\n" + .'* vpc: Virtual Private Cloud (VPC)'."\n" + .'* classic: classic network'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'classic', + ], + ], + [ + 'name' => 'RetainClassic', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to retain the classic network endpoint.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ClassicExpiredDays', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the retention period of the classic network endpoint. Unit: days.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DSSDF-SEWE-*****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ERR_INSTANCE_CANNOT_SWITCH_NETWORK_FOR_PUBLIC', + 'errorMessage' => 'Public instance cannot switch network to VPC', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\"\\n}","errorExample":""},{"type":"xml","example":"DSSDF-SEWE-*****\\ntrue","errorExample":""}]', + 'title' => 'UpdateInstanceNetwork', + 'summary' => 'Changes the network type of a PolarDB-X 1.0 instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ReleaseInstanceInternetAddress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the instance is located.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + 'default' => 'center', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The result returned by the current API.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'FD17CD3C-3355-49E8-9231-FE2DB0******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error. 默认错误码', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"FD17CD3C-3355-49E8-9231-FE2DB0******\\"\\n}","errorExample":""},{"type":"xml","example":"FD17CD3C-3355-49E8-9231-FE2DB0******\\ntrue","errorExample":""}]', + 'title' => 'ReleaseInstanceInternetAddress', + 'summary' => 'You can call this ReleaseInstanceInternetAddress to release the public endpoint of an RDS instance. This ensures the security of the instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDrdsIpWhiteList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '76084', + 'abilityTreeNodes' => [ + 'FEATUREdrdsJOW4UL', + ], + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Message Queue for Apache Kafka instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds****c6vxxyzd', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the DRDS database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'IpWhiteList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The modified whitelist. Separate multiple IP addresses with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '127.***.***.***,10.***.***.***', + ], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the mode. Valid values:'."\n" + ."\n" + .'* `True`: append modifications'."\n" + .'* `False`: overwrite modification'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the IP address whitelist group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'drds_******', + ], + ], + [ + 'name' => 'GroupAttribute', + 'in' => 'query', + 'schema' => [ + 'description' => 'The attribute of the IP address whitelist group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '933A1EC2-8260-4D4F-A56A-73BA27******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"933A1EC2-8260-4D4F-A56A-73BA27******\\"\\n}","errorExample":""},{"type":"xml","example":"933A1EC2-8260-4D4F-A56A-73BA27******\\ntrue","errorExample":""}]', + 'title' => 'ModifyDrdsIpWhiteList', + 'summary' => 'You can call this operation to modify the database whitelist.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDrdsDBIpWhiteList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'default' => 'center', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds********', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the whitelist group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'group1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '017453B9-0001-4745-87BF-DD612D850ED0', + ], + 'IpWhiteList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Ip' => [ + 'description' => 'The IP address whitelist.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.23.***.***,10.23.***.***/24', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ActionUnauthorized', + 'errorMessage' => 'The specified action is not available for you', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDRDSInstanceId.NotFound', + 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDbName.NotFound', + 'errorMessage' => 'The Drds DbName provided does not exist in our records.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"017453B9-0001-4745-87BF-DD612D850ED0\\",\\n \\"IpWhiteList\\": {\\n \\"Ip\\": [\\n \\"10.23.***.***,10.23.***.***/24\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 017453B9-0001-4745-87BF-DD612D850ED0\\n 10.23.***.***,10.23.***.***/24\\n","errorExample":""}]', + 'title' => 'DescribeDrdsDBIpWhiteList', + 'summary' => 'Queries the IP address whitelist for a specified DRDS database.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SubmitCleanTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds*********', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database that is scaled out.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'ParentJobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scale-out task. This parameter is returned if you send a request for the smooth scale-out task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The job ID of the scale-out task. The value of this parameter is the same as that of the ParentJobId parameter.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'ExpandType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The scale-out type. Valid values:'."\n" + ."\n" + .'* smooth_expand: smooth scale-out'."\n" + .'* hot_expand: hot-spot scale-out'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'smooth_expand', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DSSDF-SEWE-*****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\"\\n}","errorExample":""},{"type":"xml","example":"DSSDF-SEWE-*****\\ntrue","errorExample":""}]', + 'title' => 'SubmitCleanTask', + 'summary' => 'Submits a cleanup task for the scale-out of a PolarDB-X database.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SubmitSmoothExpandPreCheck' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds*******', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the PolarDB-X database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'DbInstType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the database. Valid values:'."\n" + ."\n" + .'* RDS'."\n" + .'* POLARDB'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'RDS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Msg' => [ + 'description' => 'The result of the precheck task.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'FE104D26-AC19-49B5-AC67-947F69******', + ], + 'TaskId' => [ + 'description' => 'The ID of the precheck task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11111', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"RequestId\\": \\"FE104D26-AC19-49B5-AC67-947F69******\\",\\n \\"TaskId\\": 11111,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"FE104D26-AC19-49B5-AC67-947F69******\\n97358\\ntrue\\nsuccess","errorExample":""}]', + 'title' => 'SubmitSmoothExpandPreCheck', + 'summary' => 'Submits a precheck task for the smooth scale-out of a PolarDB-X database.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CheckExpandStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds***********', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the PolarDB-X database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7CDBA7D5-8D62-4D24-9C65-510D62******', + ], + 'Data' => [ + 'description' => 'The result of the verification.'."\n", + 'type' => 'object', + 'properties' => [ + 'Msg' => [ + 'description' => 'The additional information.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'IsActive' => [ + 'description' => 'Indicates whether scale-out operations can be performed on the database.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"7CDBA7D5-8D62-4D24-9C65-510D62******\\",\\n \\"Data\\": {\\n \\"Msg\\": \\"success\\",\\n \\"IsActive\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n \\n\\n7CDBA7D5-8D62-4D24-9C65-510D62******\\ntrue","errorExample":""}]', + 'title' => 'CheckExpandStatus', + 'summary' => 'Verifies whether scale-out operations such as smooth scale-out can be performed on a PolarDB-X database.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SubmitHotExpandTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '76135', + 'abilityTreeNodes' => [ + 'FEATUREdrdsR9AYAV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drdshbga1138****', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'TaskDesc', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'InstanceDbMapping', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the instance to which the hot-spot database belongs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DbList' => [ + 'description' => 'The name of the hot-spot database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'hot_test_****_****', + ], + 'InstanceName' => [ + 'description' => 'The name of the ApsaraDB RDS instance to which the hot-spot database belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rm-bp1t1mk5a5bdj****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 30, + ], + ], + [ + 'name' => 'Mapping', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the hot-spot database.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HotDbName' => [ + 'description' => 'The name of the hot-spot database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hot_test_****_****', + ], + 'ShardTbValue' => [ + 'description' => 'The value of the shard key used to split a table.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'HotTableName' => [ + 'description' => 'The name of the hot-spot table. The name must be prefixed with the name of a logical table.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_table_*****', + ], + 'ShardDbValue' => [ + 'description' => 'The value of the shard key used to split a database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'TbShardColumn' => [ + 'description' => 'The shard key used to split an associated table.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'platform', + ], + 'DbShardColumn' => [ + 'description' => 'The shard key used to split the database to which the associated table belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'platform', + ], + 'LogicTable' => [ + 'description' => 'The name of the logical table on which you want to perform hot-spot scale-out.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_table', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 30, + ], + ], + [ + 'name' => 'SupperAccountMapping', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the privileged account.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'description' => 'The ID of the ApsaraDB RDS instance that has the privileged account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rm-bp1t1mk5a5bdj****', + ], + 'SupperAccount' => [ + 'description' => 'The name of the privileged account of the ApsaraDB RDS instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'SupperPassword' => [ + 'description' => 'The password of the privileged account of the ApsaraDB RDS instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '11111111', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'ExtendedMapping', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the database on which you want to perform hot-spot scale-out.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SrcDb' => [ + 'description' => 'The name of the source physical database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'SrcInstanceId' => [ + 'description' => 'The ID of the ApsaraDB RDS instance to which the source physical database belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rm-bp1t1mk5a5bdj****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 30, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0B6B7BDC-575D-4A77-A4F8-24B7EFERV45Y', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0B6B7BDC-575D-4A77-A4F8-24B7EFERV45Y\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0B6B7BDC-575D-4A77-A4F8-24B7EFERV45Y\\n","errorExample":""}]', + 'title' => 'SubmitHotExpandTask', + 'summary' => 'Submits a hot-spot scale-out task for a database.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SubmitHotExpandPreCheckTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '76134', + 'abilityTreeNodes' => [ + 'FEATUREdrdsR9AYAV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drd*********', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the PolarDB-X database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'DbInstType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the database. Valid values:'."\n" + ."\n" + .'* RDS'."\n" + .'* PolarDB'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'RDS', + ], + ], + [ + 'name' => 'TableList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => false, + 'example' => 'test', + 'maxItems' => 30, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Msg' => [ + 'description' => 'The result of the task.'."\n", + 'type' => 'string', + 'example' => 'scucess', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'FE104D26-AC19-49B5-AC67-947F69*****', + ], + 'TaskId' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11111', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"scucess\\",\\n \\"RequestId\\": \\"FE104D26-AC19-49B5-AC67-947F69*****\\",\\n \\"TaskId\\": 11111,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"FE104D26-AC19-49B5-AC67-947F69*****\\n97358\\ntrue\\nsuccess","errorExample":""}]', + 'title' => 'SubmitHotExpandPreCheckTask', + 'summary' => 'Submits a precheck task for the hot-spot scale-out of a PolarDB-X database. The task is used to check the table that does not contain the primary key.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSqlFlashbakTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds****c6vxxyzd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'Indicates the ID of the request.'."\n", + 'type' => 'string', + 'example' => '5D64DE59-44A1-E541-E0CB-B7E5C4305162', + ], + 'SqlFlashbackTasks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SqlFlashbackTask' => [ + 'description' => 'Indicates the information about flashback tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => 'Indicates the name of the table that contains the data that are flashed back.'."\n", + 'type' => 'string', + 'example' => 'drds_params', + ], + 'SearchEndTime' => [ + 'description' => 'Indicates the start time of the reverse call.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1568509597000', + ], + 'ExpireTime' => [ + 'description' => 'Indicates the time when the download URL expires.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1569216270000', + ], + 'DownloadUrl' => [ + 'description' => 'Indicates the download URL.'."\n", + 'type' => 'string', + 'example' => 'http://...', + ], + 'RecallProgress' => [ + 'description' => 'Indicates the progress of the reverse call.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'SqlPk' => [ + 'description' => 'Indicates the primary key specified in the SQL statements.'."\n", + 'type' => 'string', + 'example' => 'id', + ], + 'InstId' => [ + 'description' => 'Indicates the ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'drdshbga76p6****', + ], + 'RecallType' => [ + 'description' => 'Indicates the type of the reverse call. Valid values:'."\n" + ."\n" + .'* **0**: exact search'."\n" + .'* **1**: fuzzy search'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SearchStartTime' => [ + 'description' => 'Indicates the end time of the reverse call.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1568609597000', + ], + 'GmtModified' => [ + 'description' => 'Indicates the point in time when the flashback task is performed.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1568611469000', + ], + 'SqlCounter' => [ + 'description' => 'Indicates the number of data rows that are flashed back.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'DbName' => [ + 'description' => 'Indicates the name of the database on which a flashback task is performed.'."\n", + 'type' => 'string', + 'example' => 'drds_flashback', + ], + 'RecallRestoreType' => [ + 'description' => 'Indicates the type of the flashback task. Valid values:'."\n" + ."\n" + .'* **1**: image restoration'."\n" + .'* **2**: reverse restoration'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GmtCreate' => [ + 'description' => 'Indicates the point in time when the instance was created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1568611408000', + ], + 'TraceId' => [ + 'description' => 'Indicates the ID of the trace of the SQL query.'."\n", + 'type' => 'string', + 'example' => 'trace', + ], + 'Id' => [ + 'description' => 'Indicates the ID of the primary key that corresponds to a table used in the flashback task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '238', + ], + 'RecallStatus' => [ + 'description' => 'Indicates the status of the data recall task.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SqlType' => [ + 'description' => 'Indicates the types of the SQL statements.'."\n", + 'type' => 'string', + 'example' => 'Insert,Update,Delete', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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 \\"InstId\\": \\"drdshbga76p6****\\",\\n \\"SqlPk\\": \\"id\\",\\n \\"RecallType\\": 1,\\n \\"GmtModified\\": 1568611469000,\\n \\"SearchStartTime\\": 1568609597000,\\n \\"DbName\\": \\"drds_flashback\\",\\n \\"SqlCounter\\": 0,\\n \\"RecallRestoreType\\": 1,\\n \\"GmtCreate\\": 1568611408000,\\n \\"TraceId\\": \\"trace\\",\\n \\"Id\\": 238,\\n \\"SqlType\\": \\"Insert,Update,Delete\\",\\n \\"RecallStatus\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 1568611469000\\n 1568509597000\\n 1\\n id\\n 1\\n drds_params\\n 1568611408000\\n 1568609597000\\n drdshbga76p6****\\n 1\\n trace\\n Insert,Update,Delete\\n drds_flashback\\n 238\\n 1569216270000\\n 0\\n 10\\n http://...\\n \\n\\n5D64DE59-44A1-E541-E0CB-B7E5C4305162\\ntrue","errorExample":""}]', + 'title' => 'DescribeSqlFlashbakTask', + 'summary' => 'Queries the flashback tasks that are performed on a PolarDB-X 1.0 instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SubmitSqlFlashbackTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of a DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds*********', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the DRDS database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the flashback SQL statement.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2019-09-10 20:23:23', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the SQL flashback task ends.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2019-09-10 23:23:23', + ], + ], + [ + 'name' => 'TraceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Trace ID of the flashback SQL.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ase*****', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the table where the flashback SQL operation was performed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SqlType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the SQL statement. Valid values: INSERT, UPDATE, and DELETE. Separate multiple types with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'INSERT,UPDATE', + ], + ], + [ + 'name' => 'SqlPk', + 'in' => 'query', + 'schema' => [ + 'description' => 'The primary key of flashback SQL.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '11111', + ], + ], + [ + 'name' => 'RecallType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Exact match or fuzzy match. Valid values:'."\n" + ."\n" + .'* 0: the exact match.'."\n" + .'* 1: the fuzzy match.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RecallRestoreType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The restoration type. Valid values:'."\n" + ."\n" + .'* 1: Image restoration'."\n" + .'* 0: reverse recovery'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DSSDF-SEWE-*****', + ], + 'Success' => [ + 'description' => 'Indicates whether the database creation failure records were removed from the DRDS instance.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'TaskId' => [ + 'description' => 'The ID of the replication task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\",\\n \\"Success\\": true,\\n \\"TaskId\\": 1111\\n}","errorExample":""},{"type":"xml","example":"\\n\\tDSSDF-SEWE-*****\\n\\tTrue\\n 1111\\n","errorExample":""}]', + 'title' => 'SubmitSqlFlashbackTask', + 'summary' => 'Call the SubmitSqlFlashbackTask API to submit a flashback SQL task.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateShardTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '75963', + 'abilityTreeNodes' => [ + 'FEATUREdrdsD6TUSC', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the resource group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the DRDS database.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'SourceTableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the source table.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_tb1', + ], + ], + [ + 'name' => 'TargetTableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the destination table.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_tb2', + 'maxLength' => 100, + 'minLength' => 1, + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the task. Valid values:` SHARD_TO_SINGLE `,` SINGLE_TO_SHARD `,` SHARD_TO_SHARD `.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SINGLE_TO_SHARD', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'Task creation result'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F8997D95-94AD-416A-AE70-E24D08******', + ], + 'Success' => [ + 'description' => 'The result of the operation.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"F8997D95-94AD-416A-AE70-E24D08******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"true\\nF8997D95-94AD-416A-AE70-E24D08******\\ntrue","errorExample":""}]', + 'title' => 'CreateShardTask', + 'summary' => 'Call CreateShardTask to create a sharding task.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeInstanceAccounts' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds*********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E2E4056D-57EB-4353-8355-2E6284******', + ], + 'InstanceAccounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceAccount' => [ + 'description' => 'Indicates the information about the instance accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Host' => [ + 'description' => 'Indicates an IP address that is allowed to access the database. The value **%** indicates that each IP address is allowed to access the database. \\'."\n", + 'type' => 'string', + 'example' => '%', + ], + 'Description' => [ + 'description' => 'Indicates the description of an account. By default, if 0 is the value of the AccountType parameter, **Created by DRDS** is returned as the value of the Description parameter. If 1 is the value of the AccountType parameter, an empty string is returned as the value of the Description parameter. You can modify the description of an account on the Accounts page in the PolarDB-X console.', + 'type' => 'string', + 'example' => 'Created by DRDS', + ], + 'AccountType' => [ + 'description' => 'Indicates the type of an instance account. Valid values:'."\n" + ."\n" + .'* **0**: The instance account is a privileged account.'."\n" + .'* **1**: The instance account is a standard account.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AccountName' => [ + 'description' => 'Indicates the username of an instance account.'."\n", + 'type' => 'string', + 'example' => 'test_rds3', + ], + 'DbPrivileges' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DbPrivilege' => [ + 'description' => 'Indicates the information about the permissions of an account on a database.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DbName' => [ + 'description' => 'Indicates the name of a database.'."\n", + 'type' => 'string', + 'example' => 'test_rds3', + ], + 'Privilege' => [ + 'description' => 'Indicates the permissions that an account is granted on the database. Valid values:'."\n" + ."\n" + .'* **R**: The account is granted the permissions that are required to read the data of the database.'."\n" + .'* **W**: The account is granted the permissions that are required to write data to the database.'."\n" + .'* **DDL**: The account is granted the permissions that are required to perform DDL operations on the database.'."\n" + .'* **DML**: The account is granted the permissions that are required to perform DML operations on the database.'."\n", + 'type' => 'string', + 'example' => 'R', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ActionUnauthorized', + 'errorMessage' => 'The specified action is not available for you', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDRDSInstanceId.NotFound', + 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n \\n \\n Created by DRDS\\n \\n \\n drds_flashback\\n ROOT\\n \\n \\n %\\n drds_flashback\\n 0\\n \\n \\n \\n 2D77B55F-50C4-4FC5-A89A-7746B7D5781D\\n true\\n","errorExample":""}]', + 'title' => 'DescribeInstanceAccounts', + 'summary' => 'Queries information about an instance account.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeExpandLogicTableInfoList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '76018', + 'abilityTreeNodes' => [ + 'FEATUREdrdsT4VUG1', + ], + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds_flashback', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0B6B7BDC-575D-4A77-A4F8-24B7EF******', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'data' => [ + 'description' => 'Indicates the result that is returned.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ShardTbKey' => [ + 'description' => 'Indicates the table sharding key.'."\n", + 'type' => 'string', + 'example' => 'address', + ], + 'TableName' => [ + 'description' => 'Indicates the name of the table.'."\n", + 'type' => 'string', + 'example' => 'employee_split2', + ], + 'ShardDbKey' => [ + 'description' => 'Indicates the database sharding key.'."\n", + 'type' => 'string', + 'example' => 'id', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n0B6B7BDC-575D-4A77-A4F8-24B7EF******\\n\\n \\n employee_split2\\n address\\n id\\n \\n\\ntrue\\n","errorExample":""}]', + 'title' => 'DescribeExpandLogicTableInfoList', + 'summary' => 'Queries sharding keys.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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 ID of the region where the PolarDB-X 1.0 instance is created.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds*********', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds_flashback', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'employee_split', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'Indicates the unique ID of the request. If the request fails, provide this ID for technical support to troubleshoot the failure.', + 'type' => 'string', + 'example' => 'B5644ABB-559A-4A1C-83F2-9E7209******', + ], + 'Data' => [ + 'description' => 'Indicates the returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => 'Indicates the details about the table schema.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => 'Indicates the primary key of the table.'."\n", + 'type' => 'string', + 'example' => 'PRI', + ], + 'IsAllowNull' => [ + 'description' => 'Indicates whether the column can be empty.'."\n", + 'type' => 'string', + 'example' => 'NO', + ], + 'ColumnName' => [ + 'description' => 'Indicates the name of a column.'."\n", + 'type' => 'string', + 'example' => 'Id', + ], + 'IsPk' => [ + 'description' => 'Indicates whether the column is the primary key column of the table.'."\n", + 'type' => 'string', + 'example' => 'YES', + ], + 'ColumnType' => [ + 'description' => 'Indicates the type of the column.'."\n", + 'type' => 'string', + 'example' => 'bigint(20)', + ], + 'Extra' => [ + 'description' => 'Extra'."\n", + 'type' => 'string', + 'example' => 'auto_increment', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"B5644ABB-559A-4A1C-83F2-9E7209******\\n\\n \\n Id\\n bigint(20)\\n auto_increment\\n NO\\n YES\\n PRI\\n \\n\\ntrue","errorExample":""}]', + 'title' => 'DescribeTable', + 'summary' => 'Queries information about the schema of a table.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeTableListByType' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '76054', + 'abilityTreeNodes' => [ + 'FEATUREdrdsTIBR6Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drdshbga76p6****', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds_flash****', + ], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => [ + 'description' => 'The field that you specify for your query.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'drdshbga76p61861', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'TableType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of tables. Valid values:'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SINGLE', + 'enum' => [ + 'SINGLE', + 'SHARD', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'Indicates the number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'Indicates the page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'Indicates the unique ID of the request. If the request fails, provide this ID for technical support to troubleshoot the failure.'."\n", + 'type' => 'string', + 'example' => 'B360F47B-59E3-4D1C-BA03-6BFB1C993F88', + ], + 'Total' => [ + 'description' => 'Indicates the total number of returned tables.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'List' => [ + 'description' => 'Indicates the information about tables.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Property' => [ + 'description' => 'Indicates the property of a table.'."\n", + 'type' => 'string', + 'example' => 'single', + ], + 'TableName' => [ + 'description' => 'Indicates the name of the table.'."\n", + 'type' => 'string', + 'example' => 'employee_split', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"10\\nB360F47B-59E3-4D1C-BA03-6BFB1C993F88\\n1\\n1\\n\\n employee_split\\n single\\n\\ntrue","errorExample":""}]', + 'title' => 'DescribeTableListByType', + 'summary' => 'Queries tables based on a table type.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeShardTaskInfo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '76048', + 'abilityTreeNodes' => [ + 'FEATUREdrdsD6TUSC', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds*********', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'jjjjjj_ppppp', + ], + ], + [ + 'name' => 'SourceTableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the table that you want to convert or shard.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a1', + ], + ], + [ + 'name' => 'TargetTableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the table that is generated after you convert or shard the table.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a2', + 'maxLength' => 100, + 'minLength' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'Indicates the unique ID of the request. If the request fails, provide this ID for technical support to troubleshoot the failure.'."\n", + 'type' => 'string', + 'example' => '5D64DE5944A1E541E0CB908A', + ], + 'Data' => [ + 'description' => 'Indicates the data that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Indicates the state of the tasks to shard tables or convert tables.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Stage' => [ + 'description' => 'Indicates the current stage of the task.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'Progress' => [ + 'description' => 'Indicates the incremental data synchronization progress.'."\n", + 'type' => 'string', + 'example' => '70', + ], + 'Expired' => [ + 'description' => 'Indicates the number of remaining days before the tasks to shard tables or convert tables expire.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'TargetTableName' => [ + 'description' => 'Indicates the name of the table after you convert or shard the table.'."\n", + 'type' => 'string', + 'example' => 'a2', + ], + 'SourceTableName' => [ + 'description' => 'Indicates the name of the table that you convert or shard.'."\n", + 'type' => 'string', + 'example' => 'a1', + ], + 'Full' => [ + 'description' => 'Indicates information about full migration tasks.'."\n", + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => 'Indicates the start time when the tasks are performed.'."\n", + 'type' => 'string', + 'example' => '2019-09-16 15:11:53', + ], + 'Progress' => [ + 'description' => 'Indicates the progress of the tasks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Tps' => [ + 'description' => 'Indicates the number of transactions processed by the database per second.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Total' => [ + 'description' => 'Indicates the number of tasks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Expired' => [ + 'description' => 'Indicates the number of remaining days before the tasks expire.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'FullCheck' => [ + 'description' => 'Indicates information about full check tasks.'."\n", + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => 'Indicates the start time when the tasks are performed.'."\n", + 'type' => 'string', + 'example' => '2019-09-16 15:12:53', + ], + 'Progress' => [ + 'description' => 'Indicates the progress of the tasks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Tps' => [ + 'description' => 'Indicates the number of transactions processed by the database per second.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Total' => [ + 'description' => 'Indicates the number of tasks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Expired' => [ + 'description' => 'Indicates the number of remaining days before the tasks expire.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'FullRevise' => [ + 'description' => 'Indicates information about full correction tasks.'."\n", + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => 'Indicates the start time when the tasks are performed.'."\n", + 'type' => 'string', + 'example' => '2019-09-16 15:12:53', + ], + 'Progress' => [ + 'description' => 'Indicates the progress of the tasks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Tps' => [ + 'description' => 'Indicates the number of transactions processed by the database per second.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Total' => [ + 'description' => 'Indicates the number of tasks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Expired' => [ + 'description' => 'Indicates the number of remaining days before the tasks expire.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'Review' => [ + 'description' => 'Indicates check tasks.'."\n", + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => 'Indicates the start time when the tasks are performed.'."\n", + 'type' => 'string', + 'example' => '2019-09-16 15:12:53', + ], + 'Progress' => [ + 'description' => 'Indicates the progress of the tasks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Tps' => [ + 'description' => 'Indicates the number of transactions processed by the database per second.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => 'Indicates the number of tasks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Expired' => [ + 'description' => 'Indicates the number of remaining days before the tasks expire.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'Increment' => [ + 'description' => 'Indicates information about incremental data synchronization.'."\n", + 'type' => 'object', + 'properties' => [ + 'Delay' => [ + 'description' => 'Indicates the latency of the incremental data synchronization.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1568617906', + ], + 'StartTime' => [ + 'description' => 'Indicates the start time when the incremental data synchronization is performed.'."\n", + 'type' => 'string', + 'example' => '2019-09-16 15:12:53', + ], + 'Tps' => [ + 'description' => 'Indicates the number of transactions processed by the database per second.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"5D64DE5944A1E541E0CB908A\\n\\n 增量追平\\n a1\\n 70\\n 2\\n 0\\n a2\\n \\n 100\\n 0\\n 2\\n 2019-09-16 15:11:53\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 2019-09-16 15:12:53\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 2019-09-16 15:12:53\\n 0\\n \\n \\n 0\\n 10\\n 5\\n 2019-09-16 15:12:53\\n 0\\n \\n \\n 10\\n 2019-09-16 15:12:53\\n 1568617906\\n \\n\\ntrue","errorExample":""}]', + 'title' => 'DescribeShardTaskInfo', + 'summary' => 'Queries information about a tool used to perform conversion and sharding.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ValidateShardTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '76153', + 'abilityTreeNodes' => [ + 'FEATUREdrdsTIBR6Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the PolarDB-X 1.0 instance is created.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds23ds****', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'SourceTableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the table or table shard on which you want to perform the task.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'buyer', + ], + ], + [ + 'name' => 'TargetTableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the table or table shard on which you perform the task.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'buyer_new', + 'maxLength' => 100, + 'minLength' => 1, + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the task. Valid values:'."\n" + ."\n" + .'* **SINGLE_TO_SHARD**: converts a single table to a table shard.'."\n" + .'* **SHARD_TO_SINGLE**: converts a table shard to a single table.'."\n" + .'* **SHARD_TO_SHARD**: converts a table shard to another table shard.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SINGLE_TO_SHARD', + 'minLength' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'Indicates the ID of the request.'."\n", + 'type' => 'string', + 'example' => '0B6B7BDC-575D-4A77-A4F8-24B7EFAS45FG', + ], + 'List' => [ + 'description' => 'Indicates the check results.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => 'Indicates the result of the check item. Valid values:'."\n" + ."\n" + .'* **0**: indicates the task is valid.'."\n" + .'* **1**: indicates the task is invalid.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Item' => [ + 'description' => 'Indicates the name of a check item.'."\n", + 'type' => 'string', + 'example' => 'same_schema', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0B6B7BDC-575D-4A77-A4F8-24B7EFAS45FG\\",\\n \\"List\\": [\\n {\\n \\"Result\\": 0,\\n \\"Item\\": \\"same_schema\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0B6B7BDC-575D-4A77-A4F8-24B7EFAS45FG\\n\\n same_schema\\n 0\\n\\ntrue","errorExample":""}]', + 'title' => 'ValidateShardTask', + 'summary' => 'Checks whether a task to convert a table shard or shard a table is valid.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetupBroadcastTables' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '76118', + 'abilityTreeNodes' => [ + 'FEATUREdrds6IJXJ3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the PolarDB-X 1.0 instance resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database for which you want to configure a broadcast table.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Active', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to activate a broadcast table for the database.'."\n", + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => true, + 'example' => 'test', + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'Indicates whether the broadcast table is configured.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"A3140FC7-B78B-4D8E-B0C8-926D28******\\ntrue\\ntrue","errorExample":""}]', + 'title' => 'SetupBroadcastTables', + 'summary' => 'Configures a broadcast table for a database.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBroadcastTables' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '75974', + 'abilityTreeNodes' => [ + 'FEATUREdrdsTIBR6Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content of the query.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'tb1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'Indicates the ID of the request.'."\n", + 'type' => 'string', + 'example' => '86E420ED-43F2-4788-A58C-921849******', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsShard' => [ + 'description' => 'Indicates whether the database is sharded.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'PageNumber' => [ + 'description' => 'Indicates the page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'Indicates the number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'Total' => [ + 'description' => 'Indicates the total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'List' => [ + 'description' => 'Indicates information about broadcast tables.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Indicates the activation state of the broadcast table. Valid values:'."\n" + ."\n" + .'* **1**: The broadcast table is activated.'."\n" + .'* **2**: The broadcast table is being activated.'."\n" + .'* **3**: An exception occurs when the broadcast table is being activated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IsShard' => [ + 'description' => 'Indicates whether the broadcast table was sharded.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Broadcast' => [ + 'description' => 'Indicates whether a table is a broadcast table.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Table' => [ + 'description' => 'Indicates the name of the table.'."\n", + 'type' => 'string', + 'example' => 'nation', + ], + 'DbInstType' => [ + 'description' => 'Indicates the storage type of the database. Valid values:'."\n" + ."\n" + .'* **0**: RDS'."\n" + .'* **4**: PolarDB'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BroadcastType' => [ + 'description' => 'Indicates the type of the broadcast table. Valid values:'."\n" + ."\n" + .'* **1**: multi-write mode'."\n" + .'* **2**: synchronous mode'."\n", + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n true\\n 86E420ED-43F2-4788-A58C-921849******\\n 40\\n 1\\n 2\\n \\n 1\\n 0\\n false\\n nation
\\n true\\n 1\\n \\n true\\n","errorExample":""}]', + 'title' => 'DescribeBroadcastTables', + 'summary' => 'Queries broadcast tables.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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 ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds********', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'Indicates whether the mode of broadcast tables was switched from the multi-write mode to the asynchronous link mode.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DSSDF-SEWE-*****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"DSSDF-SEWE-*****\\ntrue\\ntrue","errorExample":""}]', + 'title' => 'SwitchGlobalBroadcastType', + 'summary' => 'Switches the mode of broadcast tables from the multi-write mode to the asynchronous link mode.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetupTable' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '76121', + 'abilityTreeNodes' => [ + 'FEATUREdrdsTIBR6Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the streaming domain resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database in which the table resides.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'AllowFullTableScan', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable full table scan.'."\n", + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The name of the associated table.'."\n", + ], + 'required' => true, + 'example' => 'test', + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'Specifies whether to use a full table scan.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"A3140FC7-B78B-4D8E-B0C8-926D28******\\ntrue\\ntrue","errorExample":""}]', + 'title' => 'SetupTable', + 'summary' => 'You can call the SetupTable operation to perform a full table scan.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeTables' => [ + 'summary' => 'Queries all tables of a specific database within a PolarDB-X 1.0 instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database whose tables you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query condition. The value of this parameter is the ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of tables returned on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of tables returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The number of returned pages.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '83AC3D7E-461C-4D87-8ACD-6CC295******', + ], + 'Total' => [ + 'description' => 'The total number of returned tables.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'List' => [ + 'description' => 'The list of returned tables.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Indicates whether sharding tasks are performed on the table. Valid values:'."\n" + ."\n" + .'* 0: No sharding task is performed on the table.'."\n" + .'* 1: Sharding tasks are performed on the table.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IsLocked' => [ + 'description' => 'Indicates whether the table is locked.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ShardKey' => [ + 'description' => 'The shard key of the table.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'IsShard' => [ + 'description' => 'Indicates whether the table is sharded.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Broadcast' => [ + 'description' => 'Indicates whether the table is a replicated table.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'AllowFullTableScan' => [ + 'description' => 'Indicates whether full table scanning is allowed.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Table' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'DbInstType' => [ + 'description' => 'The type of the PolarDB-X 1.0 instance. Valid values:'."\n" + ."\n" + .'* 0: The instance is a dedicated instance.'."\n" + .'* 1: The instance is a shard instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n 10\\n 1\\n 83AC3D7E-461C-4D87-8ACD-6CC295******\\n 1\\n true\\n \\n 0\\n false\\n null\\n false\\n false\\n false\\n test
\\n 0\\n \\n","errorExample":""}]', + 'title' => ' DescribeTables', + ], + 'SetupDrdsParams' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '76119', + 'abilityTreeNodes' => [ + 'FEATUREdrds25BO3L', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the PolarDB-X 1.0 instance is located.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance for which you want to configure parameters.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drdsjiii1b49****', + ], + ], + [ + 'name' => 'ParamLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource for which you want to configure parameters. Valid values:'."\n" + ."\n" + .'* **INSTANCE**: Configure parameters for the instance.'."\n" + .'* **DB**: Configure parameters for the databases of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DB', + ], + ], + [ + 'name' => 'Data', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DbName' => [ + 'description' => 'The name of the parameter that you want to configure for a database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_db', + ], + 'ParamType' => [ + 'description' => 'The type of the parameter that you want to configure. Valid values:'."\n" + ."\n" + .'* **ATOM**: the configuration item in the layer-3 data source.'."\n" + .'* **CONFIG**: the configuration item in ConfigServer.'."\n" + .'* **DIAMOND**: the configuration item in Diamond.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ATOM', + ], + 'ParamValue' => [ + 'description' => 'The value of parameter that you want to configure.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + 'ParamVariableName' => [ + 'description' => 'The name of the parameter that you want to configure.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'FORBID_EXECUTE_DML_ALL', + ], + 'ParamRanges' => [ + 'description' => 'The valid values of the parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[true|false]', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The returned results.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n","errorExample":""}]', + 'title' => 'SetupDrdsParams', + 'summary' => 'Configures parameters for a PolarDB-X 1.0 instance.', + ], + 'ListTagResources' => [ + 'summary' => 'Queries the tags of a resource.', + '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 ID of the region in which the resource is located.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type. Set the value to INSTANCE.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'INSTANCE', + 'enum' => [ + 'INSTANCE', + ], + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specify the token that is used to display the returned tags on multiple pages.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6ab4640a-479b-41d0-ad3c-c6e888bc3d8f', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag that you want to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'color', + ], + 'Value' => [ + 'description' => 'The value of the tag that you want to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'red', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dm-hbgau1zp****', + ], + 'required' => false, + 'maxItems' => 51, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The token that is used to display the returned tags on multiple pages.'."\n", + 'type' => 'string', + 'example' => '6ab4640a-479b-41d0-ad3c-c6e888bc3d8f', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '58CE1CB0-F0F4-4BA3-B876-135DC47DF52F', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => 'The list of returned tags.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => 'The resource type. The value of this parameter is fixed to INSTANCE.'."\n", + 'type' => 'string', + 'example' => 'INSTANCE', + ], + 'TagValue' => [ + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'ResourceId' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'example' => 'drdshzsd11****', + ], + 'TagKey' => [ + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.tagKey', + 'errorMessage' => 'Check the parameter tagKey %s', + ], + [ + 'errorCode' => 'InvalidParameter.tagValue', + 'errorMessage' => 'Check the parameter tagValue %s', + ], + [ + 'errorCode' => 'InvalidParameter.tags.exceed', + 'errorMessage' => 'Tags num exceed 10', + ], + [ + 'errorCode' => 'InvalidParameter.instanceId.and.tags', + 'errorMessage' => 'you must have one of Tags and InstanceId', + ], + [ + 'errorCode' => 'InvalidParameter.tags.json.error', + 'errorMessage' => 'The parameter tags is not a JsonArray', + ], + [ + 'errorCode' => 'TagService.%s', + 'errorMessage' => 'TagService return errorMsg: %s', + ], + [ + 'errorCode' => 'TagApi.InvalidParameter.resourceId.exceed', + 'errorMessage' => 'ResourceId num exceed 50', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n 6ab4640a-479b-41d0-ad3c-c6e888bc3d8f\\n 58CE1CB0-F0F4-4BA3-B876-135DC47DF52F\\n true\\n \\n INSTANCE\\n 1\\n drdshzsd11****\\n test\\n \\n","errorExample":""}]', + 'title' => ' ListTagResources', + ], + 'TagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '76147', + 'abilityTreeNodes' => [ + 'FEATUREdrds25BO3L', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the resource is located.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type. Set the value to INSTANCE.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'INSTANCE', + 'enum' => [ + 'INSTANCE', + ], + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag that you want to add.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'color', + ], + 'Value' => [ + 'description' => 'The value of the tag that you want to add.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'red', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dm-hbgau1zp****', + ], + 'required' => true, + 'maxItems' => 51, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'FE5D94E3-3C93-3594-95D9-AAED2A980915', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.tagKey', + 'errorMessage' => 'Check the parameter tagKey %s', + ], + [ + 'errorCode' => 'InvalidParameter.tagValue', + 'errorMessage' => 'Check the parameter tagValue %s', + ], + [ + 'errorCode' => 'InvalidParameter.tags.exceed', + 'errorMessage' => 'Tags num exceed 10', + ], + [ + 'errorCode' => 'InvalidParameter.tags.notFound', + 'errorMessage' => 'Tags connot be empty', + ], + [ + 'errorCode' => 'TagService.%s', + 'errorMessage' => 'TagService return errorMsg: %s', + ], + [ + 'errorCode' => 'TagApi.InvalidParameter.resourceId.exceed', + 'errorMessage' => 'ResourceId num exceed 50', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"FE5D94E3-3C93-3594-95D9-AAED2A980915\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n FE5D94E3-3C93-3594-95D9-AAED2A980915\\n","errorExample":""}]', + 'title' => ' TagResources', + 'summary' => 'Adds tags to a resource.', + ], + '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 of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Set the value to INSTANCE.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'INSTANCE', + 'enum' => [ + 'INSTANCE', + ], + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to delete all tags of the resource.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The ID of the resource.'."\n", + ], + 'required' => true, + 'example' => 'drds********', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The key of the tag.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'N specifies the serial number of the tag. For example,'."\n" + ."\n" + .'* Tag.1.Key represents the key of the first tag passed in.'."\n" + .'* Tag.2.Key indicates the key of the second tag.'."\n", + ], + 'required' => false, + 'example' => 'color', + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the database creation failure records were removed from the DRDS instance.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DSSDF-SEWE-*****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.tagKey', + 'errorMessage' => 'Check the parameter tagKey %s', + ], + [ + 'errorCode' => 'InvalidParameter.tagValue', + 'errorMessage' => 'Check the parameter tagValue %s', + ], + [ + 'errorCode' => 'InvalidParameter.tags.exceed', + 'errorMessage' => 'Tags num exceed 10', + ], + [ + 'errorCode' => 'InvalidParameter.tags.notFound', + 'errorMessage' => 'Tags connot be empty', + ], + [ + 'errorCode' => 'InvalidParameter.tags.json.error', + 'errorMessage' => 'Thr parameter tags is not a JsonArray', + ], + [ + 'errorCode' => 'TagService.%s', + 'errorMessage' => 'TagService return errorMsg: %s', + ], + [ + 'errorCode' => 'TagApi.InvalidParameter.resourceId.exceed', + 'errorMessage' => 'ResourceId num exceed 50', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\"\\n}","errorExample":""},{"type":"xml","example":"DSSDF-SEWE-*****\\ntrue","errorExample":""}]', + 'title' => 'UntagResources', + 'summary' => 'You can call this operation to untag resources.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDrdsInstanceVersion' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance whose version you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drdshbga1138****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2F7F8080-9132-4279-85D0-B7E5C4305162', + ], + 'Data' => [ + 'description' => 'The details about the instance version.'."\n", + 'type' => 'object', + 'properties' => [ + 'NewestVersion' => [ + 'description' => 'The latest version of the instance.'."\n", + 'type' => 'string', + 'example' => '5.4.12-16315258', + ], + 'InstanceVersion' => [ + 'description' => 'The current version of the instance.'."\n", + 'type' => 'string', + 'example' => '5.3.12-15682777', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ActionUnauthorized', + 'errorMessage' => 'The specified action is not available for you', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDRDSInstanceId.NotFound', + 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n true\\n 2F7F8080-9132-4279-85D0-B7E5C4305162\\n \\n 5.4.12-16315258\\n 5.3.12-15682777\\n \\n","errorExample":""}]', + 'title' => 'DescribeDrdsInstanceVersion', + 'summary' => 'Queries the version of a specific PolarDB-X 1.0 instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDrdsInstanceLevelTasks' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance of which the unfinished tasks you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drdssen12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2F7F8080-9132-4279-85D0-B7E5C4305162', + ], + 'Tasks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Task' => [ + 'description' => 'The list of returned unfinished tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskType' => [ + 'description' => 'The type of the task.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'TaskPhase' => [ + 'description' => 'The phase of the task.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Progress' => [ + 'description' => 'The progress of the task. Valid values: 0 to 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '99', + ], + 'AllowCancel' => [ + 'description' => 'Indicates whether the task can be canceled.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'TaskStatus' => [ + 'description' => 'The state of the task. Valid values:'."\n" + ."\n" + .'* 0: The task is being executed.'."\n" + .'* 1: The task is executed.'."\n" + .'* 2: The task failed to be executed.'."\n" + .'* 3: The task is canceled.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ShowProgress' => [ + 'description' => 'Indicates whether the progress of the task is displayed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'TaskName' => [ + 'description' => 'The name of the task.'."\n", + 'type' => 'string', + 'example' => 'upgrade_instance', + ], + 'ProgressDescription' => [ + 'description' => 'The description of the task progress.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'GmtCreate' => [ + 'description' => 'The timestamp when the task is created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1568705520000', + ], + 'TargetId' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12312', + ], + 'ErrMsg' => [ + 'description' => 'The error message returned for the task.'."\n", + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n true\\n 2F7F8080-9132-4279-85D0-B7E5C4305162\\n \\n 11\\n 1\\n 99\\n false\\n 0\\n true\\n upgrade_instance\\n 正在执行\\n 1568705520000\\n 12312\\n 实例状态异常\\n \\n","errorExample":""}]', + 'title' => 'DescribeDrdsInstanceLevelTasks', + 'summary' => 'Queries the unfinished tasks of PolarDB-X 1.0 instances.', + ], + 'UpgradeInstanceVersion' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance that you want to upgrade.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drdshbgaen89****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'Rpm', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version number of the PolarDB-X 1.0 instance. You can leave this parameter unspecified.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 't-drds-server-5.4.12-16348095.noarch.rpm', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2F7F8080-9132-4279-85D0-B7E5C4305162', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error. 默认错误码', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"success\\",\\n \\"RequestId\\": \\"2F7F8080-9132-4279-85D0-B7E5C4305162\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 2F7F8080-9132-4279-85D0-B7E5C4305162\\n","errorExample":""}]', + 'title' => 'UpgradeInstanceVersion', + 'summary' => 'Upgrades the version of a PolarDB-X 1.0 instance.', + ], + 'DescribeDrdsInstanceMonitor' => [ + 'summary' => 'Queries the details of the monitoring data of a specified instance.', + '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 ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds*********', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => 'The performance monitoring metrics. You can specify one or more metrics. Separate multiple metric names with commas (,).'."\n" + ."\n" + .'> For more information about performance monitoring metrics, see [Monitor instances](~~186703~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpu', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the query. Specify the value in the UNIX timestamp format. The timestamp must be in UTC. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1603123290000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the query. Specify the value in the UNIX timestamp format. The timestamp must be in UTC. Unit: ms.'."\n" + ."\n" + .'> If the time range that you specify is less than 1 hour, the monitoring data that is collected in a 1-hour period before the end time is returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1603209690000', + ], + ], + [ + 'name' => 'PeriodMultiple', + 'in' => 'query', + 'schema' => [ + 'description' => 'The multiple of the default time interval that you want to use to collect monitoring data. By default, the system collects monitoring data of resources at an interval of 1 minute. If you set the value of this parameter to 2, the system collects monitoring data of the instance at an interval of 2 minutes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '0', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the instance is deployed.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2F7F8080-9132-4279-85D0-B7E5C4', + ], + 'Data' => [ + 'description' => 'The result set of the query.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The name of the metric.'."\n", + 'type' => 'string', + 'example' => 'cpu', + ], + 'Unit' => [ + 'description' => 'The unit of the metric value.'."\n", + 'type' => 'string', + 'example' => '%', + ], + 'NodeNum' => [ + 'description' => 'The number of nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Values' => [ + 'description' => 'The details of the monitoring data of the metric.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Date' => [ + 'description' => 'The point in time when the value of the metric was collected. The value is in the UNIX timestamp format. The timestamp is displayed in UTC. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1603163400000', + ], + 'Value' => [ + 'description' => 'The value of the metric.'."\n", + 'type' => 'string', + 'example' => '1.40', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ActionUnauthorized', + 'errorMessage' => 'The specified action is not available for you', + ], + [ + 'errorCode' => 'InvalidParameter.Mismatch', + 'errorMessage' => 'Invalid parameter of key', + ], + [ + 'errorCode' => 'InvalidParameter.time', + 'errorMessage' => 'The startTime and endTime must in one week', + ], + [ + 'errorCode' => 'InvalidParameter.periodMultiple', + 'errorMessage' => 'The periodMultiple is too larger than the time between startTime and endTime', + ], + [ + 'errorCode' => 'DrdsInstance.NotExists', + 'errorMessage' => 'The drds instance does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'invalid parameter.', + ], + ], + 404 => [ + [ + 'errorCode' => 'Monitor.QueryRdsFailure', + 'errorMessage' => 'Failed to query RDS monitor info.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"2F7F8080-9132-4279-85D0-B7E5C4\\n\\n 1\\n %\\n cpu\\n \\n 1.40\\n 1603163400000\\n \\n","errorExample":""}]', + 'title' => 'DescribeDrdsInstanceMonitor', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDrdsInstanceDbMonitor' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Distributed Relational Database Service (DRDS) instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds*************', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds_test', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => 'The performance monitoring metrics. You can specify one or more metrics for a query at a time. Separate multiple metric parameters with commas (,).'."\n" + ."\n" + .'> For more information about the details of performance monitoring metrics, see [Database monitoring](~~186704~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'qps', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time. Specify the time in the UNIX timestamp format. The time must be in UTC. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1603162800000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time. Specify the time in the UNIX timestamp format. The time must be in UTC. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1603166400000', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2F7F8080-9132-4279-85D0-B7E5C4******', + ], + 'Data' => [ + 'description' => 'The list of monitoring data.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The name of the monitoring metric.'."\n", + 'type' => 'string', + 'example' => 'qps', + ], + 'Unit' => [ + 'description' => 'The unit of the monitoring metric.'."\n", + 'type' => 'string', + 'example' => 'qps', + ], + 'Values' => [ + 'description' => 'The details about the value of monitoring data.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Date' => [ + 'description' => 'The time point when the value of monitoring data was obtained. The value is in the UNIX timestamp format. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1603162805000', + ], + 'Value' => [ + 'description' => 'The data value.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ActionUnauthorized', + 'errorMessage' => 'The specified action is not available for you', + ], + [ + 'errorCode' => 'InvalidParameter.Mismatch', + 'errorMessage' => 'Invalid parameter of key', + ], + [ + 'errorCode' => 'InvalidParameter.time', + 'errorMessage' => 'The startTime and endTime must in one week', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDbName.NotFound', + 'errorMessage' => 'The DrdsInstanceId or DbName provided does not exist in our records.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n01685B03-4099-414F-B9E1-DB994947CA8E\\n\\n \\n 0\\n 1602234005000\\n \\n qps\\n qps\\n\\ntrue\\n","errorExample":""}]', + 'title' => 'DescribeDrdsInstanceDbMonitor', + 'summary' => 'Queries the performance monitoring data of a specified database.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ChangeAccountPassword' => [ + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds********', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the member account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new password.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DSSDF-SEWE-*****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ActionUnauthorized', + 'errorMessage' => 'The specified action is not available for you', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDRDSInstanceId.NotFound', + 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\"\\n}","errorExample":""},{"type":"xml","example":"DSSDF-SEWE-*****\\ntrue","errorExample":""}]', + 'title' => 'ChangeAccountPassword', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ChangeInstanceAzone' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '75934', + 'abilityTreeNodes' => [ + 'FEATUREdrds25BO3L', + ], + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drdsjiii1b49****', + ], + ], + [ + 'name' => 'OriginAzoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source zone of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou-B', + ], + ], + [ + 'name' => 'TargetAzoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination zone to which you want to modify'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou-A', + ], + ], + [ + 'name' => 'DrdsRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ChangeVSwitch', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'NewVSwitch', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2F7F8080-9132-4279-85D0-B7E5C4305162', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ERR_INSTANCE_NOT_RUNNING_STATUS', + 'errorMessage' => 'The instance status is not running', + ], + [ + 'errorCode' => 'ERR_OTHER_MULTI_AZONE_SWITCH', + 'errorMessage' => 'Change to multiple azone should have even number of nodes', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"2F7F8080-9132-4279-85D0-B7E5C4305162\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 2F7F8080-9132-4279-85D0-B7E5C4305162\\n","errorExample":""}]', + 'title' => 'ChangeInstanceAzone', + 'summary' => 'Changes the zone of a PolarDB-X 1.0 instance.', + ], + 'DescribeBackupLocal' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'FDC9CFD5-306D-4A23-9D8C-057274C6****', + ], + 'BackupPolicyDO' => [ + 'description' => 'The information about the backup policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'BackupDbName' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'LogBackupRetentionPeriod' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'DataBackupRetentionPeriod' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'BackupType' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'BackupLevel' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'LocalLogRetentionHours' => [ + 'description' => 'The number of hours for which log backup files are retained on the instance. Valid values: 0 to 168. Default value: **18**. The value **0** indicates that log backup files are not retained.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '18', + ], + 'HighSpaceUsageProtection' => [ + 'description' => 'Indicates whether the feature is enabled to forcibly delete binary log files if the used storage space of the instance exceeds 90% of the total storage space or the remaining storage space is less than 5 GB. Valid values:'."\n" + ."\n" + .'* 1: The feature is enabled.'."\n" + .'* 0: The feature is disabled.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'GmtModified' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'BackupRetentionPeriod' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'BackupPolicyMode' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'PreferredBackupPeriod' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'LocalLogRetentionSpace' => [ + 'description' => 'The maximum storage usage that is allowed for local log files. Valid values: 0 to 50. Default value: 30.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'BackupAppName' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'PreferredBackupTime' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'GmtCreate' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'BackupMode' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'BackupLog' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'NextBackupActuallyTime' => [ + 'description' => 'No value is returned.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n\\tFDC9CFD5-306D-4A23-9D8C-057274C6****\\n\\ttrue\\n\\t\\n\\t\\t18\\n\\t\\t30\\n\\t\\t1\\n\\t\\n","errorExample":""}]', + 'title' => 'DescribeBackupLocal', + 'summary' => 'Queries the backup settings of local logs.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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" + ."\n" + .'> You can call the [DescribeDrdsInstances](~~139284~~) operation to query the information about instances in the specified account, such as the IDs of the instances.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds*************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '123DB16B-02F2-45F7-A571-843991******', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'DbInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DbInstance' => [ + 'description' => 'The information about the custom ApsaraDB RDS for MySQL instances at the storage layer.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBInstanceCPU' => [ + 'description' => 'The number of CPU cores of the custom ApsaraDB RDS for MySQL instance at the storage layer.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'DBInstanceMemory' => [ + 'description' => 'The memory size of the custom ApsaraDB RDS for MySQL instance at the storage layer. Unit: MB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8192', + ], + 'PayType' => [ + 'description' => 'The billing method of the custom ApsaraDB RDS for MySQL instance at the storage layer. Valid values:'."\n" + ."\n" + .'* Postpaid: pay-as-you-go'."\n" + .'* Prepaid: subscription'."\n", + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'DBInstanceStatus' => [ + 'description' => 'The status of the custom ApsaraDB RDS for MySQL instance at the storage layer. Valid values:'."\n" + ."\n" + .'* 0: The instance is being created.'."\n" + .'* 1: The instance is running.'."\n" + .'* 3: The instance is being deleted.'."\n" + .'* 5: The instance is being restarted.'."\n" + .'* 6: The instance is being upgraded or downgraded.'."\n" + .'* 7: The instance is being backed up.'."\n" + .'* 8: The network type of the instance is being changed.'."\n" + .'* 9: The instance is being migrated.'."\n" + .'* 11: The data stored on the instance is being migrated.'."\n" + .'* 12: A disaster recovery instance is being generated.'."\n" + .'* 13: Data is being imported to the instance.'."\n" + .'* 14: Data is being imported from another RDS instance to the instance.'."\n" + .'* 15: A switchover is being performed.'."\n" + .'* 16: A temporary instance is being created.'."\n" + .'* 17: The network of the instance is being created.'."\n" + .'* 18: The instance is being cloned.'."\n" + .'* 19: The link is being changed.'."\n" + .'* 20: The read-only RDS instances of the instance are being migrated.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'NetworkType' => [ + 'description' => 'The network type of the custom ApsaraDB RDS for MySQL instance at the storage layer. The value is VPC.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'Port' => [ + 'description' => 'The port used to connect to the instance over an internal network.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3306', + ], + 'EngineVersion' => [ + 'description' => 'The engine version of the custom ApsaraDB RDS for MySQL instance at the storage layer. The value is 8.0.'."\n", + 'type' => 'string', + 'example' => '8.0', + ], + 'DmInstanceId' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'example' => 'dm-*************', + ], + 'DBInstanceStorage' => [ + 'description' => 'The storage space of the custom ApsaraDB RDS for MySQL instance at the storage layer. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'ConnectUrl' => [ + 'description' => 'The internal endpoint of the custom ApsaraDB RDS for MySQL instance at the storage layer.'."\n", + 'type' => 'string', + 'example' => 'rm-***************.mysql.rds.aliyuncs.com', + ], + 'ReadWeight' => [ + 'description' => 'The read and write weights of the custom ApsaraDB RDS for MySQL instance at the storage layer.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RdsInstType' => [ + 'description' => 'The type of the custom ApsaraDB RDS for MySQL instance at the storage layer. Valid values:'."\n" + ."\n" + .'* Primary: primary instance'."\n" + .'* Readonly: read-only instance'."\n", + 'type' => 'string', + 'example' => 'Primary', + ], + 'DBInstanceClassType' => [ + 'description' => 'The instance family of the custom ApsaraDB RDS for MySQL instance at the storage layer. Valid values:'."\n" + ."\n" + .'* **x**: general-purpose instance family'."\n" + .'* **d**: dedicated instance family'."\n" + .'* **h**: dedicated host instance family'."\n", + 'type' => 'string', + 'example' => 'x', + ], + 'DBInstanceId' => [ + 'description' => 'The ID of the custom ApsaraDB RDS for MySQL instance at the storage layer.'."\n", + 'type' => 'string', + 'example' => 'rm-*****************', + ], + 'Engine' => [ + 'description' => 'The engine type of the custom ApsaraDB RDS for MySQL instance at the storage layer. The value is MySQL.'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'DbInstType' => [ + 'description' => 'The type of the instance at the storage layer. The value is RDS.'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + 'LockMode' => [ + 'description' => 'The lock mode of the RDS instance. Valid values:'."\n" + ."\n" + .'0: The instance is not locked.'."\n" + ."\n" + .'1: The instance is manually locked.'."\n" + ."\n" + .'2: The instance is automatically locked if the instance expires.'."\n" + ."\n" + .'3: The instance is automatically locked if the instance is rolled back.'."\n" + ."\n" + .'4: The instance is automatically locked if the storage space of the instance reaches the upper limit.'."\n" + ."\n" + .'5: The instance is automatically locked if the storage space of the read-only instances reaches the upper limit.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LockReason' => [ + 'description' => 'The reason why the RDS instance is locked.'."\n", + 'type' => 'string', + 'example' => 'Manually Locked'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"123DB16B-02F2-45F7-A571-843991******\\n\\n \\n RDS\\n 8192\\n 8\\n 6\\n 3306\\n PostPaid\\n 4\\n x\\n rm-************.mysql.rds.aliyuncs.com\\n 0\\n rm-************\\n VPC\\n 20\\n Primary\\n dm-************\\n MySQL\\n \\n\\ntrue","errorExample":""}]', + 'title' => 'DescribeDrdsRdsInstances', + 'summary' => 'Queries the information about all custom ApsaraDB RDS for MySQL instances in a PolarDB-X instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRecycleBinStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database that is created in the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the table recycle bin. Valid values:'."\n" + ."\n" + .'* disable: The table recycle bin is enabled.'."\n" + .'* enable: The table recycle bin is disabled.'."\n", + 'type' => 'string', + 'example' => 'disable', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'ACB5258F-25AF-4D7C-8FAA-B6FE60******', + ], + 'Success' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"disable\\",\\n \\"RequestId\\": \\"ACB5258F-25AF-4D7C-8FAA-B6FE60******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"enable\\nACB5258F-25AF-4D7C-8FAA-B6FE60******\\ntrue","errorExample":""}]', + 'title' => 'DescribeRecycleBinStatus', + 'summary' => 'Queries the status of the table recycle bin.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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 ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds***********', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5D64DE5944A1E541E0CB908A', + ], + 'Data' => [ + 'description' => 'The data object returned.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OriginalTableName' => [ + 'description' => 'The original name of the table.'."\n", + 'type' => 'string', + 'example' => 'BIN_T4AG3CY5WWXPKHITCHJY', + ], + 'TableName' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'CreateTime' => [ + 'description' => 'The time when the table was created.'."\n", + 'type' => 'string', + 'example' => '2019-09-16 14:42:06', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"EC985705-2D6B-4B84-9732-BF8F5D******\\n\\n BIN_T4AG3CY5WWXPKHITCHJY\\n test\\n 2019-09-16 14:42:06\\n\\ntrue","errorExample":""}]', + 'title' => 'DescribeRecycleBinTables', + 'summary' => 'Queries the tables that can be restored in the recycle bin.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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 ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the instance resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7E9F7F16-05B5-42DA-94D6-E36402******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error. 默认错误码', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"7E9F7F16-05B5-42DA-94D6-E36402******\\"\\n}","errorExample":""},{"type":"xml","example":"7E9F7F16-05B5-42DA-94D6-E36402******\\ntrue","errorExample":""}]', + 'title' => 'EnableInstanceIpv6Address', + 'summary' => 'Creates an IPv6 address.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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 ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the table belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database to which the table belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the logical table to be restored.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'Indicates whether the deleted logical table is restored.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '463A5F0F-12AD-4544-A902-B2B983******', + ], + 'Success' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"463A5F0F-12AD-4544-A902-B2B983******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"true\\n463A5F0F-12AD-4544-A902-B2B983******\\ntrue","errorExample":""}]', + 'title' => 'FlashbackRecycleBinTable', + 'summary' => 'Restores a logical table that is deleted.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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 ID of the DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drdshbga948vbpd2', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the DRDS database.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testDb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the call was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '82FD0D9B-9A65-40D3-B1D9-8851B1D4AF75', + ], + 'Data' => [ + 'description' => 'The structure information about the storage instances of the DRDS database. Each entry corresponds to a primary storage instance.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RdsInstanceId' => [ + 'description' => 'The ID of the storage instance.'."\n", + 'type' => 'string', + 'example' => 'rm-bp16ad920ndxxxx02', + ], + 'UsedInstanceType' => [ + 'description' => 'The type of the storage instance that is in use.'."\n", + 'type' => 'string', + 'example' => 'RDS', + ], + 'UsedInstanceId' => [ + 'description' => 'The ID of the storage instance that is in use. If the specified instance in the request is a primary DRDS instance, the value of this parameter is the ID of the primary storage instance. If the specified instance in the request is a read-only DRDS instance, the value of this parameter is the ID of the secondary storage instance.'."\n", + 'type' => 'string', + 'example' => 'rm-bp1l8xi1dd9xxxxbj', + ], + 'ReadOnlyInstanceInfo' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[]', + ], + 'description' => 'The IDs of the read-only storage instances.'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"82FD0D9B-9A65-40D3-B1D9-8851B1D4AF75\\n\\n rm-bp1l8xi1dd9xxxxbj\\n RDS\\n rm-bp16ad920ndxxxx02\\n []\\n\\ntrue","errorExample":""}]', + 'title' => 'GetDrdsDbRdsRelationInfo', + 'summary' => 'Queries the structure of storage instances for a Distributed Relational Database Service (DRDS) database.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ManagePrivateRds' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the PolarDB-X 1.0 instance resides.'."\n" + ."\n" + .'> You can call the [DescribeDrdsInstances](~~139284~~) operation to query the details of all PolarDB-X 1.0 instances within an Alibaba Cloud account, including the IDs of regions in which the instances reside.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hanzhou', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n" + ."\n" + .'> You can call the [DescribeDrdsInstances](~~139284~~) operation to query the details of all PolarDB-X 1.0 instances within an Alibaba Cloud account, including the IDs of the instances.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds*************', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the custom ApsaraDB RDS instance at the storage layer.'."\n" + ."\n" + .'> You can call the [DescribeDrdsRdsInstances](~~215526~~) operation to query the details of all ApsaraDB RDS instances, including the ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-***************', + ], + ], + [ + 'name' => 'RdsAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operation that you want to perform on the custom ApsaraDB RDS instance. Valid values:'."\n" + ."\n" + .'* **DescribeDBInstanceAttribute**: queries the details of the custom ApsaraDB RDS instance.'."\n" + .'* **DescribeAvailableClasses**: queries the specifications that are supported for a custom ApsaraDB RDS instance. The specifications include the instance type and the storage capacity.'."\n" + .'* **DescribeSQLCollectorPolicy**: queries whether the SQL Explorer (SQL Audit) feature is enabled for custom ApsaraDB RDS instance.'."\n" + .'* **ModifySQLCollectorPolicy**: enables or disables the SQL Explorer (SQL Audit) feature for the custom ApsaraDB RDS instance.'."\n" + .'* **DescribeParameters**: queries the parameter settings of the custom ApsaraDB RDS instance.'."\n" + .'* **ModifyParameter**: modifies the parameters of the custom ApsaraDB RDS instance.'."\n" + .'* **DescribeDBInstanceHAConfig**: queries the high availability mode and data replication mode of the custom ApsaraDB RDS instance.'."\n" + .'* **SwitchDBInstanceHA**: switches workloads between the primary and secondary custom ApsaraDB RDS instances.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SwitchDBInstanceHA', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => 'The JSON string that consists of request parameters and the values of the request parameters of an operation that you need to call for the custom ApsaraDB RDS instance. The value of a request parameter is of the STRING type. Example: `{NodeId:"1797****"}`.'."\n" + ."\n" + .'For more information about the request parameters and valid values of the request parameters of each operation, see the request parameter sections in the following topics:'."\n" + ."\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" + .'> Among the required request parameters of the preceding operations, you do not need to specify the `Action` and `DBInstanceId` parameters. You must specify all the other required request parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{NodeId:"1797****"}', + 'default' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The parameter result set returned for the operation that is called for the custom ApsaraDB RDS instance.'."\n", + 'type' => 'string', + 'example' => '{"requestId":"E63C810A-4A13-47B6-BA67-C0E23A******"}', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0237BCD2-2C7A-4F86-A766-657AF6******', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'RDSAPI.ERROR', + 'errorMessage' => 'Failed to call the RDS API operation.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"{\\\\\\"requestId\\\\\\":\\\\\\"E63C810A-4A13-47B6-BA67-C0E23A******\\\\\\"}\\",\\n \\"RequestId\\": \\"0237BCD2-2C7A-4F86-A766-657AF6******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"0237BCD2-2C7A-4F86-A766-657AF6******\\n{\\"requestId\\":\\"E63C810A-4A13-47B6-BA67-C0E23A******\\"}\\ntrue","errorExample":""}]', + 'title' => 'ManagePrivateRds', + 'summary' => 'Manages a custom ApsaraDB RDS instance at the storage layer.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAccountDescription' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraDB RDS for PostgreSQL instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the member account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was sent successfully or not.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2F93CCD5-806F-4470-BBC7-20476A******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationFailed.ModifyAccountDescription', + 'errorMessage' => 'Modify account description failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"2F93CCD5-806F-4470-BBC7-20476A******\\"\\n}","errorExample":""},{"type":"xml","example":"2F93CCD5-806F-4470-BBC7-20476A******\\ntrue","errorExample":""}]', + 'title' => 'ModifyAccountDescription', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAccountPrivilege' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drdshbgaen89****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username of the account that you want to modify.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'account_sec', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the PolarDB-X 1.0 instance is located.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DbPrivilege', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DbName' => [ + 'description' => 'The name of the database that you want to manage by using the account to modify.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test123', + ], + 'Privilege' => [ + 'description' => 'The permissions that you want to grant to the account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ReadWrite', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationFailed.ModifyAccountPrivilege', + 'errorMessage' => 'Modify account privilege failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"73559800-3c8c-11ec-bd40-99cfcff3fe1e\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 73559800-3c8c-11ec-bd40-99cfcff3fe1e\\n","errorExample":""}]', + 'title' => 'ModifyAccountPrivilege', + 'summary' => 'Modifies the permissions that are granted to an account.', + ], + 'ModifyPolarDbReadWeight' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of a DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'DbNodeIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The node list in the destination apsaradb for PolarDB cluster. The nodes in each cluster are separated with commas (,) and colons (:).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pi-****************,pi-****************:pi-****************', + ], + ], + [ + 'name' => 'DbInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Polar cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'Weights', + 'in' => 'query', + 'schema' => [ + 'description' => 'The weight of the PolarDB cluster. Separate multiple weights with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '14,86', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the database creation failure records were removed from the PolarDB-X instance.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B12FC174-D5CE-4A6E-83C1-0F8F86******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.InvalidDbName', + 'errorMessage' => 'The dbName does not exist in this drds instance', + ], + [ + 'errorCode' => 'InvalidParameter.ReadWeighAndRdsNotMapping', + 'errorMessage' => 'The parameter read weight and rds instance not mapping', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidReadWeight', + 'errorMessage' => 'The parameter read weight is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B12FC174-D5CE-4A6E-83C1-0F8F86******\\"\\n}","errorExample":""},{"type":"xml","example":"B12FC174-D5CE-4A6E-83C1-0F8F86******\\ntrue","errorExample":""}]', + 'title' => 'ModifyPolarDbReadWeight', + 'summary' => 'You can call this operation ModifyPolarDbReadWeight to modify read/write weights of a specified PolarDB cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the DRDS database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B12FC174-D5CE-4A6E-83C1-0F8F86******', + ], + 'Result' => [ + 'description' => 'Indicates whether the connection after refresh was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B12FC174-D5CE-4A6E-83C1-0F8F86******\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"B12FC174-D5CE-4A6E-83C1-0F8F86******\\ntrue","errorExample":""}]', + 'title' => 'RefreshDrdsAtomUrl', + 'summary' => 'After the connection to the RDS instance is changed, you can call the RefreshDrdsAtomUrl to refresh the connections between DRDS and apsaradb for RDS instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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 ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the logical table.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'Indicates whether the table in the recycle bin is deleted.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', + ], + 'Success' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"A3140FC7-B78B-4D8E-B0C8-926D28******\\ntrue\\ntrue","errorExample":""}]', + 'title' => 'RemoveRecycleBinTable', + 'summary' => 'Deletes a table in the recycle bin.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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 ID of a DRDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', + ], + 'Success' => [ + 'description' => 'Indicates whether the database creation failure records were removed from the PolarDB-X instance.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'TaskId' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\",\\n \\"Success\\": true,\\n \\"TaskId\\": 1\\n}","errorExample":""},{"type":"xml","example":"A3140FC7-B78B-4D8E-B0C8-926D28******\\ntrue\\n1","errorExample":""}]', + 'title' => 'RestartDrdsInstance', + 'summary' => 'Call the RestartDrdsInstance operation to restart the instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'Indicates whether the instance version was rolled back.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DSSDF-SEWE-*****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error. 默认错误码', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"DSSDF-SEWE-*****\\"\\n}","errorExample":""},{"type":"xml","example":"\\nDSSDF-SEWE-*****\\ntrue\\n","errorExample":""}]', + 'title' => 'RollbackInstanceVersion', + 'summary' => 'Rolls back the version of a specified instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetBackupLocal' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drdshbgag23d13fds', + ], + ], + [ + 'name' => 'LocalLogRetentionHours', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of hours for which log backup files are retained on the instance. Valid values: 0 to 168. Default value: 18. A value of 0 indicates that log backup files are not retained.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12', + ], + ], + [ + 'name' => 'LocalLogRetentionSpace', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum storage space usage that is allowed for log files on the instance. Valid values: 0 to 50. Default value: 30.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'HighSpaceUsageProtection', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the feature to forcibly delete binary log files if the used storage space reaches 90% of the total storage space or the remaining storage space is less than 5 GB. Valid values: 1 and 0. A value of 1 specifies to enable this feature. A value of 0 specifies not to enable this feature.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6F70CE62-5077-4B7B-95BC-4DAC45614DBE', + ], + 'Result' => [ + 'description' => 'The result returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F70CE62-5077-4B7B-95BC-4DAC45614DBE\\",\\n \\"Result\\": \\"success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n\\t A3140FC7-B78B-4D8E-B0C8-926D28669934\\n\\t true\\n\\t success\\n","errorExample":""}]', + 'title' => 'SetBackupLocal', + 'summary' => 'Modifies a backup policy.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetupRecycleBinStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds************', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'StatusAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the status of the table recycle bin. Valid values:'."\n" + ."\n" + .'* enable: The table recycle bin is enabled.'."\n" + .'* disable: The table recycle bin is disabled.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'enable', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'Indicates whether the table recycle bin is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A3140FC7-B78B-4D8E-B0C8-926D28******', + ], + 'Success' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A3140FC7-B78B-4D8E-B0C8-926D28******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"A3140FC7-B78B-4D8E-B0C8-926D28******\\ntrue\\ntrue","errorExample":""}]', + 'title' => 'SetupRecycleBinStatus', + 'summary' => 'Enables the table recycle bin for a database.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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 PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'drds823s4esd', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the PolarDB-X 1.0 database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Msg' => [ + 'description' => 'Indicates whether the precheck task was submitted.'."\n", + 'type' => 'string', + 'example' => 'scucess', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DSSDF-SEWE-23ERW', + ], + 'TaskId' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2321', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"scucess\\",\\n \\"RequestId\\": \\"DSSDF-SEWE-23ERW\\",\\n \\"TaskId\\": 2321,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n FE104D26-AC19-49B5-AC67-947F6915E07E\\n true\\n 97358\\n","errorExample":""}]', + 'title' => 'SubmitSmoothExpandPreCheckTask', + 'summary' => 'Submits a precheck task for the smooth scale-out of a PolarDB-X 1.0 database.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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 new instance type of the custom ApsaraDB RDS instance at the storage layer.'."\n" + ."\n" + .'> You can call the [DescribeAvailableClasses](~~196546~~) operation to view the specifications that are supported for a custom ApsaraDB RDS instance. The specifications include the instance type and the storage capacity.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'rds.mysql.c1.xlarge', + ], + ], + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n" + ."\n" + .'> You can call the [DescribeDrdsInstances](~~139284~~) operation to query the details of all PolarDB-X 1.0 instances within an Alibaba Cloud account, including the IDs of the instances.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drds*************', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the custom ApsaraDB RDS instance at the storage layer.'."\n" + ."\n" + .'> You can call the [DescribeDrdsRdsInstances](~~xxxx~~) operation to query the details of all ApsaraDB RDS instances at the storage layer of a PolarDB-X 1.0 instance, including the IDs of the ApsaraDB RDS instances.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-***************', + ], + ], + [ + 'name' => 'Storage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new storage capacity of the custom ApsaraDB RDS instance at the storage layer.'."\n" + ."\n" + .'> You can call the [DescribeAvailableClasses](~~196546~~) operation to view the specifications that are supported for a custom ApsaraDB RDS instance. The specifications include the instance type and the storage capacity.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '50', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use vouchers to offset the purchase fees. Valid values: **true** and **false**. Default value: false.'."\n" + ."\n" + .'> If you downgrade the specifications of an instance after you use the vouchers, the vouchers used for the purchase cannot be refunded.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PrePayDuration', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is discontinued.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The ID of the order.'."\n", + 'type' => 'string', + 'example' => '{ "orderId": "209136011******" }', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '57D86AB4-8703-4DF4-BAB6-F7DE44******', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'ModifyRdsClassApiError', + 'errorMessage' => 'Failed to modify the class of the RDS instance.', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"{ \\\\\\"orderId\\\\\\": \\\\\\"209136011******\\\\\\" }\\",\\n \\"RequestId\\": \\"57D86AB4-8703-4DF4-BAB6-F7DE44******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"65C49036-181C-40A3-9034-465E417C6491\\n\\n 209136011******\\n\\ntrue","errorExample":""}]', + 'title' => 'UpdatePrivateRdsClass', + 'summary' => 'Updates the specifications of a custom ApsaraDB RDS instance at the storage layer.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpgradeHiStoreInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '76151', + 'abilityTreeNodes' => [ + 'FEATUREdrds25BO3L', + ], + ], + 'parameters' => [ + [ + 'name' => 'DrdsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB-X 1.0 instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'drdssad23sdfc', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'center', + ], + ], + [ + 'name' => 'HistoreInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the column-oriented storage instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'hi-sesex2e', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'Indicates whether the request was successful. A value of true indicates that the request was successful. An error message was returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DSSDF-SEWE-23ERW', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error. 默认错误码', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"DSSDF-SEWE-23ERW\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\tDSSDF-SEWE-23ERW\\n\\tTrue\\n","errorExample":""}]', + 'title' => 'UpgradeHiStoreInstance', + 'summary' => 'Upgrades the version of a column-oriented storage instance of a PolarDB-X 1.0 instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2-pop', + 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-pop', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-gov-1', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-nu16-b01', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-edge-1', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fujian', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-haidian-cm12-c01', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-bj-b01', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-prod-1', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-1', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-2', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-3', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-test-306', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong-finance-pop', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao-nebula', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et15-b01', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et2-b01', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-inner', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-internal-test-1', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-inner', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-st4-d01', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-su18-b01', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-yushanfang', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangbei-na61-b01', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou-na62-a01', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-nebula-1', + 'endpoint' => 'drds.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1-oxs', + 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'rus-west-1-pop', + 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'drds.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'drds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'drds.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'drds.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'drds.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'drds.cn-north-2-gov-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'drds.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'drds.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'drds.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'drds.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'drds.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'drds.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'drds.us-east-1.aliyuncs.com', + ], + ], +]; -- cgit v1.2.3