'1.0',
'info' => ['style' => 'RPC', 'product' => 'selectdb', 'version' => '2023-05-22'],
'directories' => [
[
'children' => ['CreateServiceLinkedRoleForSelectDB', 'CheckCreateDBInstance', 'DescribeSecurityIPList', 'ModifySecurityIPList', 'CheckIpExistsInSecurityIpList', 'ModifyDBInstanceAttribute'],
'type' => 'directory',
'title' => '实例管理',
'id' => 54661,
],
[
'children' => ['ModifyVirtualCluster', 'CreateDBClusterBinding', 'DeleteDBClusterBinding', 'GetCreateBEClusterInquiry', 'GetModifyBEClusterInquiry', 'ModifyBEClusterAttribute', 'StopBECluster', 'StartBECluster', 'RestartDBCluster', 'DescribeDBClusterConfig', 'ModifyDBClusterConfig', 'DescribeDBClusterConfigChangeLogs'],
'type' => 'directory',
'title' => '集群管理',
'id' => 54677,
],
[
'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' => '其他',
'id' => 54692,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AllocateInstancePublicConnection' => [
'summary' => '为指定云数据库SelectDB版实例申请公网地址。',
'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' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'NetType',
'in' => 'query',
'schema' => ['description' => '新增连接地址的网络类型,固定为Public(公网)。', 'type' => 'string', 'required' => true, 'example' => 'Public'],
],
[
'name' => 'ConnectionStringPrefix',
'in' => 'query',
'schema' => ['description' => '目标连接地址的前缀,即**ConnectionString**参数的前缀部分。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-h033cn****-pub-i3'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5ED62C81-9948-5612-81E1-EA3853752306'],
'InstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'New instance test'],
'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '498115273'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceNetType.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceNetType" is not valid.', 'description' => '网络类型非法。'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'The specified connection string already exists.', 'description' => '指定的连接串已存在'],
],
403 => [
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'InvalidClusterInstance.NotFound', 'errorMessage' => 'Specified cluster instance does not exist.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'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' => '申请公网地址',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'selectdb:AllocateInstancePublicConnection',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ChangeResourceGroup' => [
'summary' => '实例转资源组',
'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' => ['title' => '资源类型', 'description' => '资源类型。', 'type' => 'string', 'required' => false, 'example' => 'DBInstance', 'default' => 'Instance'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => ['title' => '资源Id', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['title' => '地域Id', 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shenzhen'],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['title' => '目标资源组', 'description' => '目标资源组。', 'type' => 'string', 'required' => true, 'example' => 'test_resource_group'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FCEEA97F-85CA-5A9F-932F-B4BAEA170896'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter.ResourceGroupId', 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing.', 'description' => 'ResourceGroupId参数缺失。'],
['errorCode' => 'MissingParameter.RegionId', 'errorMessage' => 'The RegionId parameters that are required for processing this request are missing.', 'description' => 'RegionId参数缺失。'],
['errorCode' => 'InvalidResourceGroup', 'errorMessage' => 'The specified ResourceGroupId is invalid.', 'description' => 'ResourceGroupId参数非法。'],
['errorCode' => 'MissingParameter.ResourceId', 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing.', 'description' => 'ResourceId参数缺失。'],
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => '您的账号下不存在该资源。'],
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => '系统异常。'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'NoPermission.ChangeResourceGroup', 'errorMessage' => 'You are not authorized to change resourcegroup.', 'description' => '没有更改资源组的权限。'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'title' => '实例转资源组',
'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' => '创建云数据库SelectDB版实例前的预检查。',
'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' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-4690g37929****'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => '用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。', 'type' => 'string', 'required' => false, 'example' => 'AB'],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => '数据库类型。', 'type' => 'string', 'required' => false, 'example' => 'SelectDB', 'default' => 'SelectDB'],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => ['description' => '数据库版本。', 'type' => 'string', 'required' => true, 'example' => '3.0'],
],
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => ['description' => '实例的付费类型。取值:'."\n"
."\n"
.'- **Postpaid**:后付费(按量付费)。'."\n"
."\n"
.'- **Prepaid**:预付费(包年包月)。', 'type' => 'string', 'required' => true, 'example' => 'PrePaid'],
],
[
'name' => 'UsedTime',
'in' => 'query',
'schema' => ['description' => '指定预付费实例为包年或包月类型。取值说明:'."\n"
.'- 当Period为Year时,UsedTime取值范围为:1、2、3、4、5(整数)。'."\n"
.'- 当Period为Month时,UsedTime取值范围为:1~12(整数)。'."\n"
.'> 仅当ChargeType为Prepaid时,该参数才生效且为必填参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '指定预付费集群为包年或包月类型。取值说明:'."\n"
."\n"
.'- **Year**:包年类型。'."\n"
.'- **Month**:包月类型。'."\n"
.'> 仅当**ChargeType**为**Prepaid**时,该参数才生效且为必填参数。', 'type' => 'string', 'required' => false, 'example' => 'Month'],
],
[
'name' => 'DBInstanceClass',
'in' => 'query',
'schema' => [
'description' => '实例规格,取值说明:'."\n"
.'- **selectdb.xlarge**:4核32GB。'."\n"
.'- **selectdb.2xlarge**: 8核64GB。'."\n"
.'- **selectdb.4xlarge**:16核128GB。'."\n"
.'- **selectdb.8xlarge**:32核256GB。'."\n"
.'- **selectdb.16xlarge**:64核512GB。'."\n"
.'- **selectdb.24xlarge**:96核768GB。'."\n"
.'- **selectdb.32xlarge**:128核1024GB。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['selectdb.2xlarge' => '8核64GB', 'selectdb.4xlarge' => '16核128GB', 'selectdb.24xlarge' => '96核768GB', 'selectdb.32xlarge' => '128核1024GB', 'selectdb.16xlarge' => '64核512GB', 'selectdb.xlarge' => '4核32GB', 'selectdb.8xlarge' => '32核256GB'],
'example' => 'selectdb.xlarge',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => '可用区ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-i'],
],
[
'name' => 'CacheSize',
'in' => 'query',
'schema' => ['description' => '预留缓存大小,单位:GB。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '200'],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => 'VPC ID。', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp175iuvg8nxqraf2****'],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => ['description' => '交换机ID。', 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1gzt31twhlo0sa5****'],
],
[
'name' => 'DBInstanceDescription',
'in' => 'query',
'schema' => ['description' => '实例备注信息。', 'type' => 'string', 'required' => false, 'example' => 'New instance test'],
],
[
'name' => 'ConnectionString',
'in' => 'query',
'schema' => ['description' => '实例的连接址。', 'type' => 'string', 'required' => false, 'example' => 'selectdb-cn-7213c8y****-public.selectdbfe.pre.rds.aliyuncs.com'],
],
[
'name' => 'SecurityIPList',
'in' => 'query',
'schema' => ['description' => '实例的IP白名单,多个IP地址请用英文逗号(,)分隔。', 'type' => 'string', 'required' => false, 'example' => '172.16.XX.XX/12,192.168.XX.XX/22'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ADF42B18-43FD-5100-83A9-BE81AB70C863'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
['errorCode' => 'OperationDenied.SpecificClassCodeNotSupported', 'errorMessage' => 'The uid is not in specific classcode whitelist.', 'description' => '所选规格没有对当前账号开放。'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidVPC.NotFound', 'errorMessage' => 'VPC or VSwitch is not valid.', 'description' => 'VPC或者VSwitch无效'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADF42B18-43FD-5100-83A9-BE81AB70C863\\"\\n}","type":"json"}]',
'title' => '创建实例前的预检查 ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:CheckCreateDBInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'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' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-2bl4dj****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Ip',
'in' => 'query',
'schema' => ['description' => 'IP地址。', 'type' => 'string', 'required' => true, 'example' => '192.168.0.239'],
],
],
'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'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'IpExists' => ['description' => '是否存在。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidSecurityIPs.Malformed', 'errorMessage' => 'The specified parameter "SecurityIps" is not valid.', 'description' => 'IP白名单列表不合法。'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'InvalidClusterInstance.NotFound', 'errorMessage' => 'Specified cluster instance does not exist.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '判断指定 IP 是否已经存在于网络白名单组',
'summary' => '判断指定 IP 是否已经存在于网络白名单组。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'selectdb:CheckIpExistsInSecurityIpList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4773E4EC-025D-509F-AEA9-D53123FDFB0F\\",\\n \\"Data\\": {\\n \\"IpExists\\": true\\n }\\n}","type":"json"}]',
],
'CheckServiceLinkedRole' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1F455133-981E-5AD0-80EB-26EA1EF3C65F'],
'HasServiceLinkedRole' => ['description' => '是否已创建服务关联角色。', 'type' => 'boolean', 'example' => 'False'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '检查服务关联角色',
'summary' => '调用该接口检查服务关联角色。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:CheckServiceLinkedRole',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => ['title' => '资源一级ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => '数据库类型。', 'type' => 'string', 'required' => false, 'example' => 'selectdb', 'default' => 'SelectDB'],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => ['description' => '数据库版本。', 'type' => 'string', 'required' => true, 'example' => '2.4'],
],
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => ['description' => '集群的付费类型。取值:'."\n"
."\n"
.'- **Postpaid**:后付费(按量付费)。'."\n"
."\n"
.'- **Prepaid**:预付费(包年包月)。', 'type' => 'string', 'required' => true, 'example' => 'Prepaid'],
],
[
'name' => 'UsedTime',
'in' => 'query',
'schema' => ['description' => '指定预付费集群的购买时长。取值说明:'."\n"
.'- 当Period为Year时,UsedTime取值范围为:1、2、3、5(整数)。'."\n"
.'- 当Period为Month时,UsedTime取值范围为:1~9(整数)。'."\n"
.'> 仅当ChargeType为Prepaid时,该参数才生效且为必填参数。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '指定预付费集群为包年或包月类型。取值说明:'."\n"
."\n"
.'- **Year**:包年类型。'."\n"
.'- **Month**:包月类型。'."\n"
.'> 仅当**ChargeType**为**Prepaid**时,该参数才生效且为必填参数。', 'type' => 'string', 'required' => false, 'example' => 'Month'],
],
[
'name' => 'DBClusterClass',
'in' => 'query',
'schema' => ['description' => '集群规格,取值说明:'."\n"
.'- **selectdb.xlarge**:4核32GB。'."\n"
.'- **selectdb.2xlarge**: 8核64GB。'."\n"
.'- **selectdb.4xlarge**:16核128GB。'."\n"
.'- **selectdb.8xlarge**:32核256GB。'."\n"
.'- **selectdb.16xlarge**:64核512GB。'."\n"
.'- **selectdb.24xlarge**:96核768GB。'."\n"
.'- **selectdb.32xlarge**:128核1024GB。', 'type' => 'string', 'required' => true, 'example' => 'selectdb.2xlarge'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => '可用区ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-i'],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => 'VPC ID。', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp175iuvg8nxqraf2****'],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => ['description' => '交换机ID。', 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1gzt31twhlo0sa5****'],
],
[
'name' => 'CacheSize',
'in' => 'query',
'schema' => ['description' => '预留缓存大小。', 'type' => 'string', 'required' => true, 'example' => '200'],
],
[
'name' => 'DBClusterDescription',
'in' => 'query',
'schema' => ['description' => '集群备注。', 'type' => 'string', 'required' => true, 'example' => 'testdb'],
],
[
'name' => 'ClusterNodeType',
'in' => 'query',
'schema' => ['type' => 'string'],
],
[
'name' => 'ClusterNodeCount',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1'],
],
[
'name' => 'ScaleMax',
'in' => 'query',
'schema' => ['type' => 'number', 'format' => 'double', 'default' => '32'],
],
[
'name' => 'ScaleMin',
'in' => 'query',
'schema' => ['type' => 'number', 'format' => 'double', 'default' => '4'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F8900A96-67F7-5274-A41B-7722E1ECF8C9'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'],
'OrderId' => ['description' => '订单ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '219543646290345'],
'ClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'selectdb-cn-1ls3sg0po0****'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', 'description' => '新建集群名称重复。'],
['errorCode' => 'InvalidPayType.Malformed', 'errorMessage' => 'The specified parameter "chargeType" is not valid.', 'description' => '计费方式参数不合法。'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
['errorCode' => 'OperationDenied.OrderProcessing', 'errorMessage' => 'There are orders in process.', 'description' => '存在处理中的订单。'],
['errorCode' => 'ORDER.INST_HAS_UNPAID_ORDER', 'errorMessage' => 'Instance has unpaid order.', 'description' => '实例存在未支付订单。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
['errorCode' => 'INSUFFICIENT_AVAILABLE_QUOTA', 'errorMessage' => 'Your account available limit is less than 0, please recharge before trying to purchase.', 'description' => '您的账户可用额度小于0,请先充值后再尝试购买'],
['errorCode' => 'OperationDenied.SpecificClassCodeNotSupported', 'errorMessage' => 'The uid is not in specific classcode whitelist.', 'description' => '所选规格没有对当前账号开放。'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'InvalidClusterInstance.NotFound', 'errorMessage' => 'Specified cluster instance does not exist.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建集群',
'summary' => '为指定云数据库SelectDB版实例创建集群。',
'description' => '>按量付费的实例下只可以创建按量付费的集群。包月付费的实例下两种付费类型的集群都可以创建。>',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:CreateDBCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => '部署模式为同城冗余的实例,两个集群间可创建互相绑定关系。',
'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' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv2ez'],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv2ez-be'],
],
[
'name' => 'DBClusterIdBak',
'in' => 'query',
'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-xxxb9f2w-be'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4773E4EC-025D-509F-AEA9-D53123FDFB0F'."\n"],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'DbInstanceName' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv2ez'],
'DbInstanceId' => ['description' => '实例数字ID。', 'type' => 'string', 'example' => '6585'],
'DbClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv2ez-be'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => '系统异常。'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => '当前集群状态不支持该操作。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['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' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['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' => 'SelectDB实例不存在。'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid parameter, please check.', 'description' => '无效参数,请检查。'],
['errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', 'description' => '指定的集群名称不可用'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建集群绑定',
'description' => '只有同城冗余的实例支持此操作,且需要满足以下条件:'."\n"
."\n"
.'- 位于不同可用区。'."\n"
."\n"
.'- 集群付费模式需要一致。'."\n"
.' '."\n",
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:CreateDBClusterBinding',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => '资源组ID', 'description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzt2zaluvuvqa_fake'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['title' => '幂等参数', 'description' => '用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。', 'type' => 'string', 'required' => false, 'example' => 'AB'],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => '数据库类型,默认值为**selectdb**。', 'type' => 'string', 'required' => false, 'example' => 'selectdb', 'default' => 'SelectDB'],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => ['description' => '数据库版本,默认值为**4.1**。取值说明:'."\n"
."\n"
.'- 4.0。'."\n"
."\n"
.'- 4.1。', 'type' => 'string', 'required' => true, 'example' => '4.1'],
],
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => ['description' => '实例的付费类型。取值:'."\n"
."\n"
.'- **Postpaid**:后付费(按量付费)。'."\n"
."\n"
.'- **Prepaid**:预付费(包年包月)。', 'type' => 'string', 'required' => true, 'example' => 'PrePaid'],
],
[
'name' => 'UsedTime',
'in' => 'query',
'schema' => ['description' => '指定预付费实例的购买时长。取值说明:'."\n"
.'- 当Period为Year时,UsedTime取值范围为:1、2、3、4、5(整数)。'."\n"
.'- 当Period为Month时,UsedTime取值范围为:1~12(整数)。'."\n"
.'>仅当**ChargeType**为**Prepaid**时,该参数才生效且为必填参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '指定预付费集群为包年或包月类型。取值说明:'."\n"
."\n"
.'- **Year**:包年类型。'."\n"
.'- **Month**:包月类型。'."\n"
.'> 仅当**ChargeType**为**Prepaid**时,该参数才生效且为必填参数。', 'type' => 'string', 'required' => false, 'example' => 'Month'],
],
[
'name' => 'DBInstanceClass',
'in' => 'query',
'schema' => ['description' => '实例规格,您可以通过调用[DescribeAllDBInstanceClass](~~2853363~~)接口查询实例规格。', 'type' => 'string', 'required' => true, 'example' => 'selectdb.xlarge'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => '可用区ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-e'],
],
[
'name' => 'CacheSize',
'in' => 'query',
'schema' => ['description' => '预留缓存大小。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '200GB'],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => 'VPC ID。', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp175iuvg8nxqraf2****'],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => ['description' => '交换机ID。', 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1gzt31twhlo0sa5****'],
],
[
'name' => 'DBInstanceDescription',
'in' => 'query',
'schema' => ['description' => '实例备注信息。', 'type' => 'string', 'required' => false, 'example' => 'New instance test'],
],
[
'name' => 'ConnectionString',
'in' => 'query',
'schema' => ['description' => '数据库连接地址。', 'type' => 'string', 'required' => false, 'example' => 'selectdb-cn-7213c8y****-public.selectdbfe.pre.rds.aliyuncs.com'],
],
[
'name' => 'SecurityIPList',
'in' => 'query',
'schema' => ['description' => '实例的IP白名单,多个IP地址请用英文逗号(,)分隔。', 'type' => 'string', 'required' => false, 'example' => '192.168.1.1'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '实例标签列表信息。',
'type' => 'array',
'items' => [
'description' => '实例标签列表。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'testKey'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'testValue'],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DeployScheme',
'in' => 'query',
'schema' => [
'description' => '实例部署模式',
'type' => 'string',
'required' => false,
'example' => 'single_az',
'enum' => ['multi_az', 'single_az'],
],
],
[
'name' => 'MultiZone',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '多可用区配置。'."\n"
."\n"
.'> '."\n"
.'> - 当DeployScheme为multi_az时,该参数生效,且为必填。',
'type' => 'array',
'items' => [
'description' => '多可用区列表。',
'type' => 'object',
'properties' => [
'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-k'],
'VSwitchIds' => [
'description' => '交换机ID列表。',
'type' => 'array',
'items' => ['description' => '交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp10dbralpn4bzmgkkh8f'],
'required' => false,
],
],
'required' => false,
],
'required' => false,
'maxItems' => 3,
'minItems' => 0,
],
],
[
'name' => 'AddVPCIPs',
'in' => 'query',
'schema' => [
'description' => '是否将VPC网段加入到白名单中。取值说明:'."\n"
.'- 1:是'."\n"
.'- 0:否',
'type' => 'string',
'required' => false,
'example' => '1',
'enum' => ['0', '1'],
],
],
[
'name' => 'ClusterNodeType',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'ClusterNodeCount',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'description' => ''],
],
[
'name' => 'ScaleMax',
'in' => 'query',
'schema' => ['type' => 'number', 'format' => 'double', 'required' => false, 'default' => '32', 'description' => ''],
],
[
'name' => 'ScaleMin',
'in' => 'query',
'schema' => ['type' => 'number', 'format' => 'double', 'required' => false, 'default' => '4', 'description' => ''],
],
[
'name' => 'ConfigPatternType',
'in' => 'query',
'schema' => ['title' => '实例应用的配置模板', 'description' => '实例应用的配置模板', 'type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '4773E4EC-025D-509F-AEA9-D53123FDFB0F'],
'Data' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'],
'OrderId' => ['description' => '订单ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '21137950671****'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'COMMODITY.INVALID_COMPONENT', 'errorMessage' => 'Order configuration parameters do not meet the verification conditions, please re-match the product.', 'description' => '订单配置参数不符合校验条件,请重新选配商品!'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
['errorCode' => 'InvalidVSwitchId.Malformed', 'errorMessage' => 'The specified parameter "VSwitchId" is not valid.', 'description' => '参数VSwitchId无效。'],
['errorCode' => 'InvalidMultiZone.NotThreeZones', 'errorMessage' => 'The number of zones must be three.', 'description' => '多可用区数量必须是三个。'],
['errorCode' => 'InvalidZoneId.Duplicated', 'errorMessage' => 'The zones cannot be repeated please select different zones.', 'description' => '所选可用区不能重复'],
['errorCode' => 'EngineVersionDoNotSupportMultiZone', 'errorMessage' => 'The specified engine version doesn\'t support multi zone.', 'description' => '指定版本不支持多可用区部署模式。'],
['errorCode' => 'InvalidChargeType.Malformed', 'errorMessage' => 'The specified parameter "ChargeType" is not valid.', 'description' => '参数ChargeType不是有效的参数'],
['errorCode' => 'InvalidBuyConfigCpuOrCacheSize', 'errorMessage' => 'The specified purchase configuration CPU or cache size is invalid.', 'description' => '指定的购买配置CPU或者缓存大小不合法'],
['errorCode' => 'InvalidZoneId.Malformed', 'errorMessage' => 'The specified parameter "ZoneId" is not valid.', 'description' => 'ZoneId参数不合法'],
['errorCode' => 'InvalidVpcId.Malformed', 'errorMessage' => 'The specified parameter "VpcId" is not valid.', 'description' => 'VpcId参数无效'],
['errorCode' => 'ORDER.INST_HAS_UNPAID_ORDER', 'errorMessage' => 'Instance has unpaid order.', 'description' => '实例存在未支付订单。'],
['errorCode' => 'OperationDenied.OrderProcessing', 'errorMessage' => 'There are orders in process.', 'description' => '存在处理中的订单。'],
['errorCode' => 'InvalidInstanceClass.MultiAZ', 'errorMessage' => 'The instance with 4-core BE cluster does not support multi-zone redundancy.', 'description' => '4 CPU 的 BE 集群不支持多可用区同城冗余。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
['errorCode' => 'INSUFFICIENT_AVAILABLE_QUOTA', 'errorMessage' => 'Your account available limit is less than 0, please recharge before trying to purchase.', 'description' => '您的账户可用额度小于0,请先充值后再尝试购买'],
['errorCode' => 'OperationDenied.SpecificClassCodeNotSupported', 'errorMessage' => 'The uid is not in specific classcode whitelist.', 'description' => '所选规格没有对当前账号开放。'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidVSwitch.NoIP', 'errorMessage' => 'VSwitch has zero available IP.', 'description' => '交换机无可用IP。'],
['errorCode' => 'InvalidDBClusterClass.NotFound', 'errorMessage' => 'The specified cluster class does not exist.', 'description' => '指定的集群规格不存在'],
['errorCode' => 'InvalidVPC.NotFound', 'errorMessage' => 'VPC or VSwitch is not valid.', 'description' => 'VPC或者VSwitch无效'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建实例',
'summary' => '创建一个云数据库 SelectDB 版实例。',
'description' => '不支持删除包年包月实例。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'selectdb:CreateDBInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => [
'summary' => '创建分时弹性规则。',
'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' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'."\n"],
],
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-xxxb9f2w-be'."\n"],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ElasticRuleStartTime',
'in' => 'query',
'schema' => ['description' => '分时弹性规则的开始执行时间。', 'type' => 'string', 'required' => true, 'example' => '00:00'],
],
[
'name' => 'ExecutionPeriod',
'in' => 'query',
'schema' => [
'description' => '执行周期。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['Day' => '每天重复执行'],
'example' => 'Day',
],
],
[
'name' => 'ClusterClass',
'in' => 'query',
'schema' => ['description' => '集群目标计算资源规则。', 'type' => 'string', 'required' => true, 'example' => 'selectdb.2xlarge'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F8900A96-67F7-5274-A41B-7722E1ECF8C9'],
'Data' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'DbInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'."\n"],
'ClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'selectdb-xxxb9f2w-be'],
'RuleId' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '5465'],
'ExecutionPeriod' => [
'description' => '执行周期。',
'type' => 'string',
'enumValueTitles' => ['Day' => 'Day'],
'example' => 'Day',
],
'ElasticRuleStartTime' => ['description' => '分时弹性规则的开始执行时间。', 'type' => 'string', 'example' => '00:00'],
'ClusterClass' => ['description' => '集群目标计算资源规则。', 'type' => 'string', 'example' => 'selectdb.2xlarge'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => '参数"DBInstanceId"不合法。'],
['errorCode' => 'InvalidClusterId.Malformed', 'errorMessage' => 'The specified parameter "ClusterId" is not valid.', 'description' => '参数“ClusterId”不合法。'],
['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter "RegionId" is not valid.', 'description' => '参数“RegionId”不合法。'],
['errorCode' => 'InvalidElasticRuleStartTime.Malformed', 'errorMessage' => 'The specified parameter "ElasticRuleStartTime" is not valid.', 'description' => '参数“ElasticRuleStartTime”不合法。'],
['errorCode' => 'InvalidExecutionPeriod.Malformed', 'errorMessage' => 'The specified parameter "ExecutionPeriod" is not valid.', 'description' => '参数“ExecutionPeriod”不合法。'],
['errorCode' => 'InvalidClusterClass.Malformed', 'errorMessage' => 'The specified parameter "ClusterClass" is not valid.', 'description' => '参数“ClusterClass”不合法。'],
['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' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
['errorCode' => 'InvalidInstanceType', 'errorMessage' => 'The operator is not permitted due to the instance type.', 'description' => '由于实例类型原因,该操作被禁止。'],
],
403 => [
['errorCode' => 'OperationDenied.GetResourceLockFailed', 'errorMessage' => 'the operator is not permitted due to get resource lock failed.', 'description' => '由于获取资源锁失败,本次请求被拒绝执行。'],
['errorCode' => 'OperationDenied.AdjacentRulesClusterIsTheSame', 'errorMessage' => 'the operator is not permitted due to adjacent rules cluster class is the same.', 'description' => '此操作被禁止执行因为相邻分时弹性规则的目标计算资源相同。'],
['errorCode' => 'OperationDenied.AdjacentRulesIntervalLessThanOneHour', 'errorMessage' => 'the operator is not permitted due to adjacent rules interval less than one hour.', 'description' => '操作被禁止执行因为相邻分时弹性规则的时间间隔小于1小时。'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '集群不存在。'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建分时弹性规则',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'selectdb:CreateElasticRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => [
'summary' => '调用该接口创建服务关联角色。',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'none'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F203FA74-3041-589F-BE66-E570793A0C91'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
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' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'title' => '创建服务关联角色',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'selectdb:CreateServiceLinkedRoleForSelectDB',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F203FA74-3041-589F-BE66-E570793A0C91\\"\\n}","type":"json"}]',
],
'CreateVirtualCluster' => [
'summary' => '创建虚拟集群。',
'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' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClusterName',
'in' => 'query',
'schema' => ['description' => '实例名称。命名规则为:必须字母开头,最多 64 个字符,可以使用字母(大小写不敏感)、数字以及下划线(\\_),不能包含连续两个及以上的下划线(\\_),且同一个实例下集群名称不能重复。', 'type' => 'string', 'required' => true, 'example' => 'vcg_demo'],
],
[
'name' => 'ActiveClusterId',
'in' => 'query',
'schema' => ['description' => '主集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'."\n"
.'-be'],
],
[
'name' => 'StandbyClusterId',
'in' => 'query',
'schema' => ['description' => '备集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-26a3cjv****'."\n"
.'-be'],
],
],
'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' => '5ED62C81-9948-5612-81E1-EA3853752306'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'DbInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'],
'DbClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv2ez-be'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => '系统异常。'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => '当前集群状态不支持该操作。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['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' => '新建集群名称重复。'],
['errorCode' => 'InvalidClusterName.Format', 'errorMessage' => 'Specified ClusterName is not valid. It can not be empty string.', 'description' => '输入的集群名称参数不合法。'],
['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The instance version does not support the current operation.', 'description' => '实例版本不支持当前操作。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'OperationDenied.VirtualClusterBound', 'errorMessage' => 'The operation is not permitted due to it has been bound to a virtual cluster.', 'description' => '操作不允许,因为已绑定到虚拟集群。'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['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' => 'SelectDB实例不存在。'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid parameter, please check.', 'description' => '无效参数,请检查。'],
['errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', 'description' => '指定的集群名称不可用'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建虚拟集群',
'description' => '只有同城冗余的实例支持此操作,且需要满足以下条件:'."\n"
."\n"
.'- 实例内核小版本大于等于4.0.7。'."\n"
."\n"
.'- 主备集群位于不同可用区。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'selectdb:CreateVirtualCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => [
'summary' => '删除实例下集群。',
'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' => ['title' => '资源组ID', 'description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-4690g37929****'],
],
[
'name' => 'DBInstanceId',
'in' => 'formData',
'schema' => ['title' => '资源一级ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-xxxb9f2w-be'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F203FA74-3041-589F-BE66-E570793A0C91'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'],
'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '220088764060782'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
['errorCode' => 'OperationDenied.OrderProcessing', 'errorMessage' => 'There are orders in process.', 'description' => '存在处理中的订单。'],
['errorCode' => 'ORDER.INST_HAS_UNPAID_ORDER', 'errorMessage' => 'Instance has unpaid order.', 'description' => '实例存在未支付订单。'],
['errorCode' => 'InvalidInstanceClass.MultiAZ', 'errorMessage' => 'The instance with 4-core BE cluster does not support multi-zone redundancy.', 'description' => '4 CPU 的 BE 集群不支持多可用区同城冗余。'],
['errorCode' => 'InvalidInstanceClass.ForMultiAZ', 'errorMessage' => 'The instance with 4-core BE cluster does not support upgrading to multi-zone redundancy.', 'description' => '4 CPU 的 BE 集群不支持多可用区同城冗余。'],
],
403 => [
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
['errorCode' => 'OperationDenied.VirtualClusterBound', 'errorMessage' => 'The operation is not permitted due to it has been bound to a virtual cluster.', 'description' => '操作不允许,因为已绑定到虚拟集群。'],
],
[
['errorCode' => 'InvalidDBClusterState.NotSupport', 'errorMessage' => 'The specified cluster state does\'t support this operation.', 'description' => '集群状态不支持此操作。'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'InvalidDBClusterVpc.MismatchWithInstance', 'errorMessage' => 'The specified cluster vpc doesn\'t match with instance.', 'description' => '指定的VPC不匹配该实例VPC。'],
['errorCode' => 'InvalidClusterInstance.NotFound', 'errorMessage' => 'Specified cluster instance does not exist.', 'description' => 'SelectDB实例不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除集群',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:DeleteDBCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv2ez'],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv2ez-be'."\n"],
],
[
'name' => 'DBClusterIdBak',
'in' => 'query',
'schema' => ['description' => '绑定关系中的另一个集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-xxxb9f2w-be'."\n"],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F8900A96-67F7-5274-A41B-7722E1ECF8C9'."\n"],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => '系统异常。'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => '当前集群状态不支持该操作。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', 'description' => '指定的集群名称不可用'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid parameter, please check.', 'description' => '无效参数,请检查。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除集群绑定',
'summary' => '删除两集群间的互备绑定关系。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:DeleteDBClusterBinding',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8900A96-67F7-5274-A41B-7722E1ECF8C9\\\\n\\"\\n}","type":"json"}]',
],
'DeleteDBInstance' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '185833',
'abilityTreeNodes' => ['FEATUREselectdb7H9T89'],
],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'formData',
'schema' => ['title' => '实例 ID。', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BD0D0B17-C145-5B91-BFC2-6791927EE973'],
],
],
],
],
'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' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'OperationDenied.DBInstancePayType', 'errorMessage' => 'The operation is not permitted due to the pay type of cluster.', 'description' => '当前实例的计费方式不支持此操作。'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除实例',
'summary' => '删除指定云数据库SelectDB版实例。',
'description' => '不支持删除包年包月实例。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'selectdb:DeleteDBInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BD0D0B17-C145-5B91-BFC2-6791927EE973\\"\\n}","type":"json"}]',
],
'DeleteElasticRule' => [
'summary' => '删除分时弹性规则。',
'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' => '云产品类型。', 'type' => 'string', 'required' => false, 'example' => 'selectdb', 'default' => 'selectdb'],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'."\n"],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hanghzou'],
],
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-xxx302i5-be'],
],
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100458'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '4773E4EC-025D-509F-AEA9-D53123FDFB0F'],
'Success' => [
'description' => '是否删除成功。',
'type' => 'boolean',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => '参数"DBInstanceId"不合法。'],
['errorCode' => 'InvalidClusterId.Malformed', 'errorMessage' => 'The specified parameter "ClusterId" is not valid.', 'description' => '参数“ClusterId”不合法。'],
['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter "RegionId" is not valid.', 'description' => '参数“RegionId”不合法。'],
['errorCode' => 'InvalidRuleId.Malformed', 'errorMessage' => 'The specified parameter "RuleId" is not valid.', 'description' => '参数“RuleId”不合法。'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'OperationDenied.GetResourceLockFailed', 'errorMessage' => 'the operator is not permitted due to get resource lock failed.', 'description' => '由于获取资源锁失败,本次请求被拒绝执行。'],
['errorCode' => 'OperationDenied.AdjacentRulesClusterIsTheSame', 'errorMessage' => 'the operator is not permitted due to adjacent rules cluster class is the same.', 'description' => '此操作被禁止执行因为相邻分时弹性规则的目标计算资源相同。'],
['errorCode' => 'OperationDenied.AdjacentRulesIntervalLessThanOneHour', 'errorMessage' => 'the operator is not permitted due to adjacent rules interval less than one hour.', 'description' => '操作被禁止执行因为相邻分时弹性规则的时间间隔小于1小时。'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidElasticRuleId.NotFound', 'errorMessage' => 'The ElasticRuleId provided does not exist in our records.', 'description' => '分时弹性规则不存在。'],
['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '集群不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除分时弹性规则',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'selectdb:DeleteElasticRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4773E4EC-025D-509F-AEA9-D53123FDFB0F\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DeleteVirtualCluster' => [
'summary' => '删除虚拟集群。',
'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' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => '虚拟集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-vcg-72vz***-be'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '区域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '06758CAB-1204-5852-A471-29C87D5C1D0F'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'DbInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'."\n"],
'DbClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'selectdb-cn-wny3li0****-be'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => '系统异常。'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => '当前集群状态不支持该操作。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', 'description' => '指定的集群名称不可用'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid parameter, please check.', 'description' => '无效参数,请检查。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除虚拟集群',
'description' => '> '."\n"
.'> - 仅删除虚拟集群,**不会**删除绑定的主备集群。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'selectdb:DeleteVirtualCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => '获取所有实例规格信息。',
'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' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '4773E4EC-025D-509F-AEA9-D53123FDFB0F'."\n"],
'ClassCodeList' => [
'description' => '实例规格列表。',
'type' => 'array',
'items' => [
'description' => '实例规格。',
'type' => 'object',
'properties' => [
'ClassCode' => ['description' => '规格码。', 'type' => 'string', 'example' => 'selectdb.xlarge'],
'CpuCores' => ['description' => 'CPU核数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
'MemoryInGB' => ['description' => '内存。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'],
'DefaultStorageInGB' => ['description' => '默认缓存。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'MinStorageInGB' => ['description' => '最小缓存。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxStorageInGB' => ['description' => '最大缓存。', 'type' => 'integer', 'format' => 'int64', 'example' => '2000'],
'StepStorageInGB' => ['description' => '缓存阶梯。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取所有实例规格信息',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:DescribeAllDBInstanceClass',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => '查看集群配置。',
'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' => '修改的配置项文件。'."\n"
.'- 计算集群为:be.conf。'."\n"
.'- fe集群为:fe.conf。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['fe.conf' => 'fe.conf', 'be.conf' => 'be.conf'],
'example' => 'be.conf',
],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213c8yvv09-be'],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResponse',
'description' => 'PlainResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'DbInstanceName' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-wny3li0****'],
'DbInstanceId' => ['description' => '实例数字ID。', 'type' => 'string', 'example' => '6585'],
'DbClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'selectdb-cn-wny3li0****-be'],
'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '107841167'],
'Params' => [
'description' => '用户参数。',
'type' => 'array',
'items' => [
'description' => '用户参数。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '配置项名称。', 'type' => 'string', 'example' => 'doris_scanner_thread_pool_thread_num'],
'Optional' => ['description' => '取值范围。', 'type' => 'string', 'example' => '[0-20000]'],
'Comment' => ['description' => '字段的注释。', 'type' => 'string', 'example' => '存储引擎并发扫描硬盘的线程数。采用线程池统一管理。'],
'Value' => ['description' => '当前值。', 'type' => 'string', 'example' => '10'],
'ParamCategory' => ['description' => '配置项归类。', 'type' => 'string', 'example' => 'Query'],
'DefaultValue' => ['description' => '参数默认值。', 'type' => 'string', 'example' => '15'],
'IsDynamic' => ['description' => '是否动态生效(不需要重启)。', 'type' => 'integer', 'format' => 'int32', 'example' => 'true'],
'IsUserModifiable' => ['description' => '是否允许用户修改。', 'type' => 'integer', 'format' => 'int32', 'example' => 'true'],
],
],
],
],
],
'DynamicCode' => ['description' => '动态code,暂无使用,请忽略。', 'type' => 'string', 'example' => '0'],
'DynamicMessage' => ['description' => '动态消息,暂无使用,请忽略。', 'type' => 'string', 'example' => 'An error occurred while processing your request.'],
'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息;只有校验RAM失败后,字段才会返回。', 'type' => 'string', 'example' => 'failed'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ADF42B18-43FD-5100-83A9-BE81AB70C863'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => '参数"DBInstanceId"不合法。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
],
],
'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' => '查看集群配置',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:DescribeDBClusterConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeDBClusterConfigChangeLogs' => [
'summary' => '查看集群配置变更记录。',
'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' => '修改的配置项文件,计算集群固定为be.conf,FE集群固定为fe.conf。', 'type' => 'string', 'required' => false, 'example' => 'be.conf'],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213c8****-be'],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213c8****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '变更记录查询的起始时间。格式形如:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => true, 'example' => '2023-04-25 09:48:23'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '变更记录查询的截止时间。格式形如:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => true, 'example' => '2023-05-08 15:59:59'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResponse',
'description' => 'PlainResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'DbInstanceName' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213c8****'],
'DbInstanceId' => ['description' => '实例数字ID。', 'type' => 'string', 'example' => '6585'],
'DbClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213c8****-be'],
'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '107841167'],
'ParamChangeLogs' => [
'description' => '参数变更记录。',
'type' => 'array',
'items' => [
'description' => '参数变更记录。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '修改记录ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '617975'],
'Name' => ['description' => '配置项名称。', 'type' => 'string', 'example' => 'cumulative_compaction_rounds_for_each_base_compaction_round'],
'OldValue' => ['description' => ' '."\n"
.'旧参数值。', 'type' => 'string', 'example' => '10'],
'NewValue' => ['description' => ' '."\n"
.'新参数值。', 'type' => 'string', 'example' => '12'],
'IsApplied' => ['description' => '配置是否已生效。', 'type' => 'boolean', 'example' => 'false'],
'GmtCreated' => ['description' => '任务创建时间(GMT)。', 'type' => 'string', 'example' => '2022-10-11T08:53:32Z'],
'GmtModified' => ['description' => '任务修改时间(GMT)。', 'type' => 'string', 'example' => '2024-03-08T10:08Z'],
],
],
],
],
],
'DynamicCode' => ['description' => '动态code,暂无使用,请忽略。', 'type' => 'string', 'example' => '0'],
'DynamicMessage' => ['description' => '动态消息,暂无使用,请忽略。', 'type' => 'string', 'example' => 'An error occurred while processing your request.'],
'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => 'failed'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F8900A96-67F7-5274-A41B-7722E1ECF8C9'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
['errorCode' => 'InvalidEndTime.Format', 'errorMessage' => 'Specified end time is not valid.', 'description' => '指定的结束时间不是有效参数。'],
['errorCode' => 'InvalidStartTime.Format', 'errorMessage' => 'Specified start time is not valid.', 'description' => '指定的开始时间不是有效参数。'],
['errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time.', 'description' => '结束时间必须大于开始时间。'],
['errorCode' => 'InvalidConfigKey.Malformed', 'errorMessage' => 'The specified parameter "ConfigKey" is not valid.', 'description' => '指定参数“ConfigKey”不是有效参数。'],
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => '参数"DBInstanceId"不合法。'],
['errorCode' => 'InvalidClusterId.Malformed', 'errorMessage' => 'The specified parameter "ClusterId" is not valid.', 'description' => '参数“ClusterId”不合法。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', 'description' => '指定的集群名称不可用'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查看集群配置变更记录',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:DescribeDBClusterConfigChangeLogs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => [
'summary' => '获取集群的各规格缓存限制',
'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' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213c8****-be'],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-28t3qs****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResponse',
'description' => 'PlainResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'ClassCodeList' => [
'description' => '缓存规格列表。',
'type' => 'array',
'items' => [
'description' => '缓存规格详情。',
'type' => 'object',
'properties' => [
'ClassCode' => ['description' => '规格码。', 'type' => 'string', 'example' => 'selectdb.xlarge'],
'CpuCores' => ['description' => 'CPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'MemoryInGB' => ['description' => '内存,单位GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'],
'DefaultStorageInGB' => ['description' => '默认缓存,单位GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
'MinStorageInGB' => ['description' => '最小缓存,单位GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'MaxStorageInGB' => ['description' => '最大缓存,单位GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'],
'StepStorageInGB' => ['description' => '缓存阶梯,单位GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
],
'DynamicCode' => ['description' => '动态code,暂无使用,请忽略。', 'type' => 'string', 'example' => '0'],
'DynamicMessage' => ['description' => '动态消息,暂无使用,请忽略。', 'type' => 'string', 'example' => 'An error occurred while processing your request.'],
'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息;只有校验RAM失败后,字段才会返回。', 'type' => 'string', 'example' => 'failed'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4773E4EC-025D-509F-AEA9-D53123FDFB0F'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => '参数"DBInstanceId"不合法。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查看集群各规格缓存限制',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:DescribeDBClusterStorageLimitation',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => '查询实例详情。',
'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' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '06758CAB-1204-5852-A471-29C87D5C1D0F'],
'Status' => ['title' => '实例的状态,取值说明:'."\n"
."\n"
.'- **CREATING**:创建中。'."\n"
."\n"
.'- **ACTIVE**:运行中。'."\n"
."\n"
.'- **RESOURCE_CHANGING**:变配中。'."\n"
."\n"
.'- **ORDER_PREPARING**:订单确认中。'."\n"
."\n"
.'- **READONLY_RESOURCE_CHANGING**:资源变配中(实例写入锁定)。'."\n"
."\n"
.'- **DELETING**:删除中。', 'description' => '实例的状态,取值说明:'."\n"
."\n"
.'- **CREATING**:创建中。'."\n"
."\n"
.'- **ACTIVE**:运行中。'."\n"
."\n"
.'- **RESOURCE_CHANGING**:变配中。'."\n"
."\n"
.'- **ORDER_PREPARING**:订单确认中。'."\n"
."\n"
.'- **READONLY_RESOURCE_CHANGING**:资源变配中(实例写入锁定)。'."\n"
."\n"
.'- **DELETING**:删除中。', 'type' => 'string', 'example' => 'ACTIVE'],
'SubDomain' => ['title' => '可用区。', 'description' => '可用区。', 'type' => 'string', 'example' => 'Reserved parameter.'],
'GmtModified' => ['title' => '实例修改时间(例如重启,申请公网等操作)。格式为yyyy-MM-ddTHH:mmZ(UTC时间)。', 'description' => '实例修改时间(例如重启,申请公网等操作)。格式为yyyy-MM-ddTHH:mmZ(UTC时间)。', 'type' => 'string', 'example' => '2023-08-17T09:58Z'],
'LockMode' => ['title' => '实例锁定模式,取值为**lock**,实例自动过期或欠费。', 'description' => '实例锁定模式,取值为**lock**,实例自动过期或欠费。', 'type' => 'integer', 'format' => 'int64', 'example' => 'lock'],
'LockReason' => ['title' => '实例锁定原因。', 'description' => '实例锁定原因。', 'type' => 'string', 'example' => 'nolock'],
'ResourceCpu' => ['title' => '资源CPU数量。', 'description' => '资源CPU数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'],
'StorageSize' => ['title' => '存储空间大小。', 'description' => '存储空间大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '400'],
'ObjectStoreSize' => ['title' => '存储空间。', 'description' => '存储空间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaintainStarttime' => ['title' => '实例可维护时间段的开始时间。', 'description' => '实例可维护时间段的开始时间。', 'type' => 'string', 'example' => 'Reserved parameter.'],
'MaintainEndtime' => ['title' => '实例可维护时间段的结束时间。', 'description' => '实例可维护时间段的结束时间。', 'type' => 'string', 'example' => 'Reserved parameter.'],
'DBClusterList' => [
'title' => '集群列表。',
'description' => '实例所属集群列表信息。',
'type' => 'array',
'items' => [
'title' => '集群列表。',
'description' => '集群列表。',
'type' => 'object',
'properties' => [
'DbInstanceName' => ['title' => '实例名称。', 'description' => '实例名称。', 'type' => 'string', 'example' => 'Instance test'],
'DbClusterId' => ['title' => '集群ID。', 'description' => '集群ID。', 'type' => 'string', 'example' => 'selectdb-cn-h033cjs****-be'],
'DbClusterName' => ['title' => '集群名称。', 'description' => '集群名称。', 'type' => 'string', 'example' => 'test01'],
'Status' => ['title' => '集群的状态,取值说明:'."\n"
.'- **CREATING**:创建中。'."\n"
."\n"
.'- **ACTIVATION**:运行中。'."\n"
."\n"
.'- **RESOURCE_CHANGING**:变配中。'."\n"
."\n"
.'- **ORDER_PREPARING**:订单确认中。'."\n"
."\n"
.'- **READONLY_RESOURCE_CHANGING**:资源变配中(实例写入锁定)。'."\n"
."\n"
.'- **DELETING**:删除中。', 'description' => '集群的状态,取值说明:'."\n"
.'- **CREATING**:创建中。'."\n"
."\n"
.'- **ACTIVATION**:运行中。'."\n"
."\n"
.'- **RESOURCE_CHANGING**:变配中。'."\n"
."\n"
.'- **ORDER_PREPARING**:订单确认中。'."\n"
."\n"
.'- **READONLY_RESOURCE_CHANGING**:资源变配中(实例写入锁定)。'."\n"
."\n"
.'- **DELETING**:删除中。', 'type' => 'string', 'example' => 'ACTIVATION'],
'CreatedTime' => ['title' => '集群的创建时间。', 'description' => '集群的创建时间。', 'type' => 'string', 'example' => '2023-08-14T09:24:13Z'],
'DbClusterClass' => ['title' => '集群规格,取值说明:'."\n"
.'- **selectdb.xlarge**:4核16GB。'."\n"
.'- **selectdb.2xlarge**: 8核32GB。'."\n"
.'- **selectdb.4xlarge**:16核64GB。'."\n"
.'- **selectdb.8xlarge**:32核128GB。'."\n"
.'- **selectdb.16xlarge**:64核256GB。'."\n"
.'- **selectdb.24xlarge**:96核384GB。'."\n"
.'- **selectdb.32xlarge**:128核512GB。', 'description' => '集群规格,取值说明:'."\n"
.'- **selectdb.xlarge**:4核16GB。'."\n"
.'- **selectdb.2xlarge**: 8核32GB。'."\n"
.'- **selectdb.4xlarge**:16核64GB。'."\n"
.'- **selectdb.8xlarge**:32核128GB。'."\n"
.'- **selectdb.16xlarge**:64核256GB。'."\n"
.'- **selectdb.24xlarge**:96核384GB。'."\n"
.'- **selectdb.32xlarge**:128核512GB。', 'type' => 'string', 'example' => 'selectdb.2xlarge'],
'CpuCores' => ['title' => 'CPU核数。', 'description' => 'CPU核数。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'],
'Memory' => ['title' => '内存大小。', 'description' => '内存大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '64'],
'CacheStorageType' => ['title' => '缓存空间类型。', 'description' => '缓存空间类型。', 'type' => 'string', 'example' => 'cloud_essd'],
'PerformanceLevel' => ['title' => '性能级别。', 'description' => '性能级别。', 'type' => 'string', 'example' => 'PL1'],
'CacheStorageSizeGB' => ['title' => '缓存空间,单位:GB。', 'description' => '缓存空间,单位:GB。', 'type' => 'string', 'example' => '200'],
'StartTime' => ['title' => '集群启动时间。', 'description' => '集群启动时间。', 'type' => 'string', 'example' => '2023-08-14T09:24:13Z'],
'ChargeType' => ['title' => '集群的付费类型。取值:'."\n"
."\n"
.'- **Postpaid**:后付费(按量付费)'."\n"
."\n"
.'- **Prepaid**:预付费(包年包月)', 'description' => '集群的付费类型。取值:'."\n"
."\n"
.'- **Postpaid**:后付费(按量付费)'."\n"
."\n"
.'- **Prepaid**:预付费(包年包月)', 'type' => 'string', 'example' => 'Prepaid'],
'ModifiedTime' => ['title' => '修改时间。', 'description' => '修改时间。', 'type' => 'string', 'example' => '2024-07-02T16:35:44+08:00'],
'ScalingRulesEnable' => ['title' => '是否开启分时弹性策略。', 'description' => '是否开启分时弹性策略。', 'type' => 'boolean', 'example' => 'false'],
'ZoneId' => ['title' => '可用区ID。', 'description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-k'],
'VSwitchId' => ['title' => '交换机ID。', 'description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-t4n8x7jcc8rknon85tqoa'],
'SubDomain' => ['title' => '子域。', 'description' => '子域。', 'type' => 'string', 'example' => '预留参数,暂不返回。'],
'ClusterBinding' => ['title' => '绑定的目标集群。', 'description' => '绑定的目标集群。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****-be'],
'ClusterNodeType' => [
'description' => '集群节点类型。仅在serverless下生效。',
'type' => 'string',
'enumValueTitles' => ['base' => '1SCU的CPU/内存比例为1:4'],
'example' => 'base',
],
'ClusterNodeCount' => ['description' => '集群节点数量。仅在serverless下生效。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ScaleMax' => ['title' => '实例RCU(RDS Capacity Unit)的自动扩缩范围最大值。', 'description' => '实例RCU(RDS Capacity Unit)的自动扩缩范围最大值。', 'type' => 'number', 'format' => 'double', 'example' => '4'],
'ScaleMin' => ['title' => '实例RCU(RDS Capacity Unit)自动扩缩范围的最小值。', 'description' => '实例RCU(RDS Capacity Unit)自动扩缩范围的最小值。', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
],
],
],
'Engine' => ['title' => '数据库类型。', 'description' => '数据库类型。', 'type' => 'string', 'example' => 'selectdb'],
'EngineVersion' => ['title' => '数据库版本。', 'description' => '数据库版本。', 'type' => 'string', 'example' => '2.4'],
'EngineMinorVersion' => ['title' => '实例的内核小版本号。', 'description' => '实例的内核小版本号。', 'type' => 'string', 'example' => '3.0.1'],
'DBInstanceId' => ['title' => '实例ID。', 'description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'],
'Description' => ['title' => '实例备注信息。', 'description' => '实例备注信息。', 'type' => 'string', 'example' => 'test'],
'CreateTime' => ['title' => '创建时间。', 'description' => '创建时间。', 'type' => 'string', 'example' => '2023-08-14T03:00:42Z'],
'CanUpgradeVersions' => [
'title' => '可升级的版本信息列表。',
'description' => '信息列表。',
'type' => 'array',
'items' => ['title' => '列表。', 'description' => '信息列表。', 'type' => 'string', 'example' => 'test'],
],
'ChargeType' => ['title' => '实例的付费类型。取值:'."\n"
."\n"
.'- **Postpaid**:后付费(按量付费)'."\n"
."\n"
.'- **Prepaid**:预付费(包年包月)', 'description' => '实例的付费类型。取值:'."\n"
."\n"
.'- **Postpaid**:后付费(按量付费)'."\n"
."\n"
.'- **Prepaid**:预付费(包年包月)', 'type' => 'string', 'example' => 'Prepaid'],
'ExpireTime' => ['title' => '实例到期时间。', 'description' => '实例到期时间。', 'type' => 'string', 'example' => '2023-09-17T00:00Z'],
'ResourceGroupId' => ['title' => '实例所属的资源组ID。', 'description' => '实例所属的资源组ID。', 'type' => 'string', 'example' => 'rg-aekzbck4asz3dsa'],
'Tags' => [
'title' => '实例标签列表。',
'description' => '实例标签列表信息。',
'type' => 'array',
'items' => [
'title' => '实例标签列表。',
'description' => '实例标签列表。',
'type' => 'object',
'properties' => [
'TagKey' => ['title' => '标签键。', 'description' => '标签键。', 'type' => 'string', 'example' => 'testKey'],
'TagValue' => ['title' => '标签值。', 'description' => '标签值。', 'type' => 'string', 'example' => 'testValue'],
],
],
],
'RegionId' => ['title' => '地域ID。', 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-beijing'],
'ZoneId' => ['title' => '实例可用区ID', 'description' => '实例可用区ID', 'type' => 'string', 'example' => 'cn-beijing-h'],
'VpcId' => ['title' => '实例VPC ID。', 'description' => '实例VPC ID。', 'type' => 'string', 'example' => 'vpc-bp175iuvg8nxqraf2****'],
'VSwitchId' => ['title' => '交换机ID。', 'description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-bp18iztwqrs8qj2nc6nyu'],
'DeployScheme' => ['title' => '实例部署模式', 'description' => '实例部署模式', 'type' => 'string', 'example' => 'multi_az'],
'MultiZone' => [
'title' => '多可用区列表。',
'description' => '多可用区配置。'."\n"
."\n"
.'> '."\n"
.'> - 当DeployScheme为multi_az时,该参数有效。',
'type' => 'array',
'items' => [
'title' => '多可用区列表。',
'description' => '多可用区列表。',
'type' => 'object',
'properties' => [
'ZoneId' => ['title' => '可用区ID。', 'description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-k'],
'VSwitchIds' => [
'title' => '交换机ID。',
'description' => '交换机ID列表。',
'type' => 'array',
'items' => ['title' => '交换机ID。', 'description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-bp10dbralpn4bzmgkkh8f'],
],
'Cidr' => ['title' => '前缀列表条目的CIDR地址块信息。', 'description' => '前缀列表条目的CIDR地址块信息。', 'type' => 'string', 'example' => '113.88.14.211/32'],
'AvailableIpCount' => ['title' => '可用区下可用IP。', 'description' => '可用区下可用IP。', 'type' => 'integer', 'format' => 'int64', 'example' => '4096'],
],
],
],
'Serverless' => ['title' => '当前实例是否开启了Serverless功能。'."\n"
."\n"
.'- 返回true表示开启了Serverless功能。'."\n"
.'- 返回false表示没有开启Serverless功能。', 'description' => '当前实例是否开启了Serverless功能。'."\n"
."\n"
.'- 返回true表示开启了Serverless功能。'."\n"
.'- 返回false表示没有开启Serverless功能。', 'type' => 'boolean', 'example' => 'false'],
'SecGroupConnValid' => ['title' => '当前实例所在VPC是否启用端口直连功能。'."\n"
."\n"
.'- 返回true表示开启了端口直连功能。'."\n"
.'- 返回false表示没有开启端口直连功能。', 'description' => '当前实例所在VPC是否启用端口直连功能。'."\n"
."\n"
.'- 返回true表示开启了端口直连功能。'."\n"
.'- 返回false表示没有开启端口直连功能。', 'type' => 'string', 'example' => 'false'],
'VirtualClusterList' => [
'description' => '虚拟集群列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DbClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'selectdb-vcg-33cjs****-be'],
'DbClusterName' => ['description' => '集群名称。', 'type' => 'string', 'example' => 'vgcdemo'],
'Status' => ['description' => '实例的状态,取值说明:'."\n"
."\n"
.'- **CREATING**:创建中。'."\n"
.'- **RUNNING**:运行中。'."\n"
.'- **DELETING**:删除中。'."\n"
.'- **UPDATING**:更新中。', 'type' => 'string', 'example' => 'UPDATING'],
'CreatedTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-05-31T21:01:09Z'],
'ActiveClusterId' => ['description' => '主集群ID。', 'type' => 'string', 'example' => 'selectdb-xx78***-be'],
'ActiveClusterName' => ['description' => '主集群名称。', 'type' => 'string', 'example' => 'test1'],
'StandbyClusterId' => ['description' => '备集群ID。', 'type' => 'string', 'example' => 'selectdb-x6u7***-be'."\n"],
'StandbyClusterName' => ['description' => '备集群名称。', 'type' => 'string', 'example' => 'test2'],
],
'title' => '',
'description' => '',
],
],
'ConfigPatternType' => ['title' => '实例已应用的配置模板', 'description' => '实例已应用的配置模板', 'type' => 'string', 'example' => 'log'],
'OTelGrafanaServiceStatus' => ['title' => 'OTel collector和Grafana服务状态', 'type' => 'string'],
'OTelBearerToken' => ['title' => 'OTel collector bearer token。', 'type' => 'string'],
'LangfuseInstanceIds' => [
'title' => 'selectdb实例关联的langfuse实例ID列表。',
'type' => 'array',
'items' => ['title' => 'selectdb关联的langfuse实例ID。', 'type' => 'string', 'example' => 'lfu-xxkshuf23sdj'],
],
'CanUpgradeVersionCommunityMap' => [
'type' => 'object',
'additionalProperties' => ['type' => 'string'],
],
'CommunityVersion' => ['type' => 'string'],
'MCPServerServiceStatus' => ['title' => 'MCP Server服务状态。', 'type' => 'string', 'example' => 'not_enabled'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', 'description' => '新建集群名称重复。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'InvalidClusterInstance.NotFound', 'errorMessage' => 'Specified cluster instance does not exist.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询实例详情',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeDBInstanceAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'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' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ADF42B18-43FD-5100-83A9-BE81AB70C863'],
'DBInstanceNetInfos' => [
'description' => '实例网络信息。',
'type' => 'array',
'items' => [
'description' => '实例网络信息。',
'type' => 'object',
'properties' => [
'NetType' => ['description' => '实例的网络类型,取值如下:'."\n"
."\n"
.'- **VPC**:表示专有网络VPC。'."\n"
.' '."\n"
.'- **PUBLIC**:表示公网。', 'type' => 'string', 'example' => 'VPC'],
'VpcInstanceId' => ['description' => 'VPC实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-h033cnd****-fe-20230816101006'],
'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-wz90scxq6ods388ft****'],
'VswitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-uf6mlqti065rer6m0****'],
'UserVisible' => ['description' => '用户是否可见,取值说明:'."\n"
."\n"
.'- **true**:用户可见。'."\n"
."\n"
.'- **false**:用户不可见。', 'type' => 'boolean', 'example' => 'true'],
'ConnectionString' => ['description' => '连接地址。', 'type' => 'string', 'example' => 'selectdb-cn-h033cnd****-fe.selectdbfe.pre.rds.aliyuncs.com'],
'Ip' => ['description' => 'IP地址。', 'type' => 'string', 'example' => '172.16.XX.XX'],
'PortList' => [
'description' => '端口对象。',
'type' => 'array',
'items' => [
'description' => '端口详情。',
'type' => 'object',
'properties' => [
'Protocol' => ['description' => '端口类型,取值说明:'."\n"
."\n"
.'- **HttpPort**:Http协议端口。'."\n"
."\n"
.'- **MySQLPort**:MySQL协议端口。', 'type' => 'string', 'example' => '9030'],
'Port' => ['description' => '连接端口号。', 'type' => 'integer', 'format' => 'int32', 'example' => 'MySQLPort'],
],
],
],
'ClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'selectdb-cn-****-be'],
],
],
],
'DBClustersNetInfos' => [
'description' => 'BE实例的网络列表。',
'type' => 'array',
'items' => [
'description' => 'BE实例的网络信息。',
'type' => 'object',
'properties' => [
'NetType' => ['description' => '网络类型。', 'type' => 'string', 'example' => 'VPC/PUBLIC'],
'VpcInstanceId' => ['description' => 'VPC实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-****-fe-20230816101006'],
'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-****'],
'VswitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-****'],
'UserVisible' => ['description' => '用户是否可见。', 'type' => 'boolean', 'example' => 'true/false'],
'ConnectionString' => ['description' => '连接地址。', 'type' => 'string', 'example' => 'selectdb-cn-****-fe.selectdbfe.pre.rds.aliyuncs.com'],
'Ip' => ['description' => 'IP地址。', 'type' => 'string', 'example' => '8.131.***.***'],
'PortList' => [
'description' => '端口列表。',
'type' => 'array',
'items' => [
'description' => '端口信息。',
'type' => 'object',
'properties' => [
'Protocol' => ['description' => '端口类型。', 'type' => 'string', 'example' => 'MySQLPort/HttpPort'],
'Port' => ['description' => '连接端口号。', 'type' => 'integer', 'format' => 'int32', 'example' => '9030/8080'],
],
],
],
'ClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'selectdb-cn-****-be'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'InvalidClusterInstance.NotFound', 'errorMessage' => 'Specified cluster instance does not exist.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询实例网络信息',
'summary' => '查询指定云数据库SelectDB版实例的网络信息。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'selectdb:DescribeDBInstanceNetInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => '查询实例列表。',
'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' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-4690g37929****'],
],
[
'name' => 'DBInstanceIds',
'in' => 'query',
'schema' => ['description' => '实例ID,多个实例ID之间用英文逗号(,)分隔。', 'type' => 'string', 'required' => false, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'DBInstanceStatus',
'in' => 'query',
'schema' => ['description' => '实例的状态,取值说明:'."\n"
.'- **CREATING**:创建中。'."\n"
."\n"
.'- **ACTIVATION**:运行中。'."\n"
."\n"
.'- **RESOURCE_CHANGING**:变配中。'."\n"
."\n"
.'- **ORDER_PREPARING**:订单确认中。'."\n"
."\n"
.'- **READONLY_RESOURCE_CHANGING**:资源变配中(实例写入锁定)。'."\n"
."\n"
.'- **DELETING**:删除中。', 'type' => 'string', 'required' => false, 'example' => 'ACTIVATION'],
],
[
'name' => 'DBInstanceDescription',
'in' => 'query',
'schema' => ['description' => '实例备注信息。', 'type' => 'string', 'required' => false, 'example' => 'New instance test'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页记录数,取值:'."\n"
.'- **30**(默认值)'."\n"
.'- **50**'."\n"
.'- **100**', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '实例标签列表信息。',
'type' => 'array',
'items' => [
'description' => '实例标签列表。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'testKey'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'testValue'],
],
'required' => false,
],
'required' => false,
'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BC854513-E85E-54F3-9842-B9CCD3308CDD'],
'PageNumber' => ['description' => '每页记录数,取值:'."\n"
.'- **30**(默认值)'."\n"
.'- **50**'."\n"
.'- **100**', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
'PageSize' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'Items' => [
'description' => '实例详情列表。',
'type' => 'array',
'items' => [
'description' => '实例详情列表。',
'type' => 'object',
'properties' => [
'connectionString' => ['description' => '连接地址。', 'type' => 'string', 'example' => 'Not applicable.'],
'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'],
'Description' => ['description' => '实例备注信息。', 'type' => 'string', 'example' => 'New instance test'],
'Engine' => ['description' => '数据库类型。', 'type' => 'string', 'example' => 'selectdb'],
'EngineVersion' => ['description' => '数据库版本。', 'type' => 'string', 'example' => '2.4'],
'InstanceUsedType' => ['description' => '实例使用类型。', 'type' => 'string', 'example' => 'Instance'],
'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i'],
'ChargeType' => ['description' => '实例的付费类型。取值:'."\n"
."\n"
.'- **Postpaid**:后付费(按量付费)'."\n"
."\n"
.'- **Prepaid**:预付费(包年包月)', 'type' => 'string', 'example' => 'PrePaid'],
'Category' => ['description' => '实例的系列,默认为基础版(basic)。', 'type' => 'string', 'example' => 'basic'],
'Status' => ['description' => '实例的状态,取值说明:'."\n"
.'- **CREATING**:创建中。'."\n"
."\n"
.'- **ACTIVATION**:运行中。'."\n"
."\n"
.'- **RESOURCE_CHANGING**:变配中。'."\n"
."\n"
.'- **ORDER_PREPARING**:订单确认中。'."\n"
."\n"
.'- **READONLY_RESOURCE_CHANGING**:资源变配中(实例写入锁定)。'."\n"
."\n"
.'- **DELETING**:删除中。', 'type' => 'string', 'example' => 'ACTIVATION'],
'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-bp175iuvg8nxqraf2****'],
'VswitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-bp1gzt31twhlo0sa5****'],
'ResourceCpu' => ['description' => '资源CPU。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'],
'ResourceMemory' => ['description' => '资源内存。', 'type' => 'integer', 'format' => 'int64', 'example' => '64'],
'ScaleMin' => ['description' => '实例RCU(RDS Capacity Unit)自动扩缩范围的最小值。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ScaleMax' => ['description' => '实例RCU(RDS Capacity Unit)的自动扩缩范围最大值。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ScaleReplica' => ['description' => '多余字段。', 'type' => 'integer', 'format' => 'int64', 'example' => '空'],
'StorageSize' => ['description' => '存储空间大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'StorageType' => ['description' => '实例存储类型。', 'type' => 'string', 'example' => 'cloud_essd'],
'ObjectStoreSize' => ['description' => '实例存储大小,单位:GB。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'ExpireTime' => ['description' => '集群到期时间。'."\n"
.'> 仅付费方式为**Prepaid**(包年包月)的集群会返回具体参数值,**Postpaid**(按量付费)集群则返回空值。', 'type' => 'string', 'example' => '2024-03-29T03:47:05Z'],
'LockMode' => ['description' => '实例锁定模式。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'LockReason' => ['description' => '被锁定的原因。', 'type' => 'string', 'example' => 'nolock'],
'IsDeleted' => ['description' => '实例是否已删除,取值说明:'."\n"
."\n"
.'- **true**:删除。'."\n"
."\n"
.'- **fasle**:未删除。', 'type' => 'boolean', 'example' => 'false'],
'MaintainStarttime' => ['description' => '实例可维护时间的开始时间。', 'type' => 'string', 'example' => 'Reserved parameter. Not returned.'],
'MaintainEndtime' => ['description' => '实例可维护时间的结束时间。', 'type' => 'string', 'example' => 'Reserved parameter. Not returned.'],
'GmtCreated' => ['description' => '任务创建时间(GMT)。', 'type' => 'string', 'example' => '2023-08-12T04:14Z'."\n"],
'GmtModified' => ['description' => '任务修改时间(GMT)。', 'type' => 'string', 'example' => '2023-08-12T19:05Z'],
'ParentInstance' => ['description' => '创建时间。', 'type' => 'string', 'example' => 'Reserved parameter. Not returned.'],
'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'Reserved parameter. Not returned.'],
'MaintainStartTimeStr' => ['description' => '可维护时间的开始时间戳。', 'type' => 'string', 'example' => 'Reserved parameter. Not returned.'],
'MaintainEndTimeStr' => ['description' => '可维护时间的结束时间戳。', 'type' => 'string', 'example' => 'Reserved parameter. Not returned.'],
'TenantClusterId' => ['description' => 'prometheus监控集群ID。', 'type' => 'string', 'example' => 'Reserved parameter. Not returned.'],
'TenantToken' => ['description' => 'prometheus监控接入Token。', 'type' => 'string', 'example' => 'Reserved parameter. Not returned.'],
'TenantUserId' => ['description' => 'prometheus监控用户账号label。', 'type' => 'string', 'example' => 'Reserved parameter. Not returned.'],
'Tags' => [
'description' => '实例标签列表信息。',
'type' => 'array',
'items' => [
'description' => '实例标签列表。',
'type' => 'object',
'properties' => [
'TagKey' => ['description' => '标签键。', 'type' => 'string', 'example' => 'testKey'],
'TagValue' => ['description' => '标签值。', 'type' => 'string', 'example' => 'testValue'],
],
],
],
'ClusterCount' => ['description' => '总集群数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'DeployScheme' => ['description' => '实例部署模式:'."\n"
."\n"
.'- multi_az: 同城冗余。'."\n"
.'- single_az: 本地冗余。', 'type' => 'string', 'example' => 'single_az'],
'MultiZone' => [
'description' => '多可用区配置。',
'type' => 'array',
'items' => [
'description' => '多可用区列表。',
'type' => 'object',
'properties' => [
'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-beijing-k'],
'VSwitchIds' => [
'description' => '交换机ID列表。',
'type' => 'array',
'items' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-bp1pla4vl8bs9uw9c7l2w'],
],
],
],
],
'EngineMinorVersion' => ['description' => '实例的内核小版本号。', 'type' => 'string', 'example' => '4.0.4'],
'Serverless' => ['description' => '是否serverless实例。', 'type' => 'boolean', 'example' => 'false'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter "PageNumber" is not valid.', 'description' => '每页记录数参数不合法。'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'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' => '查询实例',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeDBInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeElasticRules' => [
'summary' => '查询分时弹性规则。',
'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' => '云产品类型。', 'type' => 'string', 'required' => false, 'example' => 'selectdb', 'default' => 'selectdb'],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-nwy3jv1oa02-be'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F8900A96-67F7-5274-A41B-7722E1ECF8C9'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'DbInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'."\n"],
'ClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'selectdb-cn-nwy3jv1oa02-be'."\n"],
'Rules' => [
'description' => '规则列表。',
'type' => 'array',
'items' => [
'description' => '规则详情。',
'type' => 'object',
'properties' => [
'RuleId' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '5467'],
'ExecutionPeriod' => [
'description' => '执行周期。',
'type' => 'string',
'enumValueTitles' => ['Day' => '每天重复执行'],
'example' => 'Day',
],
'ElasticRuleStartTime' => ['description' => '分时弹性规则的开始执行时间。', 'type' => 'string', 'example' => '00:00'],
'ClusterClass' => ['description' => '集群目标计算资源规则。', 'type' => 'string', 'example' => 'selectdb.2xlarge'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidClusterId.Malformed', 'errorMessage' => 'The specified parameter "ClusterId" is not valid.', 'description' => '参数“ClusterId”不合法。'],
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => '参数"DBInstanceId"不合法。'],
['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter "RegionId" is not valid.', 'description' => '参数“RegionId”不合法。'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '集群不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询分时弹性规则',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeElasticRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => '获取查询Profile分析信息。',
'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' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'],
],
[
'name' => 'QueryId',
'in' => 'query',
'schema' => ['description' => '查询ID。', 'type' => 'string', 'required' => false, 'example' => 'sq202510231018sh3b69ad10014154'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResponse',
'description' => 'PlainResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F8900A96-67F7-5274-A41B-7722E1ECF8C9'],
'Profile' => ['description' => 'Profile文本,暂未支持。', 'type' => 'string', 'example' => 'No Demo'],
'ProfileSummary' => ['description' => 'Profile摘要总结。', '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"
.' }'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => '参数"DBInstanceId"不合法。'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Specified parameter is not valid.', 'description' => '指定的参数无效。'],
['errorCode' => 'InvalidParameter.QueryId', 'errorMessage' => 'Specified parameters is not valid.', 'description' => '指定的参数无效。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => '当前内核小版本不支持此操作。'],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', 'description' => '当前版本不支持此操作。'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询Profile信息',
'description' => '推荐您使用可视化界面执行查询并获取QueyID。具体操作,请参见[查询审计](https://help.aliyun.com/zh/selectdb/audit-queries)。'."\n"
."\n"
.'> '."\n"
."\n"
.'版本限制'."\n"
."\n"
.'- 不支持3.0版本。'."\n"
."\n"
.'- 不支持创建日期在2025-08-01前的实例,若有需要,请联系工单支持。'."\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' => '获取可选的地域和可用区信息。',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => '可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-h'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F8900A96-67F7-5274-A41B-7722E1ECF8C9'."\n"],
'RegionModelList' => [
'description' => '地域数据列表。',
'type' => 'array',
'items' => [
'description' => '地域数据详情。',
'type' => 'object',
'properties' => [
'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-beijing'],
'Zones' => [
'description' => '可用区列表。',
'type' => 'array',
'items' => [
'description' => '可用区详情。',
'type' => 'object',
'properties' => [
'ZoneId' => ['description' => 'VPC是否可用。', 'type' => 'string', 'example' => 'cn-beijing-h'],
'VpcEnabled' => ['description' => '是否开启VPC。', 'type' => 'boolean', 'example' => 'true'],
'Name' => ['description' => '可用区名。', 'type' => 'string', 'example' => 'Beijing H'],
'Description' => ['description' => '可用区描述。', 'type' => 'string', 'example' => '北京H可用区'],
'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-beijing'],
'Disabled' => ['description' => '是否禁用。', 'type' => 'boolean', 'example' => 'false'],
'SubDomain' => ['description' => '子域。', 'type' => 'string', 'example' => 'cn-beijing-h-aliyun'],
'Label' => ['description' => '标签。', 'type' => 'string', 'example' => 'test'],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'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' => '获取可选的地域和可用区',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeRegions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeSecurityIPList' => [
'summary' => '查询指定云数据库SelectDB版实例的白名单IP。',
'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' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5CBE044D-4594-525D-AC65-E988553D853E'],
'DBInstanceName' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'],
'GroupItems' => [
'description' => '白名单分组列表。',
'type' => 'array',
'items' => [
'description' => '分组白名单详情。',
'type' => 'object',
'properties' => [
'GroupName' => ['description' => '白名单分钟名称。', 'type' => 'string', 'example' => 'group1'],
'AecurityIPType' => ['description' => 'IP地址类型,取值说明:'."\n"
."\n"
.'- ipv4'."\n"
."\n"
.'- ipv6(暂不支持)', 'type' => 'string', 'example' => 'ipv4'],
'GroupTag' => ['description' => '分组标签。', 'type' => 'string', 'example' => '""'],
'SecurityIPList' => ['description' => '实例的IP白名单,多个IP地址请用英文逗号(,)分隔。', 'type' => 'string', 'example' => '127.0.XX.XX'],
'WhitelistNetType' => ['description' => '白名单的网络类型。', 'type' => 'string', 'example' => 'mix'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'InvalidClusterInstance.NotFound', 'errorMessage' => 'Specified cluster instance does not exist.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询实例白名单IP',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeSecurityIPList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => '获取指定时间段内慢查询统计信息',
'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' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shenzhen'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,默认24小时前。', 'type' => 'string', 'required' => false, 'example' => '2026-04-07 16:00:00'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,需大于起始时间,默认为现在时间。', 'type' => 'string', 'required' => false, 'example' => '2026-04-08 16:00:00'],
],
[
'name' => 'ThresholdMs',
'in' => 'query',
'schema' => ['description' => '慢查询阈值,单位毫秒,默认值5000。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5000'],
],
[
'name' => 'TopN',
'in' => 'query',
'schema' => ['description' => '慢查询前N条,默认值10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResponse',
'description' => 'PlainResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FCEEA97F-XXXX-XXXX-932F-B4BAEA170896'],
'Summary' => ['description' => '摘要信息。', '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"
.' }'],
'Percentiles' => ['description' => '查询延迟分位数信息。', 'type' => 'object', 'example' => '{'."\n"
.' "p99": "24746.0",'."\n"
.' "p50": "8295.0",'."\n"
.' "p95": "23872.0",'."\n"
.' "p90": "15794.0",'."\n"
.' "p75": "11972.25"'."\n"
.' }'],
'ByUser' => ['description' => '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"
.' ]'],
'ByTimeBucket' => ['description' => '时间分桶内慢查询信息。', '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"
.']'],
'TopQueries' => ['description' => 'TopN条慢查询审计信息。', '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"
.']'],
'TopSqlDigests' => ['description' => 'TopN条慢查询指纹分类信息。内核5.0版本以上支持。', '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"
.' ]'],
'ByDatabase' => ['description' => '数据库维度慢查询信息。', '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"
.']'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => '参数"DBInstanceId"不合法。'],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => '传入参数不是有效的参数'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Specified parameter is not valid.', 'description' => '指定的参数无效。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', 'description' => '当前版本不支持此操作。'],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => '当前内核小版本不支持此操作。'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询慢查询统计信息',
'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' => '列出可用区下交换机。',
'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' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => '实例VPC ID。', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp175iuvg8nxqraf2****'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => '可用区ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-i'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '查询页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。'."\n"
.'>预留参数,暂不支持。>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token。'."\n"
.'>预留参数,暂不支持。>', 'type' => 'string', 'required' => false, 'example' => '4ea98363565e4951e0b5e8707e68181f'],
],
],
'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'],
'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'string', 'example' => '15'],
'PageNumber' => ['description' => '当前页码。', 'type' => 'string', 'example' => '1'],
'PageSize' => ['description' => '每页包含的条目数。', 'type' => 'string', 'example' => '10'],
'Items' => [
'description' => '结果列表。',
'type' => 'array',
'items' => [
'description' => '结果列表。',
'type' => 'object',
'properties' => [
'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i'],
'VSwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-bp1usf8eabhvibkkfde96'],
'VSwitchName' => ['description' => '交换机名称。', 'type' => 'string', 'example' => 'subnet'],
],
],
],
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => '459a0909c0315bfbe0b5e8707e68181f'],
'MaxResults' => ['description' => '分页查询时每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => '系统异常。'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => '当前集群状态不支持该操作。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['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' => '新建集群名称重复。'],
['errorCode' => 'InvalidClusterName.Format', 'errorMessage' => 'Specified ClusterName is not valid. It can not be empty string.', 'description' => '输入的集群名称参数不合法。'],
['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The instance version does not support the current operation.', 'description' => '实例版本不支持当前操作。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'OperationDenied.VirtualClusterBound', 'errorMessage' => 'The operation is not permitted due to it has been bound to a virtual cluster.', 'description' => '操作不允许,因为已绑定到虚拟集群。'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['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' => 'SelectDB实例不存在。'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid parameter, please check.', 'description' => '无效参数,请检查。'],
['errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', 'description' => '指定的集群名称不可用'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询交换机列表',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeVSwitches',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => '列出售卖可用区。',
'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' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '- 如果您未指定请求参数**MaxResults**的值,则表示您不需要分批次查询。返回参数**MaxResults**的值表示列表条目总数。'."\n"
.'- 如果您指定了请求参数**MaxResults**的值,则表示您需要分批次查询。返回参数**MaxResults**的值表示当前查询批次下列表条目的数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token。', 'type' => 'string', 'required' => false, 'example' => '40831b4f-d91d-4796-9589-ad306ec528d5'],
],
],
'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' => 'ADF42B18-43FD-5100-83A9-BE81AB70C863'],
'Items' => [
'description' => '结果列表。',
'type' => 'array',
'items' => [
'description' => '可用区信息列表。',
'type' => 'object',
'properties' => [
'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-beijing'],
'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-beijing-i'],
],
],
],
'MaxResults' => ['description' => '分页查询时每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => '40831b4f-d91d-4796-9589-ad306ec528d5'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => '系统异常。'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => '当前集群状态不支持该操作。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['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' => '新建集群名称重复。'],
['errorCode' => 'InvalidClusterName.Format', 'errorMessage' => 'Specified ClusterName is not valid. It can not be empty string.', 'description' => '输入的集群名称参数不合法。'],
['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The instance version does not support the current operation.', 'description' => '实例版本不支持当前操作。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'OperationDenied.VirtualClusterBound', 'errorMessage' => 'The operation is not permitted due to it has been bound to a virtual cluster.', 'description' => '操作不允许,因为已绑定到虚拟集群。'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['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' => 'SelectDB实例不存在。'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid parameter, please check.', 'description' => '无效参数,请检查。'],
['errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', 'description' => '指定的集群名称不可用'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '列出售卖可用区',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeZones',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => '开关分时弹性策略。',
'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' => '云产品类型。', 'type' => 'string', 'required' => false, 'example' => 'selectdb', 'default' => 'selectdb'],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-nwy3jv1oa02-be'],
],
[
'name' => 'ScalingRulesEnable',
'in' => 'query',
'schema' => [
'description' => '是否开启分时弹性策略。',
'type' => 'boolean',
'required' => true,
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '4773E4EC-025D-509F-AEA9-D53123FDFB0F'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'DbInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'],
'ClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'selectdb-cn-pe33jc1nd01-be'],
'ScalingRulesEnable' => [
'description' => '是否开启分时弹性规则。',
'type' => 'boolean',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'example' => 'true',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidClusterId.Malformed', 'errorMessage' => 'The specified parameter "ClusterId" is not valid.', 'description' => '参数“ClusterId”不合法。'],
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => '参数"DBInstanceId"不合法。'],
['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter "RegionId" is not valid.', 'description' => '参数“RegionId”不合法。'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'OperationDenied.EnableScalingRules', 'errorMessage' => 'the operator is not permitted due to scaling rule\'s count is less than 2.', 'description' => '分时弹性策略规则数量小于2条时,不能开启分时弹性。'],
['errorCode' => 'OperationDenied.GetResourceLockFailed', 'errorMessage' => 'the operator is not permitted due to get resource lock failed.', 'description' => '由于获取资源锁失败,本次请求被拒绝执行。'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '集群不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '开关分时弹性策略',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:EnDisableScalingRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => [
'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' => '商品编码。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['selectdb_pre_public_intl' => '国际站-预付费商品', 'selectdb_go_public_cn' => '国内站-后付费商品', 'selectdb_go_public_intl' => '国际站-后付费商品', 'selectdb_pre_public_cn' => '国内站-预付费商品'],
'example' => 'selectdb_go_public_cn',
],
],
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => [
'description' => '计费类型。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['PREPAY' => '预付费', 'POSTPAY' => '后付费'],
'example' => 'POSTPAY',
],
],
[
'name' => 'PricingCycle',
'in' => 'query',
'schema' => [
'description' => '计费周期。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['Month' => '月', 'Year' => '年', 'Minute' => '分钟', 'Hour' => '小时', 'Day' => '天'],
'example' => 'Hour',
],
],
[
'name' => 'Quantity',
'in' => 'query',
'schema' => ['description' => '数量。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
[
'name' => 'PreCacheSize',
'in' => 'query',
'schema' => ['description' => '预留缓存空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200'],
],
[
'name' => 'PreComputeSize',
'in' => 'query',
'schema' => ['description' => '预留计算资源。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4'],
],
[
'name' => 'CacheSize',
'in' => 'query',
'schema' => ['description' => '弹性缓存空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200'],
],
[
'name' => 'ComputeSize',
'in' => 'query',
'schema' => ['description' => '弹性计算资源。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4'],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-xxx'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '区域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'],
],
[
'name' => 'PromotionOptionNo',
'in' => 'query',
'schema' => ['type' => 'string', 'example' => '2374923467'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '06758CAB-1204-5852-A471-29C87D5C1D0F'."\n"],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Currency' => ['description' => '货币。', 'type' => 'string', 'example' => 'CNY'],
'TradeAmount' => ['description' => '金额。', 'type' => 'string', 'example' => '1.76'],
'PricingRules' => [
'type' => 'object',
'additionalProperties' => ['type' => 'string'],
],
'OptionalPromotions' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OptionCode' => ['type' => 'string', 'example' => '7afs9d'],
'PromotionDesc' => ['type' => 'string', 'example' => '通用优惠券可抵扣100'],
'PromotionName' => ['type' => 'string', 'example' => '通用优惠券'],
'CanPromFee' => ['type' => 'string', 'example' => '100'],
'PromotionOptionNo' => ['type' => 'string', 'example' => '775735400028'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '新建集群询价',
'summary' => '指定云数据库SelectDB版实例下新建集群时获取价格信息。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:GetCreateBEClusterInquiry',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => '指定云数据库SelectDB版实例下新建集群时获取价格信息。',
'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' => '集群ID。', 'type' => 'string', 'required' => false, 'example' => 'selectdb-xxx-be'],
],
[
'name' => 'CommodityCode',
'in' => 'query',
'schema' => [
'description' => '商品编码。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['selectdb_pre_public_intl' => '国际站-预付费商品', 'selectdb_go_public_cn' => '中国站-后付费商品', 'selectdb_go_public_intl' => '国际站-后付费商品', 'selectdb_pre_public_cn' => '中国站-预付费商品'],
'example' => 'selectdb_go_public_cn',
],
],
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => [
'description' => '计费类型。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['PREPAY' => '预付费', 'POSTPAY' => '后付费'],
'example' => 'POSTPAY',
],
],
[
'name' => 'PricingCycle',
'in' => 'query',
'schema' => [
'description' => '计费周期。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['Month' => '月', 'Year' => '年', 'Minute' => '分钟', 'Hour' => '小时', 'Day' => '天'],
'example' => 'Hour',
],
],
[
'name' => 'Quantity',
'in' => 'query',
'schema' => ['description' => '数量。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
[
'name' => 'PreCacheSize',
'in' => 'query',
'schema' => ['description' => '预留缓存空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200'],
],
[
'name' => 'PreComputeSize',
'in' => 'query',
'schema' => ['description' => '预留计算资源。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4'],
],
[
'name' => 'CacheSize',
'in' => 'query',
'schema' => ['description' => '弹性缓存空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200'],
],
[
'name' => 'ComputeSize',
'in' => 'query',
'schema' => ['description' => '弹性计算资源。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4'],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-xxx'."\n"],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '区域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'],
],
[
'name' => 'ModifyClusterChargeType',
'in' => 'query',
'schema' => [
'description' => '是否转换集群计费类型的询价。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '是', 'false' => '否'],
'example' => 'true',
],
],
[
'name' => 'PromotionOptionNo',
'in' => 'query',
'schema' => ['title' => '优惠券编号。', 'description' => '优惠券编号。', 'type' => 'string', 'required' => false, 'example' => '123412345'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '06758CAB-1204-5852-A471-29C87D5C1D0F'."\n"],
'Data' => [
'title' => '返回数据。',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Currency' => ['title' => '货币。', 'description' => '货币。', 'type' => 'string', 'example' => 'CNY'],
'TradeAmount' => ['title' => '金额。', 'description' => '金额。', 'type' => 'string', 'example' => '1.76'],
'RefundAmount' => ['title' => '包月实例下包月集群转按量集群时的预计退款金额。', 'description' => '包月实例下包月集群转按量集群时的预计退款金额。', 'type' => 'string', 'example' => '-100'],
'PricingRules' => [
'description' => '计费项单价结果。',
'type' => 'object',
'additionalProperties' => ['type' => 'string', 'example' => '{"compute_size":{"priceUnit":"元/(CU*小时)","payFee":"0.0"},"cache_size":{"priceUnit":"元/(GB*小时)","payFee":"0.0"},"storage_size":{"priceUnit":"元/(GB*小时)","payFee":"0.0"}', 'description' => '计费项单价。包括计算资源、缓存资源和存储资源。仅在serverless集群生效。'],
],
'OptionalPromotions' => [
'title' => '优惠券编号',
'description' => '优惠券编号',
'type' => 'array',
'items' => [
'title' => '优惠券信息。',
'description' => '优惠券信息。',
'type' => 'object',
'properties' => [
'OptionCode' => ['title' => '促销活动规则描述。', 'description' => '促销活动规则描述。', 'type' => 'string', 'example' => '789asdf'],
'PromotionDesc' => ['title' => '优惠券描述。', 'description' => '优惠券描述。', 'type' => 'string', 'example' => 'General coupon deducts 100'],
'PromotionName' => ['title' => '优惠券名称。', 'description' => '优惠券名称。', 'type' => 'string', 'example' => 'General coupon'],
'CanPromFee' => ['title' => '可优惠金额。'."\n"
."\n"
.'> 中国站不涉及该参数。', 'description' => '可优惠金额。'."\n"
."\n"
.'> 中国站不涉及该参数。', 'type' => 'string', 'example' => '100'],
'PromotionOptionNo' => ['title' => '优惠券编号。', 'description' => '优惠券编号。', 'type' => 'string', 'example' => '732211480132'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
],
],
'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' => '集群变配询价',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:GetModifyBEClusterInquiry',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ModifyBEClusterAttribute' => [
'summary' => '修改云数据库SelectDB版实例的集群名称。',
'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' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-xxxb9f2w-be'],
],
[
'name' => 'InstanceAttributeType',
'in' => 'query',
'schema' => [
'description' => '修改属性类型。'."\n"
.'固定填写为DBInstanceDescription。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['DBInstanceDescription' => 'DBInstanceDescription'],
'example' => 'DBInstanceDescription',
'enum' => ['MaintainTime', 'DBInstanceDescription'],
],
],
[
'name' => 'Value',
'in' => 'query',
'schema' => ['description' => '目标集群名称。', 'type' => 'string', 'required' => true, 'example' => 'testdb'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '58E21E11-90FF-50F8-A615-8DEB193676E0'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => '当前集群状态不支持该操作。'],
['errorCode' => 'InvalidClusterName.Format', 'errorMessage' => 'Specified ClusterName is not valid. It can not be empty string.', 'description' => '输入的集群名称参数不合法。'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', 'description' => '新建集群名称重复。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', 'description' => '指定的集群名称不可用'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '修改集群名',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyBEClusterAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => ['title' => '实例 ID。', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-xxxb9f2w-be'],
],
[
'name' => 'DBClusterClass',
'in' => 'query',
'schema' => ['description' => '集群规格,取值说明:'."\n"
.'- **selectdb.xlarge**:4核 32GB。'."\n"
.'- **selectdb.2xlarge**:8核 64GB。'."\n"
.'- **selectdb.4xlarge**:16核 128GB。'."\n"
.'- **selectdb.8xlarge**:32核 256GB。'."\n"
.'- **selectdb.16xlarge**:16核 512GB。'."\n"
.'- **selectdb.24xlarge**:24核 768GB。'."\n"
.'- **selectdb.32xlarge**:32核 1024GB。', 'type' => 'string', 'required' => true, 'example' => 'selectdb.2xlarge'],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => '数据库类型,固定为selectdb。', 'type' => 'string', 'required' => false, 'example' => 'selectdb', 'default' => 'selectdb'],
],
[
'name' => 'CacheSize',
'in' => 'query',
'schema' => ['description' => '预留缓存大小。', 'type' => 'string', 'required' => false, 'example' => '200'],
],
[
'name' => 'ClusterNodeType',
'in' => 'query',
'schema' => ['type' => 'string'],
],
[
'name' => 'ClusterNodeCount',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1'],
],
[
'name' => 'ScaleMax',
'in' => 'query',
'schema' => ['type' => 'number', 'format' => 'double', 'default' => '32'],
],
[
'name' => 'ScaleMin',
'in' => 'query',
'schema' => ['type' => 'number', 'format' => 'double', 'default' => '4'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0BF61F90-ACED-55DF-A6FE-56714B2BFCF6'],
'DBInstanceId' => ['title' => '资源一级ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'],
'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'],
'OrderId' => ['description' => '订单ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '219396937240838'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidCacheSize.NotSupport', 'errorMessage' => 'The specified parameter "CacheSize" does not meet the requirements.', 'description' => '参数“CacheSize”不符合要求。'],
['errorCode' => 'InvalidUpdowngradeConfig.NoChange', 'errorMessage' => 'The upgrade or downgrade configuration is not changed, please re-select.', 'description' => '升级或降配的配置未改变,请重新选择。'],
['errorCode' => 'OperationDenied.OrderProcessing', 'errorMessage' => 'There are orders in process.', 'description' => '存在处理中的订单。'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => '当前集群状态不支持该操作。'],
['errorCode' => 'PAY.INSUFFICIENT_BALANCE', 'errorMessage' => 'Insufficient account available balance.', 'description' => '账户可用余额不足'],
['errorCode' => 'ORDER.INST_HAS_UNPAID_ORDER', 'errorMessage' => 'Instance has unpaid order.', 'description' => '实例存在未支付订单。'],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => '传入参数不是有效的参数'],
['errorCode' => 'InvalidInstanceClass.MultiAZ', 'errorMessage' => 'The instance with 4-core BE cluster does not support multi-zone redundancy.', 'description' => '4 CPU 的 BE 集群不支持多可用区同城冗余。'],
['errorCode' => 'InvalidInstanceClass.ForMultiAZ', 'errorMessage' => 'The instance with 4-core BE cluster does not support upgrading to multi-zone redundancy.', 'description' => '4 CPU 的 BE 集群不支持多可用区同城冗余。'],
],
403 => [
['errorCode' => 'OperationDenied.ScalingRuleIsEnabled', 'errorMessage' => 'the operator is not permitted due to scaling rule is enabled.', 'description' => '分时弹性策略开启时,不能手动发起集群扩缩容。'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
['errorCode' => 'INSUFFICIENT_AVAILABLE_QUOTA', 'errorMessage' => 'Your account available limit is less than 0, please recharge before trying to purchase.', 'description' => '您的账户可用额度小于0,请先充值后再尝试购买'],
['errorCode' => 'OperationDenied.SpecificClassCodeNotSupported', 'errorMessage' => 'The uid is not in specific classcode whitelist.', 'description' => '所选规格没有对当前账号开放。'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'InvalidDBClusterState.NotSupport', 'errorMessage' => 'The specified cluster state does\'t support this operation.', 'description' => '集群状态不支持此操作。'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '集群扩缩容',
'summary' => '为指定云数据库SelectDB版实例的集群扩缩容。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyDBCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => '修改集群配置。',
'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串。', 'type' => 'string', 'required' => true, 'example' => '{"param1_name":"param1_value","param2_name":"param2_value"}'],
],
[
'name' => 'ConfigKey',
'in' => 'query',
'schema' => ['description' => '修改的配置项文件,计算集群固定为be.conf,fe集群固定为fe.conf。', 'type' => 'string', 'required' => true, 'example' => 'be.conf'],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213c8*****-be'],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213c8*****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'SwitchTimeMode',
'in' => 'query',
'schema' => ['description' => '升级方式。不填写代表立即升级,填写1代表在可维护的时间段升级。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'ParallelOperation',
'in' => 'query',
'schema' => ['description' => '是否并行操作集群节点', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResponse',
'description' => 'PlainResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'DbInstanceName' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213c8*****'],
'DbInstanceId' => ['description' => '实例数字ID。', 'type' => 'string', 'example' => '6585'],
'DbClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213c8*****'],
'TaskId' => ['description' => '任务ID', 'type' => 'integer', 'format' => 'int32', 'example' => '107878719'],
],
],
'DynamicCode' => ['description' => '动态code,暂无使用,请忽略。', 'type' => 'string', 'example' => '0'],
'DynamicMessage' => ['description' => '动态消息,暂无使用,请忽略。', 'type' => 'string', 'example' => 'An error occurred while processing your request.'],
'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => 'failed'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BC854513-E85E-54F3-9842-B9CCD3308CDD'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
['errorCode' => 'InvalidConfigName', 'errorMessage' => 'The ConfigName is not valid.', 'description' => 'ConfigName不是有效值。'],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => '传入参数不是有效的参数'],
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => '参数"DBInstanceId"不合法。'],
['errorCode' => 'InvalidConfigKey.Malformed', 'errorMessage' => 'The specified parameter "ConfigKey" is not valid.', 'description' => '指定参数“ConfigKey”不是有效参数。'],
['errorCode' => 'InvalidClusterId.Malformed', 'errorMessage' => 'The specified parameter "ClusterId" is not valid.', 'description' => '参数“ClusterId”不合法。'],
['errorCode' => 'InvalidConfigParameters.Malformed', 'errorMessage' => 'The specified parameter "Parameters" is not valid.', 'description' => '指定参数“Parameters”不是有效参数。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '修改集群配置',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyDBClusterConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => [
'summary' => '修改指定云数据库SelectDB版实例的运维时间或备注信息。',
'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' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'InstanceAttributeType',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '修改项,取值说明:'."\n"
."\n"
.'- **MaintainTime**:修改运维时间,格式为hh:mm-hh:mm。'."\n"
."\n"
.'- **DBInstanceDescription**:修改实例备注。',
'type' => 'string',
'required' => true,
'example' => 'DBInstanceDescription',
'enum' => ['MaintainTime', 'DBInstanceDescription'],
],
],
[
'name' => 'Value',
'in' => 'query',
'schema' => ['description' => '修改内容。取值说明:'."\n"
."\n"
.'- 当InstanceAttributeType为MaintainTime时,您可以取值为00:00-06:00。'."\n"
."\n"
.'- 当InstanceAttributeType为DBInstanceDescription时,您可以取值为testdb。', 'type' => 'string', 'required' => true, 'example' => 'testdb01'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2DB29DEE-52E4-57EE-BF68-2C95C20E6658'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidAttributeTypeValue.Malformed', 'errorMessage' => 'The value of specified parameter "AttributeType" is not valid.', 'description' => '修改实例的属性类型值非法。'],
['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => '获取锁超时导致请求执行失败。'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidClusterInstance.NotFound', 'errorMessage' => 'Specified cluster instance does not exist.', 'description' => 'SelectDB实例不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '修改实例运维时间或备注信息',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyDBInstanceAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DB29DEE-52E4-57EE-BF68-2C95C20E6658\\"\\n}","type":"json"}]',
],
'ModifyElasticRule' => [
'summary' => '修改分时弹性规则。',
'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' => '云产品类型。', 'type' => 'string', 'required' => false, 'example' => 'selectdb', 'default' => 'selectdb'],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-nwy3jv1oa02-be'],
],
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5467'],
],
[
'name' => 'ElasticRuleStartTime',
'in' => 'query',
'schema' => ['description' => '分时弹性规则的开始执行时间。', 'type' => 'string', 'required' => false, 'example' => '00:00'],
],
[
'name' => 'ExecutionPeriod',
'in' => 'query',
'schema' => [
'description' => '执行周期。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Day' => '每天重复执行'],
'example' => 'Day',
],
],
[
'name' => 'ClusterClass',
'in' => 'query',
'schema' => ['description' => '集群目标计算资源规则。', 'type' => 'string', 'required' => false, 'example' => 'selectdb.2xlarge'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5ED62C81-9948-5612-81E1-EA3853752306'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'DbInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'],
'ClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'selectdb-cn-zpr3if5wq03-be'],
'RuleId' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '29252'],
'ExecutionPeriod' => [
'description' => '执行周期。',
'type' => 'string',
'enumValueTitles' => ['Day' => '每天重复执行'],
'example' => 'Day',
],
'ElasticRuleStartTime' => ['description' => '分时弹性规则的开始执行时间。', 'type' => 'string', 'example' => '00:00'],
'ClusterClass' => ['description' => '集群目标计算资源规则。', 'type' => 'string', 'example' => 'selectdb.2xlarge'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidClusterId.Malformed', 'errorMessage' => 'The specified parameter "ClusterId" is not valid.', 'description' => '参数“ClusterId”不合法。'],
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceId" is not valid.', 'description' => '参数"DBInstanceId"不合法。'],
['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter "RegionId" is not valid.', 'description' => '参数“RegionId”不合法。'],
['errorCode' => 'InvalidRuleId.Malformed', 'errorMessage' => 'The specified parameter "RuleId" is not valid.', 'description' => '参数“RuleId”不合法。'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'OperationDenied.GetResourceLockFailed', 'errorMessage' => 'the operator is not permitted due to get resource lock failed.', 'description' => '由于获取资源锁失败,本次请求被拒绝执行。'],
['errorCode' => 'OperationDenied.AdjacentRulesClusterIsTheSame', 'errorMessage' => 'the operator is not permitted due to adjacent rules cluster class is the same.', 'description' => '此操作被禁止执行因为相邻分时弹性规则的目标计算资源相同。'],
['errorCode' => 'OperationDenied.AdjacentRulesIntervalLessThanOneHour', 'errorMessage' => 'the operator is not permitted due to adjacent rules interval less than one hour.', 'description' => '操作被禁止执行因为相邻分时弹性规则的时间间隔小于1小时。'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidElasticRuleId.NotFound', 'errorMessage' => 'The ElasticRuleId provided does not exist in our records.', 'description' => '分时弹性规则不存在。'],
['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '集群不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '修改分时弹性规则',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyElasticRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => '修改指定云数据库SelectDB版实例的白名单IP。',
'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' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => '白名单分组名称。默认修改**Default**分组。', 'type' => 'string', 'required' => true, 'example' => 'default'],
],
[
'name' => 'SecurityIPList',
'in' => 'query',
'schema' => ['description' => '实例的IP白名单,多个IP地址请用英文逗号(,)分隔。', 'type' => 'string', 'required' => true, 'example' => '127.0.XX.XX,127.2.XX.XX'],
],
[
'name' => 'ModifyMode',
'in' => 'query',
'schema' => [
'description' => '白名单修改模式,取值说明:'."\n"
."\n"
.'- **0**:覆盖原白名单。'."\n"
.'- **1**:增加白名单。'."\n"
.'- **2**:删除白名单。',
'type' => 'string',
'required' => true,
'example' => '0',
'enum' => ['0', '1', '2'],
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '195F64C2-8F11-532B-A436-FC08A221D756'],
'GroupName' => ['description' => '白名单分组名称。', 'type' => 'string', 'example' => 'group1'],
'SecurityIPType' => ['description' => 'IP地址类型。', 'type' => 'string', 'example' => 'ipv4'],
'GroupTag' => ['description' => '分组标签。', 'type' => 'string', 'example' => 'grouptag'],
'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '479095561'],
'SecurityIPList' => ['description' => '实例的IP白名单,多个IP地址请用英文逗号(,)分隔。', 'type' => 'string', 'example' => '127.0.XX.XX,127.2.XX.XX'],
'WhitelistNetType' => ['description' => '白名单的网络类型。', 'type' => 'string', 'example' => 'mix'],
'DBInstanceName' => ['description' => '实例名称。'."\n", 'type' => 'string', 'example' => 'Instance test'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list.', 'description' => 'IP白名单列表不合法:列表中存在重复的IP。'],
['errorCode' => 'InvalidSecurityIPList.Format', 'errorMessage' => 'Specified security IP list format is not valid.', 'description' => 'IP白名单列表不合法。'],
['errorCode' => 'InvalidSecurityIPs.Malformed', 'errorMessage' => 'The specified parameter "SecurityIps" is not valid.', 'description' => 'IP白名单列表不合法。'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'SecurityIPList.Duplicate', 'errorMessage' => 'Specified same security IP already exists.', 'description' => 'IP白名单已经存在。'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'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' => '修改白名单',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifySecurityIPList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ModifyVirtualCluster' => [
'summary' => '修改虚拟集群。',
'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' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => '虚拟集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-vcg-b****-be'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ActiveClusterId',
'in' => 'query',
'schema' => ['description' => '主集群ID。', 'type' => 'string', 'required' => false, 'example' => 'selectdb-o2yg***-be'],
],
[
'name' => 'StandbyClusterId',
'in' => 'query',
'schema' => ['description' => '备集群ID。', 'type' => 'string', 'required' => false, 'example' => 'selectdb-pu6y****-be'],
],
],
'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' => '06758CAB-1204-5852-A471-29C87D5C1D0F'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'DbInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'],
'DbClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'selectdb-vcg-b****-be'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => '系统异常。'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => '当前集群状态不支持该操作。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['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' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['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' => 'SelectDB实例不存在。'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid parameter, please check.', 'description' => '无效参数,请检查。'],
['errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', 'description' => '指定的集群名称不可用'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '修改虚拟集群',
'description' => '- 支持单独修改主集群。'."\n"
."\n"
.'- 支持单独修改备集群。'."\n"
."\n"
.'- 支持主备集群切换。'."\n"
."\n"
.'>不支持同时修改主备集群为其他集群>',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyVirtualCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => '释放指定云数据库SelectDB版实例的公网地址。',
'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' => '实例的连接址。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213c8y****-public.selectdbfe.pre.rds.aliyuncs.com'],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '4773E4EC-025D-509F-AEA9-D53123FDFB0F'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '释放公网地址',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'selectdb:ReleaseInstancePublicConnection',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4773E4EC-025D-509F-AEA9-D53123FDFB0F\\"\\n}","type":"json"}]',
],
'ResetAccountPassword' => [
'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' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => ['description' => '数据库账号。', 'type' => 'string', 'required' => true, 'example' => 'admin'],
],
[
'name' => 'AccountPassword',
'in' => 'query',
'schema' => ['description' => '数据库账号的密码,取值说明:'."\n"
."\n"
.'- 由大写字母、小写字母、数字和特殊字符中的至少三种组成。'."\n"
."\n"
.'- !@#$%^&*()_+-=为特殊字符。'."\n"
."\n"
.'- 长度为8~32个字符。', 'type' => 'string', 'required' => true, 'example' => 'a1b2c3d4@'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '58E21E11-90FF-50F8-A615-8DEB193676E0'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
['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' => 'SelectDB实例不存在。'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified account name does not exist.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '重置账号密码',
'summary' => '重置云数据库SelectDB版实例的账号密码。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ResetAccountPassword',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58E21E11-90FF-50F8-A615-8DEB193676E0\\"\\n}","type":"json"}]',
],
'RestartDBCluster' => [
'summary' => '重启指定云数据库SelectDB版实例的集群。',
'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' => '资源组id', 'description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-4690g37929****', 'pattern' => '', 'default' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'formData',
'schema' => ['title' => '资源一级ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'formData',
'schema' => ['title' => '地域', 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'pattern' => '', 'default' => ''],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213c8yvv09-be'],
],
[
'name' => 'ParallelOperation',
'in' => 'query',
'schema' => ['description' => '是否并行操作集群节点', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BD0D0B17-C145-5B91-BFC2-6791927EE973'],
'Data' => [
'description' => '返回信息。',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213cjv****'],
'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'selectdb-cn-7213c8y****-be'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => '当前集群状态不支持该操作。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '重启集群',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:RestartDBCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => '启动指定云数据库SelectDB版集群。',
'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' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213c8yvv09-be'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F203FA74-3041-589F-BE66-E570793A0C91'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => '当前集群状态不支持该操作。'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '启动集群',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:StartBECluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F203FA74-3041-589F-BE66-E570793A0C91\\"\\n}","type":"json"}]',
],
'StopBECluster' => [
'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' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DBClusterId',
'in' => 'query',
'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BC854513-E85E-54F3-9842-B9CCD3308CDD'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '停止集群',
'summary' => '停止指定云数据库SelectDB版集群。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:StopBECluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC854513-E85E-54F3-9842-B9CCD3308CDD\\"\\n}","type":"json"}]',
],
'TagResources' => [
'summary' => '实例打标签',
'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' => ['title' => '资源类型', 'description' => '资源类型。', 'type' => 'string', 'required' => true, 'example' => 'DBInstance'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '实例ID数组。',
'type' => 'array',
'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'selectdb-cn-7213cjv****'."\n"],
'required' => true,
'maxItems' => 51,
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['title' => '地域Id', 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'."\n"],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签数组。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'test_key'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'test_value'],
],
'required' => false,
],
'required' => true,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '06758CAB-1204-5852-A471-29C87D5C1D0F'."\n"],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => '系统异常。'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'NoPermission.TagResources', 'errorMessage' => 'The operator is not permission for this operate.', 'description' => '您没有权限执行该操作。'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'title' => '实例打标签',
'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' => ['title' => '资源类型', 'description' => '资源类型。', 'type' => 'string', 'required' => true, 'example' => 'DBInstance'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '实例ID数组。',
'type' => 'array',
'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'selectdb-cn-7213cjv****'."\n"],
'required' => false,
'maxItems' => 51,
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['title' => '地域Id', 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签键数组。',
'type' => 'array',
'items' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'test_key'],
'required' => false,
'maxItems' => 21,
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => ['description' => '是否去除实例上的所有标签。仅当未设置TagKey时,该参数生效。默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '06758CAB-1204-5852-A471-29C87D5C1D0F'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request.', 'description' => '系统异常。'],
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'NoPermission.UntagResources', 'errorMessage' => 'The operator is not permission for this operate.', 'description' => '您没有权限执行该操作。'],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'title' => '实例去除标签',
'summary' => '实例去除标签',
'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' => '实例所属地域的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing'],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'MultiZone',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '多可用区列表。',
'type' => 'array',
'items' => [
'description' => '多可用区配置。',
'type' => 'object',
'properties' => [
'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing-k'],
'VSwitchIds' => [
'description' => '交换机ID。',
'type' => 'array',
'items' => ['description' => '交换机ID。', 'type' => 'string', 'required' => true, 'example' => 'vsw-bp10dbralpn4bzmgkkh8f'],
'required' => true,
],
],
'required' => true,
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ADF42B18-43FD-5100-83A9-BE81AB70C863'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
['errorCode' => 'InvalidZoneId.Duplicated', 'errorMessage' => 'The zones cannot be repeated please select different zones.', 'description' => '所选可用区不能重复'],
['errorCode' => 'InvalidZoneId.Malformed', 'errorMessage' => 'The specified parameter "ZoneId" is not valid.', 'description' => 'ZoneId参数不合法'],
['errorCode' => 'InvalidVSwitchId.Malformed', 'errorMessage' => 'The specified parameter "VSwitchId" is not valid.', 'description' => '参数VSwitchId无效。'],
['errorCode' => 'InvalidMultiZone.NotThreeZones', 'errorMessage' => 'The number of zones must be three.', 'description' => '多可用区数量必须是三个。'],
['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The instance version does not support the current operation.', 'description' => '实例版本不支持当前操作。'],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'Current instance cluster does not support this operation.', 'description' => '当前集群状态不支持该操作。'],
['errorCode' => 'InvalidZoneId.Undeployed', 'errorMessage' => 'The zone is undeployed.', 'description' => '可用区未开区。'],
['errorCode' => 'InvalidOperatorType.Malformed', 'errorMessage' => 'The specified operator type is not valid.', 'description' => '无效的操作。'],
['errorCode' => 'InvalidInstanceClass.MultiAZ', 'errorMessage' => 'The instance with 4-core BE cluster does not support multi-zone redundancy.', 'description' => '4 CPU 的 BE 集群不支持多可用区同城冗余。'],
['errorCode' => 'InvalidInstanceClass.ForMultiAZ', 'errorMessage' => 'The instance with 4-core BE cluster does not support upgrading to multi-zone redundancy.', 'description' => '4 CPU 的 BE 集群不支持多可用区同城冗余。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => '当前实例被锁定。'],
],
[
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '升级实例可用区部署架构',
'summary' => '将本地冗余实例升级为同城冗余。',
'description' => '实例升级到同城冗余架构,存储将升级为同城冗余规格,单位存储费用将产生变化,价格详情参考: [计费项及定价](https://help.aliyun.com/zh/selectdb/product-overview/billing-item-new-version)。'."\n"
."\n"
.'> 版本限制'."\n"
.'> - 实例小版本必须大于等于4.0.4。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:UpgradeDBInstanceDeployScheme',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADF42B18-43FD-5100-83A9-BE81AB70C863\\"\\n}","type":"json"}]',
],
'UpgradeDBInstanceEngineVersion' => [
'summary' => '升级指定云数据库SelectDB版实例的数据库版本。',
'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' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'selectdb-cn-7213cjv****'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => ['description' => '数据库版本。', 'type' => 'string', 'required' => true, 'example' => '2.4'],
],
[
'name' => 'SwitchTimeMode',
'in' => 'query',
'schema' => ['description' => '升级方式。'."\n"
."\n"
.'- 不填写代表立即升级。'."\n"
.'- 填写1代表在可维护的时间段升级。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'ParallelOperation',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => '是否并行操作集群节点', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '4773E4EC-025D-509F-AEA9-D53123FDFB0F'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'errorMessage' => 'The conversion has been failed, exceed file size limit.', 'description' => '文档转换失败,文件大小超过系统限额。'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '子账号权限不足,请先获取授权。'."\n"],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The specified database name is not allowed.', 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create order.', 'description' => '创建订单失败。'],
],
403 => [
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => '当集群未运行时,无法执行请求的操作。'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => '当前实例状态不支持此操作。'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '指定的实例状态不支持此操作。'."\n"],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => '当前阿里云账号余额不足100,请充值。'],
['errorCode' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'errorMessage' => 'The operation is not permitted due to count of database or account privilege.', 'description' => '操作失败,数据库与权限的数量不一致。'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is out of usage.', 'description' => '资源不足,请您稍后再试。'."\n"],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'SelectDB实例不存在。'],
['errorCode' => 'DBInstanceLocked', 'errorMessage' => 'The current instance lock mode does not support this operation.', 'description' => '操作失败,当前实例已锁定。'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '交换机参数无效。'],
['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' => '没有找到指定的实例,请检查实例的正确性。'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'The specified instance classic does not exist.', 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => '操作失败,输入的地域及可用区不存在。'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'description' => '询价失败,请联系客服同学。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '升级数据库版本',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:UpgradeDBInstanceEngineVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4773E4EC-025D-509F-AEA9-D53123FDFB0F\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
['regionId' => 'ap-northeast-2', 'regionName' => '韩国(首尔)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'selectdb.aliyuncs.com', 'endpoint' => 'selectdb.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚(吉隆坡)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'selectdb.aliyuncs.com', 'endpoint' => 'selectdb.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-7', 'regionName' => '泰国(曼谷)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'selectdb.aliyuncs.com', 'endpoint' => 'selectdb.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-heyuan', 'regionName' => '华南2(河源)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'selectdb.aliyuncs.com', 'endpoint' => 'selectdb.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shenzhen', 'regionName' => '华南1(深圳)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'selectdb.cn-shenzhen.aliyuncs.com', 'endpoint' => 'selectdb.cn-shenzhen.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-shenzhen.aliyuncs.com'],
['regionId' => 'cn-wulanchabu', 'regionName' => '华北6(乌兰察布)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'selectdb.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'selectdb.cn-wulanchabu.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-wulanchabu.aliyuncs.com'],
['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'selectdb.cn-beijing.aliyuncs.com', 'endpoint' => 'selectdb.cn-beijing.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-beijing.aliyuncs.com'],
['regionId' => 'ap-northeast-1', 'regionName' => '日本(东京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '西南1(成都)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'selectdb.cn-chengdu.aliyuncs.com', 'endpoint' => 'selectdb.cn-chengdu.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-chengdu.aliyuncs.com'],
['regionId' => 'cn-qingdao', 'regionName' => '华北1(青岛)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'selectdb.cn-qingdao.aliyuncs.com', 'endpoint' => 'selectdb.cn-qingdao.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-qingdao.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'selectdb.cn-shanghai.aliyuncs.com', 'endpoint' => 'selectdb.cn-shanghai.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-guangzhou', 'regionName' => '华南3(广州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'selectdb.cn-guangzhou.aliyuncs.com', 'endpoint' => 'selectdb.cn-guangzhou.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-guangzhou.aliyuncs.com'],
['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'selectdb.cn-hongkong.aliyuncs.com', 'endpoint' => 'selectdb.cn-hongkong.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-hongkong.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '华北5(呼和浩特)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'selectdb.cn-huhehaote.aliyuncs.com', 'endpoint' => 'selectdb.cn-huhehaote.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-huhehaote.aliyuncs.com'],
['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚(雅加达)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '菲律宾(马尼拉)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '华北3(张家口)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'selectdb.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'selectdb.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-zhangjiakou.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'selectdb.aliyuncs.com', 'endpoint' => 'selectdb.aliyuncs.com', 'vpc' => 'selectdb-vpc.cn-hangzhou.aliyuncs.com'],
['regionId' => 'us-west-1', 'regionName' => '美国(硅谷)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '美国(弗吉尼亚)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '德国(法兰克福)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '英国(伦敦)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '墨西哥', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'selectdb.na-south-1.aliyuncs.com', 'endpoint' => 'selectdb.na-south-1.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', '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,请充值后重试。'],
['code' => 'ClusterNotSupport', 'message' => 'Current instance cluster does not support this operation.', 'http_code' => 400, 'description' => '当前集群状态不支持该操作。'],
['code' => 'COMMODITY.INVALID_COMPONENT', 'message' => 'Order configuration parameters do not meet the verification conditions, please re-match the product.', 'http_code' => 400, 'description' => '订单配置参数不符合校验条件,请重新选配商品!'],
['code' => 'CreateOrderFailed', 'message' => 'Failed to create order.', 'http_code' => 400, 'description' => '创建订单失败。'],
['code' => 'DBClusterNotSupported', 'message' => 'The requested operation can not be performed while the cluster is not sale.', 'http_code' => 403, 'description' => '当集群未运行时,无法执行请求的操作。'],
['code' => 'DBInstanceLocked', 'message' => 'The current instance lock mode does not support this operation.', 'http_code' => 404, 'description' => '操作失败,当前实例已锁定。'],
['code' => 'DocumentConvertFailed.ExceedFileSizeLimit', 'message' => 'The conversion has been failed, exceed file size limit.', 'http_code' => 400, 'description' => '文档转换失败,文件大小超过系统限额。'],
['code' => 'EngineVersionDoNotSupportMultiZone', 'message' => 'The specified engine version doesn\'t support multi zone.', 'http_code' => 400, 'description' => '指定版本不支持多可用区部署模式。'],
['code' => 'Forbidden', 'message' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'http_code' => 400, 'description' => '子账号权限不足,请先获取授权。'."\n"],
['code' => 'IncorrectDBInstanceState', 'message' => 'Current DB instance state does not support this operation.', 'http_code' => 403, 'description' => '当前实例状态不支持此操作。'],
['code' => 'IncorrectVswitchId', 'message' => 'The specified parameter VSwitchId is not valid.', 'http_code' => 404, 'description' => '交换机参数无效。'],
['code' => 'InstanceEngineType.NotSupport', 'message' => 'The instance engine and type does not support operations.', 'http_code' => 403, 'description' => '操作失败,实例引擎和类型不支持该操作。'],
['code' => 'InsufficientResourceCapacity', 'message' => 'The resource is out of usage.', 'http_code' => 403, 'description' => '资源不足,请您稍后再试。'."\n"],
['code' => 'INSUFFICIENT_AVAILABLE_QUOTA', 'message' => 'Your account available limit is less than 0, please recharge before trying to purchase.', 'http_code' => 403, 'description' => '您的账户可用额度小于0,请先充值后再尝试购买'],
['code' => 'InvalidAttributeTypeValue.Malformed', 'message' => 'The value of specified parameter "AttributeType" is not valid.', 'http_code' => 400, 'description' => '修改实例的属性类型值非法。'],
['code' => 'InvalidBackupPolicyMeta.Malformed', 'message' => 'The parameter BackupMeta for Backup Policy is not valid.', 'http_code' => 400, 'description' => '备份策略中的参数BackupMeta无效'],
['code' => 'InvalidBackupPolicyRetention.NotAllowed', 'message' => 'The specified parameter "BackupSetRetentionPeriod" for BackupPolicy is not valid.', 'http_code' => 400, 'description' => '备份计划中的BackupSetRetentionPeriod参数不合法。'],
['code' => 'InvalidBuyConfigCpuOrCacheSize', 'message' => 'The specified purchase configuration CPU or cache size is invalid.', 'http_code' => 400, 'description' => '指定的购买配置CPU或者缓存大小不合法'],
['code' => 'InvalidCacheSize.NotSupport', 'message' => 'The specified parameter "CacheSize" does not meet the requirements.', 'http_code' => 400, 'description' => '参数“CacheSize”不符合要求。'],
['code' => 'InvalidChargeType.Malformed', 'message' => 'The specified parameter "ChargeType" is not valid.', 'http_code' => 400, 'description' => '参数ChargeType不是有效的参数'],
['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' => '参数“ClusterClass”不合法。'],
['code' => 'InvalidClusterId.Malformed', 'message' => 'The specified parameter "ClusterId" is not valid.', 'http_code' => 400, 'description' => '参数“ClusterId”不合法。'],
['code' => 'InvalidClusterInstance.NotFound', 'message' => 'Specified cluster instance does not exist.', 'http_code' => 404, 'description' => 'SelectDB实例不存在。'],
['code' => 'InvalidClusterName.Format', 'message' => 'Specified ClusterName is not valid. It can not be empty string.', 'http_code' => 400, 'description' => '输入的集群名称参数不合法。'],
['code' => 'InvalidClusterName.NotFound', 'message' => 'The specified cluster name is not available.', 'http_code' => 404, 'description' => '指定的集群名称不可用'],
['code' => 'InvalidConfigKey.Malformed', 'message' => 'The specified parameter "ConfigKey" is not valid.', 'http_code' => 400, 'description' => '指定参数“ConfigKey”不是有效参数。'],
['code' => 'InvalidConfigName', 'message' => 'The ConfigName is not valid.', 'http_code' => 400, 'description' => 'ConfigName不是有效值。'],
['code' => 'InvalidConfigParameters.Malformed', 'message' => 'The specified parameter "Parameters" is not valid.', 'http_code' => 400, 'description' => '指定参数“Parameters”不是有效参数。'],
['code' => 'InvalidConnectionString.Duplicate', 'message' => 'The specified connection string already exists.', 'http_code' => 400, 'description' => '指定的连接串已存在'],
['code' => 'InvalidDBClusterClass.NotFound', 'message' => 'The specified cluster class does not exist.', 'http_code' => 404, 'description' => '指定的集群规格不存在'],
['code' => 'InvalidDBClusterId.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => '集群不存在。'],
['code' => 'InvalidDBClusterState.NotSupport', 'message' => 'The specified cluster state does\'t support this operation.', 'http_code' => 404, 'description' => '集群状态不支持此操作。'],
['code' => 'InvalidDBClusterVpc.MismatchWithInstance', 'message' => 'The specified cluster vpc doesn\'t match with instance.', 'http_code' => 404, 'description' => '指定的VPC不匹配该实例VPC。'],
['code' => 'InvalidDBInstance.NotFound', 'message' => 'The specified instance is not found.', 'http_code' => 404, 'description' => '没有找到指定的实例,请检查实例的正确性。'],
['code' => 'InvalidDBInstanceClass.NotFound', 'message' => 'The specified instance classic does not exist.', 'http_code' => 404, 'description' => '当前选择的配置或规格不存在或已停售,请重新选择。'],
['code' => 'InvalidDBInstanceId.Malformed', 'message' => 'The specified parameter "DBInstanceId" is not valid.', 'http_code' => 400, 'description' => '参数"DBInstanceId"不合法。'],
['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'The DBInstanceId provided does not exist in our records.', 'http_code' => 404, 'description' => 'SelectDB实例不存在。'],
['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'DBInstanceId not found.', 'http_code' => 400, 'description' => '指定的实例ID不存在'],
['code' => 'InvalidDBInstanceNetType.Malformed', 'message' => 'The specified parameter "DBInstanceNetType" is not valid.', 'http_code' => 400, 'description' => '网络类型非法。'],
['code' => 'InvalidDBInstanceState.NotSupport', 'message' => 'The specified instance state does\'t support this operation.', 'http_code' => 403, 'description' => '指定的实例状态不支持此操作。'."\n"],
['code' => 'InvalidDBName', 'message' => 'The specified database name is not allowed.', 'http_code' => 400, 'description' => '数据库名称不符合要求,请确认数据名称是否正确。'],
['code' => 'InvalidDBName.Duplicate', 'message' => 'Specified DB name already exists in the This instance.', 'http_code' => 400, 'description' => '新建集群名称重复。'],
['code' => 'InvalidElasticRuleId.NotFound', 'message' => 'The ElasticRuleId provided does not exist in our records.', 'http_code' => 404, 'description' => '分时弹性规则不存在。'],
['code' => 'InvalidElasticRuleStartTime.Malformed', 'message' => 'The specified parameter "ElasticRuleStartTime" is not valid.', 'http_code' => 400, 'description' => '参数“ElasticRuleStartTime”不合法。'],
['code' => 'InvalidEndTime.Format', 'message' => 'Specified end time is not valid.', 'http_code' => 400, 'description' => '指定的结束时间不是有效参数。'],
['code' => 'InvalidExecutionPeriod.Malformed', 'message' => 'The specified parameter "ExecutionPeriod" is not valid.', 'http_code' => 400, 'description' => '参数“ExecutionPeriod”不合法。'],
['code' => 'InvalidInstance', 'message' => 'This instance don\'t support the action.', 'http_code' => 403, 'description' => '实例不支持此操作。'],
['code' => 'InvalidMultiZone.NotThreeZones', 'message' => 'The number of zones must be three.', 'http_code' => 400, 'description' => '多可用区数量必须是三个。'],
['code' => 'InvalidMultiZone.ShouldEmpty', 'message' => 'The "MultiZone" should be empty, please check "DeployScheme".', 'http_code' => 400, 'description' => '多可用区信息无需填写,请检查部署模式。'],
['code' => 'InvalidPageNumber.Malformed', 'message' => 'The specified parameter "PageNumber" is not valid.', 'http_code' => 400, 'description' => '每页记录数参数不合法。'],
['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' => '结束时间必须大于开始时间。'],
['code' => 'InvalidParameters.Format', 'message' => 'Specified parameters is not valid.', 'http_code' => 400, 'description' => '传入参数不是有效的参数'],
['code' => 'InvalidPayType.Malformed', 'message' => 'The specified parameter "chargeType" is not valid.', 'http_code' => 400, 'description' => '计费方式参数不合法。'],
['code' => 'InvalidRegionId.Malformed', 'message' => 'The specified parameter "RegionId" is not valid.', 'http_code' => 400, 'description' => '参数“RegionId”不合法。'],
['code' => 'InvalidRegionId.NotFound', 'message' => 'The provided RegionId does not exist in our records.', 'http_code' => 404, 'description' => '操作失败,输入的地域及可用区不存在。'],
['code' => 'InvalidResourceGroup', 'message' => 'The specified ResourceGroupId is invalid.', 'http_code' => 400, 'description' => 'ResourceGroupId参数非法。'],
['code' => 'InvalidRuleId.Malformed', 'message' => 'The specified parameter "RuleId" is not valid.', 'http_code' => 400, 'description' => '参数“RuleId”不合法。'],
['code' => 'InvalidSecurityIPList.Duplicate', 'message' => 'Specified security IP list is not valid: Duplicate IP address in the list.', 'http_code' => 400, 'description' => 'IP白名单列表不合法:列表中存在重复的IP。'],
['code' => 'InvalidSecurityIPList.Format', 'message' => 'Specified security IP list format is not valid.', 'http_code' => 400, 'description' => 'IP白名单列表不合法。'],
['code' => 'InvalidSecurityIPs.Malformed', 'message' => 'The specified parameter "SecurityIps" is not valid.', 'http_code' => 400, 'description' => 'IP白名单列表不合法。'],
['code' => 'InvalidStartTime.Format', 'message' => 'Specified start time is not valid.', 'http_code' => 400, 'description' => '指定的开始时间不是有效参数。'],
['code' => 'InvalidUpdowngradeConfig.NoChange', 'message' => 'The upgrade or downgrade configuration is not changed, please re-select.', 'http_code' => 400, 'description' => '升级或降配的配置未改变,请重新选择。'],
['code' => 'InvalidVPC.NotFound', 'message' => 'VPC or VSwitch is not valid.', 'http_code' => 404, 'description' => 'VPC或者VSwitch无效'],
['code' => 'InvalidVpcId.Malformed', 'message' => 'The specified parameter "VpcId" is not valid.', 'http_code' => 400, 'description' => 'VpcId参数无效'],
['code' => 'InvalidVPCId.NotFound', 'message' => 'Specified virtual vpc is not found.', 'http_code' => 404, 'description' => '未找到指定的VPC'],
['code' => 'InvalidVSwitch.NoIP', 'message' => 'VSwitch has zero available IP.', 'http_code' => 404, 'description' => '交换机无可用IP。'],
['code' => 'InvalidVSwitchId.Malformed', 'message' => 'The specified parameter "VSwitchId" is not valid.', 'http_code' => 400, 'description' => '参数VSwitchId无效。'],
['code' => 'InvalidZoneId.Duplicated', 'message' => 'The zones cannot be repeated please select different zones.', 'http_code' => 400, 'description' => '所选可用区不能重复'],
['code' => 'InvalidZoneId.Malformed', 'message' => 'The specified parameter "ZoneId" is not valid.', 'http_code' => 400, 'description' => 'ZoneId参数不合法'],
['code' => 'LockTimeout', 'message' => 'The request processing has failed due to lock timeout.', 'http_code' => 400, 'description' => '获取锁超时导致请求执行失败。'],
['code' => 'MissingParameter.RegionId', 'message' => 'The RegionId parameters that are required for processing this request are missing.', 'http_code' => 400, 'description' => 'RegionId参数缺失。'],
['code' => 'MissingParameter.ResourceGroupId', 'message' => 'The ResourceGroupId parameters that are required for processing this request are missing.', 'http_code' => 400, 'description' => 'ResourceGroupId参数缺失。'],
['code' => 'MissingParameter.ResourceId', 'message' => 'The ResourceId parameters that are required for processing this request are missing.', 'http_code' => 400, 'description' => 'ResourceId参数缺失。'],
['code' => 'MoneyLessThan100', 'message' => 'The Account Monet less Than 100.', 'http_code' => 403, 'description' => '当前阿里云账号余额不足100,请充值。'],
['code' => 'NoPermission.ChangeResourceGroup', 'message' => 'You are not authorized to change resourcegroup.', 'http_code' => 403, 'description' => '没有更改资源组的权限。'],
['code' => 'NoPermission.ListTagResources', 'message' => 'The operator is not permission for this operate.', 'http_code' => 403, 'description' => '您没有权限执行该操作。'],
['code' => 'NoPermission.TagResources', 'message' => 'The operator is not permission for this operate.', 'http_code' => 403, 'description' => '您没有权限执行该操作。'],
['code' => 'NoPermission.UntagResources', 'message' => 'The operator is not permission for this operate.', 'http_code' => 403, 'description' => '您没有权限执行该操作。'],
['code' => 'OperationDenied.AdjacentRulesClusterIsTheSame', 'message' => 'the operator is not permitted due to adjacent rules cluster class is the same.', 'http_code' => 403, 'description' => '此操作被禁止执行因为相邻分时弹性规则的目标计算资源相同。'],
['code' => 'OperationDenied.AdjacentRulesIntervalLessThanOneHour', 'message' => 'the operator is not permitted due to adjacent rules interval less than one hour.', 'http_code' => 403, 'description' => '操作被禁止执行因为相邻分时弹性规则的时间间隔小于1小时。'],
['code' => 'OperationDenied.DBInstancePayType', 'message' => 'The operation is not permitted due to the pay type of cluster.', 'http_code' => 403, 'description' => '当前实例的计费方式不支持此操作。'],
['code' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'message' => 'The operation is not permitted due to count of database or account privilege.', 'http_code' => 403, 'description' => '操作失败,数据库与权限的数量不一致。'],
['code' => 'OperationDenied.EnableScalingRules', 'message' => 'the operator is not permitted due to scaling rule\'s count is less than 2.', 'http_code' => 403, 'description' => '分时弹性策略规则数量小于2条时,不能开启分时弹性。'],
['code' => 'OperationDenied.GetResourceLockFailed', 'message' => 'the operator is not permitted due to get resource lock failed.', 'http_code' => 403, 'description' => '由于获取资源锁失败,本次请求被拒绝执行。'],
['code' => 'OperationDenied.OrderProcessing', 'message' => 'There are orders in process.', 'http_code' => 400, 'description' => '存在处理中的订单。'],
['code' => 'OperationDenied.PrepayDBInstanceContainsAtLeastOnePrepayCluster', 'message' => 'the operator is not permitted due to prepay dbinstance contains at least one prepay cluster.', 'http_code' => 403, 'description' => '包年包月实例下至少包含一个包年包月集群。'],
['code' => 'OperationDenied.ScalingRuleIsEnabled', 'message' => 'the operator is not permitted due to scaling rule is enabled.', 'http_code' => 403, 'description' => '分时弹性策略开启时,不能手动发起集群扩缩容。'],
['code' => 'PAY.INSUFFICIENT_BALANCE', 'message' => 'Insufficient account available balance.', 'http_code' => 400, 'description' => '账户可用余额不足'],
['code' => 'QueryPrice.Failed', 'message' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.', 'http_code' => 404, 'description' => '询价失败,请联系客服同学。'],
['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白名单已经存在。'],
['code' => 'SystemError', 'message' => 'A system error occurred while processing your request.', 'http_code' => 400, 'description' => '系统异常。'],
['code' => 'Param.Invalid', 'message' => 'key: toStartTime\'s regexp not match.', 'http_code' => 400, 'description' => '参数不合法,开始时间不符合要求的时间格式'],
['code' => 'Param.NotFound', 'message' => 'Parameter not found, please check.', 'http_code' => 404, 'description' => '参数未传递。'],
['code' => 'InvalidFileName.NotFound', 'message' => 'The specified file name does not exist.', 'http_code' => 404, 'description' => '指定的文件名不存在。'],
['code' => 'OperationDenied.VirtualClusterBound', 'message' => 'The operation is not permitted due to it has been bound to a virtual cluster.', 'http_code' => 403, 'description' => '操作不允许,因为已绑定到虚拟集群。'],
['code' => 'MinorVersionNotSupport', 'message' => 'The instance version does not support the current operation.', 'http_code' => 400, 'description' => '实例版本不支持当前操作。'],
['code' => 'ORDER.INST_HAS_UNPAID_ORDER', 'message' => 'Instance has unpaid order.', 'http_code' => 400, 'description' => '实例存在未支付订单。'],
['code' => 'InvalidOperatorType.Malformed', 'message' => 'The specified operator type is not valid.', 'http_code' => 400, 'description' => '无效的操作。'],
['code' => 'IncorrectDBInstanceLockMode', 'message' => 'Current DB instance lock mode does not support this operation.', 'http_code' => 403, 'description' => '当前实例被锁定。'],
['code' => 'InvalidZoneId.Undeployed', 'message' => 'The zone is undeployed.', 'http_code' => 400, 'description' => '可用区未开区。'],
['code' => 'InvalidInstanceType', 'message' => 'The operator is not permitted due to the instance type.', 'http_code' => 400, 'description' => '由于实例类型原因,该操作被禁止。'],
['code' => 'OperationDenied.SpecificClassCodeNotSupported', 'message' => 'The uid is not in specific classcode whitelist.', 'http_code' => 403, 'description' => '所选规格没有对当前账号开放。'],
['code' => 'RequestTimeout', 'message' => 'Query timed out. Please try again or narrow down the query scope.', 'http_code' => 408, 'description' => '请求超时,请重试或缩小时间范围'],
['code' => 'InvalidOthers.Timeout', 'message' => 'Query timed out. Please try again or narrow down the query scope.', 'http_code' => 408, 'description' => '请求超时,请重试或缩小时间范围'],
['code' => 'Param.Invalid', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => '参数不合法'],
['code' => 'InvalidParam', 'message' => 'Specified parameter is not valid.', 'http_code' => 400, 'description' => '输入参数无效'],
['code' => 'InvalidRequest', 'message' => 'Invalid Request.', 'http_code' => 400, 'description' => '无效请求'],
['code' => 'InvalidParameter.Malformed', 'message' => 'The specified parameter format is not valid.', 'http_code' => 400, 'description' => '参数格式错误'],
['code' => 'DBInstanceStatusNotActive', 'message' => 'Current DB instance status should be active.', 'http_code' => 403, 'description' => '该实例状态是运行中,才可以操作。'],
['code' => 'IncorrectEngineVersion', 'message' => 'Current engine version does not support operations.', 'http_code' => 403, 'description' => '当前版本不支持此操作。'],
['code' => 'InvalidParameter', 'message' => 'Specified parameter is not valid.', 'http_code' => 400, 'description' => '指定的参数无效。'],
['code' => 'IncorrectMinorVersion', 'message' => 'Current engine minor version does not support operations.', 'http_code' => 403, 'description' => '当前内核小版本不支持此操作。'],
['code' => 'InvalidParameter.QueryId', 'message' => 'Specified parameters is not valid.', 'http_code' => 400, 'description' => '指定的参数无效。'],
['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 集群不支持多可用区同城冗余。'],
['code' => 'InvalidInstanceClass.MultiAZ', 'message' => 'The instance with 4-core BE cluster does not support multi-zone redundancy.', 'http_code' => 400, 'description' => '4 CPU 的 BE 集群不支持多可用区同城冗余。'],
['code' => 'InvalidFENodeCount.Blank', 'message' => 'The specified parameter "FENodeCount" is blank.', 'http_code' => 400, 'description' => '请求参数FENodeCount为空。'],
['code' => 'InvalidFEClassCode.Blank', 'message' => 'The specified parameter "FEClassCode" is blank.', 'http_code' => 400, 'description' => '请求参数FEClassCode为空。'],
['code' => 'InvalidFENodeCount', 'message' => 'The specified parameter "FENodeCount" is not valid.', 'http_code' => 400, 'description' => 'FENodeCount参数不合法。'],
['code' => 'InvalidNodeCountClassCode.BothChanged', 'message' => 'The specified parameter "FENodeCount" and "FEClassCode" are both changed.', 'http_code' => 400, 'description' => 'FENodeCount和FEClassCode同时改变。'],
['code' => 'InvalidNodeCountClassCode.BothBlank', 'message' => 'The specified parameter "FENodeCount" and "FEClassCode" are both blank.', 'http_code' => 400, 'description' => 'FENodeCount和FEClassCode两个参数都是空。'],
['code' => 'InvalidDBInstanceType.NotSupport', 'message' => 'The specified instance type does\'t support this operation.', 'http_code' => 400, 'description' => '当前实例类型不支持此操作'],
['code' => 'InvalidFEClass.NotFound', 'message' => 'The specified fe class doesn\'t exist.', 'http_code' => 404, 'description' => 'FE集群规格不存在。'],
['code' => 'InvalidFENodeCount.ForMultiAZ', 'message' => 'The instance with FENodeCount that less than 3 does not support upgrading to multi-zone redundancy.', 'http_code' => 400, 'description' => '同城冗余实例的FE节点数必须大于等于3。'],
['code' => 'EngineVersionDoNotSupportModifyFE', 'message' => 'The specified engine version doesn\'t support modify fe.', 'http_code' => 400, 'description' => '当前实例版本不支持发起FE变配操作。'],
['code' => 'InvalidNodeCountClassCode.BothNotChanged', 'message' => 'The specified parameter "FENodeCount" and "FEClassCode" are both not changed.', 'http_code' => 400, 'description' => 'FE单节点规格和FE节点数参数都没有改变。'],
],
'changeSet' => [],
'ram' => [
'productCode' => 'SelectDB',
'productName' => '云数据库 SelectDB 版',
'ramCodes' => ['selectdb'],
'ramLevel' => '操作级',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'DescribeDBClusterStorageLimitation',
'description' => '查看集群各规格缓存限制',
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:DescribeDBClusterStorageLimitation',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDBInstanceNetInfo',
'description' => '查询实例网络信息',
'operationType' => 'none',
'ramAction' => [
'action' => 'selectdb:DescribeDBInstanceNetInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDBInstance',
'description' => '删除实例',
'operationType' => 'delete',
'ramAction' => [
'action' => 'selectdb:DeleteDBInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCreateBEClusterInquiry',
'description' => '新建集群询价',
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:GetCreateBEClusterInquiry',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyBEClusterAttribute',
'description' => '修改集群名',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyBEClusterAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ResetAccountPassword',
'description' => '重置账号密码',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ResetAccountPassword',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSecurityIPList',
'description' => '查询实例白名单IP',
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeSecurityIPList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDBClusterBinding',
'description' => '删除集群绑定',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:DeleteDBClusterBinding',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDBCluster',
'description' => '删除集群',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:DeleteDBCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeZones',
'description' => '列出售卖可用区',
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeZones',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CheckServiceLinkedRole',
'description' => '检查服务关联角色',
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:CheckServiceLinkedRole',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDBInstanceAttribute',
'description' => '查询实例详情',
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeDBInstanceAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDBInstance',
'description' => '创建实例',
'operationType' => 'create',
'ramAction' => [
'action' => 'selectdb:CreateDBInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', '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' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDBClusterConfigChangeLogs',
'description' => '查看集群配置变更记录',
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:DescribeDBClusterConfigChangeLogs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteVirtualCluster',
'description' => '删除虚拟集群',
'operationType' => 'delete',
'ramAction' => [
'action' => 'selectdb:DeleteVirtualCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpgradeDBInstanceDeployScheme',
'description' => '升级实例可用区部署架构',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:UpgradeDBInstanceDeployScheme',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDBClusterConfig',
'description' => '查看集群配置',
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:DescribeDBClusterConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetModifyBEClusterInquiry',
'description' => '集群变配询价',
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:GetModifyBEClusterInquiry',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeAllDBInstanceClass',
'description' => '获取所有实例规格信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:DescribeAllDBInstanceClass',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'StopBECluster',
'description' => '停止集群',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:StopBECluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeVSwitches',
'description' => '查询交换机列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeVSwitches',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSlowQueryStats',
'description' => '查询慢查询统计信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:DescribeSlowQueryStats',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateElasticRule',
'description' => '创建分时弹性规则',
'operationType' => 'create',
'ramAction' => [
'action' => 'selectdb:CreateElasticRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpgradeDBInstanceEngineVersion',
'description' => '升级数据库版本',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:UpgradeDBInstanceEngineVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyDBClusterConfig',
'description' => '修改集群配置',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyDBClusterConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeElasticRules',
'description' => '查询分时弹性规则',
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeElasticRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifySecurityIPList',
'description' => '修改白名单',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifySecurityIPList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDBClusterBinding',
'description' => '创建集群绑定',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:CreateDBClusterBinding',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'StartBECluster',
'description' => '启动集群',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:StartBECluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CheckCreateDBInstance',
'description' => '创建实例前的预检查 ',
'operationType' => 'get',
'ramAction' => [
'action' => 'selectdb:CheckCreateDBInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AllocateInstancePublicConnection',
'description' => '申请公网地址',
'operationType' => 'create',
'ramAction' => [
'action' => 'selectdb:AllocateInstancePublicConnection',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'EnDisableScalingRules',
'description' => '开关分时弹性策略',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:EnDisableScalingRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeRegions',
'description' => '获取可选的地域和可用区',
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeRegions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyDBCluster',
'description' => '集群扩缩容',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyDBCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RestartDBCluster',
'description' => '重启集群',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:RestartDBCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteElasticRule',
'description' => '删除分时弹性规则',
'operationType' => 'delete',
'ramAction' => [
'action' => 'selectdb:DeleteElasticRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateVirtualCluster',
'description' => '创建虚拟集群',
'operationType' => 'create',
'ramAction' => [
'action' => 'selectdb:CreateVirtualCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CheckIpExistsInSecurityIpList',
'description' => '判断指定 IP 是否已经存在于网络白名单组',
'operationType' => 'none',
'ramAction' => [
'action' => 'selectdb:CheckIpExistsInSecurityIpList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDBInstances',
'description' => '查询实例',
'operationType' => 'list',
'ramAction' => [
'action' => 'selectdb:DescribeDBInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyVirtualCluster',
'description' => '修改虚拟集群',
'operationType' => 'update',
'ramAction' => [
'action' => 'selectdb:ModifyVirtualCluster',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ReleaseInstancePublicConnection',
'description' => '释放公网地址',
'operationType' => 'delete',
'ramAction' => [
'action' => 'selectdb:ReleaseInstancePublicConnection',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateServiceLinkedRoleForSelectDB',
'description' => '创建服务关联角色',
'operationType' => 'none',
'ramAction' => [
'action' => 'selectdb:CreateServiceLinkedRoleForSelectDB',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SelectDB', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [
['validationType' => 'always', 'resourceType' => 'DBInstance', 'arn' => 'acs:selectdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'],
],
],
];