'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'Drds', 'version' => '2017-10-16', ], 'directories' => [ [ 'id' => 0, 'title' => '其它', 'type' => 'directory', 'children' => [ 'CreateDrdsAccount', 'CreateDrdsDB', 'CreateDrdsInstance', 'CreateReadOnlyAccount', 'DeleteDrdsDB', 'DeleteFailedDrdsDB', 'DescribeDrdsDB', 'DescribeDrdsDBIpWhiteList', 'DescribeDrdsDBs', 'DescribeDrdsInstance', 'DescribeDrdsInstanceDbMonitor', 'DescribeDrdsInstanceMonitor', 'DescribeDrdsInstances', 'DescribeRdsList', 'DescribeReadOnlyAccount', 'DescribeRegions', 'DescribeShardDBs', 'EnableInstance', 'ModifyDrdsDBPasswd', 'ModifyDrdsInstanceDescription', 'ModifyDrdsIpWhiteList', 'ModifyFullTableScan', 'ModifyRdsReadWeight', 'ModifyReadOnlyAccountPassword', 'QueryInstanceInfoByConn', 'RemoveDrdsInstance', 'RemoveReadOnlyAccount', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'CreateDrdsAccount' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76425', 'abilityTreeNodes' => [ 'FEATUREdrds0ML0VG', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdsusrzimk2****', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。'."\n" ."\n" .'> 如果DbName为空则获取实例中所有数据库，如果实例没有任何DbName，产生报错。', 'type' => 'string', 'required' => false, 'example' => 'testdb', ], ], [ 'name' => 'UserName', 'in' => 'query', 'schema' => [ 'description' => '数据库拥有读写权限账号的名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testaccount', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => '读写权限账号的密码。', 'type' => 'string', 'required' => false, 'example' => 'Test!123', 'default' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。取值如下：'."\n" ."\n" .'- **true**：创建成功。'."\n" .'- **false**：创建失败。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '890BB376-5746-4145-A088-4E610EF3WERT', ], ], ], ], ], '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' => 'InvalidPassword.MalFormed', 'errorMessage' => 'The specified parameter password is not valid.', ], [ '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', ], [ 'errorCode' => 'InvalidAccountName.Duplicate', 'errorMessage' => 'Account already exists', ], ], 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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"890BB376-5746-4145-A088-4E610EF3WERT\\"\\n}","errorExample":""},{"type":"xml","example":"890BB376-5746-4145-A088-4E610EF3WERT\\ntrue","errorExample":""}]', 'title' => '创建 DRDS 数据库的读写账户', 'summary' => '调用CreateDrdsAccount接口创建数据库的读写权限账号。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateDrdsDB' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drdssen12****', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'test123', ], ], [ 'name' => 'Encode', 'in' => 'query', 'schema' => [ 'description' => '数据库编码，取值如下：'."\n" ."\n" .'- **utf8**'."\n" .'- **gbk**'."\n" .'- **latin1**'."\n" .'- **utf8mb4**', 'type' => 'string', 'required' => true, 'example' => 'utf8', 'enum' => [ 'utf8', 'gbk', 'latin1', 'utf8mb4', ], ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => '数据库密码。', 'type' => 'string', 'required' => true, 'example' => '*********', ], ], [ 'name' => 'RdsInstances', 'in' => 'query', 'schema' => [ 'description' => 'RDS实例名列表。', 'type' => 'string', 'required' => true, 'example' => '[“rdsId1”, “rdsId2”]', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '8734773E-7B21-4A22-9106-CBD245F8TG57', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], [ 'errorCode' => 'InvalidParameter.Mismatch', 'errorMessage' => 'RDS instance and drds instance must belong to owner', ], [ 'errorCode' => 'QuotaExceeded.DrdsDB', 'errorMessage' => 'The quota of create DrdsDB exceeds.', ], [ 'errorCode' => 'InvalidDbname.MalFormed', 'errorMessage' => 'The specified parameter Dbname is not valid.', ], [ 'errorCode' => 'InvalidEncode.ValueNotSupported', 'errorMessage' => 'The specified parameter encode is not valid.', ], [ 'errorCode' => 'InvalidPassword.MalFormed', 'errorMessage' => 'The specified parameter password is not valid.', ], [ 'errorCode' => 'InvalidRds.MalFormed', 'errorMessage' => 'The rds is invalide', ], [ 'errorCode' => 'InvalidDbprefixOrPassword.MalFormed', 'errorMessage' => 'The dbprefix or password is invalid', ], [ 'errorCode' => 'DrdsVersionIsOld', 'errorMessage' => 'This drds instance version too old.not allow create drds db', ], [ 'errorCode' => 'OperationDenied.RdsDbNameExists', 'errorMessage' => 'The operation is not permitted due to Rds DbName exist.', ], [ 'errorCode' => 'InvalidDbprefixDuplicated', 'errorMessage' => 'db name in this drds instance duplicate', ], [ 'errorCode' => 'OperationDenied.RdsAccoutExists', 'errorMessage' => 'The operation is not permitted due to Rds accout exist.', ], [ 'errorCode' => 'InvalidParameter.DbprefixCannotEndWithUnderline', 'errorMessage' => 'DB prefix can not end up with underline.', ], [ 'errorCode' => 'InvalidRds.RegionNotMatch', 'errorMessage' => 'The rds region does not match Drds region', ], [ 'errorCode' => 'InvalidDbNumber.DBNumberExceed', 'errorMessage' => 'The db number in this drds has exceed, please create drds db in another drds instance', ], [ 'errorCode' => 'OperationDenied.DrdsInstanceUpgrading', 'errorMessage' => 'The drds instance is upgrading, please create db later', ], [ 'errorCode' => 'InvalidDBName.AlreadExist', 'errorMessage' => 'This drds db name alread exist in this instance', ], [ 'errorCode' => 'InvalidRds.RdsNotFound', 'errorMessage' => 'rds not found under this account', ], ], 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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"8734773E-7B21-4A22-9106-CBD245F8TG57\\"\\n}","errorExample":""},{"type":"xml","example":"8734773E-7B21-4A22-9106-CBD245F8TG57\\ntrue","errorExample":""}]', 'title' => '创建DRDS数据库实例', 'summary' => '调用CreateDrdsDB接口创建数据库。', ], 'CreateDrdsInstance' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76427', 'abilityTreeNodes' => [ 'FEATUREdrdsO50E25', ], ], 'parameters' => [ [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '实例描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a test instance', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => '可用区ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-e', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => '实例类型，取值：'."\n" ."\n" .'- **PRIVATE**：专享实例'."\n" .'- **PUBLIC**：共享实例', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PRIVATE', 'enum' => [ 'PRIVATE', 'PUBLIC', '1', '0', ], ], ], [ 'name' => 'Quantity', 'in' => 'query', 'schema' => [ 'description' => '购买的实例数量。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', ], ], [ 'name' => 'InstanceSeries', 'in' => 'query', 'schema' => [ 'description' => '实例类型，取值如下：'."\n" ."\n" .'- **入门版**：drds.sn2.4c8g'."\n" .'- **标准版**：drds.sn2.8c16g'."\n" .'- **企业版**：drds.sn2.16c32g'."\n" .'- **至尊版**：drds.sn2.32c64g', 'type' => 'string', 'required' => false, 'example' => 'drds.sn2.4c16g ', ], ], [ 'name' => 'Specification', 'in' => 'query', 'schema' => [ 'description' => '实例规格，由实例系列（如drds.sn2.4c8g）加上具体的实例规格（如8C16G）组成。 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drds.sn2.4c8g.8C16G', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => '付费类型。取值：'."\n" ."\n" .'- **drdsPost**：后付费'."\n" .'- **drdsPre**：预付费', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'drdsPre', 'enum' => [ 'drdsPost', 'drdsPre', ], ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => '虚拟专用网络ID。'."\n" ."\n" .'> 创建VPC网络类型的实例时必须指定。', 'type' => 'string', 'required' => false, 'example' => 'vpc-en23cxsel1', ], ], [ 'name' => 'VswitchId', 'in' => 'query', 'schema' => [ 'description' => '虚拟交换机ID。'."\n" ."\n" .'> 创建VPC网络类型的实例时必须指定。', 'type' => 'string', 'required' => false, 'example' => 'vsw-ewk32dsk', ], ], [ 'name' => 'IsHa', 'in' => 'query', 'schema' => [ 'description' => '是否为高可用实例。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'PricingCycle', 'in' => 'query', 'schema' => [ 'description' => '订购的周期单位。取值：'."\n" ."\n" .'- **year**'."\n" .'- **month**'."\n" .'> 付费类型是drdsPre时参数生效。', 'type' => 'string', 'required' => false, 'example' => 'month', 'enum' => [ 'year', 'month', ], ], ], [ 'name' => 'Duration', 'in' => 'query', 'schema' => [ 'description' => '订购的周期数量 。'."\n" ."\n" .'- PricingCycle=year时，取值1~3；'."\n" .'- PricingCycle=month时，取值1~9。'."\n" ."\n" .'> 付费类型是drdsPre时参数生效。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', ], ], [ 'name' => 'IsAutoRenew', 'in' => 'query', 'schema' => [ 'description' => '是否自动续费，取值：'."\n" ."\n" .'- **true**：是'."\n" .'- **false**：否'."\n" ."\n" .'> 付费类型是drdsPre时参数生效。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => '创建实例的token。', 'type' => 'string', 'required' => false, 'example' => 'DEWCEWQA', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'FF13E47D-4E38-4A5A-BA68-32A554RTY67H', ], 'Data' => [ 'description' => '返回的创建实例结果信息。', 'type' => 'object', 'properties' => [ 'OrderId' => [ 'description' => '订单ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2334632414', ], 'DrdsInstanceIdList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DrdsInstanceId' => [ 'type' => 'array', 'items' => [ 'description' => '实例ID。', 'type' => 'string', 'example' => 'drdsjwe23ds23,drdsjwe23ds24', ], ], ], ], ], ], ], ], ], ], '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', ], [ 'errorCode' => 'Invalid vswitchId', 'errorMessage' => 'Invalid vpcId, or the region of vpc does not match', ], [ 'errorCode' => 'Duplicate.client.token', 'errorMessage' => 'The request may have been successful, refused to submit duplicate', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"FF13E47D-4E38-4A5A-BA68-32A554RTY67H\\",\\n \\"Data\\": {\\n \\"OrderId\\": 2334632414,\\n \\"DrdsInstanceIdList\\": {\\n \\"DrdsInstanceId\\": [\\n \\"drdsjwe23ds23,drdsjwe23ds24\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"FF13E47D-4E38-4A5A-BA68-32A554RTY67H\\n\\n 2334632414\\n \\n drdsjwe23ds23,drdsjwe23ds24\\n \\n\\ntrue","errorExample":""}]', 'title' => '创建一个实例', 'summary' => '创建 DRDS 实例。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateReadOnlyAccount' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76428', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'password', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'object', 'properties' => [ 'DrdsInstanceId' => [ 'type' => 'string', ], 'DbName' => [ 'type' => 'string', ], 'AccountName' => [ 'type' => 'string', ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], [ 'errorCode' => 'DrdsVersionIsOld', 'errorMessage' => 'This drds instance version too old.not allow create drds db', ], [ 'errorCode' => 'InvalidPassword.MalFormed', 'errorMessage' => 'The specified parameter password is not valid.', ], [ 'errorCode' => 'InvalidDbUserName.NotFound', 'errorMessage' => 'The Username of db is not valid.', ], [ 'errorCode' => 'UpdateDbUserPasswordFailed', 'errorMessage' => 'update password failed', ], [ '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', ], [ 'errorCode' => 'OperationDenied.DrdsInstanceUpgrading', 'errorMessage' => 'The drds instance is upgrading, please try again later', ], [ 'errorCode' => 'CreateReadOnlyAccount.Failed', 'errorMessage' => 'Create read only account failed, please try again later.', ], [ 'errorCode' => 'InvalidInstanceStatus.NotRunning', 'errorMessage' => 'The Instance is not in running status', ], [ 'errorCode' => 'InvalidDbStatus.NotRunning', 'errorMessage' => 'The drds database is not in running status', ], ], 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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], 'DeleteDrdsDB' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76429', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], [ 'errorCode' => 'DbIsCreating', 'errorMessage' => 'The specified db is in creating status', ], [ 'errorCode' => 'InvalidDbname.DeleteStatusOrFailed', 'errorMessage' => 'The specified db is in deleting status or failed status', ], [ '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', ], [ 'errorCode' => 'ExistedNotCompleteAsynTask.ExistedAsynTask', 'errorMessage' => 'There exist an unfinished asynchronous task', ], [ 'errorCode' => 'OperationDenied.DrdsInstanceUpgrading', 'errorMessage' => 'The drds instance is upgrading, please create db later', ], ], 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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], 'DeleteFailedDrdsDB' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76430', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], [ 'errorCode' => 'DbIsCreating', 'errorMessage' => 'The specified db is in creating status', ], [ 'errorCode' => 'InvalidDbname.DeleteStatusOrFailed', 'errorMessage' => 'The specified db is in deleting status or failed status', ], [ '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.', ], [ 'errorCode' => 'InvalidDbname.MalFormed', 'errorMessage' => 'The specified parameter dbname is not valid.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], 'DescribeDrdsDB' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76432', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'object', 'properties' => [ 'Msg' => [ 'type' => 'string', ], 'Status' => [ 'type' => 'integer', 'format' => 'int32', ], 'DbName' => [ 'type' => 'string', ], 'Mode' => [ 'type' => 'string', ], 'CreateTime' => [ 'type' => 'string', ], ], ], ], ], ], ], '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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], 'DescribeDrdsDBIpWhiteList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'object', 'properties' => [ 'IpWhiteList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Ip' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], ], ], ], ], ], ], ], ], ], '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' => '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', ], [ 'errorCode' => 'InvalidInstanceStatus.NotRunning', 'errorMessage' => 'The Instance is not in running status', ], ], 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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], 'DescribeDrdsDBs' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Db' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Msg' => [ 'type' => 'string', ], 'Status' => [ 'type' => 'integer', 'format' => 'int32', ], 'DbName' => [ 'type' => 'string', ], 'Mode' => [ 'type' => 'string', ], 'CreateTime' => [ 'type' => 'string', ], ], ], ], ], ], ], ], ], ], '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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], 'DescribeDrdsInstance' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76436', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drdshbga33pe****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'B4F76641-BA45-4320-BE7C-9C62CFDAC9B2', ], 'Data' => [ 'description' => '返回数据列表。', 'type' => 'object', 'properties' => [ 'VpcCloudInstanceId' => [ 'description' => 'VPC Cloud Instance ID，与VPC交互时使用。', 'type' => 'string', 'example' => 'oogbx6c2atj****', ], 'Status' => [ 'description' => '实例状态：'."\n" ."\n" .'- **0**：运行中'."\n" .'- **1**：创建中（不能管理或释放）'."\n" .'- **2**：异常'."\n" .'- **3**：已过期（不能管理或释放）。'."\n" .'- **4**：释放中（不能管理或释放）'."\n" .'- **5**：已释放（不能管理或释放）'."\n" .'- **6**：锁定', 'type' => 'string', 'example' => '0', ], 'Type' => [ 'description' => '实例类型：'."\n" ."\n" .'- **0**：表示共享'."\n" .'- **1**：表示专享', 'type' => 'string', 'example' => '0', ], 'Specification' => [ 'description' => '实例规格。', 'type' => 'string', 'example' => 'drds.sn1.4c8g.8C16G', ], 'Description' => [ 'description' => '实例描述。', 'type' => 'string', 'example' => '111111', ], 'Version' => [ 'description' => '实例版本，目前为空。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'CreateTime' => [ 'description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1568620311000', ], 'ZoneId' => [ 'description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-e', ], 'DrdsInstanceId' => [ 'description' => '实例ID。', 'type' => 'string', 'example' => 'drdshbga33pe****', ], 'NetworkType' => [ 'description' => '网络类型：'."\n" ."\n" .'- **VPC**'."\n" .'- **Classic**', 'type' => 'string', 'example' => 'VPC', ], 'RegionId' => [ 'description' => '地域ID。', 'type' => 'string', 'example' => 'China (Hangzhou)', ], 'Vips' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Vip' => [ 'description' => 'VIP信息列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VpcId' => [ 'description' => 'VPC的ID。', 'type' => 'string', 'example' => 'vpc-en23cx****', ], 'Type' => [ 'description' => '网络类型，取值为：'."\n" ."\n" .'- **internet**：公网'."\n" .'- **intranet**：内网'."\n" .'- **VPC**：私有网络', 'type' => 'string', 'example' => 'VPC', ], 'VswitchId' => [ 'description' => '交换机的ID。', 'type' => 'string', 'example' => 'vsw-ewk3****', ], 'Port' => [ 'description' => '端口。', 'type' => 'string', 'example' => '3306', ], 'IP' => [ 'description' => 'IP地址。', 'type' => 'string', 'example' => '1.2.XX.XX', ], ], ], ], ], ], ], ], ], ], ], ], '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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B4F76641-BA45-4320-BE7C-9C62CFDAC9B2\\",\\n \\"Data\\": {\\n \\"VpcCloudInstanceId\\": \\"oogbx6c2atj****\\",\\n \\"Status\\": \\"0\\",\\n \\"Type\\": \\"0\\",\\n \\"Specification\\": \\"drds.sn1.4c8g.8C16G\\",\\n \\"Description\\": \\"111111\\",\\n \\"Version\\": 0,\\n \\"CreateTime\\": 1568620311000,\\n \\"ZoneId\\": \\"cn-hangzhou-e\\",\\n \\"DrdsInstanceId\\": \\"drdshbga33pe****\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"RegionId\\": \\"China (Hangzhou)\\",\\n \\"Vips\\": {\\n \\"Vip\\": [\\n {\\n \\"VpcId\\": \\"vpc-en23cx****\\",\\n \\"Type\\": \\"VPC\\",\\n \\"VswitchId\\": \\"vsw-ewk3****\\",\\n \\"Port\\": \\"3306\\",\\n \\"IP\\": \\"1.2.XX.XX\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"B4F76641-BA45-4320-BE7C-9C62CFDAC9B2\\n\\n 0\\n 0\\n 111111\\n cn-hangzhou-e\\n drdshbga33pe****\\n 0\\n VPC\\n 1568620311000\\n oogbx6c2atj****\\n drds.sn1.4c8g.8C16G\\n China (Hangzhou)\\n \\n \\n VPC\\n vpc-en23cx****\\n 3306\\n 1.2.XX.XX\\n vsw-ewk3****\\n \\n \\n\\ntrue","errorExample":""}]', 'title' => '查询 DRDS 数据库实例详情', 'summary' => '调用DescribeDrdsInstance接口查询指定实例的基本信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDrdsInstanceDbMonitor' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76437', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'Key', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PartialPerformanceData' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => [ 'type' => 'string', ], 'Unit' => [ 'type' => 'string', ], 'Values' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PerformanceValue' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Date' => [ 'type' => 'integer', 'format' => 'int64', ], 'Value' => [ 'type' => 'string', ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], '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' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId or DbName provided does not exist in our records.', ], [ '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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], 'DescribeDrdsInstanceMonitor' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76438', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'Key', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, ], ], [ 'name' => 'PeriodMultiple', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PartialPerformanceData' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => [ 'type' => 'string', ], 'Unit' => [ 'type' => 'string', ], 'Values' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PerformanceValue' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Date' => [ 'type' => 'integer', 'format' => 'int64', ], 'Value' => [ 'type' => 'string', ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], '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', ], ], 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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], 'DescribeDrdsInstances' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76440', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'enum' => [ 'PRIVATE', 'PUBLIC', '1', '0', ], ], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Instance' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'type' => 'string', ], 'Status' => [ 'type' => 'string', ], 'CreateTime' => [ 'type' => 'integer', 'format' => 'int64', ], 'MasterInstId' => [ 'type' => 'string', ], 'NetworkType' => [ 'type' => 'string', ], 'RegionId' => [ 'type' => 'string', ], 'VpcCloudInstanceId' => [ 'type' => 'string', ], 'Description' => [ 'type' => 'string', ], 'Version' => [ 'type' => 'integer', 'format' => 'int64', ], 'DrdsInstanceId' => [ 'type' => 'string', ], 'ZoneId' => [ 'type' => 'string', ], 'InstRole' => [ 'type' => 'string', ], 'Vips' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Vip' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VpcId' => [ 'type' => 'string', ], 'Type' => [ 'type' => 'string', ], 'VswitchId' => [ 'type' => 'string', ], 'Port' => [ 'type' => 'string', ], 'IP' => [ 'type' => 'string', ], ], ], ], ], ], 'SlaveInstId' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'instId' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], ], ], ], ], ], ], ], ], ], ], ], ], '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.', ], [ 'errorCode' => 'TagService.%s', 'errorMessage' => 'TagService return errorMsg: %s', ], [ '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 50', ], [ 'errorCode' => 'InvalidParameter.tags.json.error', 'errorMessage' => 'The parameter tags is not a JsonArray', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], 'DescribeRdsList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76441', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RdsInstance' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ConnectUrl' => [ 'type' => 'string', ], 'ReadWeight' => [ 'type' => 'integer', 'format' => 'int32', ], 'DbType' => [ 'type' => 'string', ], 'InstanceName' => [ 'type' => 'string', ], 'InstanceStatus' => [ 'type' => 'string', ], 'InstanceId' => [ 'type' => 'integer', 'format' => 'int32', ], 'Port' => [ 'type' => 'integer', 'format' => 'int32', ], 'ReadOnlyChildren' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Child' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ConnectUrl' => [ 'type' => 'string', ], 'ReadWeight' => [ 'type' => 'integer', 'format' => 'int32', ], 'DbType' => [ 'type' => 'string', ], 'InstanceName' => [ 'type' => 'string', ], 'InstanceStatus' => [ 'type' => 'string', ], 'InstanceId' => [ 'type' => 'string', ], 'port' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], '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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], 'DescribeReadOnlyAccount' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76442', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drdsusrzimk2****', ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'testdb', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '结果集。', 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求结果。取值如下：'."\n" .'- true：创建成功。'."\n" .'- false：创建失败。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '890BB376-5746-4145-A088-4E610EF312QA', ], 'Data' => [ 'description' => '结果集。', 'type' => 'object', 'properties' => [ 'DrdsInstanceId' => [ 'description' => '实例ID。', 'type' => 'string', 'example' => 'drdsusrzimk2****', ], 'DbName' => [ 'description' => '数据库名称。', 'type' => 'string', 'example' => 'testdb', ], 'AccountName' => [ 'description' => '只读账户名，如果不存在只读账户则为空。', 'type' => 'string', 'example' => 'testaccount', ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], [ 'errorCode' => 'DrdsVersionIsOld', 'errorMessage' => 'This drds instance version too old.not allow create drds db', ], [ 'errorCode' => 'InvalidPassword.MalFormed', 'errorMessage' => 'The specified parameter password is not valid.', ], [ 'errorCode' => 'InvalidDbUserName.NotFound', 'errorMessage' => 'The Username of db is not valid.', ], [ 'errorCode' => 'UpdateDbUserPasswordFailed', 'errorMessage' => 'update password failed', ], [ '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', ], [ 'errorCode' => 'InvalidInstanceStatus.NotRunning', 'errorMessage' => 'The Instance is not in running status', ], [ 'errorCode' => 'InvalidDbStatus.NotRunning', 'errorMessage' => 'The drds database is not in running status', ], ], 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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"890BB376-5746-4145-A088-4E610EF312QA\\",\\n \\"Data\\": {\\n \\"DrdsInstanceId\\": \\"drdsusrzimk2****\\",\\n \\"DbName\\": \\"testdb\\",\\n \\"AccountName\\": \\"testaccount\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 890BB376-5746-4145-A088-4E610EF312QA\\n \\n drdsusrzimk2****\\n testdb\\n testaccount\\n \\n","errorExample":""}]', 'title' => '查询 DRDS 数据库的只读账户', 'summary' => '调用DescribeReadOnlyAccount接口查询数据库中的只读账号。', ], 'DescribeRegions' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76443', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], 'DrdsRegions' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DrdsRegion' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ZoneId' => [ 'type' => 'string', ], 'RegionName' => [ 'type' => 'string', ], 'ZoneName' => [ 'type' => 'string', ], 'RegionId' => [ 'type' => 'string', ], 'InstanceSeriesList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'InstanceSeries' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SeriesName' => [ 'type' => 'string', ], 'SeriesId' => [ 'type' => 'string', ], 'SpecList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Spec' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SpecId' => [ 'type' => 'string', ], 'SpecName' => [ 'type' => 'string', ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], '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' => '', ], 'DescribeShardDBs' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76445', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DbIntancePair' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SubDbName' => [ 'type' => 'string', ], 'GroupName' => [ 'type' => 'string', ], 'InstanceName' => [ 'type' => 'string', ], ], ], ], ], ], ], ], ], ], '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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], 'EnableInstance' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'docRequired' => true, ], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'SourceDbInstId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'DbInstanceClass', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'SwitchId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'type' => 'string', ], 'Result' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '', ], 'ModifyDrdsDBPasswd' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76446', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'NewPasswd', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], [ 'errorCode' => 'DrdsVersionIsOld', 'errorMessage' => 'This drds instance version too old.not allow create drds db', ], [ 'errorCode' => 'InvalidPassword.MalFormed', 'errorMessage' => 'The specified parameter password is not valid.', ], [ 'errorCode' => 'InvalidDbUserName.NotFound', 'errorMessage' => 'The Username of db is not valid.', ], [ 'errorCode' => 'UpdateDbUserPasswordFailed', 'errorMessage' => 'update password failed', ], [ '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', ], [ 'errorCode' => 'OperationDenied.DrdsInstanceUpgrading', 'errorMessage' => 'The drds instance is upgrading, please create db later', ], ], 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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], 'ModifyDrdsInstanceDescription' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76447', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'drdshbga33pe****', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '实例描述。', 'type' => 'string', 'required' => true, 'example' => 'This is a test instance.', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'B4F76641-BA45-4320-BE7C-9C62CFDAR56T', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], [ 'errorCode' => 'InvalidDescription.MalFormed', 'errorMessage' => 'The specified parameter description is not valid.', ], [ 'errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records', ], ], 404 => [ [ 'errorCode' => 'InvalidDRDSInstanceId.NotFound', 'errorMessage' => 'The DrdsInstanceId provided does not exist in our records.', ], [ 'errorCode' => 'InvalidParameters.DescriptionTooLong', 'errorMessage' => 'The drds description is too long', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B4F76641-BA45-4320-BE7C-9C62CFDAR56T\\"\\n}","errorExample":""},{"type":"xml","example":"B4F76641-BA45-4320-BE7C-9C62CFDAR56T\\ntrue","errorExample":""}]', 'title' => '修改实例描述', 'summary' => '调用ModifyDrdsInstanceDescription接口修改PolarDB-X实例的描述信息。', ], 'ModifyDrdsIpWhiteList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76448', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'IpWhiteList', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'Mode', 'in' => 'query', 'schema' => [ 'type' => 'boolean', 'required' => false, 'default' => 'true', ], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'GroupAttribute', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], ], ], ], ], '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' => 'InvalidPassword.MalFormed', 'errorMessage' => 'The specified parameter password is not valid.', ], [ 'errorCode' => 'NumberIpWhiteList.Error', 'errorMessage' => 'The number of ip in the whilte list must be less than 300', ], [ 'errorCode' => 'ModifyIpwhiteListError.VPCInstance', 'errorMessage' => 'The Ip whitelist of VPC instance is not changeable.', ], [ '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', ], [ 'errorCode' => 'MaxIpGroupExceed', 'errorMessage' => 'The number of ip group exceed.', ], [ 'errorCode' => 'MaxIpNumberExceed', 'errorMessage' => 'The number of ip exceed.', ], ], 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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], 'ModifyFullTableScan' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76449', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'TableNames', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'FullTableScan', 'in' => 'query', 'schema' => [ 'type' => 'boolean', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], ], ], ], ], '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' => 'InvalidParameter.PartitionTableNotFound', 'errorMessage' => 'The specified table name does not match.', ], [ 'errorCode' => 'InvalidAction.ConflictWithAnotherAction', 'errorMessage' => 'The specified action conflict with another.', ], [ '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', ], [ 'errorCode' => 'OperationFailed.ModifyFullTableScan', 'errorMessage' => 'Modify full table scan failed, please try again later', ], ], 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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], 'ModifyRdsReadWeight' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'InstanceNames', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'Weights', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], ], ], ], ], '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' => 'InvalidAction.ConflictWithAnotherAction', 'errorMessage' => 'The specified action conflict with another.', ], [ 'errorCode' => 'InvalidParameter.InvalidMainInstance', 'errorMessage' => 'The specified main rds instance is invalid.', ], [ 'errorCode' => 'InvalidParameter.IllegalWeightParameter', 'errorMessage' => 'The specified parameter weight is invalid', ], [ 'errorCode' => 'InvalidParameter.InvalidRdsReadInstance_NotFound', 'errorMessage' => 'The specified read rds instance not found.', ], [ 'errorCode' => 'InvalidStatus.RdsReadInstance', 'errorMessage' => 'The specified rds read instance is in wrong status.', ], [ 'errorCode' => 'InvalidMainInstance.WeightNotFound', 'errorMessage' => 'The specified main instance does not have weight configuration.', ], [ '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', ], [ 'errorCode' => 'OperationDenied.DrdsInstanceUpgrading', 'errorMessage' => 'The drds instance is upgrading, please create db later', ], ], 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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], 'ModifyReadOnlyAccountPassword' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76451', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'OriginPassword', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'NewPasswd', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], [ 'errorCode' => 'DrdsVersionIsOld', 'errorMessage' => 'This drds instance version too old.not allow create drds db', ], [ 'errorCode' => 'InvalidPassword.MalFormed', 'errorMessage' => 'The specified parameter password is not valid.', ], [ 'errorCode' => 'InvalidDbUserName.NotFound', 'errorMessage' => 'The Username of db is not valid.', ], [ 'errorCode' => 'UpdateDbUserPasswordFailed', 'errorMessage' => 'update password failed', ], [ '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', ], [ 'errorCode' => 'InvalidAccountOrPassword.MalFormed', 'errorMessage' => 'Invalid account name or password.', ], [ 'errorCode' => 'UpdateDbUserPassword.Failed', 'errorMessage' => 'Update password failed, Please try again later', ], [ 'errorCode' => 'OperationDenied.DrdsInstanceUpgrading', 'errorMessage' => 'The drds instance is upgrading, please try again later', ], [ 'errorCode' => 'InvalidReadOnlyAccount.NotFound', 'errorMessage' => 'read only account not found.', ], [ 'errorCode' => 'InvalidInstanceStatus.NotRunning', 'errorMessage' => 'The Instance is not in running status', ], [ 'errorCode' => 'InvalidDbStatus.NotRunning', 'errorMessage' => 'The drds database is not in running status', ], ], 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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], 'QueryInstanceInfoByConn' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76452', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'Host', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => true, ], ], [ 'name' => 'UserName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'type' => 'string', ], 'Status' => [ 'type' => 'string', ], 'Specification' => [ 'type' => 'string', ], 'CreateTime' => [ 'type' => 'integer', 'format' => 'int64', ], 'SpecTypeId' => [ 'type' => 'string', ], 'NetworkType' => [ 'type' => 'string', ], 'RegionId' => [ 'type' => 'string', ], 'SpecTypeName' => [ 'type' => 'string', ], 'VpcCloudInstanceId' => [ 'type' => 'string', ], 'Description' => [ 'type' => 'string', ], 'Version' => [ 'type' => 'integer', 'format' => 'int64', ], 'DrdsInstanceId' => [ 'type' => 'string', ], 'ZoneId' => [ 'type' => 'string', ], 'Vips' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Vip' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VpcId' => [ 'type' => 'string', ], 'Type' => [ 'type' => 'string', ], 'VswitchId' => [ 'type' => 'string', ], 'Port' => [ 'type' => 'string', ], 'IP' => [ 'type' => 'string', ], ], ], ], ], ], ], ], ], ], ], ], '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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], 'RemoveDrdsInstance' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], [ 'errorCode' => 'RemoveDrdsDBFirst', 'errorMessage' => 'There are Drds DB exist in this instance. Please delete drds db first', ], [ 'errorCode' => 'OperationDenied.DrdsInstanceStatus', 'errorMessage' => 'The drds instance is not in running status, please try again later', ], ], 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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], 'RemoveReadOnlyAccount' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '76454', 'abilityTreeNodes' => [ 'FEATUREdrds25BO3L', ], ], 'parameters' => [ [ 'name' => 'DrdsInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'DbName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => [ 'type' => 'boolean', ], 'RequestId' => [ 'type' => 'string', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you', ], [ 'errorCode' => 'DrdsVersionIsOld', 'errorMessage' => 'This drds instance version too old.not allow create drds db', ], [ 'errorCode' => 'InvalidPassword.MalFormed', 'errorMessage' => 'The specified parameter password is not valid.', ], [ 'errorCode' => 'InvalidDbUserName.NotFound', 'errorMessage' => 'The Username of db is not valid.', ], [ 'errorCode' => 'UpdateDbUserPasswordFailed', 'errorMessage' => 'update password failed', ], [ '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', ], [ 'errorCode' => 'OperationDenied.DrdsInstanceUpgrading', 'errorMessage' => 'The drds instance is upgrading, please try again later', ], [ 'errorCode' => 'OperationFailed.RemoveDbUserFailed', 'errorMessage' => 'Remove readonly account failed, please try again later', ], [ 'errorCode' => 'InvalidReadOnlyAccount.NotFound', 'errorMessage' => 'read only account not found.', ], [ 'errorCode' => 'InvalidInstanceStatus.NotRunning', 'errorMessage' => 'The Instance is not in running status', ], [ 'errorCode' => 'InvalidDbStatus.NotRunning', 'errorMessage' => 'The drds database is not in running status', ], ], 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.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], ], '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', ], ], ];