'1.0',
'info' => ['style' => 'RPC', 'product' => 'selectdb', 'version' => '2023-05-22'],
'directories' => [
[
'children' => ['CreateServiceLinkedRoleForSelectDB', 'CheckCreateDBInstance', 'DescribeSecurityIPList', 'ModifySecurityIPList', 'CheckIpExistsInSecurityIpList', 'ModifyDBInstanceAttribute'],
'type' => 'directory',
'title' => 'Instance management',
],
[
'children' => ['ModifyVirtualCluster', 'CreateDBClusterBinding', 'DeleteDBClusterBinding', 'GetCreateBEClusterInquiry', 'GetModifyBEClusterInquiry', 'ModifyBEClusterAttribute', 'StopBECluster', 'StartBECluster', 'RestartDBCluster', 'DescribeDBClusterConfig', 'ModifyDBClusterConfig', 'DescribeDBClusterConfigChangeLogs'],
'type' => 'directory',
'title' => 'Cluster management',
],
[
'children' => [
'DescribeAllDBInstanceClass', 'ModifyElasticRule', 'DescribeElasticRules', 'DescribeDBClusterStorageLimitation', 'DeleteElasticRule', 'EnDisableScalingRules', 'CreateElasticRule', 'AllocateInstancePublicConnection', 'ChangeResourceGroup', 'CheckServiceLinkedRole', 'CreateDBCluster', 'CreateDBInstance', 'CreateVirtualCluster', 'DeleteDBCluster', 'DeleteDBInstance', 'DeleteVirtualCluster', 'DescribeDBInstanceAttribute', 'DescribeDBInstanceNetInfo', 'DescribeDBInstances', 'DescribeProfile',
'DescribeRegions', 'DescribeSlowQueryStats', 'DescribeVSwitches', 'DescribeZones', 'ModifyDBCluster', 'ReleaseInstancePublicConnection', 'ResetAccountPassword', 'TagResources', 'UntagResources', 'UpgradeDBInstanceDeployScheme', 'UpgradeDBInstanceEngineVersion',
],
'type' => 'directory',
'title' => 'Others',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AllocateInstancePublicConnection' => [
'summary' => 'Applies for a public endpoint for an ApsaraDB for SelectDB instance.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '189186',
'abilityTreeNodes' => ['FEATUREselectdbIVFRFW'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'NetType',
'in' => 'query',
'schema' => ['description' => 'The network type of the endpoint to be applied for. Set the value to Public.', 'type' => 'string', 'required' => true, 'example' => 'Public', 'title' => ''],
],
[
'name' => 'ConnectionStringPrefix',
'in' => 'query',
'schema' => ['description' => 'The prefix of the endpoint. Set the parameter to the prefix of the value of **ConnectionString**.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-h033cn****-pub-i3', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5ED62C81-9948-5612-81E1-EA3853752306'],
'InstanceName' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'New instance test', 'title' => ''],
'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '498115273', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceNetType.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceNetType" is not valid.', 'description' => 'Illegal network type.'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'The specified connection string already exists.', 'description' => 'The specified connection string already exists'],
],
403 => [
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'InvalidClusterInstance.NotFound', 'errorMessage' => 'Specified cluster instance does not exist.', 'description' => 'SelectDB instance does not exist.'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5ED62C81-9948-5612-81E1-EA3853752306\\",\\n \\"InstanceName\\": \\"New instance test\\",\\n \\"TaskId\\": 498115273\\n}","type":"json"}]',
'title' => 'AllocateInstancePublicConnection',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'selectdb:AllocateInstancePublicConnection',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'translator' => 'manual',
],
'ChangeResourceGroup' => [
'summary' => 'Moves a specified database instance to a different resource group.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '214635',
'abilityTreeNodes' => ['FEATUREselectdb7TFVYR'],
],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The type of the resource. Default value: `DBInstance`.', 'type' => 'string', 'required' => false, 'default' => 'Instance', 'title' => '', 'example' => 'DBInstance'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance you want to move.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-shenzhen'],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The destination resource group.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_resource_group'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'FCEEA97F-85CA-5A9F-932F-B4BAEA170896'],
],
'title' => '',
'description' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter.ResourceGroupId', 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing.', 'description' => 'Missing ResourceGroupId parameter.'],
['errorCode' => 'MissingParameter.RegionId', 'errorMessage' => 'The RegionId parameters that are required for processing this request are missing.', 'description' => 'Missing required parameter RegionId'],
['errorCode' => 'InvalidResourceGroup', 'errorMessage' => 'The specified ResourceGroupId is invalid.', 'description' => 'ResourceGroupId parameter is illegal.'],
['errorCode' => 'MissingParameter.ResourceId', 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing.', 'description' => 'Missing ResourceId parameter.'],
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => ''],
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => 'The system is abnormal.'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'NoPermission.ChangeResourceGroup', 'errorMessage' => 'You are not authorized to change resourcegroup.', 'description' => 'You do not have permission to modify the resource group.'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'title' => 'ChangeResourceGroup',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ChangeResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:selectdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FCEEA97F-85CA-5A9F-932F-B4BAEA170896\\"\\n}","type":"json"}]',
],
'CheckCreateDBInstance' => [
'summary' => 'Performs a precheck on the resources required to create an ApsaraDB for SelectDB instance.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREselectdb318HEK'],
],
'parameters' => [
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-4690g37929****', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client-generated token that is used to ensure the idempotence of the request. The token must be unique among different requests. The token can be up to 64 ASCII characters in length and cannot contain non-ASCII characters.', 'type' => 'string', 'required' => false, 'example' => 'AB', 'title' => ''],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => 'The database engine type.', 'type' => 'string', 'default' => 'SelectDB', 'required' => false, 'example' => 'SelectDB', 'title' => ''],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => ['description' => 'The database engine version.', 'type' => 'string', 'required' => true, 'example' => '3.0', 'title' => ''],
],
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => ['description' => 'The billing method of the instance. Valid values:'."\n"
."\n"
.'- **Postpaid**: pay-as-you-go.'."\n"
."\n"
.'- **Prepaid**: subscription.', 'type' => 'string', 'required' => true, 'example' => 'PrePaid', 'title' => ''],
],
[
'name' => 'UsedTime',
'in' => 'query',
'schema' => ['description' => 'The subscription duration. Valid values:'."\n"
."\n"
.'- If Period is set to Year, valid values are 1, 2, 3, 4, and 5.'."\n"
."\n"
.'- If Period is set to Month, valid values are integers from 1 to 12.'."\n"
."\n"
.'> This parameter is required and takes effect only when ChargeType is set to Prepaid.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => 'The unit of the subscription duration. Valid values:'."\n"
."\n"
.'- **Year**'."\n"
."\n"
.'- **Month**'."\n"
."\n"
.'> This parameter is required and takes effect only when **ChargeType** is set to **Prepaid**.', 'type' => 'string', 'required' => false, 'example' => 'Month', 'title' => ''],
],
[
'name' => 'DBInstanceClass',
'in' => 'query',
'schema' => [
'description' => 'The instance type. Valid values:'."\n"
."\n"
.'- **selectdb.xlarge**: 4 cores, 32 GB.'."\n"
."\n"
.'- **selectdb.2xlarge**: 8 cores, 64 GB.'."\n"
."\n"
.'- **selectdb.4xlarge**: 16 cores, 128 GB.'."\n"
."\n"
.'- **selectdb.8xlarge**: 32 cores, 256 GB.'."\n"
."\n"
.'- **selectdb.16xlarge**: 64 cores, 512 GB.'."\n"
."\n"
.'- **selectdb.24xlarge**: 96 cores, 768 GB.'."\n"
."\n"
.'- **selectdb.32xlarge**: 128 cores, 1024 GB.',
'enumValueTitles' => ['selectdb.2xlarge' => '8 cores, 64 GB', 'selectdb.4xlarge' => '16 cores, 128 GB', 'selectdb.24xlarge' => '96 cores, 768 GB', 'selectdb.32xlarge' => '128 cores, 1024 GB', 'selectdb.16xlarge' => '64 cores, 512 GB', 'selectdb.xlarge' => '4 cores, 32 GB', 'selectdb.8xlarge' => '32 cores, 256 GB'],
'type' => 'string',
'required' => true,
'example' => 'selectdb.xlarge',
'title' => '',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-i', 'title' => ''],
],
[
'name' => 'CacheSize',
'in' => 'query',
'schema' => ['description' => 'The reserved cache size, in GB.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '200', 'title' => ''],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => 'The VPC ID.', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp175iuvg8nxqraf2****', 'title' => ''],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1gzt31twhlo0sa5****', 'title' => ''],
],
[
'name' => 'DBInstanceDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the instance.', 'type' => 'string', 'example' => 'New instance test', 'required' => false, 'title' => ''],
],
[
'name' => 'ConnectionString',
'in' => 'query',
'schema' => ['description' => 'The connection string of the instance.', 'type' => 'string', 'required' => false, 'example' => 'selectdb-cn-7213c8y****-public.selectdbfe.pre.rds.aliyuncs.com', 'title' => ''],
],
[
'name' => 'SecurityIPList',
'in' => 'query',
'schema' => ['description' => 'The IP address whitelist for the instance. Separate multiple IP addresses with commas (,).', 'type' => 'string', 'required' => false, 'example' => '172.16.XX.XX/12,192.168.XX.XX/22', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ADF42B18-43FD-5100-83A9-BE81AB70C863'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
['errorCode' => 'OperationDenied.SpecificClassCodeNotSupported', 'errorMessage' => 'The uid is not in specific classcode whitelist.', 'description' => 'The selected specification is not open to the current account.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidVPC.NotFound', 'errorMessage' => 'VPC or VSwitch is not valid.', 'description' => 'Invalid VPC or VSwitch'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADF42B18-43FD-5100-83A9-BE81AB70C863\\"\\n}","type":"json"}]',
'title' => 'CheckCreateDBInstance',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:CheckCreateDBInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'translator' => 'manual',
],
'CheckIpExistsInSecurityIpList' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '221358',
'abilityTreeNodes' => ['FEATUREselectdb72PXTX'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'selectdb-cn-2bl4dj****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'Ip',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => '192.168.0.239', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => '4773E4EC-025D-509F-AEA9-D53123FDFB0F'],
'Data' => [
'type' => 'object',
'properties' => [
'IpExists' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'description' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidSecurityIPs.Malformed', 'errorMessage' => 'The specified parameter "SecurityIps" is not valid.', 'description' => 'The IP whitelist is illegal.'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'InvalidClusterInstance.NotFound', 'errorMessage' => 'Specified cluster instance does not exist.', 'description' => 'SelectDB instance does not exist.'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'CheckIpExistsInSecurityIpList',
'summary' => ' ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'selectdb:CheckIpExistsInSecurityIpList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4773E4EC-025D-509F-AEA9-D53123FDFB0F\\",\\n \\"Data\\": {\\n \\"IpExists\\": true\\n }\\n}","type":"json"}]',
],
'CheckServiceLinkedRole' => [
'summary' => 'Call this operation to check the service-linked role.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '1F455133-981E-5AD0-80EB-26EA1EF3C65F'],
'HasServiceLinkedRole' => ['description' => 'Indicates whether the service-linked role has been created.', 'type' => 'boolean', 'example' => 'False', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'CheckServiceLinkedRole',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:CheckServiceLinkedRole',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1F455133-981E-5AD0-80EB-26EA1EF3C65F\\",\\n \\"HasServiceLinkedRole\\": true\\n}","type":"json"}]',
],
'CreateDBCluster' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '189724',
'abilityTreeNodes' => ['FEATUREselectdbF7Q0Y1'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => 'The database engine type.', 'type' => 'string', 'default' => 'SelectDB', 'required' => false, 'example' => 'selectdb', 'title' => ''],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => ['description' => 'The database engine version.', 'type' => 'string', 'required' => true, 'example' => '2.4', 'title' => ''],
],
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => ['description' => 'The billing method of the cluster. Valid values:'."\n"
."\n"
.'- **Postpaid**: pay-as-you-go.'."\n"
."\n"
.'- **Prepaid**: subscription.', 'type' => 'string', 'required' => true, 'example' => 'Prepaid', 'title' => ''],
],
[
'name' => 'UsedTime',
'in' => 'query',
'schema' => ['description' => 'The subscription duration of the subscription cluster. Valid values:'."\n"
."\n"
.'- If Period is set to Year, valid values for UsedTime are 1, 2, 3, and 5.'."\n"
."\n"
.'- If Period is set to Month, the value of UsedTime can be an integer from 1 to 9.'."\n"
."\n"
.'> This parameter is required and takes effect only when ChargeType is set to Prepaid.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => 'The billing cycle of the subscription cluster. Valid values:'."\n"
."\n"
.'- **Year**: The cluster is billed on a yearly basis.'."\n"
."\n"
.'- **Month**: The cluster is billed on a monthly basis.'."\n"
."\n"
.'> This parameter is required and takes effect only when **ChargeType** is set to **Prepaid**.', 'type' => 'string', 'required' => false, 'example' => 'Month', 'title' => ''],
],
[
'name' => 'DBClusterClass',
'in' => 'query',
'schema' => ['description' => 'The instance type of the cluster. Valid values:'."\n"
."\n"
.'- **selectdb.xlarge**: 4 cores, 32 GB.'."\n"
."\n"
.'- **selectdb.2xlarge**: 8 cores, 64 GB.'."\n"
."\n"
.'- **selectdb.4xlarge**: 16 cores, 128 GB.'."\n"
."\n"
.'- **selectdb.8xlarge**: 32 cores, 256 GB.'."\n"
."\n"
.'- **selectdb.16xlarge**: 64 cores, 512 GB.'."\n"
."\n"
.'- **selectdb.24xlarge**: 96 cores, 768 GB.'."\n"
."\n"
.'- **selectdb.32xlarge**: 128 cores, 1024 GB.', 'type' => 'string', 'required' => true, 'example' => 'selectdb.2xlarge', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-i', 'title' => ''],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => 'The VPC ID.', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp175iuvg8nxqraf2****', 'title' => ''],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1gzt31twhlo0sa5****', 'title' => ''],
],
[
'name' => 'CacheSize',
'in' => 'query',
'schema' => ['description' => 'The reserved cache size.', 'type' => 'string', 'required' => true, 'example' => '200', 'title' => ''],
],
[
'name' => 'DBClusterDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'testdb', 'title' => ''],
],
[
'name' => 'ClusterNodeType',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'ClusterNodeCount',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'ScaleMax',
'in' => 'query',
'schema' => ['type' => 'number', 'format' => 'double', 'default' => '32', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'ScaleMin',
'in' => 'query',
'schema' => ['type' => 'number', 'format' => 'double', 'default' => '4', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The returned parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F8900A96-67F7-5274-A41B-7722E1ECF8C9'],
'Data' => [
'description' => 'The data returned.',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '219543646290345', 'title' => ''],
'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'selectdb-cn-1ls3sg0po0****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', 'description' => 'New Cluster Name'],
['errorCode' => 'InvalidPayType.Malformed', 'errorMessage' => 'The specified parameter "chargeType" is not valid.', 'description' => 'Billing method parameter is illegal.'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
['errorCode' => 'OperationDenied.OrderProcessing', 'errorMessage' => 'There are orders in process.', 'description' => 'There are orders in process.'],
['errorCode' => 'ORDER.INST_HAS_UNPAID_ORDER', 'errorMessage' => 'Instance has unpaid order.', 'description' => 'The instance has an unpaid order.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
['errorCode' => 'INSUFFICIENT_AVAILABLE_QUOTA', 'errorMessage' => 'Your account available limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase'],
['errorCode' => 'OperationDenied.SpecificClassCodeNotSupported', 'errorMessage' => 'The uid is not in specific classcode whitelist.', 'description' => 'The selected specification is not open to the current account.'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'InvalidClusterInstance.NotFound', 'errorMessage' => 'Specified cluster instance does not exist.', 'description' => 'SelectDB instance does not exist.'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'CreateDBCluster',
'summary' => 'Creates a cluster for a specified ApsaraDB for SelectDB instance.',
'description' => '>'."\n"
."\n"
.'Pay-as-you-go instances support only pay-as-you-go clusters. Subscription instances support both pay-as-you-go and subscription clusters.'."\n"
."\n"
.'>',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:CreateDBCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8900A96-67F7-5274-A41B-7722E1ECF8C9\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"selectdb-cn-7213cjv****\\",\\n \\"OrderId\\": 219543646290345,\\n \\"ClusterId\\": \\"selectdb-cn-1ls3sg0po0****\\"\\n }\\n}","type":"json"}]',
],
'CreateDBClusterBinding' => [
'summary' => 'Creates a binding relationship for clusters. If the zone-redundant storage (ZRS) deployment method is used, you can create a binding relationship between two clusters.',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREselectdbVAZKUZ'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv2ez', 'title' => ''],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv2ez-be', 'title' => ''],
],
[
'name' => 'DBClusterIdBak',
'in' => 'query',
'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-xxxb9f2w-be', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4773E4EC-025D-509F-AEA9-D53123FDFB0F'."\n"],
'Data' => [
'description' => 'The data returned.',
'type' => 'object',
'properties' => [
'DbInstanceName' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv2ez', 'title' => ''],
'DbInstanceId' => ['description' => 'The numeric ID.', 'type' => 'string', 'example' => '6585', 'title' => ''],
'DbClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv2ez-be', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => 'The system is abnormal.'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => 'The operation is not supported in the current cluster state.'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidChargeType.NotSupport', 'errorMessage' => 'The specified parameter "ChargeType" does not meet the requirements.', 'description' => ''],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid parameter, please check.', 'description' => ''],
['errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', 'description' => 'The specified cluster name is not available'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'CreateDBClusterBinding',
'description' => 'This operation is supported only for instances that use the zone-redundant storage (ZRS) feature and meet the following requirements:'."\n"
."\n"
.'- The instance clusters reside in different zones.'."\n"
."\n"
.'- The billing method of the instance clusters is consistent.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:CreateDBClusterBinding',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4773E4EC-025D-509F-AEA9-D53123FDFB0F\\\\n\\",\\n \\"Data\\": {\\n \\"DbInstanceName\\": \\"selectdb-cn-7213cjv2ez\\",\\n \\"DbInstanceId\\": \\"6585\\",\\n \\"DbClusterId\\": \\"selectdb-cn-7213cjv2ez-be\\"\\n }\\n}","type":"json"}]',
],
'CreateDBInstance' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '185832',
'abilityTreeNodes' => ['FEATUREselectdb318HEK'],
],
'parameters' => [
[
'name' => 'ResourceGroupId',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzt2zaluvuvqa_fake'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['title' => '', 'description' => 'The client token that is used to ensure the idempotency of the request and prevent repeated submissions. The value is generated by the client, must be unique across different requests, can contain a maximum of 64 ASCII characters, and cannot contain non-ASCII characters.', 'type' => 'string', 'required' => false, 'example' => 'AB'],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => 'The database type. Default value: **selectdb**.', 'type' => 'string', 'default' => 'SelectDB', 'required' => false, 'example' => 'selectdb', 'title' => ''],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => ['description' => 'The database engine version. Default value: **4.1**. Valid values:'."\n"
."\n"
.'- 4.0.'."\n"
."\n"
.'- 4.1.', 'type' => 'string', 'required' => true, 'example' => '4.1', 'title' => ''],
],
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => ['description' => 'The billing method of the instance. Valid values:'."\n"
."\n"
.'- **Postpaid**: pay-as-you-go.'."\n"
."\n"
.'- **Prepaid**: subscription.', 'type' => 'string', 'required' => true, 'example' => 'PrePaid', 'title' => ''],
],
[
'name' => 'UsedTime',
'in' => 'query',
'schema' => ['description' => 'The subscription duration of the instance. Valid values:'."\n"
.'- If Period is set to Year, valid values of UsedTime are 1, 2, 3, 4, and 5.'."\n"
.'- If Period is set to Month, valid values of UsedTime are 1 to 12.'."\n"
.'>This parameter takes effect and is required only when **ChargeType** is set to **Prepaid**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => 'The unit of the subscription duration for the subscription cluster. Valid values:'."\n"
."\n"
.'- **Year**: yearly upfront.'."\n"
.'- **Month**: monthly upfront.'."\n"
.'> This parameter takes effect and is required only when **ChargeType** is set to **Prepaid**.', 'type' => 'string', 'required' => false, 'example' => 'Month', 'title' => ''],
],
[
'name' => 'DBInstanceClass',
'in' => 'query',
'schema' => ['description' => 'The instance specifications. You can call the [DescribeAllDBInstanceClass](~~2853363~~) operation to query available instance specifications.', 'type' => 'string', 'required' => true, 'example' => 'selectdb.xlarge', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-e', 'title' => ''],
],
[
'name' => 'CacheSize',
'in' => 'query',
'schema' => ['description' => 'The reserved cache size.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '200GB', 'title' => ''],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => 'The VPC ID.', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp175iuvg8nxqraf2****', 'title' => ''],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1gzt31twhlo0sa5****', 'title' => ''],
],
[
'name' => 'DBInstanceDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the instance.', 'type' => 'string', 'required' => false, 'example' => 'New instance test', 'title' => ''],
],
[
'name' => 'ConnectionString',
'in' => 'query',
'schema' => ['description' => 'The database endpoint.', 'type' => 'string', 'required' => false, 'example' => 'selectdb-cn-7213c8y****-public.selectdbfe.pre.rds.aliyuncs.com', 'title' => ''],
],
[
'name' => 'SecurityIPList',
'in' => 'query',
'schema' => ['description' => 'The IP address whitelist of the instance. Separate multiple IP addresses with commas (,).', 'type' => 'string', 'required' => false, 'example' => '192.168.1.1', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The list of instance tags.',
'type' => 'array',
'items' => [
'description' => 'The list of instance tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'testKey', 'title' => ''],
'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'testValue', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
[
'name' => 'DeployScheme',
'in' => 'query',
'schema' => [
'description' => 'The deployment mode of the instance.',
'type' => 'string',
'enum' => ['multi_az', 'single_az'],
'required' => false,
'example' => 'single_az',
'title' => '',
],
],
[
'name' => 'MultiZone',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The multi-zone configuration.'."\n"
."\n"
.'> '."\n"
.'> - This parameter takes effect and is required when DeployScheme is set to multi_az.',
'type' => 'array',
'items' => [
'description' => 'The list of zones.',
'type' => 'object',
'properties' => [
'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-k', 'title' => ''],
'VSwitchIds' => [
'description' => 'The list of vSwitch IDs.',
'type' => 'array',
'items' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp10dbralpn4bzmgkkh8f', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 3,
'minItems' => 0,
'title' => '',
'example' => '',
],
],
[
'name' => 'AddVPCIPs',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether to add the VPC CIDR block to the whitelist. Valid values:'."\n"
.'- 1: yes.'."\n"
.'- 0: no.',
'type' => 'string',
'enum' => ['0', '1'],
'required' => false,
'example' => '1',
'title' => '',
],
],
[
'name' => 'ClusterNodeType',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
[
'name' => 'ClusterNodeCount',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
[
'name' => 'ScaleMax',
'in' => 'query',
'schema' => ['type' => 'number', 'format' => 'double', 'default' => '32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
[
'name' => 'ScaleMin',
'in' => 'query',
'schema' => ['type' => 'number', 'format' => 'double', 'default' => '4', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
[
'name' => 'ConfigPatternType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The configuration template applied to the instance.', 'type' => 'string', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4773E4EC-025D-509F-AEA9-D53123FDFB0F'],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '21137950671****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'COMMODITY.INVALID_COMPONENT', 'errorMessage' => 'Order configuration parameters do not meet the verification conditions, please re-match the product.', 'description' => 'Order configuration parameters do not meet the verification conditions, please re-match the product!'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
['errorCode' => 'InvalidVSwitchId.Malformed', 'errorMessage' => 'The specified parameter "VSwitchId" is not valid.', 'description' => 'The parameter VSwitchId is invalid.'],
['errorCode' => 'InvalidMultiZone.NotThreeZones', 'errorMessage' => 'The number of zones must be three.', 'description' => 'The number of multi-availability zones must be three.'],
['errorCode' => 'InvalidZoneId.Duplicated', 'errorMessage' => 'The zones cannot be repeated please select different zones.', 'description' => 'The selected Availability Zone cannot be duplicated'],
['errorCode' => 'EngineVersionDoNotSupportMultiZone', 'errorMessage' => 'The specified engine version doesn\'t support multi zone.', 'description' => 'The specified version does not support the multi_az deploy scheme.'],
['errorCode' => 'InvalidChargeType.Malformed', 'errorMessage' => 'The specified parameter "ChargeType" is not valid.', 'description' => 'The specified parameter "ChargeType" is not valid.'],
['errorCode' => 'InvalidBuyConfigCpuOrCacheSize', 'errorMessage' => 'The specified purchase configuration CPU or cache size is invalid.', 'description' => 'The specified purchase configuration CPU or cache size is invalid.'],
['errorCode' => 'InvalidZoneId.Malformed', 'errorMessage' => 'The specified parameter "ZoneId" is not valid.', 'description' => 'The ZoneId parameter is invalid'],
['errorCode' => 'InvalidVpcId.Malformed', 'errorMessage' => 'The specified parameter "VpcId" is not valid.', 'description' => 'Invalid VpcId parameter'],
['errorCode' => 'ORDER.INST_HAS_UNPAID_ORDER', 'errorMessage' => 'Instance has unpaid order.', 'description' => 'The instance has an unpaid order.'],
['errorCode' => 'OperationDenied.OrderProcessing', 'errorMessage' => 'There are orders in process.', 'description' => 'There are orders in process.'],
['errorCode' => 'InvalidInstanceClass.MultiAZ', 'errorMessage' => 'The instance with 4-core BE cluster does not support multi-zone redundancy.', 'description' => '4-CPU BE clusters do not support multi-zone same-city redundancy.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
['errorCode' => 'INSUFFICIENT_AVAILABLE_QUOTA', 'errorMessage' => 'Your account available limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase'],
['errorCode' => 'OperationDenied.SpecificClassCodeNotSupported', 'errorMessage' => 'The uid is not in specific classcode whitelist.', 'description' => 'The selected specification is not open to the current account.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidVSwitch.NoIP', 'errorMessage' => 'VSwitch has zero available IP.', 'description' => 'VSwitch has zero available IP.'],
['errorCode' => 'InvalidDBClusterClass.NotFound', 'errorMessage' => 'The specified cluster class does not exist.', 'description' => 'The specified cluster class does not exist.'],
['errorCode' => 'InvalidVPC.NotFound', 'errorMessage' => 'VPC or VSwitch is not valid.', 'description' => 'Invalid VPC or VSwitch'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create an instance',
'summary' => 'Creates an ApsaraDB for SelectDB instance.',
'description' => 'Subscription instances cannot be deleted.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'selectdb:CreateDBInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4773E4EC-025D-509F-AEA9-D53123FDFB0F\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"selectdb-cn-7213cjv****\\",\\n \\"OrderId\\": 0\\n }\\n}","type":"json"}]',
],
'CreateElasticRule' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '248767',
'abilityTreeNodes' => ['FEATUREselectdbVAZKUZ'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'."\n", 'title' => ''],
],
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-xxxb9f2w-be'."\n", 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ElasticRuleStartTime',
'in' => 'query',
'schema' => ['description' => 'The start time of the time-based scaling rule.', 'type' => 'string', 'required' => true, 'example' => '00:00', 'title' => ''],
],
[
'name' => 'ExecutionPeriod',
'in' => 'query',
'schema' => [
'description' => 'The execution epoch.',
'enumValueTitles' => ['Day' => 'The rule is executed every day.'],
'type' => 'string',
'required' => true,
'example' => 'Day',
'title' => '',
],
],
[
'name' => 'ClusterClass',
'in' => 'query',
'schema' => ['description' => 'The target compute resource class for the cluster.', 'type' => 'string', 'required' => true, 'example' => 'selectdb.2xlarge', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F8900A96-67F7-5274-A41B-7722E1ECF8C9'],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'DbInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'."\n", 'title' => ''],
'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'selectdb-xxxb9f2w-be', 'title' => ''],
'RuleId' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '5465', 'title' => ''],
'ExecutionPeriod' => [
'description' => 'The execution epoch.',
'enumValueTitles' => ['Day' => 'Day'],
'type' => 'string',
'example' => 'Day',
'title' => '',
],
'ElasticRuleStartTime' => ['description' => 'The start time of the time-based scaling rule.', 'type' => 'string', 'example' => '00:00', 'title' => ''],
'ClusterClass' => ['description' => 'The target compute resource class for the cluster.', 'type' => 'string', 'example' => 'selectdb.2xlarge', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => 'The parameter "DBInstanceId" is illegal.'],
['errorCode' => 'InvalidClusterId.Malformed', 'errorMessage' => 'The specified parameter "ClusterId" is not valid.', 'description' => ''],
['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter "RegionId" is not valid.', 'description' => ''],
['errorCode' => 'InvalidElasticRuleStartTime.Malformed', 'errorMessage' => 'The specified parameter "ElasticRuleStartTime" is not valid.', 'description' => ''],
['errorCode' => 'InvalidExecutionPeriod.Malformed', 'errorMessage' => 'The specified parameter "ExecutionPeriod" is not valid.', 'description' => ''],
['errorCode' => 'InvalidClusterClass.Malformed', 'errorMessage' => 'The specified parameter "ClusterClass" is not valid.', 'description' => ''],
['errorCode' => 'InvalidChargeType.NotSupport', 'errorMessage' => 'The specified parameter "ChargeType" does not meet the requirements.', 'description' => ''],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
['errorCode' => 'InvalidInstanceType', 'errorMessage' => 'The operator is not permitted due to the instance type.', 'description' => 'The operation is prohibited because of the instance type.'],
],
403 => [
['errorCode' => 'OperationDenied.GetResourceLockFailed', 'errorMessage' => 'the operator is not permitted due to get resource lock failed.', 'description' => 'The request was denied because the resource lock failed to be obtained.'],
['errorCode' => 'OperationDenied.AdjacentRulesClusterIsTheSame', 'errorMessage' => 'the operator is not permitted due to adjacent rules cluster class is the same.', 'description' => 'This operation is prohibited because the target computing resources of adjacent timesharing elasticity rules are the same.'],
['errorCode' => 'OperationDenied.AdjacentRulesIntervalLessThanOneHour', 'errorMessage' => 'the operator is not permitted due to adjacent rules interval less than one hour.', 'description' => 'The operation is prohibited because the time interval between adjacent timesharing elasticity rules is less than 1 hour.'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The cluster does not exist.'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'CreateElasticRule',
'summary' => 'Creates a time-based scaling rule.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'selectdb:CreateElasticRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8900A96-67F7-5274-A41B-7722E1ECF8C9\\",\\n \\"Data\\": {\\n \\"DbInstanceId\\": \\"selectdb-cn-7213cjv****\\\\n\\",\\n \\"ClusterId\\": \\"selectdb-xxxb9f2w-be\\",\\n \\"RuleId\\": 5465,\\n \\"ExecutionPeriod\\": \\"Day\\",\\n \\"ElasticRuleStartTime\\": \\"00:00\\",\\n \\"ClusterClass\\": \\"selectdb.2xlarge\\"\\n }\\n}","type":"json"}]',
],
'CreateServiceLinkedRoleForSelectDB' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'none'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'F203FA74-3041-589F-BE66-E570793A0C91'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'SLR.NoPermission', 'errorMessage' => 'No permission for creating AliyunServiceRoleForSelectdb.', 'description' => ''],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'title' => 'CreateServiceLinkedRoleForSelectDB',
'summary' => 'Call this operation to create a service-linked role.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'selectdb:CreateServiceLinkedRoleForSelectDB',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F203FA74-3041-589F-BE66-E570793A0C91\\"\\n}","type":"json"}]',
],
'CreateVirtualCluster' => [
'summary' => 'Creates a virtual cluster.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREselectdbVAZKUZ'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClusterName',
'in' => 'query',
'schema' => ['description' => 'The name of the cluster. The name must start with a letter and be up to 64 characters long. It can contain letters (case-insensitive), digits, and underscores (\\_). The name cannot contain two or more consecutive underscores. The cluster name must be unique within the instance.', 'type' => 'string', 'required' => true, 'example' => 'vcg_demo', 'title' => ''],
],
[
'name' => 'ActiveClusterId',
'in' => 'query',
'schema' => ['description' => 'The ID of the primary cluster.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'."\n"
.'-be', 'title' => ''],
],
[
'name' => 'StandbyClusterId',
'in' => 'query',
'schema' => ['description' => 'The ID of the standby cluster.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-26a3cjv****'."\n"
.'-be', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '5ED62C81-9948-5612-81E1-EA3853752306'],
'Data' => [
'type' => 'object',
'properties' => [
'DbInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
'DbClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv2ez-be', 'title' => ''],
],
'description' => 'The returned data.',
'title' => '',
'example' => '',
],
],
'title' => '',
'description' => 'The response schema.',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => 'The system is abnormal.'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => 'The operation is not supported in the current cluster state.'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidChargeType.NotSupport', 'errorMessage' => 'The specified parameter "ChargeType" does not meet the requirements.', 'description' => ''],
['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', 'description' => 'New Cluster Name'],
['errorCode' => 'InvalidClusterName.Format', 'errorMessage' => 'Specified ClusterName is not valid. It can not be empty string.', 'description' => 'The entered cluster name parameter is invalid.'],
['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The instance version does not support the current operation.', 'description' => 'The instance version does not support the current operation.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.VirtualClusterBound', 'errorMessage' => 'The operation is not permitted due to it has been bound to a virtual cluster.', 'description' => 'Operation is not allowed because it is bound to a virtual cluster.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid parameter, please check.', 'description' => ''],
['errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', 'description' => 'The specified cluster name is not available'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'CreateVirtualCluster',
'description' => 'This operation is supported only for instances that use zone-redundant storage. The following conditions must also be met:'."\n"
."\n"
.'- The minor engine version of the instance is 4.0.7 or later.'."\n"
."\n"
.'- The primary and standby clusters are in different zones.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'selectdb:CreateVirtualCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5ED62C81-9948-5612-81E1-EA3853752306\\",\\n \\"Data\\": {\\n \\"DbInstanceId\\": \\"selectdb-cn-7213cjv****\\",\\n \\"DbClusterId\\": \\"selectdb-cn-7213cjv2ez-be\\"\\n }\\n}","type":"json"}]',
],
'DeleteDBCluster' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '189842',
'abilityTreeNodes' => ['FEATUREselectdb59T2BL'],
],
'parameters' => [
[
'name' => 'ResourceGroupId',
'in' => 'formData',
'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rg-4690g37929****'],
],
[
'name' => 'DBInstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-xxxb9f2w-be', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F203FA74-3041-589F-BE66-E570793A0C91'],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '220088764060782', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
['errorCode' => 'OperationDenied.OrderProcessing', 'errorMessage' => 'There are orders in process.', 'description' => 'There are orders in process.'],
['errorCode' => 'ORDER.INST_HAS_UNPAID_ORDER', 'errorMessage' => 'Instance has unpaid order.', 'description' => 'The instance has an unpaid order.'],
['errorCode' => 'InvalidInstanceClass.MultiAZ', 'errorMessage' => 'The instance with 4-core BE cluster does not support multi-zone redundancy.', 'description' => '4-CPU BE clusters do not support multi-zone same-city redundancy.'],
['errorCode' => 'InvalidInstanceClass.ForMultiAZ', 'errorMessage' => 'The instance with 4-core BE cluster does not support upgrading to multi-zone redundancy.', 'description' => '4-CPU BE clusters do not support multi-zone same-city redundancy.'],
],
403 => [
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
['errorCode' => 'OperationDenied.VirtualClusterBound', 'errorMessage' => 'The operation is not permitted due to it has been bound to a virtual cluster.', 'description' => 'Operation is not allowed because it is bound to a virtual cluster.'],
],
[
['errorCode' => 'InvalidDBClusterState.NotSupport', 'errorMessage' => 'The specified cluster state does\'t support this operation.', 'description' => 'This operation is not supported in the cluster state.'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'InvalidDBClusterVpc.MismatchWithInstance', 'errorMessage' => 'The specified cluster vpc doesn\'t match with instance.', 'description' => 'The specified cluster vpc doesn\'t match with instance.'],
['errorCode' => 'InvalidClusterInstance.NotFound', 'errorMessage' => 'Specified cluster instance does not exist.', 'description' => 'SelectDB instance does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DeleteDBCluster',
'summary' => 'Deletes a cluster from an instance.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:DeleteDBCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F203FA74-3041-589F-BE66-E570793A0C91\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"selectdb-cn-7213cjv****\\",\\n \\"OrderId\\": \\"220088764060782\\"\\n }\\n}","type":"json"}]',
],
'DeleteDBClusterBinding' => [
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREselectdbVAZKUZ'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv2ez', 'title' => ''],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => 'The ID of Cluster 1.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv2ez-be'."\n", 'title' => ''],
],
[
'name' => 'DBClusterIdBak',
'in' => 'query',
'schema' => ['description' => 'The ID of Cluster 2.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-xxxb9f2w-be'."\n", 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F8900A96-67F7-5274-A41B-7722E1ECF8C9'."\n"],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => 'The system is abnormal.'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => 'The operation is not supported in the current cluster state.'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', 'description' => 'The specified cluster name is not available'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid parameter, please check.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DeleteDBClusterBinding',
'summary' => 'Deletes the binding relationship between two clusters for mutual backup.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:DeleteDBClusterBinding',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8900A96-67F7-5274-A41B-7722E1ECF8C9\\\\n\\"\\n}","type":"json"}]',
],
'DeleteDBInstance' => [
'summary' => 'Deletes a specified ApsaraDB SelectDB instance.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '185833',
'abilityTreeNodes' => ['FEATUREselectdb7H9T89'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'formData',
'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'BD0D0B17-C145-5B91-BFC2-6791927EE973'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => ''],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'OperationDenied.DBInstancePayType', 'errorMessage' => 'The operation is not permitted due to the pay type of cluster.', 'description' => 'The billing method of the current instance does not support this operation.'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DeleteDBInstance',
'description' => 'Subscription instances cannot be deleted.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'selectdb:DeleteDBInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BD0D0B17-C145-5B91-BFC2-6791927EE973\\"\\n}","type":"json"}]',
],
'DeleteElasticRule' => [
'summary' => 'Deletes a scheduled scaling rule.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '248785',
'abilityTreeNodes' => ['FEATUREselectdbVAZKUZ'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Product',
'in' => 'query',
'schema' => ['description' => 'The cloud service.', 'type' => 'string', 'default' => 'selectdb', 'required' => false, 'example' => 'selectdb', 'title' => ''],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'."\n", 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hanghzou', 'title' => ''],
],
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-xxx302i5-be', 'title' => ''],
],
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100458', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4773E4EC-025D-509F-AEA9-D53123FDFB0F'],
'Success' => [
'description' => 'Indicates whether the deletion is successful.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- true'."\n"
."\n"
.'- false',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => 'The parameter "DBInstanceId" is illegal.'],
['errorCode' => 'InvalidClusterId.Malformed', 'errorMessage' => 'The specified parameter "ClusterId" is not valid.', 'description' => ''],
['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter "RegionId" is not valid.', 'description' => ''],
['errorCode' => 'InvalidRuleId.Malformed', 'errorMessage' => 'The specified parameter "RuleId" is not valid.', 'description' => ''],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'OperationDenied.GetResourceLockFailed', 'errorMessage' => 'the operator is not permitted due to get resource lock failed.', 'description' => 'The request was denied because the resource lock failed to be obtained.'],
['errorCode' => 'OperationDenied.AdjacentRulesClusterIsTheSame', 'errorMessage' => 'the operator is not permitted due to adjacent rules cluster class is the same.', 'description' => 'This operation is prohibited because the target computing resources of adjacent timesharing elasticity rules are the same.'],
['errorCode' => 'OperationDenied.AdjacentRulesIntervalLessThanOneHour', 'errorMessage' => 'the operator is not permitted due to adjacent rules interval less than one hour.', 'description' => 'The operation is prohibited because the time interval between adjacent timesharing elasticity rules is less than 1 hour.'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidElasticRuleId.NotFound', 'errorMessage' => 'The ElasticRuleId provided does not exist in our records.', 'description' => 'Time-sharing elasticity rule does not exist.'],
['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The cluster does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DeleteElasticRule',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'selectdb:DeleteElasticRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4773E4EC-025D-509F-AEA9-D53123FDFB0F\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DeleteVirtualCluster' => [
'summary' => 'Deletes a virtual cluster.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREselectdbVAZKUZ'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => 'The virtual cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-vcg-72vz***-be', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '06758CAB-1204-5852-A471-29C87D5C1D0F'],
'Data' => [
'type' => 'object',
'properties' => [
'DbInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'."\n", 'title' => ''],
'DbClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'selectdb-cn-wny3li0****-be', 'title' => ''],
],
'description' => 'The returned data.',
'title' => '',
'example' => '',
],
],
'title' => '',
'description' => 'Schema of Response',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => 'The system is abnormal.'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => 'The operation is not supported in the current cluster state.'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', 'description' => 'The specified cluster name is not available'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid parameter, please check.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DeleteVirtualCluster',
'description' => '> - This operation deletes only the virtual cluster. It **does not** delete the attached primary or secondary cluster.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'selectdb:DeleteVirtualCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06758CAB-1204-5852-A471-29C87D5C1D0F\\",\\n \\"Data\\": {\\n \\"DbInstanceId\\": \\"selectdb-cn-7213cjv****\\\\n\\",\\n \\"DbClusterId\\": \\"selectdb-cn-wny3li0****-be\\"\\n }\\n}","type":"json"}]',
],
'DescribeAllDBInstanceClass' => [
'summary' => 'Retrieves all instance type information.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '211772',
'abilityTreeNodes' => ['FEATUREselectdb8OHQ00'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '4773E4EC-025D-509F-AEA9-D53123FDFB0F'."\n"],
'ClassCodeList' => [
'description' => 'Instance type list.',
'type' => 'array',
'items' => [
'description' => 'Instance type.',
'type' => 'object',
'properties' => [
'ClassCode' => ['description' => 'Type code.', 'type' => 'string', 'example' => 'selectdb.xlarge', 'title' => ''],
'CpuCores' => ['description' => 'Number of CPU cores.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''],
'MemoryInGB' => ['description' => 'Memory.', 'type' => 'integer', 'format' => 'int64', 'example' => '16', 'title' => ''],
'DefaultStorageInGB' => ['description' => 'Default cache.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'MinStorageInGB' => ['description' => 'Minimum cache.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'MaxStorageInGB' => ['description' => 'Maximum cache.', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', 'title' => ''],
'StepStorageInGB' => ['description' => 'Cache increment.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DescribeAllDBInstanceClass',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:DescribeAllDBInstanceClass',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4773E4EC-025D-509F-AEA9-D53123FDFB0F\\\\n\\",\\n \\"ClassCodeList\\": [\\n {\\n \\"ClassCode\\": \\"selectdb.xlarge\\",\\n \\"CpuCores\\": 4,\\n \\"MemoryInGB\\": 16,\\n \\"DefaultStorageInGB\\": 200,\\n \\"MinStorageInGB\\": 100,\\n \\"MaxStorageInGB\\": 2000,\\n \\"StepStorageInGB\\": 100\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeDBClusterConfig' => [
'summary' => 'Queries the configuration information about a cluster in an ApsaraDB for SelectDB instance.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '213180',
'abilityTreeNodes' => ['FEATUREselectdb7TFVYR'],
],
'parameters' => [
[
'name' => 'ConfigKey',
'in' => 'query',
'schema' => [
'description' => 'The configuration file to be modified.'."\n"
."\n"
.'- For a compute cluster, set the value to be.conf.'."\n"
."\n"
.'- For a frontend (FE) cluster, set the value to fe.conf.',
'enumValueTitles' => ['fe.conf' => 'fe.conf', 'be.conf' => 'be.conf'],
'type' => 'string',
'required' => true,
'example' => 'be.conf',
'title' => '',
],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213c8yvv09-be', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResponse',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'Data' => [
'description' => 'The information returned.',
'type' => 'object',
'properties' => [
'DbInstanceName' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-wny3li0****', 'title' => ''],
'DbInstanceId' => ['description' => 'The numeric ID of the instance.', 'type' => 'string', 'example' => '6585', 'title' => ''],
'DbClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'selectdb-cn-wny3li0****-be', 'title' => ''],
'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '107841167', 'title' => ''],
'Params' => [
'description' => 'The details about each parameter returned.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'doris_scanner_thread_pool_thread_num', 'title' => ''],
'Optional' => ['description' => 'The value range of the parameter.', 'type' => 'string', 'example' => '[0-20000]', 'title' => ''],
'Comment' => ['description' => 'The comments on the parameter.', 'type' => 'string', 'example' => '存储引擎并发扫描硬盘的线程数。采用线程池统一管理。', 'title' => ''],
'Value' => ['description' => 'The current value of the parameter.', 'type' => 'string', 'example' => '10', 'title' => ''],
'ParamCategory' => ['description' => 'The category of the parameter.', 'type' => 'string', 'example' => 'Query', 'title' => ''],
'DefaultValue' => ['description' => 'The default value of the parameter.', 'type' => 'string', 'example' => '15', 'title' => ''],
'IsDynamic' => ['description' => 'Indicates whether the parameter immediately takes effect without requiring a restart.', 'type' => 'integer', 'format' => 'int32', 'example' => 'true', 'title' => ''],
'IsUserModifiable' => ['description' => 'Indicates whether the parameter is modifiable.', 'type' => 'integer', 'format' => 'int32', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'DynamicCode' => ['description' => 'The dynamic code. This parameter is not returned.', 'type' => 'string', 'example' => '0', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message. This parameter is not returned.', 'type' => 'string', 'example' => 'An error occurred while processing your request.', 'title' => ''],
'AccessDeniedDetail' => ['description' => 'The details about the access denial. This parameter is returned only if Resource Access Management (RAM) authentication failed.', 'type' => 'string', 'example' => 'failed', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ADF42B18-43FD-5100-83A9-BE81AB70C863', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => 'The parameter "DBInstanceId" is illegal.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"DbInstanceName\\": \\"selectdb-cn-wny3li0****\\",\\n \\"DbInstanceId\\": \\"6585\\",\\n \\"DbClusterId\\": \\"selectdb-cn-wny3li0****-be\\",\\n \\"TaskId\\": 107841167,\\n \\"Params\\": [\\n {\\n \\"Name\\": \\"doris_scanner_thread_pool_thread_num\\",\\n \\"Optional\\": \\"[0-20000]\\",\\n \\"Comment\\": \\"存储引擎并发扫描硬盘的线程数。采用线程池统一管理。\\",\\n \\"Value\\": \\"10\\",\\n \\"ParamCategory\\": \\"Query\\",\\n \\"DefaultValue\\": \\"15\\",\\n \\"IsDynamic\\": 0,\\n \\"IsUserModifiable\\": 0\\n }\\n ]\\n },\\n \\"DynamicCode\\": \\"0\\",\\n \\"DynamicMessage\\": \\"An error occurred while processing your request.\\",\\n \\"AccessDeniedDetail\\": \\"failed\\",\\n \\"RequestId\\": \\"ADF42B18-43FD-5100-83A9-BE81AB70C863\\"\\n}","type":"json"}]',
'title' => 'DescribeDBClusterConfig',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:DescribeDBClusterConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'translator' => 'manual',
],
'DescribeDBClusterConfigChangeLogs' => [
'summary' => 'Queries the change logs for cluster configurations.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '213178',
'abilityTreeNodes' => ['FEATUREselectdb7TFVYR'],
],
'parameters' => [
[
'name' => 'ConfigKey',
'in' => 'query',
'schema' => ['description' => 'The configuration file that was modified. The value is \\`be.conf\\` for a compute cluster and \\`fe.conf\\` for an FE cluster.', 'type' => 'string', 'required' => false, 'example' => 'be.conf', 'title' => ''],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213c8****-be', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213c8****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The start time to query change logs. The format is \\`yyyy-MM-dd HH:mm:ss\\`.', 'type' => 'string', 'required' => true, 'example' => '2023-04-25 09:48:23', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end time to query change logs. The format is \\`yyyy-MM-dd HH:mm:ss\\`.', 'type' => 'string', 'required' => true, 'example' => '2023-05-08 15:59:59', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResponse',
'description' => 'PlainResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'DbInstanceName' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213c8****', 'title' => ''],
'DbInstanceId' => ['description' => 'The numeric ID of the instance.', 'type' => 'string', 'example' => '6585', 'title' => ''],
'DbClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213c8****-be', 'title' => ''],
'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '107841167', 'title' => ''],
'ParamChangeLogs' => [
'description' => 'The parameter change logs.',
'type' => 'array',
'items' => [
'description' => 'The parameter change logs.',
'type' => 'object',
'properties' => [
'Id' => ['description' => 'The ID of the change record.', 'type' => 'integer', 'format' => 'int64', 'example' => '617975', 'title' => ''],
'Name' => ['description' => 'The name of the configuration item.', 'type' => 'string', 'example' => 'cumulative_compaction_rounds_for_each_base_compaction_round', 'title' => ''],
'OldValue' => ['description' => 'The original parameter value.', 'type' => 'string', 'example' => '10', 'title' => ''],
'NewValue' => ['description' => 'The new parameter value.', 'type' => 'string', 'example' => '12', 'title' => ''],
'IsApplied' => ['description' => 'Indicates whether the configuration has taken effect.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'GmtCreated' => ['description' => 'The time when the task was created. The time is in GMT.', 'type' => 'string', 'example' => '2022-10-11T08:53:32Z', 'title' => ''],
'GmtModified' => ['description' => 'The time when the task was last modified. The time is in GMT.', 'type' => 'string', 'example' => '2024-03-08T10:08Z', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'DynamicCode' => ['description' => 'The dynamic code. This parameter is not used. Ignore this parameter.', 'type' => 'string', 'example' => '0', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message. This parameter is not used. Ignore this parameter.', 'type' => 'string', 'example' => 'An error occurred while processing your request.', 'title' => ''],
'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'failed', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F8900A96-67F7-5274-A41B-7722E1ECF8C9', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
['errorCode' => 'InvalidEndTime.Format', 'errorMessage' => 'Specified end time is not valid.', 'description' => 'The specified jie time is not a valid parameter.'],
['errorCode' => 'InvalidStartTime.Format', 'errorMessage' => 'Specified start time is not valid.', 'description' => 'The specified start time is not a valid parameter.'],
['errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time.', 'description' => 'The end time must be greater than the start time.'],
['errorCode' => 'InvalidConfigKey.Malformed', 'errorMessage' => 'The specified parameter "ConfigKey" is not valid.', 'description' => 'The specified parameter Parameters is not a valid parameter.'],
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => 'The parameter "DBInstanceId" is illegal.'],
['errorCode' => 'InvalidClusterId.Malformed', 'errorMessage' => 'The specified parameter "ClusterId" is not valid.', 'description' => ''],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', 'description' => 'The specified cluster name is not available'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DescribeDBClusterConfigChangeLogs',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:DescribeDBClusterConfigChangeLogs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"DbInstanceName\\": \\"selectdb-cn-7213c8****\\",\\n \\"DbInstanceId\\": \\"6585\\",\\n \\"DbClusterId\\": \\"selectdb-cn-7213c8****-be\\",\\n \\"TaskId\\": 107841167,\\n \\"ParamChangeLogs\\": [\\n {\\n \\"Id\\": 617975,\\n \\"Name\\": \\"cumulative_compaction_rounds_for_each_base_compaction_round\\",\\n \\"OldValue\\": \\"10\\",\\n \\"NewValue\\": \\"12\\",\\n \\"IsApplied\\": false,\\n \\"GmtCreated\\": \\"2022-10-11T08:53:32Z\\",\\n \\"GmtModified\\": \\"2024-03-08T10:08Z\\"\\n }\\n ]\\n },\\n \\"DynamicCode\\": \\"0\\",\\n \\"DynamicMessage\\": \\"An error occurred while processing your request.\\",\\n \\"AccessDeniedDetail\\": \\"failed\\",\\n \\"RequestId\\": \\"F8900A96-67F7-5274-A41B-7722E1ECF8C9\\"\\n}","type":"json"}]',
],
'DescribeDBClusterStorageLimitation' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '222354',
'abilityTreeNodes' => ['FEATUREselectdbMUDYZN'],
],
'parameters' => [
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213c8****-be', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-28t3qs****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'type' => 'object',
'properties' => [
'ClassCodeList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ClassCode' => ['description' => 'The specification code.', 'type' => 'string', 'example' => 'selectdb.xlarge', 'title' => ''],
'CpuCores' => ['description' => 'The number of vCPU cores.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
'MemoryInGB' => ['description' => 'The memory size in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''],
'DefaultStorageInGB' => ['description' => 'The default cache size in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''],
'MinStorageInGB' => ['description' => 'The minimum cache size in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'MaxStorageInGB' => ['description' => 'The maximum cache size in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''],
'StepStorageInGB' => ['description' => 'The cache step size in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'description' => 'The details of the cache specification.',
'title' => '',
'example' => '',
],
'description' => 'The list of cache specifications.',
'title' => '',
'example' => '',
],
],
'description' => 'The returned data.',
'title' => '',
'example' => '',
],
'DynamicCode' => ['description' => 'The dynamic code. This parameter is not used. Ignore this parameter.', 'type' => 'string', 'example' => '0', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message. This parameter is not used. Ignore this parameter.', 'type' => 'string', 'example' => 'An error occurred while processing your request.', 'title' => ''],
'AccessDeniedDetail' => ['description' => 'The details of the access denial. This field is returned only when the RAM verification fails.', 'type' => 'string', 'example' => 'failed', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4773E4EC-025D-509F-AEA9-D53123FDFB0F', 'title' => ''],
],
'title' => '',
'description' => 'PlainResponse',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => 'The parameter "DBInstanceId" is illegal.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DescribeDBClusterStorageLimitation',
'summary' => 'Queries the cache limits for each cluster specification.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:DescribeDBClusterStorageLimitation',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ClassCodeList\\": [\\n {\\n \\"ClassCode\\": \\"selectdb.xlarge\\",\\n \\"CpuCores\\": 4,\\n \\"MemoryInGB\\": 16,\\n \\"DefaultStorageInGB\\": 8,\\n \\"MinStorageInGB\\": 2,\\n \\"MaxStorageInGB\\": 16,\\n \\"StepStorageInGB\\": 1\\n }\\n ]\\n },\\n \\"DynamicCode\\": \\"0\\",\\n \\"DynamicMessage\\": \\"An error occurred while processing your request.\\",\\n \\"AccessDeniedDetail\\": \\"failed\\",\\n \\"RequestId\\": \\"4773E4EC-025D-509F-AEA9-D53123FDFB0F\\"\\n}","type":"json"}]',
],
'DescribeDBInstanceAttribute' => [
'summary' => 'Gets the details of a specified instance.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '189179',
'abilityTreeNodes' => ['FEATUREselectdb72PXTX'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response schema.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '06758CAB-1204-5852-A471-29C87D5C1D0F'],
'Status' => ['description' => 'The state of the instance. Valid values:'."\n"
."\n"
.'- **CREATING**: The instance is being created.'."\n"
."\n"
.'- **ACTIVE**: The instance is running.'."\n"
."\n"
.'- **RESOURCE\\_CHANGING**: The instance configuration is being changed.'."\n"
."\n"
.'- **ORDER\\_PREPARING**: The order is being confirmed.'."\n"
."\n"
.'- **READONLY\\_RESOURCE\\_CHANGING**: The instance configuration is being changed, and the instance is write-locked.'."\n"
."\n"
.'- **DELETING**: The instance is being deleted.', 'type' => 'string', 'example' => 'ACTIVE', 'title' => ''],
'SubDomain' => ['description' => 'The subdomain.', 'type' => 'string', 'example' => 'Reserved parameter.', 'title' => ''],
'GmtModified' => ['description' => 'The time when the instance was last modified. The time is in `yyyy-MM-ddTHH:mmZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2023-08-17T09:58Z', 'title' => ''],
'LockMode' => ['description' => 'The lock mode of the instance. A value of **lock** indicates that the instance was automatically locked due to an expired subscription or an overdue payment.', 'type' => 'integer', 'format' => 'int64', 'example' => 'lock', 'title' => ''],
'LockReason' => ['description' => 'The reason the instance is locked.', 'type' => 'string', 'example' => 'nolock', 'title' => ''],
'ResourceCpu' => ['description' => 'The number of CPU cores.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''],
'StorageSize' => ['description' => 'The storage space, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '400', 'title' => ''],
'ObjectStoreSize' => ['description' => 'The object storage space, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'MaintainStarttime' => ['description' => 'The start time of the maintenance window.', 'type' => 'string', 'example' => 'Reserved parameter.', 'title' => ''],
'MaintainEndtime' => ['description' => 'The end time of the maintenance window.', 'type' => 'string', 'example' => 'Reserved parameter.', 'title' => ''],
'DBClusterList' => [
'description' => 'A list of clusters in the instance.',
'type' => 'array',
'items' => [
'description' => 'The details of a cluster.',
'type' => 'object',
'properties' => [
'DbInstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'Instance test', 'title' => ''],
'DbClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'selectdb-cn-h033cjs****-be', 'title' => ''],
'DbClusterName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'test01', 'title' => ''],
'Status' => ['description' => 'The state of the cluster. Valid values:'."\n"
."\n"
.'- **CREATING**: The cluster is being created.'."\n"
."\n"
.'- **ACTIVATION**: The cluster is running.'."\n"
."\n"
.'- **RESOURCE\\_CHANGING**: The cluster configuration is being changed.'."\n"
."\n"
.'- **ORDER\\_PREPARING**: The order is being confirmed.'."\n"
."\n"
.'- **READONLY\\_RESOURCE\\_CHANGING**: The cluster configuration is being changed, and the cluster is write-locked.'."\n"
."\n"
.'- **DELETING**: The cluster is being deleted.', 'type' => 'string', 'example' => 'ACTIVATION', 'title' => ''],
'CreatedTime' => ['description' => 'The time when the cluster was created.', 'type' => 'string', 'example' => '2023-08-14T09:24:13Z', 'title' => ''],
'DbClusterClass' => ['description' => 'The cluster class. Valid values:'."\n"
."\n"
.'- **selectdb.xlarge**: 4 CPU cores, 16 GB of memory.'."\n"
."\n"
.'- **selectdb.2xlarge**: 8 CPU cores, 32 GB of memory.'."\n"
."\n"
.'- **selectdb.4xlarge**: 16 CPU cores, 64 GB of memory.'."\n"
."\n"
.'- **selectdb.8xlarge**: 32 CPU cores, 128 GB of memory.'."\n"
."\n"
.'- **selectdb.16xlarge**: 64 CPU cores, 256 GB of memory.'."\n"
."\n"
.'- **selectdb.24xlarge**: 96 CPU cores, 384 GB of memory.'."\n"
."\n"
.'- **selectdb.32xlarge**: 128 CPU cores, 512 GB of memory.', 'type' => 'string', 'example' => 'selectdb.2xlarge', 'title' => ''],
'CpuCores' => ['description' => 'The number of CPU cores.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''],
'Memory' => ['description' => 'The memory size, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '64', 'title' => ''],
'CacheStorageType' => ['description' => 'The cache storage type.', 'type' => 'string', 'example' => 'cloud_essd', 'title' => ''],
'PerformanceLevel' => ['description' => 'The performance level.', 'type' => 'string', 'example' => 'PL1', 'title' => ''],
'CacheStorageSizeGB' => ['description' => 'The cache storage size, in GB.', 'type' => 'string', 'example' => '200', 'title' => ''],
'StartTime' => ['description' => 'The time when the cluster was started.', 'type' => 'string', 'example' => '2023-08-14T09:24:13Z', 'title' => ''],
'ChargeType' => ['description' => 'The billing method of the cluster. Valid values:'."\n"
."\n"
.'- **Postpaid**: pay-as-you-go'."\n"
."\n"
.'- **Prepaid**: subscription', 'type' => 'string', 'example' => 'Prepaid', 'title' => ''],
'ModifiedTime' => ['description' => 'The time when the cluster was last modified.', 'type' => 'string', 'example' => '2024-07-02T16:35:44+08:00', 'title' => ''],
'ScalingRulesEnable' => ['description' => 'Indicates whether a scheduled scaling policy is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-k', 'title' => ''],
'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-t4n8x7jcc8rknon85tqoa', 'title' => ''],
'SubDomain' => ['description' => 'The subdomain.', 'type' => 'string', 'example' => '预留参数,暂不返回。', 'title' => ''],
'ClusterBinding' => ['description' => 'The ID of the target cluster to which this cluster is bound.', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****-be', 'title' => ''],
'ClusterNodeType' => [
'description' => 'The cluster node type. This parameter applies only to serverless instances.',
'enumValueTitles' => ['base' => 'The CPU-to-memory ratio is 1:4 per SCU.'],
'type' => 'string',
'example' => 'base',
'title' => '',
],
'ClusterNodeCount' => ['description' => 'The number of nodes in the cluster. This parameter applies only to serverless instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'ScaleMax' => ['description' => 'The maximum value of the auto-scaling range for the cluster\'s RDS Capacity Units (RCUs).', 'type' => 'number', 'format' => 'double', 'example' => '4', 'title' => ''],
'ScaleMin' => ['description' => 'The minimum value of the auto-scaling range for the cluster\'s RDS Capacity Units (RCUs).', 'type' => 'number', 'format' => 'double', 'example' => '0.5', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Engine' => ['description' => 'The database engine.', 'type' => 'string', 'example' => 'selectdb', 'title' => ''],
'EngineVersion' => ['description' => 'The database engine version.', 'type' => 'string', 'example' => '2.4', 'title' => ''],
'EngineMinorVersion' => ['description' => 'The minor engine version of the instance.', 'type' => 'string', 'example' => '3.0.1', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
'Description' => ['description' => 'The instance description.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'CreateTime' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2023-08-14T03:00:42Z', 'title' => ''],
'CanUpgradeVersions' => [
'description' => 'The engine versions to which the instance can be upgraded.',
'type' => 'array',
'items' => ['description' => 'An engine version available for an upgrade.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'title' => '',
'example' => '',
],
'ChargeType' => ['description' => 'The billing method of the instance. Valid values:'."\n"
."\n"
.'- **Postpaid**: pay-as-you-go'."\n"
."\n"
.'- **Prepaid**: subscription', 'type' => 'string', 'example' => 'Prepaid', 'title' => ''],
'ExpireTime' => ['description' => 'The expiration time of the subscription instance.', 'type' => 'string', 'example' => '2023-09-17T00:00Z', 'title' => ''],
'ResourceGroupId' => ['description' => 'The ID of the instance\'s resource group.', 'type' => 'string', 'example' => 'rg-aekzbck4asz3dsa', 'title' => ''],
'Tags' => [
'description' => 'A list of tags attached to the instance.',
'type' => 'array',
'items' => [
'description' => 'A tag attached to the instance.',
'type' => 'object',
'properties' => [
'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'testKey', 'title' => ''],
'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'testValue', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID of the instance.', 'type' => 'string', 'example' => 'cn-beijing-h', 'title' => ''],
'VpcId' => ['description' => 'The VPC ID of the instance.', 'type' => 'string', 'example' => 'vpc-bp175iuvg8nxqraf2****', 'title' => ''],
'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp18iztwqrs8qj2nc6nyu', 'title' => ''],
'DeployScheme' => ['description' => 'The instance deployment mode.', 'type' => 'string', 'example' => 'multi_az', 'title' => ''],
'MultiZone' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-k', 'title' => ''],
'VSwitchIds' => [
'type' => 'array',
'items' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp10dbralpn4bzmgkkh8f', 'title' => ''],
'description' => 'A list of vSwitch IDs.',
'title' => '',
'example' => '',
],
'Cidr' => ['description' => 'The CIDR block.', 'type' => 'string', 'example' => '113.88.14.211/32', 'title' => ''],
'AvailableIpCount' => ['description' => 'The number of available IP addresses in the zone.', 'type' => 'integer', 'format' => 'int64', 'example' => '4096', 'title' => ''],
],
'description' => 'The details of a zone in the multi-zone deployment.',
'title' => '',
'example' => '',
],
'description' => 'The multi-zone configuration.'."\n"
."\n"
.'> - This parameter is returned only if the `DeployScheme` parameter is set to `multi_az`.',
'title' => '',
'example' => '',
],
'Serverless' => ['description' => 'Indicates whether the serverless feature is enabled for the instance.'."\n"
."\n"
.'- `true`: Enabled.'."\n"
."\n"
.'- `false`: Disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'SecGroupConnValid' => ['description' => 'Indicates whether the direct port connection feature is enabled for the instance\'s VPC.'."\n"
."\n"
.'- `true`: Enabled.'."\n"
."\n"
.'- `false`: Disabled.', 'type' => 'string', 'example' => 'false', 'title' => ''],
'VirtualClusterList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DbClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'selectdb-vcg-33cjs****-be', 'title' => ''],
'DbClusterName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'vgcdemo', 'title' => ''],
'Status' => ['description' => 'The state of the virtual cluster. Valid values:'."\n"
."\n"
.'- **CREATING**: The virtual cluster is being created.'."\n"
."\n"
.'- **RUNNING**: The virtual cluster is running.'."\n"
."\n"
.'- **DELETING**: The virtual cluster is being deleted.'."\n"
."\n"
.'- **UPDATING**: The virtual cluster is being updated.', 'type' => 'string', 'example' => 'UPDATING', 'title' => ''],
'CreatedTime' => ['description' => 'The time when the virtual cluster was created.', 'type' => 'string', 'example' => '2025-05-31T21:01:09Z', 'title' => ''],
'ActiveClusterId' => ['description' => 'The ID of the primary cluster.', 'type' => 'string', 'example' => 'selectdb-xx78***-be', 'title' => ''],
'ActiveClusterName' => ['description' => 'The name of the primary cluster.', 'type' => 'string', 'example' => 'test1', 'title' => ''],
'StandbyClusterId' => ['description' => 'The ID of the standby cluster.', 'type' => 'string', 'example' => 'selectdb-x6u7***-be'."\n", 'title' => ''],
'StandbyClusterName' => ['description' => 'The name of the standby cluster.', 'type' => 'string', 'example' => 'test2', 'title' => ''],
],
'description' => 'The details of a virtual cluster.',
'title' => '',
'example' => '',
],
'description' => 'A list of virtual clusters.',
'title' => '',
'example' => '',
],
'ConfigPatternType' => ['description' => 'The configuration template applied to the instance.', 'type' => 'string', 'title' => '', 'example' => 'log'],
'OTelGrafanaServiceStatus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'OTelBearerToken' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'LangfuseInstanceIds' => [
'type' => 'array',
'items' => ['type' => 'string', 'example' => 'lfu-xxkshuf23sdj', 'description' => '', 'title' => ''],
'description' => '',
'title' => '',
'example' => '',
],
'CanUpgradeVersionCommunityMap' => [
'type' => 'object',
'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
'CommunityVersion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'MCPServerServiceStatus' => ['type' => 'string', 'example' => 'not_enabled', 'description' => '', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', 'description' => 'New Cluster Name'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'InvalidClusterInstance.NotFound', 'errorMessage' => 'Specified cluster instance does not exist.', 'description' => 'SelectDB instance does not exist.'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06758CAB-1204-5852-A471-29C87D5C1D0F\\",\\n \\"Status\\": \\"ACTIVE\\",\\n \\"SubDomain\\": \\"Reserved parameter.\\",\\n \\"GmtModified\\": \\"2023-08-17T09:58Z\\",\\n \\"LockMode\\": 0,\\n \\"LockReason\\": \\"nolock\\",\\n \\"ResourceCpu\\": 8,\\n \\"StorageSize\\": 400,\\n \\"ObjectStoreSize\\": 0,\\n \\"MaintainStarttime\\": \\"Reserved parameter.\\",\\n \\"MaintainEndtime\\": \\"Reserved parameter.\\",\\n \\"DBClusterList\\": [\\n {\\n \\"DbInstanceName\\": \\"Instance test\\",\\n \\"DbClusterId\\": \\"selectdb-cn-h033cjs****-be\\",\\n \\"DbClusterName\\": \\"test01\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"CreatedTime\\": \\"2023-08-14T09:24:13Z\\",\\n \\"DbClusterClass\\": \\"selectdb.2xlarge\\",\\n \\"CpuCores\\": 8,\\n \\"Memory\\": 64,\\n \\"CacheStorageType\\": \\"cloud_essd\\",\\n \\"PerformanceLevel\\": \\"PL1\\",\\n \\"CacheStorageSizeGB\\": \\"200\\",\\n \\"StartTime\\": \\"2023-08-14T09:24:13Z\\",\\n \\"ChargeType\\": \\"Prepaid\\",\\n \\"ModifiedTime\\": \\"2024-07-02T16:35:44+08:00\\",\\n \\"ScalingRulesEnable\\": false,\\n \\"ZoneId\\": \\"cn-hangzhou-k\\",\\n \\"VSwitchId\\": \\"vsw-t4n8x7jcc8rknon85tqoa\\",\\n \\"SubDomain\\": \\"预留参数,暂不返回。\\",\\n \\"ClusterBinding\\": \\"selectdb-cn-7213cjv****-be\\",\\n \\"ClusterNodeType\\": \\"base\\",\\n \\"ClusterNodeCount\\": 1,\\n \\"ScaleMax\\": 4,\\n \\"ScaleMin\\": 0.5\\n }\\n ],\\n \\"Engine\\": \\"selectdb\\",\\n \\"EngineVersion\\": \\"2.4\\",\\n \\"EngineMinorVersion\\": \\"3.0.1\\",\\n \\"DBInstanceId\\": \\"selectdb-cn-7213cjv****\\",\\n \\"Description\\": \\"test\\",\\n \\"CreateTime\\": \\"2023-08-14T03:00:42Z\\",\\n \\"CanUpgradeVersions\\": [\\n \\"test\\"\\n ],\\n \\"ChargeType\\": \\"Prepaid\\",\\n \\"ExpireTime\\": \\"2023-09-17T00:00Z\\",\\n \\"ResourceGroupId\\": \\"rg-aekzbck4asz3dsa\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"testKey\\",\\n \\"TagValue\\": \\"testValue\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-h\\",\\n \\"VpcId\\": \\"vpc-bp175iuvg8nxqraf2****\\",\\n \\"VSwitchId\\": \\"vsw-bp18iztwqrs8qj2nc6nyu\\",\\n \\"DeployScheme\\": \\"multi_az\\",\\n \\"MultiZone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-k\\",\\n \\"VSwitchIds\\": [\\n \\"vsw-bp10dbralpn4bzmgkkh8f\\"\\n ],\\n \\"Cidr\\": \\"113.88.14.211/32\\",\\n \\"AvailableIpCount\\": 4096\\n }\\n ],\\n \\"Serverless\\": false,\\n \\"SecGroupConnValid\\": \\"false\\",\\n \\"VirtualClusterList\\": [\\n {\\n \\"DbClusterId\\": \\"selectdb-vcg-33cjs****-be\\",\\n \\"DbClusterName\\": \\"vgcdemo\\",\\n \\"Status\\": \\"UPDATING\\",\\n \\"CreatedTime\\": \\"2025-05-31T21:01:09Z\\",\\n \\"ActiveClusterId\\": \\"selectdb-xx78***-be\\",\\n \\"ActiveClusterName\\": \\"test1\\",\\n \\"StandbyClusterId\\": \\"selectdb-x6u7***-be\\\\n\\",\\n \\"StandbyClusterName\\": \\"test2\\"\\n }\\n ],\\n \\"ConfigPatternType\\": \\"log\\",\\n \\"OTelGrafanaServiceStatus\\": \\"\\",\\n \\"OTelBearerToken\\": \\"\\",\\n \\"LangfuseInstanceIds\\": [\\n \\"lfu-xxkshuf23sdj\\"\\n ],\\n \\"CanUpgradeVersionCommunityMap\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"CommunityVersion\\": \\"\\",\\n \\"MCPServerServiceStatus\\": \\"not_enabled\\"\\n}","type":"json"}]',
'title' => 'DescribeDBInstanceAttribute',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeDBInstanceAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeDBInstanceNetInfo' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '189188',
'abilityTreeNodes' => ['FEATUREselectdb72PXTX'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'ADF42B18-43FD-5100-83A9-BE81AB70C863'],
'DBInstanceNetInfos' => [
'description' => 'Instance network information.',
'type' => 'array',
'items' => [
'description' => 'Instance network information.',
'type' => 'object',
'properties' => [
'NetType' => ['description' => 'Network type of the instance. Valid values:'."\n"
."\n"
.'- **VPC**: Virtual Private Cloud (VPC).'."\n"
."\n"
.'- **PUBLIC**: Internet.', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
'VpcInstanceId' => ['description' => 'VPC instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-h033cnd****-fe-20230816101006', 'title' => ''],
'VpcId' => ['description' => 'VPC ID.', 'type' => 'string', 'example' => 'vpc-wz90scxq6ods388ft****', 'title' => ''],
'VswitchId' => ['description' => 'vSwitch ID.', 'type' => 'string', 'example' => 'vsw-uf6mlqti065rer6m0****', 'title' => ''],
'UserVisible' => ['description' => 'Indicates whether the information is visible to users. Valid values:'."\n"
."\n"
.'- **true**: Visible to users.'."\n"
."\n"
.'- **false**: Not visible to users.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ConnectionString' => ['description' => 'Connection address.', 'type' => 'string', 'example' => 'selectdb-cn-h033cnd****-fe.selectdbfe.pre.rds.aliyuncs.com', 'title' => ''],
'Ip' => ['description' => 'IP address.', 'type' => 'string', 'example' => '172.16.XX.XX', 'title' => ''],
'PortList' => [
'description' => 'Port object.',
'type' => 'array',
'items' => [
'description' => 'Port details.',
'type' => 'object',
'properties' => [
'Protocol' => ['description' => 'Port type. Valid values:'."\n"
."\n"
.'- **HttpPort**: HTTP protocol port.'."\n"
."\n"
.'- **MySQLPort**: MySQL protocol port.', 'type' => 'string', 'example' => '9030', 'title' => ''],
'Port' => ['description' => 'Connection port number.', 'type' => 'integer', 'format' => 'int32', 'example' => 'MySQLPort', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'ClusterId' => ['description' => 'Cluster ID.', 'type' => 'string', 'example' => 'selectdb-cn-****-be', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'DBClustersNetInfos' => [
'description' => 'Network list of BE instances.',
'type' => 'array',
'items' => [
'description' => 'Network information of BE instances.',
'type' => 'object',
'properties' => [
'NetType' => ['description' => 'Network type.', 'type' => 'string', 'example' => 'VPC/PUBLIC', 'title' => ''],
'VpcInstanceId' => ['description' => 'VPC instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-****-fe-20230816101006', 'title' => ''],
'VpcId' => ['description' => 'VPC ID.', 'type' => 'string', 'example' => 'vpc-****', 'title' => ''],
'VswitchId' => ['description' => 'vSwitch ID.', 'type' => 'string', 'example' => 'vsw-****', 'title' => ''],
'UserVisible' => ['description' => 'Indicates whether the information is visible to users.', 'type' => 'boolean', 'example' => 'true/false', 'title' => ''],
'ConnectionString' => ['description' => 'Connection address.', 'type' => 'string', 'example' => 'selectdb-cn-****-fe.selectdbfe.pre.rds.aliyuncs.com', 'title' => ''],
'Ip' => ['description' => 'IP address.', 'type' => 'string', 'example' => '8.131.***.***', 'title' => ''],
'PortList' => [
'description' => 'Port list.',
'type' => 'array',
'items' => [
'description' => 'Port information.',
'type' => 'object',
'properties' => [
'Protocol' => ['description' => 'Port type.', 'type' => 'string', 'example' => 'MySQLPort/HttpPort', 'title' => ''],
'Port' => ['description' => 'Connection port number.', 'type' => 'integer', 'format' => 'int32', 'example' => '9030/8080', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'ClusterId' => ['description' => 'Cluster ID.', 'type' => 'string', 'example' => 'selectdb-cn-****-be', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'InvalidClusterInstance.NotFound', 'errorMessage' => 'Specified cluster instance does not exist.', 'description' => 'SelectDB instance does not exist.'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DescribeDBInstanceNetInfo',
'summary' => 'Queries the network information of a specified ApsaraDB SelectDB instance.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'selectdb:DescribeDBInstanceNetInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADF42B18-43FD-5100-83A9-BE81AB70C863\\",\\n \\"DBInstanceNetInfos\\": [\\n {\\n \\"NetType\\": \\"VPC\\",\\n \\"VpcInstanceId\\": \\"selectdb-cn-h033cnd****-fe-20230816101006\\",\\n \\"VpcId\\": \\"vpc-wz90scxq6ods388ft****\\",\\n \\"VswitchId\\": \\"vsw-uf6mlqti065rer6m0****\\",\\n \\"UserVisible\\": true,\\n \\"ConnectionString\\": \\"selectdb-cn-h033cnd****-fe.selectdbfe.pre.rds.aliyuncs.com\\",\\n \\"Ip\\": \\"172.16.XX.XX\\",\\n \\"PortList\\": [\\n {\\n \\"Protocol\\": \\"9030\\",\\n \\"Port\\": 0\\n }\\n ],\\n \\"ClusterId\\": \\"selectdb-cn-****-be\\"\\n }\\n ],\\n \\"DBClustersNetInfos\\": [\\n {\\n \\"NetType\\": \\"VPC/PUBLIC\\",\\n \\"VpcInstanceId\\": \\"selectdb-cn-****-fe-20230816101006\\",\\n \\"VpcId\\": \\"vpc-****\\",\\n \\"VswitchId\\": \\"vsw-****\\",\\n \\"UserVisible\\": true,\\n \\"ConnectionString\\": \\"selectdb-cn-****-fe.selectdbfe.pre.rds.aliyuncs.com\\",\\n \\"Ip\\": \\"8.131.***.***\\",\\n \\"PortList\\": [\\n {\\n \\"Protocol\\": \\"MySQLPort/HttpPort\\",\\n \\"Port\\": 0\\n }\\n ],\\n \\"ClusterId\\": \\"selectdb-cn-****-be\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeDBInstances' => [
'summary' => 'Queries instances.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '189152',
'abilityTreeNodes' => ['FEATUREselectdb69DNVG'],
],
'parameters' => [
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-4690g37929****', 'title' => ''],
],
[
'name' => 'DBInstanceIds',
'in' => 'query',
'schema' => ['description' => 'The instance ID. Separate multiple instance IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'DBInstanceStatus',
'in' => 'query',
'schema' => ['description' => 'The state of the instance. Valid values:'."\n"
."\n"
.'- **CREATING**: The instance is being created.'."\n"
."\n"
.'- **ACTIVATION**: The instance is running.'."\n"
."\n"
.'- **RESOURCE\\_CHANGING**: The instance is being upgraded or downgraded.'."\n"
."\n"
.'- **ORDER\\_PREPARING**: The order is being confirmed.'."\n"
."\n"
.'- **READONLY\\_RESOURCE\\_CHANGING**: The instance configuration is being changed, and the instance is write-locked.'."\n"
."\n"
.'- **DELETING**: The instance is being deleted.', 'type' => 'string', 'required' => false, 'example' => 'ACTIVATION', 'title' => ''],
],
[
'name' => 'DBInstanceDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the instance.', 'type' => 'string', 'example' => 'New instance test', 'required' => false, 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n"
."\n"
.'- **30** (default)'."\n"
."\n"
.'- **50**'."\n"
."\n"
.'- **100**', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The list of tags of instances.',
'type' => 'array',
'items' => [
'description' => 'The list of instance tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'testKey', 'title' => ''],
'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'testValue', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BC854513-E85E-54F3-9842-B9CCD3308CDD'],
'PageNumber' => ['description' => 'The number of entries to return per page. Valid values:'."\n"
."\n"
.'- **30** (default value)'."\n"
."\n"
.'- **50**'."\n"
."\n"
.'- **100**', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
'Items' => [
'description' => 'The list of instance details.',
'type' => 'array',
'items' => [
'description' => 'The list of instance details.',
'type' => 'object',
'properties' => [
'connectionString' => ['description' => 'The connection address.', 'type' => 'string', 'example' => 'Not applicable.', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
'Description' => ['description' => 'The description of the instance.', 'type' => 'string', 'example' => 'New instance test', 'title' => ''],
'Engine' => ['description' => 'The database type.', 'type' => 'string', 'example' => 'selectdb', 'title' => ''],
'EngineVersion' => ['description' => 'The database version.', 'type' => 'string', 'example' => '2.4', 'title' => ''],
'InstanceUsedType' => ['description' => 'The instance usage type.', 'type' => 'string', 'example' => 'Instance', 'title' => ''],
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''],
'ChargeType' => ['description' => 'The billing method of the instance. Valid values:'."\n"
."\n"
.'- **Postpaid**: pay-as-you-go'."\n"
."\n"
.'- **Prepaid**: subscription', 'type' => 'string', 'example' => 'PrePaid', 'title' => ''],
'Category' => ['description' => 'The instance edition. The default value is basic.', 'type' => 'string', 'example' => 'basic', 'title' => ''],
'Status' => ['description' => 'The state of the instance. Valid values:'."\n"
."\n"
.'- **CREATING**: The instance is being created.'."\n"
."\n"
.'- **ACTIVATION**: The instance is running.'."\n"
."\n"
.'- **RESOURCE\\_CHANGING**: The instance is being upgraded or downgraded.'."\n"
."\n"
.'- **ORDER\\_PREPARING**: The order is being confirmed.'."\n"
."\n"
.'- **READONLY\\_RESOURCE\\_CHANGING**: The instance configuration is being changed, and the instance is write-locked.'."\n"
."\n"
.'- **DELETING**: The instance is being deleted.', 'type' => 'string', 'example' => 'ACTIVATION', 'title' => ''],
'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp175iuvg8nxqraf2****', 'title' => ''],
'VswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1gzt31twhlo0sa5****', 'title' => ''],
'ResourceCpu' => ['description' => 'The allocated CPU for the resource.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''],
'ResourceMemory' => ['description' => 'The memory size.', 'type' => 'integer', 'format' => 'int64', 'example' => '64', 'title' => ''],
'ScaleMin' => ['description' => 'The minimum number of RDS Capacity Units (RCUs) for the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'ScaleMax' => ['description' => 'The maximum number of RDS Capacity Units (RCUs) for the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'ScaleReplica' => ['description' => 'This field is redundant.', 'type' => 'integer', 'format' => 'int64', 'example' => '空', 'title' => ''],
'StorageSize' => ['description' => 'The storage capacity.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'StorageType' => ['description' => 'The storage class of the instance.', 'type' => 'string', 'example' => 'cloud_essd', 'title' => ''],
'ObjectStoreSize' => ['description' => 'The instance storage size. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'ExpireTime' => ['description' => 'The expiration time of the cluster.'."\n"
."\n"
.'> This parameter is returned only for **Prepaid** (subscription) clusters. For **Postpaid** (pay-as-you-go) clusters, this parameter is empty.', 'type' => 'string', 'example' => '2024-03-29T03:47:05Z', 'title' => ''],
'LockMode' => ['description' => 'The lock mode of the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'LockReason' => ['description' => 'The reason why the instance is locked.', 'type' => 'string', 'example' => 'nolock', 'title' => ''],
'IsDeleted' => ['description' => 'Indicates whether the instance is deleted. Valid values:'."\n"
."\n"
.'- **true**: The instance is deleted.'."\n"
."\n"
.'- **false**: The instance is not deleted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'MaintainStarttime' => ['description' => 'The start time of the maintenance window for the instance.', 'type' => 'string', 'example' => 'Reserved parameter. Not returned.', 'title' => ''],
'MaintainEndtime' => ['description' => 'The end time of the maintenance window for the instance.', 'type' => 'string', 'example' => 'Reserved parameter. Not returned.', 'title' => ''],
'GmtCreated' => ['description' => 'The time when the task was created (GMT).', 'type' => 'string', 'example' => '2023-08-12T04:14Z'."\n", 'title' => ''],
'GmtModified' => ['description' => 'The time when the task was last modified (GMT).', 'type' => 'string', 'example' => '2023-08-12T19:05Z', 'title' => ''],
'ParentInstance' => ['description' => 'The creation time.', 'type' => 'string', 'example' => 'Reserved parameter. Not returned.', 'title' => ''],
'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'Reserved parameter. Not returned.', 'title' => ''],
'MaintainStartTimeStr' => ['description' => 'The timestamp that indicates the start of the maintenance window.', 'type' => 'string', 'example' => 'Reserved parameter. Not returned.', 'title' => ''],
'MaintainEndTimeStr' => ['description' => 'The timestamp that indicates the end of the maintenance window.', 'type' => 'string', 'example' => 'Reserved parameter. Not returned.', 'title' => ''],
'TenantClusterId' => ['description' => 'The ID of the Prometheus monitoring cluster.', 'type' => 'string', 'example' => 'Reserved parameter. Not returned.', 'title' => ''],
'TenantToken' => ['description' => 'The token for connecting to Prometheus monitoring.', 'type' => 'string', 'example' => 'Reserved parameter. Not returned.', 'title' => ''],
'TenantUserId' => ['description' => 'The user account label for Prometheus monitoring.', 'type' => 'string', 'example' => 'Reserved parameter. Not returned.', 'title' => ''],
'Tags' => [
'description' => 'The list of tags of the instance.',
'type' => 'array',
'items' => [
'description' => 'The list of instance tags.',
'type' => 'object',
'properties' => [
'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'testKey', 'title' => ''],
'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'testValue', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'ClusterCount' => ['description' => 'The total number of clusters.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'DeployScheme' => ['description' => 'The deployment mode of the instance:'."\n"
."\n"
.'- multi\\_az: zone-redundant storage.'."\n"
."\n"
.'- single\\_az: locally redundant storage.', 'type' => 'string', 'example' => 'single_az', 'title' => ''],
'MultiZone' => [
'description' => 'The multi-zone configuration.',
'type' => 'array',
'items' => [
'description' => 'The list of multiple zones.',
'type' => 'object',
'properties' => [
'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-beijing-k', 'title' => ''],
'VSwitchIds' => [
'description' => 'The list of vSwitch IDs.',
'type' => 'array',
'items' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1pla4vl8bs9uw9c7l2w', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'EngineMinorVersion' => ['description' => 'The minor engine version of the instance.', 'type' => 'string', 'example' => '4.0.4', 'title' => ''],
'Serverless' => ['description' => 'Indicates whether the instance is a serverless instance.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter "PageNumber" is not valid.', 'description' => 'The number of records per page parameter is illegal.'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC854513-E85E-54F3-9842-B9CCD3308CDD\\",\\n \\"PageNumber\\": 30,\\n \\"PageSize\\": 1,\\n \\"TotalRecordCount\\": 2,\\n \\"Items\\": [\\n {\\n \\"connectionString\\": \\"Not applicable.\\",\\n \\"DBInstanceId\\": \\"selectdb-cn-7213cjv****\\",\\n \\"Description\\": \\"New instance test\\",\\n \\"Engine\\": \\"selectdb\\",\\n \\"EngineVersion\\": \\"2.4\\",\\n \\"InstanceUsedType\\": \\"Instance\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"Category\\": \\"basic\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"VpcId\\": \\"vpc-bp175iuvg8nxqraf2****\\",\\n \\"VswitchId\\": \\"vsw-bp1gzt31twhlo0sa5****\\",\\n \\"ResourceCpu\\": 8,\\n \\"ResourceMemory\\": 64,\\n \\"ScaleMin\\": 0,\\n \\"ScaleMax\\": 0,\\n \\"ScaleReplica\\": 0,\\n \\"StorageSize\\": 100,\\n \\"StorageType\\": \\"cloud_essd\\",\\n \\"ObjectStoreSize\\": 200,\\n \\"ExpireTime\\": \\"2024-03-29T03:47:05Z\\",\\n \\"LockMode\\": 0,\\n \\"LockReason\\": \\"nolock\\",\\n \\"IsDeleted\\": false,\\n \\"MaintainStarttime\\": \\"Reserved parameter. Not returned.\\",\\n \\"MaintainEndtime\\": \\"Reserved parameter. Not returned.\\",\\n \\"GmtCreated\\": \\"2023-08-12T04:14Z\\\\n\\",\\n \\"GmtModified\\": \\"2023-08-12T19:05Z\\",\\n \\"ParentInstance\\": \\"Reserved parameter. Not returned.\\",\\n \\"ResourceGroupId\\": \\"Reserved parameter. Not returned.\\",\\n \\"MaintainStartTimeStr\\": \\"Reserved parameter. Not returned.\\",\\n \\"MaintainEndTimeStr\\": \\"Reserved parameter. Not returned.\\",\\n \\"TenantClusterId\\": \\"Reserved parameter. Not returned.\\",\\n \\"TenantToken\\": \\"Reserved parameter. Not returned.\\",\\n \\"TenantUserId\\": \\"Reserved parameter. Not returned.\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"testKey\\",\\n \\"TagValue\\": \\"testValue\\"\\n }\\n ],\\n \\"ClusterCount\\": 1,\\n \\"DeployScheme\\": \\"single_az\\",\\n \\"MultiZone\\": [\\n {\\n \\"ZoneId\\": \\"cn-beijing-k\\",\\n \\"VSwitchIds\\": [\\n \\"vsw-bp1pla4vl8bs9uw9c7l2w\\"\\n ]\\n }\\n ],\\n \\"EngineMinorVersion\\": \\"4.0.4\\",\\n \\"Serverless\\": false\\n }\\n ]\\n}","type":"json"}]',
'title' => 'DescribeDBInstances',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeDBInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'translator' => 'manual',
],
'DescribeElasticRules' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '248790',
'abilityTreeNodes' => ['FEATUREselectdbVAZKUZ'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Product',
'in' => 'query',
'schema' => ['description' => 'The cloud service.', 'type' => 'string', 'default' => 'selectdb', 'required' => false, 'example' => 'selectdb', 'title' => ''],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-nwy3jv1oa02-be', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F8900A96-67F7-5274-A41B-7722E1ECF8C9'],
'Data' => [
'description' => 'The data returned.',
'type' => 'object',
'properties' => [
'DbInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'."\n", 'title' => ''],
'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'selectdb-cn-nwy3jv1oa02-be'."\n", 'title' => ''],
'Rules' => [
'description' => 'The details of the rules.',
'type' => 'array',
'items' => [
'description' => 'The details of the rule.',
'type' => 'object',
'properties' => [
'RuleId' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '5467', 'title' => ''],
'ExecutionPeriod' => [
'description' => 'The execution cycle.'."\n"
."\n"
.'Valid value:'."\n"
."\n"
.'- Day',
'enumValueTitles' => ['Day' => 'Execute daily'],
'type' => 'string',
'example' => 'Day',
'title' => '',
],
'ElasticRuleStartTime' => ['description' => 'The time when you want to execute the scheduled scaling rule.', 'type' => 'string', 'example' => '00:00', 'title' => ''],
'ClusterClass' => ['description' => 'The rule for computing resources of the required cluster.', 'type' => 'string', 'example' => 'selectdb.2xlarge', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidClusterId.Malformed', 'errorMessage' => 'The specified parameter "ClusterId" is not valid.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => 'The parameter "DBInstanceId" is illegal.'],
['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter "RegionId" is not valid.', 'description' => ''],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The cluster does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DescribeElasticRules',
'summary' => 'Queries scheduled scaling rules.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeElasticRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8900A96-67F7-5274-A41B-7722E1ECF8C9\\",\\n \\"Data\\": {\\n \\"DbInstanceId\\": \\"selectdb-cn-7213cjv****\\\\n\\",\\n \\"ClusterId\\": \\"selectdb-cn-nwy3jv1oa02-be\\\\n\\",\\n \\"Rules\\": [\\n {\\n \\"RuleId\\": 5467,\\n \\"ExecutionPeriod\\": \\"Day\\",\\n \\"ElasticRuleStartTime\\": \\"00:00\\",\\n \\"ClusterClass\\": \\"selectdb.2xlarge\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeProfile' => [
'summary' => 'Retrieves the Profile analysis for a query.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '222354',
'abilityTreeNodes' => ['FEATUREselectdbWRISTG'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'QueryId',
'in' => 'query',
'schema' => ['description' => 'The query ID.', 'type' => 'string', 'required' => false, 'example' => 'sq202510231018sh3b69ad10014154', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F8900A96-67F7-5274-A41B-7722E1ECF8C9', 'title' => ''],
'Profile' => ['description' => 'The profile text. This parameter is not yet supported.', 'type' => 'string', 'example' => 'No Demo', 'title' => ''],
'ProfileSummary' => ['description' => 'The profile summary.', 'type' => 'any', 'example' => '{'."\n"
.' "summary": {'."\n"
.' "workloadGroup": "normal",'."\n"
.' "totalTime": "16ms",'."\n"
.' "totalTimeMs": 16,'."\n"
.' "state": "OK",'."\n"
.' "queryId": "8c7776d539f2426b-b0b654c7acc9bf8f",'."\n"
.' "sql": "SELECT * FROM demo_db.user_info WHERE status = 1"'."\n"
.' },'."\n"
.' "operators": ['."\n"
.' {'."\n"
.' "pipeline": 0,'."\n"
.' "frag": 0,'."\n"
.' "skewRatio": 1,'."\n"
.' "name": "RESULT_SINK_OPERATOR",'."\n"
.' "timePct": 0.34,'."\n"
.' "inputRows": 4,'."\n"
.' "execTimeAvgMs": 0.05'."\n"
.' },'."\n"
.' {'."\n"
.' "pipeline": 0,'."\n"
.' "frag": 0,'."\n"
.' "name": "OLAP_SCAN_OPERATOR(nereids_id=84. table_name=user_info(user_info))",'."\n"
.' "timePct": 0,'."\n"
.' "runtimeFilters": ['."\n"
.' "RuntimeFilterInfo: sum , avg , max , min"'."\n"
.' ],'."\n"
.' "execTimeAvgMs": 0,'."\n"
.' "table": "demo_db.user_info"'."\n"
.' }'."\n"
.' ],'."\n"
.' "queryStats": {'."\n"
.' "blockedOperators": 0,'."\n"
.' "operatorCount": 2,'."\n"
.' "spilledOperators": 0,'."\n"
.' "fragmentCount": 2'."\n"
.' },'."\n"
.' "fragments": ['."\n"
.' {'."\n"
.' "pipelines": 1,'."\n"
.' "instances": 1,'."\n"
.' "execTimeMs": 0.05,'."\n"
.' "id": 0'."\n"
.' },'."\n"
.' {'."\n"
.' "pipelines": 0,'."\n"
.' "instances": 0,'."\n"
.' "execTimeMs": 0,'."\n"
.' "id": 0'."\n"
.' }'."\n"
.' ],'."\n"
.' "timeBreakdown": {'."\n"
.' "schedule": "4ms",'."\n"
.' "parseSql": "1ms",'."\n"
.' "nereidsAnalysis": "1ms",'."\n"
.' "waitFetchResult": "5ms",'."\n"
.' "fetchResult": "1ms",'."\n"
.' "nereidsOptimize": "N/A",'."\n"
.' "plan": "6ms",'."\n"
.' "nereidsRewrite": "1ms"'."\n"
.' },'."\n"
.' "scannedTables": {'."\n"
.' "demoDb.userInfo": {'."\n"
.' "totalSizeGb": 0,'."\n"
.' "totalRows": 5,'."\n"
.' "tabletSkew": 1.6,'."\n"
.' "ddl": "CREATE TABLE `user_info` xxx",'."\n"
.' "tablets": 8'."\n"
.' }'."\n"
.' }'."\n"
.' }', 'title' => ''],
],
'title' => '',
'description' => 'The returned data.',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => 'The parameter "DBInstanceId" is illegal.'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Specified parameter is not valid.', 'description' => 'Specified parameter is not valid.'],
['errorCode' => 'InvalidParameter.QueryId', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'Specified parameters is not valid.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'Current engine minor version does not support operations.'],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', 'description' => 'Current engine version does not support operations.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DescribeProfile',
'description' => 'We recommend using the visual interface to run a query and obtain its QueryID. For more information, see [query audit](https://help.aliyun.com/zh/selectdb/audit-queries).'."\n"
."\n"
.'>'."\n"
."\n"
.'Version limitations'."\n"
."\n"
.'- Version 3.0 is not supported.'."\n"
."\n"
.'- This feature is not available for instances created before 2025-08-01. To enable this feature for an older instance, please submit a ticket.'."\n"
."\n"
.'>',
'changeSet' => [],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8900A96-67F7-5274-A41B-7722E1ECF8C9\\",\\n \\"Profile\\": \\"No Demo\\",\\n \\"ProfileSummary\\": \\"{\\\\n \\\\\\"summary\\\\\\": {\\\\n \\\\\\"workloadGroup\\\\\\": \\\\\\"normal\\\\\\",\\\\n \\\\\\"totalTime\\\\\\": \\\\\\"16ms\\\\\\",\\\\n \\\\\\"totalTimeMs\\\\\\": 16,\\\\n \\\\\\"state\\\\\\": \\\\\\"OK\\\\\\",\\\\n \\\\\\"queryId\\\\\\": \\\\\\"8c7776d539f2426b-b0b654c7acc9bf8f\\\\\\",\\\\n \\\\\\"sql\\\\\\": \\\\\\"SELECT * FROM demo_db.user_info WHERE status = 1\\\\\\"\\\\n },\\\\n \\\\\\"operators\\\\\\": [\\\\n {\\\\n \\\\\\"pipeline\\\\\\": 0,\\\\n \\\\\\"frag\\\\\\": 0,\\\\n \\\\\\"skewRatio\\\\\\": 1,\\\\n \\\\\\"name\\\\\\": \\\\\\"RESULT_SINK_OPERATOR\\\\\\",\\\\n \\\\\\"timePct\\\\\\": 0.34,\\\\n \\\\\\"inputRows\\\\\\": 4,\\\\n \\\\\\"execTimeAvgMs\\\\\\": 0.05\\\\n },\\\\n {\\\\n \\\\\\"pipeline\\\\\\": 0,\\\\n \\\\\\"frag\\\\\\": 0,\\\\n \\\\\\"name\\\\\\": \\\\\\"OLAP_SCAN_OPERATOR(nereids_id=84. table_name=user_info(user_info))\\\\\\",\\\\n \\\\\\"timePct\\\\\\": 0,\\\\n \\\\\\"runtimeFilters\\\\\\": [\\\\n \\\\\\"RuntimeFilterInfo: sum , avg , max , min\\\\\\"\\\\n ],\\\\n \\\\\\"execTimeAvgMs\\\\\\": 0,\\\\n \\\\\\"table\\\\\\": \\\\\\"demo_db.user_info\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"queryStats\\\\\\": {\\\\n \\\\\\"blockedOperators\\\\\\": 0,\\\\n \\\\\\"operatorCount\\\\\\": 2,\\\\n \\\\\\"spilledOperators\\\\\\": 0,\\\\n \\\\\\"fragmentCount\\\\\\": 2\\\\n },\\\\n \\\\\\"fragments\\\\\\": [\\\\n {\\\\n \\\\\\"pipelines\\\\\\": 1,\\\\n \\\\\\"instances\\\\\\": 1,\\\\n \\\\\\"execTimeMs\\\\\\": 0.05,\\\\n \\\\\\"id\\\\\\": 0\\\\n },\\\\n {\\\\n \\\\\\"pipelines\\\\\\": 0,\\\\n \\\\\\"instances\\\\\\": 0,\\\\n \\\\\\"execTimeMs\\\\\\": 0,\\\\n \\\\\\"id\\\\\\": 0\\\\n }\\\\n ],\\\\n \\\\\\"timeBreakdown\\\\\\": {\\\\n \\\\\\"schedule\\\\\\": \\\\\\"4ms\\\\\\",\\\\n \\\\\\"parseSql\\\\\\": \\\\\\"1ms\\\\\\",\\\\n \\\\\\"nereidsAnalysis\\\\\\": \\\\\\"1ms\\\\\\",\\\\n \\\\\\"waitFetchResult\\\\\\": \\\\\\"5ms\\\\\\",\\\\n \\\\\\"fetchResult\\\\\\": \\\\\\"1ms\\\\\\",\\\\n \\\\\\"nereidsOptimize\\\\\\": \\\\\\"N/A\\\\\\",\\\\n \\\\\\"plan\\\\\\": \\\\\\"6ms\\\\\\",\\\\n \\\\\\"nereidsRewrite\\\\\\": \\\\\\"1ms\\\\\\"\\\\n },\\\\n \\\\\\"scannedTables\\\\\\": {\\\\n \\\\\\"demoDb.userInfo\\\\\\": {\\\\n \\\\\\"totalSizeGb\\\\\\": 0,\\\\n \\\\\\"totalRows\\\\\\": 5,\\\\n \\\\\\"tabletSkew\\\\\\": 1.6,\\\\n \\\\\\"ddl\\\\\\": \\\\\\"CREATE TABLE `user_info` xxx\\\\\\",\\\\n \\\\\\"tablets\\\\\\": 8\\\\n }\\\\n }\\\\n }\\"\\n}","type":"json"}]',
],
'DescribeRegions' => [
'summary' => 'Queries available regions and zones.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-h', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F8900A96-67F7-5274-A41B-7722E1ECF8C9'."\n"],
'RegionModelList' => [
'description' => 'An array of regions.',
'type' => 'array',
'items' => [
'description' => 'The details of the region.',
'type' => 'object',
'properties' => [
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
'Zones' => [
'description' => 'An array of zones.',
'type' => 'array',
'items' => [
'description' => 'The details of the zone.',
'type' => 'object',
'properties' => [
'ZoneId' => ['description' => 'Indicates whether the virtual private cloud (VPC) is available.', 'type' => 'string', 'example' => 'cn-beijing-h', 'title' => ''],
'VpcEnabled' => ['description' => 'Indicates whether the VPC is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Name' => ['description' => 'The zone name.', 'type' => 'string', 'example' => 'Beijing H', 'title' => ''],
'Description' => ['description' => 'The zone description.', 'type' => 'string', 'example' => '北京H可用区', 'title' => ''],
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
'Disabled' => ['description' => 'Indicates whether the VPC is disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'SubDomain' => ['description' => 'The subdomain.', 'type' => 'string', 'example' => 'cn-beijing-h-aliyun', 'title' => ''],
'Label' => ['description' => 'The label.', 'type' => 'string', 'example' => 'test', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8900A96-67F7-5274-A41B-7722E1ECF8C9\\\\n\\",\\n \\"RegionModelList\\": [\\n {\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"Zones\\": [\\n {\\n \\"ZoneId\\": \\"cn-beijing-h\\",\\n \\"VpcEnabled\\": true,\\n \\"Name\\": \\"Beijing H\\",\\n \\"Description\\": \\"北京H可用区\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"Disabled\\": false,\\n \\"SubDomain\\": \\"cn-beijing-h-aliyun\\",\\n \\"Label\\": \\"test\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => 'DescribeRegions',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeRegions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'translator' => 'manual',
],
'DescribeSecurityIPList' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '189644',
'abilityTreeNodes' => ['FEATUREselectdb72PXTX'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5CBE044D-4594-525D-AC65-E988553D853E'],
'DBInstanceName' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
'GroupItems' => [
'description' => 'The details about each IP address whitelist returned.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'GroupName' => ['description' => 'The name of the whitelist.', 'type' => 'string', 'example' => 'group1', 'title' => ''],
'AecurityIPType' => ['description' => 'The IP address type. Valid values:'."\n"
."\n"
.'- ipv4'."\n"
."\n"
.'- ipv6 (not supported)', 'type' => 'string', 'example' => 'ipv4', 'title' => ''],
'GroupTag' => ['description' => 'The tag of the whitelist.', 'type' => 'string', 'example' => '""', 'title' => ''],
'SecurityIPList' => ['description' => 'The IP addresses in the whitelist. Multiple IP addresses are separated by commas (,).', 'type' => 'string', 'example' => '127.0.XX.XX', 'title' => ''],
'WhitelistNetType' => ['description' => 'The network type of the whitelist.', 'type' => 'string', 'example' => 'mix', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'InvalidClusterInstance.NotFound', 'errorMessage' => 'Specified cluster instance does not exist.', 'description' => 'SelectDB instance does not exist.'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DescribeSecurityIPList',
'summary' => 'Queries the IP addresses in the whitelists of an ApsaraDB for SelectDB instance.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeSecurityIPList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CBE044D-4594-525D-AC65-E988553D853E\\",\\n \\"DBInstanceName\\": \\"selectdb-cn-7213cjv****\\",\\n \\"GroupItems\\": [\\n {\\n \\"GroupName\\": \\"group1\\",\\n \\"AecurityIPType\\": \\"ipv4\\",\\n \\"GroupTag\\": \\"\\\\\\"\\\\\\"\\",\\n \\"SecurityIPList\\": \\"127.0.XX.XX\\",\\n \\"WhitelistNetType\\": \\"mix\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeSlowQueryStats' => [
'summary' => 'Retrieve slow query statistics for a time range.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '222354',
'abilityTreeNodes' => ['FEATUREselectdbWRISTG'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-shenzhen', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The start time. Defaults to 24 hours before the current time.', 'type' => 'string', 'required' => false, 'example' => '2026-04-07 16:00:00', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end time. Must be later than the start time. Defaults to the current time.', 'type' => 'string', 'required' => false, 'example' => '2026-04-08 16:00:00', 'title' => ''],
],
[
'name' => 'ThresholdMs',
'in' => 'query',
'schema' => ['description' => 'The slow query threshold, in milliseconds. The default value is 5000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5000', 'title' => ''],
],
[
'name' => 'TopN',
'in' => 'query',
'schema' => ['description' => 'The number of top slow queries to return. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FCEEA97F-XXXX-XXXX-932F-B4BAEA170896', 'title' => ''],
'Summary' => ['description' => 'The summary of slow query statistics.', 'type' => 'object', 'example' => '{'."\n"
.' "totalAllQueries": "4531",'."\n"
.' "maxScanBytes": "279794422882",'."\n"
.' "totalQueries": "45",'."\n"
.' "minScanRows": "0",'."\n"
.' "totalScanRows": "214219674180",'."\n"
.' "errorQueryCount": "0",'."\n"
.' "avgLatency": "9862",'."\n"
.' "minLatency": "5051",'."\n"
.' "maxLatency": "24746",'."\n"
.' "totalScanBytes": "4657224498428",'."\n"
.' "avgScanBytes": "103493877742",'."\n"
.' "distinctUsers": "1",'."\n"
.' "minScanBytes": "0",'."\n"
.' "slowQueryRatio": "0.009931582432134187",'."\n"
.' "maxScanRows": "23040660808",'."\n"
.' "avgCpuTimeMs": "649451",'."\n"
.' "avgScanRows": "4760437204",'."\n"
.' "maxCpuTimeMs": "1368932",'."\n"
.' "totalCpuTimeMs": "29225330"'."\n"
.' }', 'title' => ''],
'Percentiles' => ['description' => 'The percentile statistics for query latency.', 'type' => 'object', 'example' => '{'."\n"
.' "p99": "24746.0",'."\n"
.' "p50": "8295.0",'."\n"
.' "p95": "23872.0",'."\n"
.' "p90": "15794.0",'."\n"
.' "p75": "11972.25"'."\n"
.' }', 'title' => ''],
'ByUser' => ['description' => 'An array of slow query statistics, grouped by user.', 'type' => 'any', 'example' => '['."\n"
.' {'."\n"
.' "maxScanBytes": 279794422882,'."\n"
.' "minScanRows": 0,'."\n"
.' "totalScanRows": 214219674180,'."\n"
.' "avgLatency": 9862.755555555555,'."\n"
.' "minLatency": 5051,'."\n"
.' "maxLatency": 24746,'."\n"
.' "totalScanBytes": 4657224498428,'."\n"
.' "queryCount": 45,'."\n"
.' "avgScanBytes": 103493877742.84445,'."\n"
.' "minScanBytes": 0,'."\n"
.' "totalLatency": 443824,'."\n"
.' "maxScanRows": 23040660808,'."\n"
.' "avgCpuTimeMs": 649451.7777777778,'."\n"
.' "avgScanRows": 4760437204,'."\n"
.' "maxCpuTimeMs": 1368932,'."\n"
.' "distinctSqlDigests": 1,'."\n"
.' "user": "admin",'."\n"
.' "totalCpuTimeMs": 29225330,'."\n"
.' "minCpuTimeMs": 2434'."\n"
.' }'."\n"
.' ]', 'title' => ''],
'ByTimeBucket' => ['description' => 'An array of slow query statistics, grouped by time bucket.', 'type' => 'any', 'example' => '['."\n"
.' {'."\n"
.' "maxScanBytes": 261400873691,'."\n"
.' "minScanRows": 5915582721,'."\n"
.' "totalScanRows": 23662330884,'."\n"
.' "avgLatency": 6988.5,'."\n"
.' "minLatency": 6657,'."\n"
.' "maxLatency": 7401,'."\n"
.' "totalScanBytes": 1045601376995,'."\n"
.' "queryCount": 4,'."\n"
.' "avgScanBytes": 261400344248.75,'."\n"
.' "minScanBytes": 261400167768,'."\n"
.' "maxScanRows": 5915582721,'."\n"
.' "avgCpuTimeMs": 603488.25,'."\n"
.' "avgScanRows": 5915582721,'."\n"
.' "maxCpuTimeMs": 637311,'."\n"
.' "timeBucket": "2026-04-15 22:00:00",'."\n"
.' "totalCpuTimeMs": 2413953,'."\n"
.' "minCpuTimeMs": 567462'."\n"
.' }'."\n"
.']', 'title' => ''],
'TopQueries' => ['description' => 'An array of detailed audit records for the top N slow queries.', 'type' => 'any', 'example' => '['."\n"
.' {'."\n"
.' "peakMemoryBytes": 71731165356,'."\n"
.' "planTimesMs": "{\\"plan\\":15, \\"garbage_collect\\":0, \\"lock_tables\\":0, \\"analyze\\":2, \\"rewrite\\":4, \\"fold_const_by_be\\":0, \\"collect_partitions\\":0, \\"optimize\\":3, \\"translate\\":2, \\"init_scan_node\\":-1, \\"finalize_scan_node\\":-1, \\"create_scan_range\\":-1, \\"distribute\\":4}",'."\n"
.' "catalog": "internal",'."\n"
.' "sqlMode": "ONLY_FULL_GROUP_BY",'."\n"
.' "errorCode": 0,'."\n"
.' "spillReadBytesFromLocalStorage": -1,'."\n"
.' "computeGroup": "test",'."\n"
.' "queryId": "921f10bc054d4dbb-903784520a2ab26f",'."\n"
.' "parseTimeMs": 0,'."\n"
.' "stmtId": 5822,'."\n"
.' "hitSqlCache": false,'."\n"
.' "chosenMViews": "[]",'."\n"
.' "scanBytesFromLocalStorage": 861079963,'."\n"
.' "frontendIp": "172.16.17.192",'."\n"
.' "handledInFe": false,'."\n"
.' "returnRows": 100,'."\n"
.' "state": "EOF",'."\n"
.' "scanRows": 550584606,'."\n"
.' "cpuTimeMs": 1368932,'."\n"
.' "scheduleTimesMs": "{\\"schedule_time_ms\\":14, \\"fragment_assign_time_ms\\":0, \\"fragment_serialize_time_ms\\":2, \\"fragment_rpc_phase_1_time_ms\\":11, \\"fragment_rpc_phase_2_time_ms\\":1, \\"fragment_compressed_size_byte\\":142152, \\"fragment_rpc_count\\":6}",'."\n"
.' "shuffleSendBytes": 27745167331,'."\n"
.' "stmtType": "SELECT",'."\n"
.' "sqlHash": "ecf08bbca3e4b33b1630e03a9dc671b4",'."\n"
.' "errorMessage": "",'."\n"
.' "isQuery": true,'."\n"
.' "isNereids": true,'."\n"
.' "changedVariables": "{\\"enable_profile\\":\\"true\\", \\"enable_auto_analyze\\":\\"false\\", \\"runtime_filter_wait_time_ms\\":\\"10000\\", \\"sql_converter_service_url\\":\\"http://127.0.0.1:5001/api/v1/convert\\"}",'."\n"
.' "scanBytesFromRemoteStorage": 0,'."\n"
.' "scanBytes": 11358721363,'."\n"
.' "isInternal": false,'."\n"
.' "workloadGroup": "normal",'."\n"
.' "queriedTablesAndViews": "[\\"internal.tpcds_1000g.item\\", \\"internal.tpcds_1000g.store_sales\\", \\"internal.tpcds_1000g.date_dim\\", \\"internal.tpcds_1000g.store\\"]",'."\n"
.' "sqlDigest": "d41d8cd98f00b204e9800998ecf8427e",'."\n"
.' "clientIp": "123.56.117.27:33664",'."\n"
.' "queryTime": 24746,'."\n"
.' "shuffleSendRows": 454538612,'."\n"
.' "time": "1776267563848",'."\n"
.' "getMetaTimesMs": "{\\"get_partition_version_time_ms\\":3381937, \\"get_partition_version_count_has_data\\":0, \\"get_partition_version_count\\":1, \\"get_table_version_time_ms\\":0, \\"get_table_version_count\\":0}",'."\n"
.' "spillWriteBytesFromLocalStorage": -1,'."\n"
.' "user": "admin",'."\n"
.' "db": "tpcds_1000g",'."\n"
.' "stmt": "xxx"'."\n"
.' }'."\n"
.']', 'title' => ''],
'TopSqlDigests' => ['description' => 'An array of statistics for the top N slow queries, grouped by SQL digest. Available for kernel version 5.0 and later.', 'type' => 'any', 'example' => '['."\n"
.' {'."\n"
.' "maxScanBytes": 279794422882,'."\n"
.' "minScanRows": 0,'."\n"
.' "totalScanRows": 214219674180,'."\n"
.' "avgLatency": 9862.755555555555,'."\n"
.' "minLatency": 5051,'."\n"
.' "maxLatency": 24746,'."\n"
.' "totalScanBytes": 4657224498428,'."\n"
.' "queryCount": 45,'."\n"
.' "avgScanBytes": 103493877742.84445,'."\n"
.' "minScanBytes": 0,'."\n"
.' "totalLatency": 443824,'."\n"
.' "sqlDigest": "d41d8cd98f00b204e9800998ecf8427e",'."\n"
.' "maxScanRows": 23040660808,'."\n"
.' "avgCpuTimeMs": 649451.7777777778,'."\n"
.' "avgScanRows": 4760437204,'."\n"
.' "maxCpuTimeMs": 1368932,'."\n"
.' "sampleStmt": "xxx",'."\n"
.' "user": "admin",'."\n"
.' "db": "tpcds_1000g",'."\n"
.' "totalCpuTimeMs": 29225330,'."\n"
.' "minCpuTimeMs": 2434'."\n"
.' }'."\n"
.' ]', 'title' => ''],
'ByDatabase' => ['description' => 'An array of slow query statistics, grouped by database.', 'type' => 'any', 'example' => '['."\n"
.' {'."\n"
.' "maxScanBytes": 271603242215,'."\n"
.' "minScanRows": 550584606,'."\n"
.' "totalScanRows": 96977924056,'."\n"
.' "avgLatency": 10804,'."\n"
.' "minLatency": 5138,'."\n"
.' "maxLatency": 24746,'."\n"
.' "totalScanBytes": 1441239240695,'."\n"
.' "queryCount": 29,'."\n"
.' "avgScanBytes": 49697904851,'."\n"
.' "minScanBytes": 8691897406,'."\n"
.' "totalLatency": 313322,'."\n"
.' "maxScanRows": 23040660808,'."\n"
.' "avgCpuTimeMs": 732085,'."\n"
.' "avgScanRows": 3344066346,'."\n"
.' "maxCpuTimeMs": 1368932,'."\n"
.' "db": "tpcds_1000g",'."\n"
.' "totalCpuTimeMs": 21230477,'."\n"
.' "minCpuTimeMs": 292711'."\n"
.' }'."\n"
.']', 'title' => ''],
],
'title' => '',
'description' => 'The data returned.',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => 'The parameter "DBInstanceId" is illegal.'],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'Incoming parameter is not a valid parameter'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Specified parameter is not valid.', 'description' => 'Specified parameter is not valid.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', 'description' => 'Current engine version does not support operations.'],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'Current engine minor version does not support operations.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DescribeSlowQueryStats',
'changeSet' => [],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FCEEA97F-XXXX-XXXX-932F-B4BAEA170896\\",\\n \\"Summary\\": {\\n \\"totalAllQueries\\": \\"4531\\",\\n \\"maxScanBytes\\": \\"279794422882\\",\\n \\"totalQueries\\": \\"45\\",\\n \\"minScanRows\\": \\"0\\",\\n \\"totalScanRows\\": \\"214219674180\\",\\n \\"errorQueryCount\\": \\"0\\",\\n \\"avgLatency\\": \\"9862\\",\\n \\"minLatency\\": \\"5051\\",\\n \\"maxLatency\\": \\"24746\\",\\n \\"totalScanBytes\\": \\"4657224498428\\",\\n \\"avgScanBytes\\": \\"103493877742\\",\\n \\"distinctUsers\\": \\"1\\",\\n \\"minScanBytes\\": \\"0\\",\\n \\"slowQueryRatio\\": \\"0.009931582432134187\\",\\n \\"maxScanRows\\": \\"23040660808\\",\\n \\"avgCpuTimeMs\\": \\"649451\\",\\n \\"avgScanRows\\": \\"4760437204\\",\\n \\"maxCpuTimeMs\\": \\"1368932\\",\\n \\"totalCpuTimeMs\\": \\"29225330\\"\\n },\\n \\"Percentiles\\": {\\n \\"p99\\": \\"24746.0\\",\\n \\"p50\\": \\"8295.0\\",\\n \\"p95\\": \\"23872.0\\",\\n \\"p90\\": \\"15794.0\\",\\n \\"p75\\": \\"11972.25\\"\\n },\\n \\"ByUser\\": \\"[\\\\n {\\\\n \\\\\\"maxScanBytes\\\\\\": 279794422882,\\\\n \\\\\\"minScanRows\\\\\\": 0,\\\\n \\\\\\"totalScanRows\\\\\\": 214219674180,\\\\n \\\\\\"avgLatency\\\\\\": 9862.755555555555,\\\\n \\\\\\"minLatency\\\\\\": 5051,\\\\n \\\\\\"maxLatency\\\\\\": 24746,\\\\n \\\\\\"totalScanBytes\\\\\\": 4657224498428,\\\\n \\\\\\"queryCount\\\\\\": 45,\\\\n \\\\\\"avgScanBytes\\\\\\": 103493877742.84445,\\\\n \\\\\\"minScanBytes\\\\\\": 0,\\\\n \\\\\\"totalLatency\\\\\\": 443824,\\\\n \\\\\\"maxScanRows\\\\\\": 23040660808,\\\\n \\\\\\"avgCpuTimeMs\\\\\\": 649451.7777777778,\\\\n \\\\\\"avgScanRows\\\\\\": 4760437204,\\\\n \\\\\\"maxCpuTimeMs\\\\\\": 1368932,\\\\n \\\\\\"distinctSqlDigests\\\\\\": 1,\\\\n \\\\\\"user\\\\\\": \\\\\\"admin\\\\\\",\\\\n \\\\\\"totalCpuTimeMs\\\\\\": 29225330,\\\\n \\\\\\"minCpuTimeMs\\\\\\": 2434\\\\n }\\\\n ]\\",\\n \\"ByTimeBucket\\": \\"[\\\\n {\\\\n \\\\\\"maxScanBytes\\\\\\": 261400873691,\\\\n \\\\\\"minScanRows\\\\\\": 5915582721,\\\\n \\\\\\"totalScanRows\\\\\\": 23662330884,\\\\n \\\\\\"avgLatency\\\\\\": 6988.5,\\\\n \\\\\\"minLatency\\\\\\": 6657,\\\\n \\\\\\"maxLatency\\\\\\": 7401,\\\\n \\\\\\"totalScanBytes\\\\\\": 1045601376995,\\\\n \\\\\\"queryCount\\\\\\": 4,\\\\n \\\\\\"avgScanBytes\\\\\\": 261400344248.75,\\\\n \\\\\\"minScanBytes\\\\\\": 261400167768,\\\\n \\\\\\"maxScanRows\\\\\\": 5915582721,\\\\n \\\\\\"avgCpuTimeMs\\\\\\": 603488.25,\\\\n \\\\\\"avgScanRows\\\\\\": 5915582721,\\\\n \\\\\\"maxCpuTimeMs\\\\\\": 637311,\\\\n \\\\\\"timeBucket\\\\\\": \\\\\\"2026-04-15 22:00:00\\\\\\",\\\\n \\\\\\"totalCpuTimeMs\\\\\\": 2413953,\\\\n \\\\\\"minCpuTimeMs\\\\\\": 567462\\\\n }\\\\n]\\",\\n \\"TopQueries\\": \\"[\\\\n {\\\\n \\\\\\"peakMemoryBytes\\\\\\": 71731165356,\\\\n \\\\\\"planTimesMs\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"plan\\\\\\\\\\\\\\":15, \\\\\\\\\\\\\\"garbage_collect\\\\\\\\\\\\\\":0, \\\\\\\\\\\\\\"lock_tables\\\\\\\\\\\\\\":0, \\\\\\\\\\\\\\"analyze\\\\\\\\\\\\\\":2, \\\\\\\\\\\\\\"rewrite\\\\\\\\\\\\\\":4, \\\\\\\\\\\\\\"fold_const_by_be\\\\\\\\\\\\\\":0, \\\\\\\\\\\\\\"collect_partitions\\\\\\\\\\\\\\":0, \\\\\\\\\\\\\\"optimize\\\\\\\\\\\\\\":3, \\\\\\\\\\\\\\"translate\\\\\\\\\\\\\\":2, \\\\\\\\\\\\\\"init_scan_node\\\\\\\\\\\\\\":-1, \\\\\\\\\\\\\\"finalize_scan_node\\\\\\\\\\\\\\":-1, \\\\\\\\\\\\\\"create_scan_range\\\\\\\\\\\\\\":-1, \\\\\\\\\\\\\\"distribute\\\\\\\\\\\\\\":4}\\\\\\",\\\\n \\\\\\"catalog\\\\\\": \\\\\\"internal\\\\\\",\\\\n \\\\\\"sqlMode\\\\\\": \\\\\\"ONLY_FULL_GROUP_BY\\\\\\",\\\\n \\\\\\"errorCode\\\\\\": 0,\\\\n \\\\\\"spillReadBytesFromLocalStorage\\\\\\": -1,\\\\n \\\\\\"computeGroup\\\\\\": \\\\\\"test\\\\\\",\\\\n \\\\\\"queryId\\\\\\": \\\\\\"921f10bc054d4dbb-903784520a2ab26f\\\\\\",\\\\n \\\\\\"parseTimeMs\\\\\\": 0,\\\\n \\\\\\"stmtId\\\\\\": 5822,\\\\n \\\\\\"hitSqlCache\\\\\\": false,\\\\n \\\\\\"chosenMViews\\\\\\": \\\\\\"[]\\\\\\",\\\\n \\\\\\"scanBytesFromLocalStorage\\\\\\": 861079963,\\\\n \\\\\\"frontendIp\\\\\\": \\\\\\"172.16.17.192\\\\\\",\\\\n \\\\\\"handledInFe\\\\\\": false,\\\\n \\\\\\"returnRows\\\\\\": 100,\\\\n \\\\\\"state\\\\\\": \\\\\\"EOF\\\\\\",\\\\n \\\\\\"scanRows\\\\\\": 550584606,\\\\n \\\\\\"cpuTimeMs\\\\\\": 1368932,\\\\n \\\\\\"scheduleTimesMs\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"schedule_time_ms\\\\\\\\\\\\\\":14, \\\\\\\\\\\\\\"fragment_assign_time_ms\\\\\\\\\\\\\\":0, \\\\\\\\\\\\\\"fragment_serialize_time_ms\\\\\\\\\\\\\\":2, \\\\\\\\\\\\\\"fragment_rpc_phase_1_time_ms\\\\\\\\\\\\\\":11, \\\\\\\\\\\\\\"fragment_rpc_phase_2_time_ms\\\\\\\\\\\\\\":1, \\\\\\\\\\\\\\"fragment_compressed_size_byte\\\\\\\\\\\\\\":142152, \\\\\\\\\\\\\\"fragment_rpc_count\\\\\\\\\\\\\\":6}\\\\\\",\\\\n \\\\\\"shuffleSendBytes\\\\\\": 27745167331,\\\\n \\\\\\"stmtType\\\\\\": \\\\\\"SELECT\\\\\\",\\\\n \\\\\\"sqlHash\\\\\\": \\\\\\"ecf08bbca3e4b33b1630e03a9dc671b4\\\\\\",\\\\n \\\\\\"errorMessage\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"isQuery\\\\\\": true,\\\\n \\\\\\"isNereids\\\\\\": true,\\\\n \\\\\\"changedVariables\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"enable_profile\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"enable_auto_analyze\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"false\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"runtime_filter_wait_time_ms\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"10000\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"sql_converter_service_url\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://127.0.0.1:5001/api/v1/convert\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"scanBytesFromRemoteStorage\\\\\\": 0,\\\\n \\\\\\"scanBytes\\\\\\": 11358721363,\\\\n \\\\\\"isInternal\\\\\\": false,\\\\n \\\\\\"workloadGroup\\\\\\": \\\\\\"normal\\\\\\",\\\\n \\\\\\"queriedTablesAndViews\\\\\\": \\\\\\"[\\\\\\\\\\\\\\"internal.tpcds_1000g.item\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"internal.tpcds_1000g.store_sales\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"internal.tpcds_1000g.date_dim\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"internal.tpcds_1000g.store\\\\\\\\\\\\\\"]\\\\\\",\\\\n \\\\\\"sqlDigest\\\\\\": \\\\\\"d41d8cd98f00b204e9800998ecf8427e\\\\\\",\\\\n \\\\\\"clientIp\\\\\\": \\\\\\"123.56.117.27:33664\\\\\\",\\\\n \\\\\\"queryTime\\\\\\": 24746,\\\\n \\\\\\"shuffleSendRows\\\\\\": 454538612,\\\\n \\\\\\"time\\\\\\": \\\\\\"1776267563848\\\\\\",\\\\n \\\\\\"getMetaTimesMs\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"get_partition_version_time_ms\\\\\\\\\\\\\\":3381937, \\\\\\\\\\\\\\"get_partition_version_count_has_data\\\\\\\\\\\\\\":0, \\\\\\\\\\\\\\"get_partition_version_count\\\\\\\\\\\\\\":1, \\\\\\\\\\\\\\"get_table_version_time_ms\\\\\\\\\\\\\\":0, \\\\\\\\\\\\\\"get_table_version_count\\\\\\\\\\\\\\":0}\\\\\\",\\\\n \\\\\\"spillWriteBytesFromLocalStorage\\\\\\": -1,\\\\n \\\\\\"user\\\\\\": \\\\\\"admin\\\\\\",\\\\n \\\\\\"db\\\\\\": \\\\\\"tpcds_1000g\\\\\\",\\\\n \\\\\\"stmt\\\\\\": \\\\\\"xxx\\\\\\"\\\\n }\\\\n]\\",\\n \\"TopSqlDigests\\": \\"[\\\\n {\\\\n \\\\\\"maxScanBytes\\\\\\": 279794422882,\\\\n \\\\\\"minScanRows\\\\\\": 0,\\\\n \\\\\\"totalScanRows\\\\\\": 214219674180,\\\\n \\\\\\"avgLatency\\\\\\": 9862.755555555555,\\\\n \\\\\\"minLatency\\\\\\": 5051,\\\\n \\\\\\"maxLatency\\\\\\": 24746,\\\\n \\\\\\"totalScanBytes\\\\\\": 4657224498428,\\\\n \\\\\\"queryCount\\\\\\": 45,\\\\n \\\\\\"avgScanBytes\\\\\\": 103493877742.84445,\\\\n \\\\\\"minScanBytes\\\\\\": 0,\\\\n \\\\\\"totalLatency\\\\\\": 443824,\\\\n \\\\\\"sqlDigest\\\\\\": \\\\\\"d41d8cd98f00b204e9800998ecf8427e\\\\\\",\\\\n \\\\\\"maxScanRows\\\\\\": 23040660808,\\\\n \\\\\\"avgCpuTimeMs\\\\\\": 649451.7777777778,\\\\n \\\\\\"avgScanRows\\\\\\": 4760437204,\\\\n \\\\\\"maxCpuTimeMs\\\\\\": 1368932,\\\\n \\\\\\"sampleStmt\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"user\\\\\\": \\\\\\"admin\\\\\\",\\\\n \\\\\\"db\\\\\\": \\\\\\"tpcds_1000g\\\\\\",\\\\n \\\\\\"totalCpuTimeMs\\\\\\": 29225330,\\\\n \\\\\\"minCpuTimeMs\\\\\\": 2434\\\\n }\\\\n ]\\",\\n \\"ByDatabase\\": \\"[\\\\n {\\\\n \\\\\\"maxScanBytes\\\\\\": 271603242215,\\\\n \\\\\\"minScanRows\\\\\\": 550584606,\\\\n \\\\\\"totalScanRows\\\\\\": 96977924056,\\\\n \\\\\\"avgLatency\\\\\\": 10804,\\\\n \\\\\\"minLatency\\\\\\": 5138,\\\\n \\\\\\"maxLatency\\\\\\": 24746,\\\\n \\\\\\"totalScanBytes\\\\\\": 1441239240695,\\\\n \\\\\\"queryCount\\\\\\": 29,\\\\n \\\\\\"avgScanBytes\\\\\\": 49697904851,\\\\n \\\\\\"minScanBytes\\\\\\": 8691897406,\\\\n \\\\\\"totalLatency\\\\\\": 313322,\\\\n \\\\\\"maxScanRows\\\\\\": 23040660808,\\\\n \\\\\\"avgCpuTimeMs\\\\\\": 732085,\\\\n \\\\\\"avgScanRows\\\\\\": 3344066346,\\\\n \\\\\\"maxCpuTimeMs\\\\\\": 1368932,\\\\n \\\\\\"db\\\\\\": \\\\\\"tpcds_1000g\\\\\\",\\\\n \\\\\\"totalCpuTimeMs\\\\\\": 21230477,\\\\n \\\\\\"minCpuTimeMs\\\\\\": 292711\\\\n }\\\\n]\\"\\n}","type":"json"}]',
],
'DescribeVSwitches' => [
'summary' => 'Queries vSwitches in a specified zone.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREselectdb69DNVG'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => 'The VPC ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp175iuvg8nxqraf2****', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-i', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.'."\n"
.'>This is a reserved parameter and is not supported.>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used to start the next query.'."\n"
.'>This is a reserved parameter and is not supported.>', 'type' => 'string', 'required' => false, 'example' => '4ea98363565e4951e0b5e8707e68181f', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4773E4EC-025D-509F-AEA9-D53123FDFB0F'],
'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'string', 'example' => '15', 'title' => ''],
'PageNumber' => ['description' => 'The current page number.', 'type' => 'string', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries on the current page.', 'type' => 'string', 'example' => '10', 'title' => ''],
'Items' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''],
'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1usf8eabhvibkkfde96', 'title' => ''],
'VSwitchName' => ['description' => 'The vSwitch name.', 'type' => 'string', 'example' => 'subnet', 'title' => ''],
],
'description' => 'The list of results.',
'title' => '',
'example' => '',
],
'description' => 'The list of results.',
'title' => '',
'example' => '',
],
'NextToken' => ['description' => 'The token that is used to start the next query. If this parameter is empty, all results have been returned.', 'type' => 'string', 'example' => '459a0909c0315bfbe0b5e8707e68181f', 'title' => ''],
'MaxResults' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'title' => '',
'description' => 'The response schema.',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => 'The system is abnormal.'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => 'The operation is not supported in the current cluster state.'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidChargeType.NotSupport', 'errorMessage' => 'The specified parameter "ChargeType" does not meet the requirements.', 'description' => ''],
['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', 'description' => 'New Cluster Name'],
['errorCode' => 'InvalidClusterName.Format', 'errorMessage' => 'Specified ClusterName is not valid. It can not be empty string.', 'description' => 'The entered cluster name parameter is invalid.'],
['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The instance version does not support the current operation.', 'description' => 'The instance version does not support the current operation.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.VirtualClusterBound', 'errorMessage' => 'The operation is not permitted due to it has been bound to a virtual cluster.', 'description' => 'Operation is not allowed because it is bound to a virtual cluster.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid parameter, please check.', 'description' => ''],
['errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', 'description' => 'The specified cluster name is not available'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DescribeVSwitches',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeVSwitches',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4773E4EC-025D-509F-AEA9-D53123FDFB0F\\",\\n \\"TotalRecordCount\\": \\"15\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"Items\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"VSwitchId\\": \\"vsw-bp1usf8eabhvibkkfde96\\",\\n \\"VSwitchName\\": \\"subnet\\"\\n }\\n ],\\n \\"NextToken\\": \\"459a0909c0315bfbe0b5e8707e68181f\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]',
],
'DescribeZones' => [
'summary' => 'Describes the available zones.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREselectdb69DNVG'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '- If you do not specify the **MaxResults** request parameter, paged query is disabled. The **MaxResults** response parameter indicates the total number of entries.'."\n"
."\n"
.'- If you specify the **MaxResults** request parameter, paged query is enabled. The **MaxResults** response parameter indicates the number of entries on the current page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'required' => false, 'example' => '40831b4f-d91d-4796-9589-ad306ec528d5', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => 'ADF42B18-43FD-5100-83A9-BE81AB70C863'],
'Items' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-beijing-i', 'title' => ''],
],
'description' => 'A list of zone information.',
'title' => '',
'example' => '',
],
'description' => 'The list of results.',
'title' => '',
'example' => '',
],
'MaxResults' => ['description' => 'The number of entries per page for a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'NextToken' => ['description' => 'The token for the next page of results. If this parameter is empty, all results have been returned.', 'type' => 'string', 'example' => '40831b4f-d91d-4796-9589-ad306ec528d5', 'title' => ''],
],
'title' => '',
'description' => 'Schema of Response',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => 'The system is abnormal.'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => 'The operation is not supported in the current cluster state.'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidChargeType.NotSupport', 'errorMessage' => 'The specified parameter "ChargeType" does not meet the requirements.', 'description' => ''],
['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', 'description' => 'New Cluster Name'],
['errorCode' => 'InvalidClusterName.Format', 'errorMessage' => 'Specified ClusterName is not valid. It can not be empty string.', 'description' => 'The entered cluster name parameter is invalid.'],
['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The instance version does not support the current operation.', 'description' => 'The instance version does not support the current operation.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.VirtualClusterBound', 'errorMessage' => 'The operation is not permitted due to it has been bound to a virtual cluster.', 'description' => 'Operation is not allowed because it is bound to a virtual cluster.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid parameter, please check.', 'description' => ''],
['errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', 'description' => 'The specified cluster name is not available'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DescribeZones',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeZones',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADF42B18-43FD-5100-83A9-BE81AB70C863\\",\\n \\"Items\\": [\\n {\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-i\\"\\n }\\n ],\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"40831b4f-d91d-4796-9589-ad306ec528d5\\"\\n}","type":"json"}]',
],
'EnDisableScalingRules' => [
'summary' => 'Uses the scheduled scaling policy.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '248793',
'abilityTreeNodes' => ['FEATUREselectdbVAZKUZ'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Product',
'in' => 'query',
'schema' => ['description' => 'The cloud service.', 'type' => 'string', 'default' => 'selectdb', 'required' => false, 'example' => 'selectdb', 'title' => ''],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-nwy3jv1oa02-be', 'title' => ''],
],
[
'name' => 'ScalingRulesEnable',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether to enable the scheduled scaling policy.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- true'."\n"
."\n"
.'- false',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'boolean',
'required' => true,
'example' => 'true',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4773E4EC-025D-509F-AEA9-D53123FDFB0F'],
'Data' => [
'description' => 'The data returned.',
'type' => 'object',
'properties' => [
'DbInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'selectdb-cn-pe33jc1nd01-be', 'title' => ''],
'ScalingRulesEnable' => [
'description' => 'Indicates whether the scheduled scaling policy is enabled.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- true'."\n"
."\n"
.'- false',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidClusterId.Malformed', 'errorMessage' => 'The specified parameter "ClusterId" is not valid.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => 'The parameter "DBInstanceId" is illegal.'],
['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter "RegionId" is not valid.', 'description' => ''],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'OperationDenied.EnableScalingRules', 'errorMessage' => 'the operator is not permitted due to scaling rule\'s count is less than 2.', 'description' => ''],
['errorCode' => 'OperationDenied.GetResourceLockFailed', 'errorMessage' => 'the operator is not permitted due to get resource lock failed.', 'description' => 'The request was denied because the resource lock failed to be obtained.'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The cluster does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'EnDisableScalingRules',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:EnDisableScalingRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4773E4EC-025D-509F-AEA9-D53123FDFB0F\\",\\n \\"Data\\": {\\n \\"DbInstanceId\\": \\"selectdb-cn-7213cjv****\\",\\n \\"ClusterId\\": \\"selectdb-cn-pe33jc1nd01-be\\",\\n \\"ScalingRulesEnable\\": true\\n }\\n}","type":"json"}]',
],
'GetCreateBEClusterInquiry' => [
'summary' => 'Queries pricing information for creating a new cluster in a SelectDB instance.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '200392',
'abilityTreeNodes' => ['FEATUREselectdb7TFVYR'],
],
'parameters' => [
[
'name' => 'CommodityCode',
'in' => 'query',
'schema' => [
'description' => 'The commodity code.',
'enumValueTitles' => ['selectdb_pre_public_intl' => 'Subscription product for the international site (alibabacloud.com).', 'selectdb_go_public_cn' => 'Pay-as-you-go product for the China site (aliyun.com).', 'selectdb_go_public_intl' => 'Pay-as-you-go product for the international site (alibabacloud.com).', 'selectdb_pre_public_cn' => 'Subscription product for the China site (aliyun.com).'],
'type' => 'string',
'required' => false,
'example' => 'selectdb_go_public_cn',
'title' => '',
],
],
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => [
'description' => 'The billing method.',
'enumValueTitles' => ['PREPAY' => 'Subscription', 'POSTPAY' => 'Pay-as-you-go'],
'type' => 'string',
'required' => true,
'example' => 'POSTPAY',
'title' => '',
],
],
[
'name' => 'PricingCycle',
'in' => 'query',
'schema' => [
'description' => 'The billing cycle.',
'enumValueTitles' => ['Month' => 'Month', 'Year' => 'Year', 'Minute' => 'Minute', 'Hour' => 'Hour', 'Day' => 'Day'],
'type' => 'string',
'required' => true,
'example' => 'Hour',
'title' => '',
],
],
[
'name' => 'Quantity',
'in' => 'query',
'schema' => ['description' => 'The quantity.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PreCacheSize',
'in' => 'query',
'schema' => ['description' => 'The reserved cache space.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200', 'title' => ''],
],
[
'name' => 'PreComputeSize',
'in' => 'query',
'schema' => ['description' => 'The reserved computing resources.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4', 'title' => ''],
],
[
'name' => 'CacheSize',
'in' => 'query',
'schema' => ['description' => 'The elastic cache space.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200', 'title' => ''],
],
[
'name' => 'ComputeSize',
'in' => 'query',
'schema' => ['description' => 'The elastic computing resources.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4', 'title' => ''],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-xxx', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'PromotionOptionNo',
'in' => 'query',
'schema' => ['type' => 'string', 'example' => '2374923467', 'description' => '', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '06758CAB-1204-5852-A471-29C87D5C1D0F'."\n"],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'Currency' => ['description' => 'The currency.', 'type' => 'string', 'example' => 'CNY', 'title' => ''],
'TradeAmount' => ['description' => 'The amount.', 'type' => 'string', 'example' => '1.76', 'title' => ''],
'PricingRules' => [
'type' => 'object',
'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
'OptionalPromotions' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OptionCode' => ['type' => 'string', 'example' => '7afs9d', 'description' => '', 'title' => ''],
'PromotionDesc' => ['type' => 'string', 'example' => '通用优惠券可抵扣100', 'description' => '', 'title' => ''],
'PromotionName' => ['type' => 'string', 'example' => '通用优惠券', 'description' => '', 'title' => ''],
'CanPromFee' => ['type' => 'string', 'example' => '100', 'description' => '', 'title' => ''],
'PromotionOptionNo' => ['type' => 'string', 'example' => '775735400028', 'description' => '', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'GetCreateBEClusterInquiry',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:GetCreateBEClusterInquiry',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06758CAB-1204-5852-A471-29C87D5C1D0F\\\\n\\",\\n \\"Data\\": {\\n \\"Currency\\": \\"CNY\\",\\n \\"TradeAmount\\": \\"1.76\\",\\n \\"PricingRules\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"OptionalPromotions\\": [\\n {\\n \\"OptionCode\\": \\"7afs9d\\",\\n \\"PromotionDesc\\": \\"通用优惠券可抵扣100\\",\\n \\"PromotionName\\": \\"通用优惠券\\",\\n \\"CanPromFee\\": \\"100\\",\\n \\"PromotionOptionNo\\": \\"775735400028\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'GetModifyBEClusterInquiry' => [
'summary' => 'Retrieves the pricing information for creating a new cluster in a specified ApsaraDB for SelectDB instance.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '201173',
'abilityTreeNodes' => ['FEATUREselectdb7TFVYR'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'selectdb-xxx-be', 'title' => ''],
],
[
'name' => 'CommodityCode',
'in' => 'query',
'schema' => [
'description' => 'The commodity code.',
'enumValueTitles' => ['selectdb_pre_public_intl' => 'Subscription product for the international site (alibabacloud.com).', 'selectdb_go_public_cn' => 'Pay-as-you-go product for the China site (aliyun.com).', 'selectdb_go_public_intl' => 'Pay-as-you-go product for the international site (alibabacloud.com).', 'selectdb_pre_public_cn' => 'Subscription product for the China site (aliyun.com).'],
'type' => 'string',
'required' => true,
'example' => 'selectdb_go_public_cn',
'title' => '',
],
],
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => [
'description' => 'The billing method.',
'enumValueTitles' => ['PREPAY' => 'subscription', 'POSTPAY' => 'pay-as-you-go'],
'type' => 'string',
'required' => true,
'example' => 'POSTPAY',
'title' => '',
],
],
[
'name' => 'PricingCycle',
'in' => 'query',
'schema' => [
'description' => 'The billing cycle.',
'enumValueTitles' => ['Month' => 'Month', 'Year' => 'Year', 'Minute' => 'Minute', 'Hour' => 'Hour', 'Day' => 'Day'],
'type' => 'string',
'required' => true,
'example' => 'Hour',
'title' => '',
],
],
[
'name' => 'Quantity',
'in' => 'query',
'schema' => ['description' => 'The quantity.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PreCacheSize',
'in' => 'query',
'schema' => ['description' => 'The reserved cache space.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200', 'title' => ''],
],
[
'name' => 'PreComputeSize',
'in' => 'query',
'schema' => ['description' => 'The reserved computing resources.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4', 'title' => ''],
],
[
'name' => 'CacheSize',
'in' => 'query',
'schema' => ['description' => 'The elastic cache space.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200', 'title' => ''],
],
[
'name' => 'ComputeSize',
'in' => 'query',
'schema' => ['description' => 'The elastic computing resources.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4', 'title' => ''],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-xxx'."\n", 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'ModifyClusterChargeType',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether this is an inquiry for changing the billing method of the cluster.',
'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'],
'type' => 'boolean',
'required' => false,
'example' => 'true',
'title' => '',
],
],
[
'name' => 'PromotionOptionNo',
'in' => 'query',
'schema' => ['type' => 'string', 'example' => '123412345', 'description' => '', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response schema.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '06758CAB-1204-5852-A471-29C87D5C1D0F'."\n"],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'Currency' => ['description' => 'The currency.', 'type' => 'string', 'example' => 'CNY', 'title' => ''],
'TradeAmount' => ['description' => 'The amount.', 'type' => 'string', 'example' => '1.76', 'title' => ''],
'RefundAmount' => ['description' => 'The estimated refund amount when you change the billing method of a subscription cluster to pay-as-you-go.', 'type' => 'string', 'example' => '-100', 'title' => ''],
'PricingRules' => [
'type' => 'object',
'additionalProperties' => ['type' => 'string', 'description' => '', 'example' => '{"compute_size":{"priceUnit":"元/(CU*小时)","payFee":"0.0"},"cache_size":{"priceUnit":"元/(GB*小时)","payFee":"0.0"},"storage_size":{"priceUnit":"元/(GB*小时)","payFee":"0.0"}', 'title' => ''],
'description' => '',
'title' => '',
'example' => '',
],
'OptionalPromotions' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OptionCode' => ['type' => 'string', 'example' => '789asdf', 'description' => '', 'title' => ''],
'PromotionDesc' => ['type' => 'string', 'example' => 'General coupon deducts 100', 'description' => '', 'title' => ''],
'PromotionName' => ['type' => 'string', 'example' => 'General coupon', 'description' => '', 'title' => ''],
'CanPromFee' => ['type' => 'string', 'example' => '100', 'description' => '', 'title' => ''],
'PromotionOptionNo' => ['type' => 'string', 'example' => '732211480132', 'description' => '', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06758CAB-1204-5852-A471-29C87D5C1D0F\\\\n\\",\\n \\"Data\\": {\\n \\"Currency\\": \\"CNY\\",\\n \\"TradeAmount\\": \\"1.76\\",\\n \\"RefundAmount\\": \\"-100\\",\\n \\"PricingRules\\": {\\n \\"key\\": \\"{\\\\\\"compute_size\\\\\\":{\\\\\\"priceUnit\\\\\\":\\\\\\"元/(CU*小时)\\\\\\",\\\\\\"payFee\\\\\\":\\\\\\"0.0\\\\\\"},\\\\\\"cache_size\\\\\\":{\\\\\\"priceUnit\\\\\\":\\\\\\"元/(GB*小时)\\\\\\",\\\\\\"payFee\\\\\\":\\\\\\"0.0\\\\\\"},\\\\\\"storage_size\\\\\\":{\\\\\\"priceUnit\\\\\\":\\\\\\"元/(GB*小时)\\\\\\",\\\\\\"payFee\\\\\\":\\\\\\"0.0\\\\\\"}\\"\\n },\\n \\"OptionalPromotions\\": [\\n {\\n \\"OptionCode\\": \\"789asdf\\",\\n \\"PromotionDesc\\": \\"General coupon deducts 100\\",\\n \\"PromotionName\\": \\"General coupon\\",\\n \\"CanPromFee\\": \\"100\\",\\n \\"PromotionOptionNo\\": \\"732211480132\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => 'GetModifyBEClusterInquiry',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:GetModifyBEClusterInquiry',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'translator' => 'machine',
],
'ModifyBEClusterAttribute' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '189397',
'abilityTreeNodes' => ['FEATUREselectdb7TFVYR'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => 'Cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-xxxb9f2w-be', 'title' => ''],
],
[
'name' => 'InstanceAttributeType',
'in' => 'query',
'schema' => [
'description' => 'Attribute type to modify.'."\n"
.'Set to DBInstanceDescription.',
'enumValueTitles' => ['DBInstanceDescription' => 'DBInstanceDescription'],
'type' => 'string',
'required' => true,
'enum' => ['MaintainTime', 'DBInstanceDescription'],
'example' => 'DBInstanceDescription',
'title' => '',
],
],
[
'name' => 'Value',
'in' => 'query',
'schema' => ['description' => 'Target cluster name.', 'type' => 'string', 'required' => true, 'example' => 'testdb', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '58E21E11-90FF-50F8-A615-8DEB193676E0'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => 'The operation is not supported in the current cluster state.'],
['errorCode' => 'InvalidClusterName.Format', 'errorMessage' => 'Specified ClusterName is not valid. It can not be empty string.', 'description' => 'The entered cluster name parameter is invalid.'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', 'description' => 'New Cluster Name'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', 'description' => 'The specified cluster name is not available'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ModifyBEClusterAttribute',
'summary' => 'Modifies the cluster name of an ApsaraDB SelectDB instance.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyBEClusterAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58E21E11-90FF-50F8-A615-8DEB193676E0\\"\\n}","type":"json"}]',
],
'ModifyDBCluster' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '190081',
'abilityTreeNodes' => ['FEATUREselectdbVAZKUZ'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-xxxb9f2w-be', 'title' => ''],
],
[
'name' => 'DBClusterClass',
'in' => 'query',
'schema' => ['description' => 'The instance class of the cluster. Valid values:'."\n"
."\n"
.'- **selectdb.xlarge**: 4 cores, 32 GB memory.'."\n"
."\n"
.'- **selectdb.2xlarge**: 8 cores, 64 GB memory.'."\n"
."\n"
.'- **selectdb.4xlarge**: 16 cores, 128 GB memory.'."\n"
."\n"
.'- **selectdb.8xlarge**: 32 cores, 256 GB memory.'."\n"
."\n"
.'- **selectdb.16xlarge**: 16 cores, 512 GB memory.'."\n"
."\n"
.'- **selectdb.24xlarge**: 24 cores, 768 GB memory.'."\n"
."\n"
.'- **selectdb.32xlarge**: 32 cores, 1024 GB memory.', 'type' => 'string', 'required' => true, 'example' => 'selectdb.2xlarge', 'title' => ''],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => 'The database type. The value is fixed to selectdb.', 'type' => 'string', 'default' => 'selectdb', 'required' => false, 'example' => 'selectdb', 'title' => ''],
],
[
'name' => 'CacheSize',
'in' => 'query',
'schema' => ['description' => 'The size of the reserved cache.', 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''],
],
[
'name' => 'ClusterNodeType',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'ClusterNodeCount',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'ScaleMax',
'in' => 'query',
'schema' => ['type' => 'number', 'format' => 'double', 'default' => '32', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'ScaleMin',
'in' => 'query',
'schema' => ['type' => 'number', 'format' => 'double', 'default' => '4', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0BF61F90-ACED-55DF-A6FE-56714B2BFCF6'],
'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'selectdb-cn-7213cjv****'],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '219396937240838', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidCacheSize.NotSupport', 'errorMessage' => 'The specified parameter "CacheSize" does not meet the requirements.', 'description' => 'The parameter "CacheSize" does not meet the requirements.'],
['errorCode' => 'InvalidUpdowngradeConfig.NoChange', 'errorMessage' => 'The upgrade or downgrade configuration is not changed, please re-select.', 'description' => 'The upgrade or downgrade configuration is not changed, please re-select.'],
['errorCode' => 'OperationDenied.OrderProcessing', 'errorMessage' => 'There are orders in process.', 'description' => 'There are orders in process.'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => 'The operation is not supported in the current cluster state.'],
['errorCode' => 'PAY.INSUFFICIENT_BALANCE', 'errorMessage' => 'Insufficient account available balance.', 'description' => 'Insufficient account available balance.'],
['errorCode' => 'ORDER.INST_HAS_UNPAID_ORDER', 'errorMessage' => 'Instance has unpaid order.', 'description' => 'The instance has an unpaid order.'],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'Incoming parameter is not a valid parameter'],
['errorCode' => 'InvalidInstanceClass.MultiAZ', 'errorMessage' => 'The instance with 4-core BE cluster does not support multi-zone redundancy.', 'description' => '4-CPU BE clusters do not support multi-zone same-city redundancy.'],
['errorCode' => 'InvalidInstanceClass.ForMultiAZ', 'errorMessage' => 'The instance with 4-core BE cluster does not support upgrading to multi-zone redundancy.', 'description' => '4-CPU BE clusters do not support multi-zone same-city redundancy.'],
],
403 => [
['errorCode' => 'OperationDenied.ScalingRuleIsEnabled', 'errorMessage' => 'the operator is not permitted due to scaling rule is enabled.', 'description' => 'When the time-sharing elastic policy is enabled, you cannot manually initiate cluster scaling.'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
['errorCode' => 'INSUFFICIENT_AVAILABLE_QUOTA', 'errorMessage' => 'Your account available limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase'],
['errorCode' => 'OperationDenied.SpecificClassCodeNotSupported', 'errorMessage' => 'The uid is not in specific classcode whitelist.', 'description' => 'The selected specification is not open to the current account.'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'InvalidDBClusterState.NotSupport', 'errorMessage' => 'The specified cluster state does\'t support this operation.', 'description' => 'This operation is not supported in the cluster state.'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ModifyDBCluster',
'summary' => 'Scales out or in a specified ApsaraDB for SelectDB cluster.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyDBCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0BF61F90-ACED-55DF-A6FE-56714B2BFCF6\\",\\n \\"DBInstanceId\\": \\"selectdb-cn-7213cjv****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"selectdb-cn-7213cjv****\\",\\n \\"DBClusterId\\": \\"selectdb-cn-7213cjv****\\",\\n \\"OrderId\\": 219396937240838\\n }\\n}","type":"json"}]',
],
'ModifyDBClusterConfig' => [
'summary' => 'Modifies the cluster configuration.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '213179',
'abilityTreeNodes' => ['FEATUREselectdb7TFVYR'],
],
'parameters' => [
[
'name' => 'Parameters',
'in' => 'query',
'schema' => ['description' => 'JSON string of parameters and parameter values.', 'type' => 'string', 'required' => true, 'example' => '{"param1_name":"param1_value","param2_name":"param2_value"}', 'title' => ''],
],
[
'name' => 'ConfigKey',
'in' => 'query',
'schema' => ['description' => 'Configuration file to modify. For compute clusters, it is fixed as be.conf. For fe clusters, it is fixed as fe.conf.', 'type' => 'string', 'required' => true, 'example' => 'be.conf', 'title' => ''],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => 'Cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213c8*****-be', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213c8*****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'SwitchTimeMode',
'in' => 'query',
'schema' => ['description' => 'Upgrade method. If not specified, the upgrade will be performed immediately. If set to 1, the upgrade will be performed during the maintenance window.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'ParallelOperation',
'in' => 'query',
'schema' => ['description' => 'Whether to operate cluster nodes in parallel', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResponse',
'description' => 'PlainResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => 'Return data.',
'type' => 'object',
'properties' => [
'DbInstanceName' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213c8*****', 'title' => ''],
'DbInstanceId' => ['description' => 'Instance numeric ID.', 'type' => 'string', 'example' => '6585', 'title' => ''],
'DbClusterId' => ['description' => 'Cluster ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213c8*****', 'title' => ''],
'TaskId' => ['description' => 'Task ID', 'type' => 'integer', 'format' => 'int32', 'example' => '107878719', 'title' => ''],
],
'title' => '',
'example' => '',
],
'DynamicCode' => ['description' => 'Dynamic code, currently not in use, please ignore.', 'type' => 'string', 'example' => '0', 'title' => ''],
'DynamicMessage' => ['description' => 'Dynamic message, currently not in use, please ignore.', 'type' => 'string', 'example' => 'An error occurred while processing your request.', 'title' => ''],
'AccessDeniedDetail' => ['description' => 'Access denied details.', 'type' => 'string', 'example' => 'failed', 'title' => ''],
'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BC854513-E85E-54F3-9842-B9CCD3308CDD', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
['errorCode' => 'InvalidConfigName', 'errorMessage' => 'The ConfigName is not valid.', 'description' => 'ConfigName is not a valid value.'],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'Incoming parameter is not a valid parameter'],
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => 'The parameter "DBInstanceId" is illegal.'],
['errorCode' => 'InvalidConfigKey.Malformed', 'errorMessage' => 'The specified parameter "ConfigKey" is not valid.', 'description' => 'The specified parameter Parameters is not a valid parameter.'],
['errorCode' => 'InvalidClusterId.Malformed', 'errorMessage' => 'The specified parameter "ClusterId" is not valid.', 'description' => ''],
['errorCode' => 'InvalidConfigParameters.Malformed', 'errorMessage' => 'The specified parameter "Parameters" is not valid.', 'description' => 'The specified parameter Parameters is not a valid parameter.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ModifyDBClusterConfig',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyDBClusterConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"DbInstanceName\\": \\"selectdb-cn-7213c8*****\\",\\n \\"DbInstanceId\\": \\"6585\\",\\n \\"DbClusterId\\": \\"selectdb-cn-7213c8*****\\",\\n \\"TaskId\\": 107878719\\n },\\n \\"DynamicCode\\": \\"0\\",\\n \\"DynamicMessage\\": \\"An error occurred while processing your request.\\",\\n \\"AccessDeniedDetail\\": \\"failed\\",\\n \\"RequestId\\": \\"BC854513-E85E-54F3-9842-B9CCD3308CDD\\"\\n}","type":"json"}]',
],
'ModifyDBInstanceAttribute' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '189266',
'abilityTreeNodes' => ['FEATUREselectdb72PXTX'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'InstanceAttributeType',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => 'The instance parameter to be modified. Valid values:'."\n"
."\n"
.'- **MaintainTime**: Modify the maintenance window of the instance in the hh:mm-hh:mm format.'."\n"
."\n"
.'- **DBInstanceDescription**: Modify the description of the instance.',
'type' => 'string',
'required' => true,
'enum' => ['MaintainTime', 'DBInstanceDescription'],
'example' => 'DBInstanceDescription',
'title' => '',
],
],
[
'name' => 'Value',
'in' => 'query',
'schema' => ['description' => 'The new value of the instance parameter to be modified. Examples:'."\n"
."\n"
.'- If InstanceAttributeType is set to MaintainTime, you can set Value to 00:00-06:00.'."\n"
."\n"
.'- If InstanceAttributeType is set to DBInstanceDescription, you can set Value to testdb.', 'type' => 'string', 'required' => true, 'example' => 'testdb01', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2DB29DEE-52E4-57EE-BF68-2C95C20E6658'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidAttributeTypeValue.Malformed', 'errorMessage' => 'The value of specified parameter "AttributeType" is not valid.', 'description' => 'The property type value of the modified instance is invalid.'],
['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => 'Request execution failed due to lock acquisition timeout.'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidClusterInstance.NotFound', 'errorMessage' => 'Specified cluster instance does not exist.', 'description' => 'SelectDB instance does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ModifyDBInstanceAttribute',
'summary' => 'Modifies the maintenance window or description of an ApsaraDB for SelectDB instance.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyDBInstanceAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DB29DEE-52E4-57EE-BF68-2C95C20E6658\\"\\n}","type":"json"}]',
],
'ModifyElasticRule' => [
'summary' => 'Modifies a scheduled scaling rule.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '248788',
'abilityTreeNodes' => ['FEATUREselectdbVAZKUZ'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Product',
'in' => 'query',
'schema' => ['description' => 'The cloud service.', 'type' => 'string', 'default' => 'selectdb', 'required' => false, 'example' => 'selectdb', 'title' => ''],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-nwy3jv1oa02-be', 'title' => ''],
],
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5467', 'title' => ''],
],
[
'name' => 'ElasticRuleStartTime',
'in' => 'query',
'schema' => ['description' => 'The time when you want to execute the scheduled scaling rule.', 'type' => 'string', 'required' => false, 'example' => '00:00', 'title' => ''],
],
[
'name' => 'ExecutionPeriod',
'in' => 'query',
'schema' => [
'description' => 'The execution cycle.'."\n"
."\n"
.'Valid value:'."\n"
."\n"
.'- Day',
'enumValueTitles' => ['Day' => 'Day'],
'type' => 'string',
'required' => false,
'example' => 'Day',
'title' => '',
],
],
[
'name' => 'ClusterClass',
'in' => 'query',
'schema' => ['description' => 'The rule for computing resources of the required cluster.', 'type' => 'string', 'required' => false, 'example' => 'selectdb.2xlarge', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5ED62C81-9948-5612-81E1-EA3853752306'],
'Data' => [
'description' => 'The data returned.',
'type' => 'object',
'properties' => [
'DbInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'selectdb-cn-zpr3if5wq03-be', 'title' => ''],
'RuleId' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '29252', 'title' => ''],
'ExecutionPeriod' => [
'description' => 'The execution cycle.'."\n"
."\n"
.'Valid value:'."\n"
."\n"
.'- Day',
'enumValueTitles' => ['Day' => 'Day'],
'type' => 'string',
'example' => 'Day',
'title' => '',
],
'ElasticRuleStartTime' => ['description' => 'The time when the scheduled scaling rule is executed.', 'type' => 'string', 'example' => '00:00', 'title' => ''],
'ClusterClass' => ['description' => 'The rule for computing resources of the required cluster.', 'type' => 'string', 'example' => 'selectdb.2xlarge', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidClusterId.Malformed', 'errorMessage' => 'The specified parameter "ClusterId" is not valid.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => 'The parameter "DBInstanceId" is illegal.'],
['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter "RegionId" is not valid.', 'description' => ''],
['errorCode' => 'InvalidRuleId.Malformed', 'errorMessage' => 'The specified parameter "RuleId" is not valid.', 'description' => ''],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'OperationDenied.GetResourceLockFailed', 'errorMessage' => 'the operator is not permitted due to get resource lock failed.', 'description' => 'The request was denied because the resource lock failed to be obtained.'],
['errorCode' => 'OperationDenied.AdjacentRulesClusterIsTheSame', 'errorMessage' => 'the operator is not permitted due to adjacent rules cluster class is the same.', 'description' => 'This operation is prohibited because the target computing resources of adjacent timesharing elasticity rules are the same.'],
['errorCode' => 'OperationDenied.AdjacentRulesIntervalLessThanOneHour', 'errorMessage' => 'the operator is not permitted due to adjacent rules interval less than one hour.', 'description' => 'The operation is prohibited because the time interval between adjacent timesharing elasticity rules is less than 1 hour.'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidElasticRuleId.NotFound', 'errorMessage' => 'The ElasticRuleId provided does not exist in our records.', 'description' => 'Time-sharing elasticity rule does not exist.'],
['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The cluster does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ModifyElasticRule',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyElasticRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5ED62C81-9948-5612-81E1-EA3853752306\\",\\n \\"Data\\": {\\n \\"DbInstanceId\\": \\"selectdb-cn-7213cjv****\\",\\n \\"ClusterId\\": \\"selectdb-cn-zpr3if5wq03-be\\",\\n \\"RuleId\\": 29252,\\n \\"ExecutionPeriod\\": \\"Day\\",\\n \\"ElasticRuleStartTime\\": \\"00:00\\",\\n \\"ClusterClass\\": \\"selectdb.2xlarge\\"\\n }\\n}","type":"json"}]',
],
'ModifySecurityIPList' => [
'summary' => 'Modifies the IP addresses in a whitelist of an ApsaraDB for SelectDB instance.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '189652',
'abilityTreeNodes' => ['FEATUREselectdb72PXTX'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => 'The name of the whitelist. Default value: **Default**.', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''],
],
[
'name' => 'SecurityIPList',
'in' => 'query',
'schema' => ['description' => 'The IP addresses in the whitelist of the instance. Separate multiple IP addresses with commas (,).', 'type' => 'string', 'required' => true, 'example' => '127.0.XX.XX,127.2.XX.XX', 'title' => ''],
],
[
'name' => 'ModifyMode',
'in' => 'query',
'schema' => [
'description' => 'The mode in which you want to modify the whitelist. Valid values:'."\n"
."\n"
.'- **0**: overwrites the IP addresses in the whitelist.'."\n"
."\n"
.'- **1**: adds IP addresses to the whitelist.'."\n"
."\n"
.'- **2**: removes IP addresses from the whitelist.',
'type' => 'string',
'required' => true,
'enum' => ['0', '1', '2'],
'example' => '0',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '195F64C2-8F11-532B-A436-FC08A221D756'],
'GroupName' => ['description' => 'The name of the whitelist.', 'type' => 'string', 'example' => 'group1', 'title' => ''],
'SecurityIPType' => ['description' => 'The IP address type.', 'type' => 'string', 'example' => 'ipv4', 'title' => ''],
'GroupTag' => ['description' => 'The tag of the whitelist.', 'type' => 'string', 'example' => 'grouptag', 'title' => ''],
'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '479095561', 'title' => ''],
'SecurityIPList' => ['description' => 'The IP addresses in the whitelist of the instance. Multiple IP addresses are separated by commas (,).', 'type' => 'string', 'example' => '127.0.XX.XX,127.2.XX.XX', 'title' => ''],
'WhitelistNetType' => ['description' => 'The network type of the whitelist.', 'type' => 'string', 'example' => 'mix', 'title' => ''],
'DBInstanceName' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'Instance test', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list.', 'description' => 'Illegal IP whitelist list: duplicate IP addresses exist in the list.'],
['errorCode' => 'InvalidSecurityIPList.Format', 'errorMessage' => 'Specified security IP list format is not valid.', 'description' => 'The IP whitelist is illegal.'],
['errorCode' => 'InvalidSecurityIPs.Malformed', 'errorMessage' => 'The specified parameter "SecurityIps" is not valid.', 'description' => 'The IP whitelist is illegal.'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'SecurityIPList.Duplicate', 'errorMessage' => 'Specified same security IP already exists.', 'description' => 'IP whitelist already exists.'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"195F64C2-8F11-532B-A436-FC08A221D756\\",\\n \\"GroupName\\": \\"group1\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"GroupTag\\": \\"grouptag\\",\\n \\"TaskId\\": 479095561,\\n \\"SecurityIPList\\": \\"127.0.XX.XX,127.2.XX.XX\\",\\n \\"WhitelistNetType\\": \\"mix\\",\\n \\"DBInstanceName\\": \\"Instance test\\"\\n}","type":"json"}]',
'title' => 'ModifySecurityIPList',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifySecurityIPList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'translator' => 'manual',
],
'ModifyVirtualCluster' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREselectdbVAZKUZ'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => 'The virtual cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-vcg-b****-be', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ActiveClusterId',
'in' => 'query',
'schema' => ['description' => 'The ID of the primary cluster.', 'type' => 'string', 'required' => false, 'example' => 'selectdb-o2yg***-be', 'title' => ''],
],
[
'name' => 'StandbyClusterId',
'in' => 'query',
'schema' => ['description' => 'The ID of the standby cluster.', 'type' => 'string', 'required' => false, 'example' => 'selectdb-pu6y****-be', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '06758CAB-1204-5852-A471-29C87D5C1D0F'],
'Data' => [
'type' => 'object',
'properties' => [
'DbInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
'DbClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'selectdb-vcg-b****-be', 'title' => ''],
],
'description' => 'The returned data.',
'title' => '',
'example' => '',
],
],
'title' => '',
'description' => 'The response body.',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => 'The system is abnormal.'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => 'The operation is not supported in the current cluster state.'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidChargeType.NotSupport', 'errorMessage' => 'The specified parameter "ChargeType" does not meet the requirements.', 'description' => ''],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid parameter, please check.', 'description' => ''],
['errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', 'description' => 'The specified cluster name is not available'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ModifyVirtualCluster',
'summary' => 'Modifies a virtual cluster.',
'description' => '- You can modify the primary cluster independently.'."\n"
."\n"
.'- You can modify the standby cluster independently.'."\n"
."\n"
.'- You can switch between the primary and standby clusters.'."\n"
."\n"
.'>'."\n"
."\n"
.'You cannot modify both the primary and standby clusters in the same operation.'."\n"
."\n"
.'>',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyVirtualCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06758CAB-1204-5852-A471-29C87D5C1D0F\\",\\n \\"Data\\": {\\n \\"DbInstanceId\\": \\"selectdb-cn-7213cjv****\\",\\n \\"DbClusterId\\": \\"selectdb-vcg-b****-be\\"\\n }\\n}","type":"json"}]',
],
'ReleaseInstancePublicConnection' => [
'summary' => 'Releases the public endpoint of an ApsaraDB for SelectDB instance.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '189187',
'abilityTreeNodes' => ['FEATUREselectdb0UAOLL'],
],
'parameters' => [
[
'name' => 'ConnectionString',
'in' => 'query',
'schema' => ['description' => 'The connection string of the instance.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213c8y****-public.selectdbfe.pre.rds.aliyuncs.com', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4773E4EC-025D-509F-AEA9-D53123FDFB0F'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ReleaseInstancePublicConnection',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'selectdb:ReleaseInstancePublicConnection',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4773E4EC-025D-509F-AEA9-D53123FDFB0F\\"\\n}","type":"json"}]',
],
'ResetAccountPassword' => [
'summary' => 'Resets the password for a database account in an ApsaraDB for SelectDB instance.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '189793',
'abilityTreeNodes' => ['FEATUREselectdb22B46K'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => ['description' => 'The database account.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'admin'],
],
[
'name' => 'AccountPassword',
'in' => 'query',
'schema' => ['description' => 'The password of the database account. The password must meet the following requirements:'."\n"
."\n"
.'- The password must consist of at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n"
.'- The special characters are !@#$%^&\\*()\\_+-=.'."\n"
.'- The password must be 8 to 32 characters in length.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a1b2c3d4@'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '58E21E11-90FF-50F8-A615-8DEB193676E0'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
['errorCode' => 'IncorrectAccountType', 'errorMessage' => 'Current account type does not support this operation.', 'description' => ''],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified account name does not exist.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ResetAccountPassword',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ResetAccountPassword',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58E21E11-90FF-50F8-A615-8DEB193676E0\\"\\n}","type":"json"}]',
],
'RestartDBCluster' => [
'summary' => 'Restarts the cluster of a specified ApsaraDB for SelectDB instance.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '191294',
'abilityTreeNodes' => ['FEATUREselectdbIVKE5B'],
],
'parameters' => [
[
'name' => 'ResourceGroupId',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'pattern' => '', 'default' => '', 'example' => 'rg-4690g37929****'],
],
[
'name' => 'DBInstanceId',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'pattern' => '', 'default' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'selectdb-cn-7213c8yvv09-be'],
],
[
'name' => 'ParallelOperation',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to restart the cluster nodes in parallel.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Response schema',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BD0D0B17-C145-5B91-BFC2-6791927EE973'],
'Data' => [
'description' => 'The returned information.',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'title' => '', 'example' => 'selectdb-cn-7213cjv****'],
'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'selectdb-cn-7213c8y****-be'],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => 'The operation is not supported in the current cluster state.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'RestartDBCluster',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:RestartDBCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BD0D0B17-C145-5B91-BFC2-6791927EE973\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"selectdb-cn-7213cjv****\\",\\n \\"DBClusterId\\": \\"selectdb-cn-7213c8y****-be\\"\\n }\\n}","type":"json"}]',
],
'StartBECluster' => [
'summary' => 'Starts a specified ApsaraDB SelectDB cluster.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '189577',
'abilityTreeNodes' => ['FEATUREselectdbIVKE5B'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213c8yvv09-be', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F203FA74-3041-589F-BE66-E570793A0C91'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => 'The operation is not supported in the current cluster state.'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'StartBECluster',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:StartBECluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F203FA74-3041-589F-BE66-E570793A0C91\\"\\n}","type":"json"}]',
],
'StopBECluster' => [
'summary' => 'Stops a specified ApsaraDB SelectDB cluster.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '189470',
'abilityTreeNodes' => ['FEATUREselectdbIVKE5B'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => 'Cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'BC854513-E85E-54F3-9842-B9CCD3308CDD'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'StopBECluster',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:StopBECluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC854513-E85E-54F3-9842-B9CCD3308CDD\\"\\n}","type":"json"}]',
],
'TagResources' => [
'summary' => 'Adds tags to one or more instances.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '218998',
'abilityTreeNodes' => ['FEATUREselectdb72PXTX'],
],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The resource type.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'DBInstance'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'selectdb-cn-7213cjv****'."\n", 'title' => ''],
'required' => true,
'maxItems' => 51,
'description' => 'An array of instance IDs.',
'title' => '',
'example' => '',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'."\n"],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'test_key', 'title' => ''],
'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'test_value', 'title' => ''],
],
'description' => 'The tag.',
'required' => false,
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 21,
'description' => 'An array of tags.',
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '06758CAB-1204-5852-A471-29C87D5C1D0F'."\n"],
],
'title' => '',
'description' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => 'The system is abnormal.'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'NoPermission.TagResources', 'errorMessage' => 'The operator is not permission for this operate.', 'description' => 'You are not authorized to perform this operation.'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'title' => 'TagResources',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'selectdb:TagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:selectdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06758CAB-1204-5852-A471-29C87D5C1D0F\\\\n\\"\\n}","type":"json"}]',
],
'UntagResources' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '219008',
'abilityTreeNodes' => ['FEATUREselectdb72PXTX'],
],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The resource type.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'DBInstance'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'selectdb-cn-7213cjv****'."\n", 'title' => ''],
'maxItems' => 51,
'description' => 'An array of instance IDs.',
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'test_key', 'title' => ''],
'maxItems' => 21,
'description' => 'An array of tag keys.',
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to remove all tags from the instances. This parameter takes effect only when you do not specify TagKey. The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '06758CAB-1204-5852-A471-29C87D5C1D0F'],
],
'title' => '',
'description' => 'Schema of Response',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => 'The system is abnormal.'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'NoPermission.UntagResources', 'errorMessage' => 'The operator is not permission for this operate.', 'description' => 'You do not have permission to perform this operation.'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'title' => 'UntagResources',
'summary' => 'Removes tags from instances.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'selectdb:UntagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:selectdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06758CAB-1204-5852-A471-29C87D5C1D0F\\"\\n}","type":"json"}]',
],
'UpgradeDBInstanceDeployScheme' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '220014',
'abilityTreeNodes' => ['FEATUREselectdb318HEK'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'The ID of the region where the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****', 'title' => ''],
],
[
'name' => 'MultiZone',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing-k', 'title' => ''],
'VSwitchIds' => [
'type' => 'array',
'items' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => true, 'example' => 'vsw-bp10dbralpn4bzmgkkh8f', 'title' => ''],
'required' => true,
'description' => 'The vSwitch ID.',
'title' => '',
'example' => '',
],
],
'required' => true,
'description' => 'Multi-zone configuration.',
'title' => '',
'example' => '',
],
'required' => true,
'description' => 'A list of multi-zone configurations.',
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ADF42B18-43FD-5100-83A9-BE81AB70C863', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
['errorCode' => 'InvalidZoneId.Duplicated', 'errorMessage' => 'The zones cannot be repeated please select different zones.', 'description' => 'The selected Availability Zone cannot be duplicated'],
['errorCode' => 'InvalidZoneId.Malformed', 'errorMessage' => 'The specified parameter "ZoneId" is not valid.', 'description' => 'The ZoneId parameter is invalid'],
['errorCode' => 'InvalidVSwitchId.Malformed', 'errorMessage' => 'The specified parameter "VSwitchId" is not valid.', 'description' => 'The parameter VSwitchId is invalid.'],
['errorCode' => 'InvalidMultiZone.NotThreeZones', 'errorMessage' => 'The number of zones must be three.', 'description' => 'The number of multi-availability zones must be three.'],
['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The instance version does not support the current operation.', 'description' => 'The instance version does not support the current operation.'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => 'The operation is not supported in the current cluster state.'],
['errorCode' => 'InvalidZoneId.Undeployed', 'errorMessage' => 'The zone is undeployed.', 'description' => 'The zone is undeployed.'],
['errorCode' => 'InvalidOperatorType.Malformed', 'errorMessage' => 'The specified operator type is not valid.', 'description' => 'Invalid operation.'],
['errorCode' => 'InvalidInstanceClass.MultiAZ', 'errorMessage' => 'The instance with 4-core BE cluster does not support multi-zone redundancy.', 'description' => '4-CPU BE clusters do not support multi-zone same-city redundancy.'],
['errorCode' => 'InvalidInstanceClass.ForMultiAZ', 'errorMessage' => 'The instance with 4-core BE cluster does not support upgrading to multi-zone redundancy.', 'description' => '4-CPU BE clusters do not support multi-zone same-city redundancy.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'Current DB instance lock mode does not support this operation.'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'UpgradeDBInstanceDeployScheme',
'summary' => 'Upgrades a locally redundant instance to a zone-redundant instance.',
'description' => 'When an instance is upgraded to a zone-redundant architecture, its storage is also upgraded to be zone-redundant. The unit price for storage changes. For more information, see [Billing items and pricing](https://help.aliyun.com/zh/selectdb/product-overview/billing-item-new-version).'."\n"
."\n"
.'> Version requirements'."\n"
.'>'."\n"
.'> - The minor version of the instance must be 4.0.4 or later.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:UpgradeDBInstanceDeployScheme',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADF42B18-43FD-5100-83A9-BE81AB70C863\\"\\n}","type":"json"}]',
],
'UpgradeDBInstanceEngineVersion' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '189245',
'abilityTreeNodes' => ['FEATUREselectdbMK32OZ'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => ['description' => 'Database version.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2.4'],
],
[
'name' => 'SwitchTimeMode',
'in' => 'query',
'schema' => ['description' => 'Upgrade method.'."\n"
."\n"
.'- If you do not specify this parameter, the system immediately upgrades the instance.'."\n"
.'- If you set this parameter to 1, the system upgrades the instance during the maintenance window.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1'],
],
[
'name' => 'ParallelOperation',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'Specifies whether to perform parallel operations on cluster nodes', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '4773E4EC-025D-509F-AEA9-D53123FDFB0F'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => 'english description1'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => 'english description1'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => 'Failed to create order.'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => 'The instance is in a state that does not support the current operation.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'english description1'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => 'english description1'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Not enough resources, please try again later.'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'Instance does not exist.'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => 'english description1'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'english description1'],
['errorCode' => 'InvalidApi.NotFound', 'errorMessage' => 'Specified api is not found, please check your url and method.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'english description1'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => 'english description1'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'english description1'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => 'english description1'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'UpgradeDBInstanceEngineVersion',
'summary' => 'Upgrades the database version of a specified ApsaraDB SelectDB instance.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:UpgradeDBInstanceEngineVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4773E4EC-025D-509F-AEA9-D53123FDFB0F\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'selectdb.aliyuncs.com', 'endpoint' => 'selectdb.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'selectdb.aliyuncs.com', 'endpoint' => 'selectdb.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-7', 'regionName' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'selectdb.aliyuncs.com', 'endpoint' => 'selectdb.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'selectdb.aliyuncs.com', 'endpoint' => 'selectdb.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'selectdb.cn-shenzhen.aliyuncs.com', 'endpoint' => 'selectdb.cn-shenzhen.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-shenzhen.aliyuncs.com'],
['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'selectdb.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'selectdb.cn-wulanchabu.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-wulanchabu.aliyuncs.com'],
['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'selectdb.cn-beijing.aliyuncs.com', 'endpoint' => 'selectdb.cn-beijing.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-beijing.aliyuncs.com'],
['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'selectdb.ap-northeast-1.aliyuncs.com', 'endpoint' => 'selectdb.ap-northeast-1.aliyuncs.com', 'vpc' => 'selectdb-vpc.ap-northeast-1.aliyuncs.com'],
['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'selectdb.cn-chengdu.aliyuncs.com', 'endpoint' => 'selectdb.cn-chengdu.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-chengdu.aliyuncs.com'],
['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'selectdb.cn-qingdao.aliyuncs.com', 'endpoint' => 'selectdb.cn-qingdao.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-qingdao.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'selectdb.cn-shanghai.aliyuncs.com', 'endpoint' => 'selectdb.cn-shanghai.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'selectdb.cn-guangzhou.aliyuncs.com', 'endpoint' => 'selectdb.cn-guangzhou.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-guangzhou.aliyuncs.com'],
['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'selectdb.cn-hongkong.aliyuncs.com', 'endpoint' => 'selectdb.cn-hongkong.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-hongkong.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'selectdb.ap-southeast-1.aliyuncs.com', 'endpoint' => 'selectdb.ap-southeast-1.aliyuncs.com', 'vpc' => 'selectdb-vpc.ap-southeast-1.aliyuncs.com'],
['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'selectdb.cn-huhehaote.aliyuncs.com', 'endpoint' => 'selectdb.cn-huhehaote.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-huhehaote.aliyuncs.com'],
['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'selectdb.ap-southeast-5.aliyuncs.com', 'endpoint' => 'selectdb.ap-southeast-5.aliyuncs.com', 'vpc' => 'selectdb-vpc.ap-southeast-5.aliyuncs.com'],
['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'selectdb.ap-southeast-6.aliyuncs.com', 'endpoint' => 'selectdb.ap-southeast-6.aliyuncs.com', 'vpc' => 'selectdb-vpc.ap-southeast-6.aliyuncs.com'],
['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'selectdb.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'selectdb.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-zhangjiakou.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'selectdb.aliyuncs.com', 'endpoint' => 'selectdb.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-hangzhou.aliyuncs.com'],
['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'selectdb.us-west-1.aliyuncs.com', 'endpoint' => 'selectdb.us-west-1.aliyuncs.com', 'vpc' => 'selectdb-vpc.us-west-1.aliyuncs.com'],
['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'selectdb.us-east-1.aliyuncs.com', 'endpoint' => 'selectdb.us-east-1.aliyuncs.com', 'vpc' => 'selectdb-vpc.us-east-1.aliyuncs.com'],
['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'selectdb.eu-central-1.aliyuncs.com', 'endpoint' => 'selectdb.eu-central-1.aliyuncs.com', 'vpc' => 'selectdb-vpc.eu-central-1.aliyuncs.com'],
['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'selectdb.eu-west-1.aliyuncs.com', 'endpoint' => 'selectdb.eu-west-1.aliyuncs.com', 'vpc' => 'selectdb-vpc.eu-west-1.aliyuncs.com'],
['regionId' => 'na-south-1', 'regionName' => 'Mexico', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'selectdb.na-south-1.aliyuncs.com', 'endpoint' => 'selectdb.na-south-1.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'selectdb.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'selectdb.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-shanghai-finance-1.aliyuncs.com'],
],
'errorCodes' => [
['code' => 'AccountBalanceInsufficient', 'message' => 'The account balance less than 100, plesae charge the balance and retry.', 'http_code' => 403, 'description' => '100 the balance of Aliyun account is insufficient,'],
['code' => 'ClusterNotSupport', 'message' => 'Current instance cluster does not support this operation.', 'http_code' => 400, 'description' => 'The operation is not supported in the current cluster state.'],
['code' => 'COMMODITY.INVALID_COMPONENT', 'message' => 'Order configuration parameters do not meet the verification conditions, please re-match the product.', 'http_code' => 400, 'description' => 'Order configuration parameters do not meet the verification conditions, please re-match the product!'],
['code' => 'CreateOrderFailed', 'message' => 'Failed to create order.', 'http_code' => 400, 'description' => 'Failed to create order.'],
['code' => 'DBClusterNotSupported', 'message' => 'The requested operation can not be performed while the cluster is not sale.', 'http_code' => 403, 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['code' => 'DBInstanceLocked', 'message' => 'The current instance lock mode does not support this operation.', 'http_code' => 404, 'description' => 'english description1'],
['code' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'message' => 'The conversion has been failed, exceed file size limit.', 'http_code' => 400, 'description' => 'english description1'],
['code' => 'EngineVersionDoNotSupportMultiZone', 'message' => 'The specified engine version doesn\'t support multi zone.', 'http_code' => 400, 'description' => 'The specified version does not support the multi_az deploy scheme.'],
['code' => 'Forbidden', 'message' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'http_code' => 400, 'description' => 'english description1'],
['code' => 'IncorrectDBInstanceState', 'message' => 'Current DB instance state does not support this operation.', 'http_code' => 403, 'description' => 'english description1'],
['code' => 'IncorrectVswitchId', 'message' => 'The specified parameter VSwitchId is not valid.', 'http_code' => 404, 'description' => 'english description1'],
['code' => 'InstanceEngineType.NotSupport', 'message' => 'The instance engine and type does not support operations.', 'http_code' => 403, 'description' => 'english description1'],
['code' => 'InsufficientResourceCapacity', 'message' => 'The resource is out of usage.', 'http_code' => 403, 'description' => 'Not enough resources, please try again later.'],
['code' => 'INSUFFICIENT_AVAILABLE_QUOTA', 'message' => 'Your account available limit is less than 0, please recharge before trying to purchase.', 'http_code' => 403, 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase'],
['code' => 'InvalidAttributeTypeValue.Malformed', 'message' => 'The value of specified parameter "AttributeType" is not valid.', 'http_code' => 400, 'description' => 'The property type value of the modified instance is invalid.'],
['code' => 'InvalidBackupPolicyMeta.Malformed', 'message' => 'The parameter BackupMeta for Backup Policy is not valid.', 'http_code' => 400, 'description' => 'Invalid parameter BackupMeta in backup policy'],
['code' => 'InvalidBackupPolicyRetention.NotAllowed', 'message' => 'The specified parameter "BackupSetRetentionPeriod" for BackupPolicy is not valid.', 'http_code' => 400, 'description' => 'BackupSetRetentionPeriod parameters in the backup plan are illegal.'],
['code' => 'InvalidBuyConfigCpuOrCacheSize', 'message' => 'The specified purchase configuration CPU or cache size is invalid.', 'http_code' => 400, 'description' => 'The specified purchase configuration CPU or cache size is invalid.'],
['code' => 'InvalidCacheSize.NotSupport', 'message' => 'The specified parameter "CacheSize" does not meet the requirements.', 'http_code' => 400, 'description' => 'The parameter "CacheSize" does not meet the requirements.'],
['code' => 'InvalidChargeType.Malformed', 'message' => 'The specified parameter "ChargeType" is not valid.', 'http_code' => 400, 'description' => 'The specified parameter "ChargeType" is not valid.'],
['code' => 'InvalidChargeType.NotSupport', 'message' => 'The specified parameter "ChargeType" does not meet the requirements.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidClusterClass.Malformed', 'message' => 'The specified parameter "ClusterClass" is not valid.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidClusterId.Malformed', 'message' => 'The specified parameter "ClusterId" is not valid.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidClusterInstance.NotFound', 'message' => 'Specified cluster instance does not exist.', 'http_code' => 404, 'description' => 'SelectDB instance does not exist.'],
['code' => 'InvalidClusterName.Format', 'message' => 'Specified ClusterName is not valid. It can not be empty string.', 'http_code' => 400, 'description' => 'The entered cluster name parameter is invalid.'],
['code' => 'InvalidClusterName.NotFound', 'message' => 'The specified cluster name is not available.', 'http_code' => 404, 'description' => 'The specified cluster name is not available'],
['code' => 'InvalidConfigKey.Malformed', 'message' => 'The specified parameter "ConfigKey" is not valid.', 'http_code' => 400, 'description' => 'The specified parameter Parameters is not a valid parameter.'],
['code' => 'InvalidConfigName', 'message' => 'The ConfigName is not valid.', 'http_code' => 400, 'description' => 'ConfigName is not a valid value.'],
['code' => 'InvalidConfigParameters.Malformed', 'message' => 'The specified parameter "Parameters" is not valid.', 'http_code' => 400, 'description' => 'The specified parameter Parameters is not a valid parameter.'],
['code' => 'InvalidConnectionString.Duplicate', 'message' => 'The specified connection string already exists.', 'http_code' => 400, 'description' => 'The specified connection string already exists'],
['code' => 'InvalidDBClusterClass.NotFound', 'message' => 'The specified cluster class does not exist.', 'http_code' => 404, 'description' => 'The specified cluster class does not exist.'],
['code' => 'InvalidDBClusterId.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The cluster does not exist.'],
['code' => 'InvalidDBClusterState.NotSupport', 'message' => 'The specified cluster state does\'t support this operation.', 'http_code' => 404, 'description' => 'This operation is not supported in the cluster state.'],
['code' => 'InvalidDBClusterVpc.MismatchWithInstance', 'message' => 'The specified cluster vpc doesn\'t match with instance.', 'http_code' => 404, 'description' => 'The specified cluster vpc doesn\'t match with instance.'],
['code' => 'InvalidDBInstance.NotFound', 'message' => 'The specified instance is not found.', 'http_code' => 404, 'description' => 'english description1'],
['code' => 'InvalidDBInstanceClass.NotFound', 'message' => 'The specified instance classic does not exist.', 'http_code' => 404, 'description' => 'english description1'],
['code' => 'InvalidDBInstanceId.Malformed', 'message' => 'The specified parameter "DBInstanceId" is not valid.', 'http_code' => 400, 'description' => 'The parameter "DBInstanceId" is illegal.'],
['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'The DBInstanceId provided does not exist in our records.', 'http_code' => 404, 'description' => 'Instance does not exist.'],
['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'DBInstanceId not found.', 'http_code' => 400, 'description' => 'The specified instance ID does not exist.'],
['code' => 'InvalidDBInstanceNetType.Malformed', 'message' => 'The specified parameter "DBInstanceNetType" is not valid.', 'http_code' => 400, 'description' => 'Illegal network type.'],
['code' => 'InvalidDBInstanceState.NotSupport', 'message' => 'The specified instance state does\'t support this operation.', 'http_code' => 403, 'description' => 'The instance is in a state that does not support the current operation.'],
['code' => 'InvalidDBName', 'message' => 'The specified database name is not allowed.', 'http_code' => 400, 'description' => 'english description1'],
['code' => 'InvalidDBName.Duplicate', 'message' => 'Specified DB name already exists in the This instance.', 'http_code' => 400, 'description' => 'New Cluster Name'],
['code' => 'InvalidElasticRuleId.NotFound', 'message' => 'The ElasticRuleId provided does not exist in our records.', 'http_code' => 404, 'description' => 'Time-sharing elasticity rule does not exist.'],
['code' => 'InvalidElasticRuleStartTime.Malformed', 'message' => 'The specified parameter "ElasticRuleStartTime" is not valid.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidEndTime.Format', 'message' => 'Specified end time is not valid.', 'http_code' => 400, 'description' => 'The specified jie time is not a valid parameter.'],
['code' => 'InvalidExecutionPeriod.Malformed', 'message' => 'The specified parameter "ExecutionPeriod" is not valid.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidInstance', 'message' => 'This instance don\'t support the action.', 'http_code' => 403, 'description' => 'Instance does not support this operation.'],
['code' => 'InvalidMultiZone.NotThreeZones', 'message' => 'The number of zones must be three.', 'http_code' => 400, 'description' => 'The number of multi-availability zones must be three.'],
['code' => 'InvalidMultiZone.ShouldEmpty', 'message' => 'The "MultiZone" should be empty, please check "DeployScheme".', 'http_code' => 400, 'description' => 'You do not need to fill in the MultiZone. Please check the DeployScheme.'],
['code' => 'InvalidPageNumber.Malformed', 'message' => 'The specified parameter "PageNumber" is not valid.', 'http_code' => 400, 'description' => 'The number of records per page parameter is illegal.'],
['code' => 'InvalidParam', 'message' => 'Invalid parameter, please check.', 'http_code' => 404, 'description' => ''],
['code' => 'InvalidParameterCombination', 'message' => 'The end time must be greater than the start time.', 'http_code' => 400, 'description' => 'The end time must be greater than the start time.'],
['code' => 'InvalidParameters.Format', 'message' => 'Specified parameters is not valid.', 'http_code' => 400, 'description' => 'Incoming parameter is not a valid parameter'],
['code' => 'InvalidPayType.Malformed', 'message' => 'The specified parameter "chargeType" is not valid.', 'http_code' => 400, 'description' => 'Billing method parameter is illegal.'],
['code' => 'InvalidRegionId.Malformed', 'message' => 'The specified parameter "RegionId" is not valid.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidRegionId.NotFound', 'message' => 'The provided RegionId does not exist in our records.', 'http_code' => 404, 'description' => 'english description1'],
['code' => 'InvalidResourceGroup', 'message' => 'The specified ResourceGroupId is invalid.', 'http_code' => 400, 'description' => 'ResourceGroupId parameter is illegal.'],
['code' => 'InvalidRuleId.Malformed', 'message' => 'The specified parameter "RuleId" is not valid.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidSecurityIPList.Duplicate', 'message' => 'Specified security IP list is not valid: Duplicate IP address in the list.', 'http_code' => 400, 'description' => 'Illegal IP whitelist list: duplicate IP addresses exist in the list.'],
['code' => 'InvalidSecurityIPList.Format', 'message' => 'Specified security IP list format is not valid.', 'http_code' => 400, 'description' => 'The IP whitelist is illegal.'],
['code' => 'InvalidSecurityIPs.Malformed', 'message' => 'The specified parameter "SecurityIps" is not valid.', 'http_code' => 400, 'description' => 'The IP whitelist is illegal.'],
['code' => 'InvalidStartTime.Format', 'message' => 'Specified start time is not valid.', 'http_code' => 400, 'description' => 'The specified start time is not a valid parameter.'],
['code' => 'InvalidUpdowngradeConfig.NoChange', 'message' => 'The upgrade or downgrade configuration is not changed, please re-select.', 'http_code' => 400, 'description' => 'The upgrade or downgrade configuration is not changed, please re-select.'],
['code' => 'InvalidVPC.NotFound', 'message' => 'VPC or VSwitch is not valid.', 'http_code' => 404, 'description' => 'Invalid VPC or VSwitch'],
['code' => 'InvalidVpcId.Malformed', 'message' => 'The specified parameter "VpcId" is not valid.', 'http_code' => 400, 'description' => 'Invalid VpcId parameter'],
['code' => 'InvalidVPCId.NotFound', 'message' => 'Specified virtual vpc is not found.', 'http_code' => 404, 'description' => 'Specified VPC not found'],
['code' => 'InvalidVSwitch.NoIP', 'message' => 'VSwitch has zero available IP.', 'http_code' => 404, 'description' => 'VSwitch has zero available IP.'],
['code' => 'InvalidVSwitchId.Malformed', 'message' => 'The specified parameter "VSwitchId" is not valid.', 'http_code' => 400, 'description' => 'The parameter VSwitchId is invalid.'],
['code' => 'InvalidZoneId.Duplicated', 'message' => 'The zones cannot be repeated please select different zones.', 'http_code' => 400, 'description' => 'The selected Availability Zone cannot be duplicated'],
['code' => 'InvalidZoneId.Malformed', 'message' => 'The specified parameter "ZoneId" is not valid.', 'http_code' => 400, 'description' => 'The ZoneId parameter is invalid'],
['code' => 'LockTimeout', 'message' => 'The request processing has failed due to lock timeout.', 'http_code' => 400, 'description' => 'Request execution failed due to lock acquisition timeout.'],
['code' => 'MissingParameter.RegionId', 'message' => 'The RegionId parameters that are required for processing this request are missing.', 'http_code' => 400, 'description' => 'Missing required parameter RegionId'],
['code' => 'MissingParameter.ResourceGroupId', 'message' => 'The ResourceGroupId parameters that are required for processing this request are missing.', 'http_code' => 400, 'description' => 'Missing ResourceGroupId parameter.'],
['code' => 'MissingParameter.ResourceId', 'message' => 'The ResourceId parameters that are required for processing this request are missing.', 'http_code' => 400, 'description' => 'Missing ResourceId parameter.'],
['code' => 'MoneyLessThan100', 'message' => 'The Account Monet less Than 100.', 'http_code' => 403, 'description' => 'english description1'],
['code' => 'NoPermission.ChangeResourceGroup', 'message' => 'You are not authorized to change resourcegroup.', 'http_code' => 403, 'description' => 'You do not have permission to modify the resource group.'],
['code' => 'NoPermission.ListTagResources', 'message' => 'The operator is not permission for this operate.', 'http_code' => 403, 'description' => 'You do not have permission to perform this operation.'],
['code' => 'NoPermission.TagResources', 'message' => 'The operator is not permission for this operate.', 'http_code' => 403, 'description' => 'You are not authorized to perform this operation.'],
['code' => 'NoPermission.UntagResources', 'message' => 'The operator is not permission for this operate.', 'http_code' => 403, 'description' => 'You do not have permission to perform this operation.'],
['code' => 'OperationDenied.AdjacentRulesClusterIsTheSame', 'message' => 'the operator is not permitted due to adjacent rules cluster class is the same.', 'http_code' => 403, 'description' => 'This operation is prohibited because the target computing resources of adjacent timesharing elasticity rules are the same.'],
['code' => 'OperationDenied.AdjacentRulesIntervalLessThanOneHour', 'message' => 'the operator is not permitted due to adjacent rules interval less than one hour.', 'http_code' => 403, 'description' => 'The operation is prohibited because the time interval between adjacent timesharing elasticity rules is less than 1 hour.'],
['code' => 'OperationDenied.DBInstancePayType', 'message' => 'The operation is not permitted due to the pay type of cluster.', 'http_code' => 403, 'description' => 'The billing method of the current instance does not support this operation.'],
['code' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'message' => 'The operation is not permitted due to count of database or account privilege.', 'http_code' => 403, 'description' => 'english description1'],
['code' => 'OperationDenied.EnableScalingRules', 'message' => 'the operator is not permitted due to scaling rule\'s count is less than 2.', 'http_code' => 403, 'description' => ''],
['code' => 'OperationDenied.GetResourceLockFailed', 'message' => 'the operator is not permitted due to get resource lock failed.', 'http_code' => 403, 'description' => 'The request was denied because the resource lock failed to be obtained.'],
['code' => 'OperationDenied.OrderProcessing', 'message' => 'There are orders in process.', 'http_code' => 400, 'description' => 'There are orders in process.'],
['code' => 'OperationDenied.PrepayDBInstanceContainsAtLeastOnePrepayCluster', 'message' => 'the operator is not permitted due to prepay dbinstance contains at least one prepay cluster.', 'http_code' => 403, 'description' => 'The package year and package month instance contains at least one package year and package month cluster.'],
['code' => 'OperationDenied.ScalingRuleIsEnabled', 'message' => 'the operator is not permitted due to scaling rule is enabled.', 'http_code' => 403, 'description' => 'When the time-sharing elastic policy is enabled, you cannot manually initiate cluster scaling.'],
['code' => 'PAY.INSUFFICIENT_BALANCE', 'message' => 'Insufficient account available balance.', 'http_code' => 400, 'description' => 'Insufficient account available balance.'],
['code' => 'QueryPrice.Failed', 'message' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'http_code' => 404, 'description' => 'english description1'],
['code' => 'ResourceNotFound', 'message' => 'The specified resource is not found.', 'http_code' => 400, 'description' => ''],
['code' => 'SecurityIPList.Duplicate', 'message' => 'Specified same security IP already exists.', 'http_code' => 403, 'description' => 'IP whitelist already exists.'],
['code' => 'SystemError', 'message' => 'A system error occurred while processing your request.', 'http_code' => 400, 'description' => 'The system is abnormal.'],
['code' => 'Param.Invalid', 'message' => 'key: toStartTime\'s regexp not match.', 'http_code' => 400, 'description' => 'The parameter is invalid and the start time does not meet the required time format.'],
['code' => 'Param.NotFound', 'message' => 'Parameter not found, please check.', 'http_code' => 404, 'description' => 'Parameter not passed.'],
['code' => 'InvalidFileName.NotFound', 'message' => 'The specified file name does not exist.', 'http_code' => 404, 'description' => 'The specified file name does not exist.'],
['code' => 'OperationDenied.VirtualClusterBound', 'message' => 'The operation is not permitted due to it has been bound to a virtual cluster.', 'http_code' => 403, 'description' => 'Operation is not allowed because it is bound to a virtual cluster.'],
['code' => 'MinorVersionNotSupport', 'message' => 'The instance version does not support the current operation.', 'http_code' => 400, 'description' => 'The instance version does not support the current operation.'],
['code' => 'ORDER.INST_HAS_UNPAID_ORDER', 'message' => 'Instance has unpaid order.', 'http_code' => 400, 'description' => 'The instance has an unpaid order.'],
['code' => 'InvalidOperatorType.Malformed', 'message' => 'The specified operator type is not valid.', 'http_code' => 400, 'description' => 'Invalid operation.'],
['code' => 'IncorrectDBInstanceLockMode', 'message' => 'Current DB instance lock mode does not support this operation.', 'http_code' => 403, 'description' => 'Current DB instance lock mode does not support this operation.'],
['code' => 'InvalidZoneId.Undeployed', 'message' => 'The zone is undeployed.', 'http_code' => 400, 'description' => 'The zone is undeployed.'],
['code' => 'InvalidInstanceType', 'message' => 'The operator is not permitted due to the instance type.', 'http_code' => 400, 'description' => 'The operation is prohibited because of the instance type.'],
['code' => 'OperationDenied.SpecificClassCodeNotSupported', 'message' => 'The uid is not in specific classcode whitelist.', 'http_code' => 403, 'description' => 'The selected specification is not open to the current account.'],
['code' => 'RequestTimeout', 'message' => 'Query timed out. Please try again or narrow down the query scope.', 'http_code' => 408, 'description' => 'Request timed out, please try again or narrow the time range'],
['code' => 'InvalidOthers.Timeout', 'message' => 'Query timed out. Please try again or narrow down the query scope.', 'http_code' => 408, 'description' => 'Request timed out, please try again or narrow the time range'],
['code' => 'Param.Invalid', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => 'The specified parameter is invalid'],
['code' => 'InvalidParam', 'message' => 'Specified parameter is not valid.', 'http_code' => 400, 'description' => 'Invalid input parameter'],
['code' => 'InvalidRequest', 'message' => 'Invalid Request.', 'http_code' => 400, 'description' => 'Invalid Request'],
['code' => 'InvalidParameter.Malformed', 'message' => 'The specified parameter format is not valid.', 'http_code' => 400, 'description' => 'Parameter format error'],
['code' => 'DBInstanceStatusNotActive', 'message' => 'Current DB instance status should be active.', 'http_code' => 403, 'description' => 'The instance can be operated only when it is in the Running state.'],
['code' => 'IncorrectEngineVersion', 'message' => 'Current engine version does not support operations.', 'http_code' => 403, 'description' => 'Current engine version does not support operations.'],
['code' => 'InvalidParameter', 'message' => 'Specified parameter is not valid.', 'http_code' => 400, 'description' => 'Specified parameter is not valid.'],
['code' => 'IncorrectMinorVersion', 'message' => 'Current engine minor version does not support operations.', 'http_code' => 403, 'description' => 'Current engine minor version does not support operations.'],
['code' => 'InvalidParameter.QueryId', 'message' => 'Specified parameters is not valid.', 'http_code' => 400, 'description' => 'Specified parameters is not valid.'],
['code' => 'InvalidInstanceClass.ForMultiAZ', 'message' => 'The instance with 4-core BE cluster does not support upgrading to multi-zone redundancy.', 'http_code' => 400, 'description' => '4-CPU BE clusters do not support multi-zone same-city redundancy.'],
['code' => 'InvalidInstanceClass.MultiAZ', 'message' => 'The instance with 4-core BE cluster does not support multi-zone redundancy.', 'http_code' => 400, 'description' => '4-CPU BE clusters do not support multi-zone same-city redundancy.'],
['code' => 'InvalidFENodeCount.Blank', 'message' => 'The specified parameter "FENodeCount" is blank.', 'http_code' => 400, 'description' => 'Request parameters'],
['code' => 'InvalidFEClassCode.Blank', 'message' => 'The specified parameter "FEClassCode" is blank.', 'http_code' => 400, 'description' => 'The request parameter FEClassCode is empty.'],
['code' => 'InvalidFENodeCount', 'message' => 'The specified parameter "FENodeCount" is not valid.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidNodeCountClassCode.BothChanged', 'message' => 'The specified parameter "FENodeCount" and "FEClassCode" are both changed.', 'http_code' => 400, 'description' => 'FENodeCount and FEClassCode change at the same time.'],
['code' => 'InvalidNodeCountClassCode.BothBlank', 'message' => 'The specified parameter "FENodeCount" and "FEClassCode" are both blank.', 'http_code' => 400, 'description' => 'Both the FENodeCount and FEClassCode parameters are empty.'],
['code' => 'InvalidDBInstanceType.NotSupport', 'message' => 'The specified instance type does\'t support this operation.', 'http_code' => 400, 'description' => 'The current instance type does not support this operation'],
['code' => 'InvalidFEClass.NotFound', 'message' => 'The specified fe class doesn\'t exist.', 'http_code' => 404, 'description' => 'The FE cluster specification does not exist.'],
['code' => 'InvalidFENodeCount.ForMultiAZ', 'message' => 'The instance with FENodeCount that less than 3 does not support upgrading to multi-zone redundancy.', 'http_code' => 400, 'description' => 'The number of FE nodes of a redundant instance in the same city must be greater than or equal to 3.'],
['code' => 'EngineVersionDoNotSupportModifyFE', 'message' => 'The specified engine version doesn\'t support modify fe.', 'http_code' => 400, 'description' => 'The current instance version does not support'],
['code' => 'InvalidNodeCountClassCode.BothNotChanged', 'message' => 'The specified parameter "FENodeCount" and "FEClassCode" are both not changed.', 'http_code' => 400, 'description' => 'FE Single Node Specifications and Number of FE Nodes'],
],
'changeSet' => [],
'ram' => [
'productCode' => 'SelectDB',
'productName' => 'ApsaraDB for SelectDB',
'ramCodes' => ['selectdb'],
'ramLevel' => 'OPERATION',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'DescribeDBClusterStorageLimitation',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:DescribeDBClusterStorageLimitation',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDBInstanceNetInfo',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'selectdb:DescribeDBInstanceNetInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDBInstance',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'selectdb:DeleteDBInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCreateBEClusterInquiry',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:GetCreateBEClusterInquiry',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyBEClusterAttribute',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyBEClusterAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ResetAccountPassword',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ResetAccountPassword',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ChangeResourceGroup',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ChangeResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:selectdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'],
],
],
],
[
'apiName' => 'CreateDBCluster',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:CreateDBCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSecurityIPList',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeSecurityIPList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDBClusterBinding',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:DeleteDBClusterBinding',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDBCluster',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:DeleteDBCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeZones',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeZones',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CheckServiceLinkedRole',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:CheckServiceLinkedRole',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDBInstanceAttribute',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeDBInstanceAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UntagResources',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'selectdb:UntagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:selectdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'],
],
],
],
[
'apiName' => 'ModifyDBInstanceAttribute',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyDBInstanceAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDBInstance',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'selectdb:CreateDBInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'TagResources',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'selectdb:TagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'DBInstance', 'arn' => 'acs:selectdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'],
],
],
],
[
'apiName' => 'ModifyElasticRule',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyElasticRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDBClusterConfigChangeLogs',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:DescribeDBClusterConfigChangeLogs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteVirtualCluster',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'selectdb:DeleteVirtualCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpgradeDBInstanceDeployScheme',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:UpgradeDBInstanceDeployScheme',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDBClusterConfig',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:DescribeDBClusterConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetModifyBEClusterInquiry',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:GetModifyBEClusterInquiry',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeAllDBInstanceClass',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:DescribeAllDBInstanceClass',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'StopBECluster',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:StopBECluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeVSwitches',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeVSwitches',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSlowQueryStats',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:DescribeSlowQueryStats',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateElasticRule',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'selectdb:CreateElasticRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpgradeDBInstanceEngineVersion',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:UpgradeDBInstanceEngineVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyDBClusterConfig',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyDBClusterConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeElasticRules',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeElasticRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifySecurityIPList',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifySecurityIPList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDBClusterBinding',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:CreateDBClusterBinding',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'StartBECluster',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:StartBECluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CheckCreateDBInstance',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:CheckCreateDBInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'AllocateInstancePublicConnection',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'selectdb:AllocateInstancePublicConnection',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'EnDisableScalingRules',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:EnDisableScalingRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeRegions',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeRegions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyDBCluster',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyDBCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RestartDBCluster',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:RestartDBCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteElasticRule',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'selectdb:DeleteElasticRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateVirtualCluster',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'selectdb:CreateVirtualCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CheckIpExistsInSecurityIpList',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'selectdb:CheckIpExistsInSecurityIpList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDBInstances',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeDBInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyVirtualCluster',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyVirtualCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ReleaseInstancePublicConnection',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'selectdb:ReleaseInstancePublicConnection',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateServiceLinkedRoleForSelectDB',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'selectdb:CreateServiceLinkedRoleForSelectDB',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [
['validationType' => 'always', 'resourceType' => 'DBInstance', 'arn' => 'acs:selectdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'],
],
],
];