'1.0', 'info' => ['style' => 'RPC', 'product' => 'hitsdb', 'version' => '2020-06-15'], 'directories' => [ [ 'children' => ['DescribeRegions'], 'type' => 'directory', 'title' => 'Area', ], [ 'children' => ['CreateLindormInstance', 'ReleaseLindormInstance', 'UpgradeLindormInstance', 'GetLindormInstance', 'GetLindormInstanceEngineList', 'GetLindormInstanceList', 'RenewLindormInstance', 'ModifyInstancePayType', 'SwitchLSQLV3MySQLService'], 'type' => 'directory', 'title' => 'Instance', ], [ 'children' => ['UpdateInstanceIpWhiteList', 'GetInstanceIpWhiteList'], 'type' => 'directory', 'title' => 'Whitelists', ], [ 'children' => ['ListTagResources', 'TagResources', 'UntagResources'], 'type' => 'directory', 'title' => 'Tag', ], [ 'children' => ['ChangeResourceGroup', 'CreateLindormV2Instance', 'GetLindormFsUsedDetail', 'ReleaseLindormV2Instance', 'UpdateLindormV2Instance'], 'type' => 'directory', 'title' => 'Other', ], [ 'children' => ['GetInstanceSummary', 'GetLindormV2InstanceDetails', 'GetLindormV2StorageUsage', 'UpdateLindormInstanceAttribute', 'UpdateLindormV2WhiteIpList'], 'title' => 'Others', 'type' => 'directory', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'ChangeResourceGroup' => [ 'summary' => 'Moves a resource to a different resource group.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '145137', 'abilityTreeNodes' => ['FEATUREhitsdb6YHIIK'], ], 'parameters' => [ [ 'name' => 'ResourceId', 'in' => 'query', 'schema' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ld-bp17j28j2y7pm****'], ], [ 'name' => 'ResourceRegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the destination resource group.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rg-aek2i6wee****'], ], ], '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' => 'FAED4C02-AF99-5015-A075-692DE9C99630'], 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'NoPermission.ChangeResourceGroup', 'errorMessage' => 'You are not authorized to change resourcegroup', 'description' => ''], ['errorCode' => 'MissingParameter.ResourceRegionId', 'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing', 'description' => ''], ['errorCode' => 'MissingParameter.ResourceId', 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', 'description' => ''], ['errorCode' => 'MissingParameter.ResourceGroupId', 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', 'description' => ''], ['errorCode' => 'InvalidResourceGroup', 'errorMessage' => 'The specified ResourceGroupId is invalid', 'description' => ''], ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request', 'description' => ''], ['errorCode' => 'ResourceNotFound', 'errorMessage' => ' The specified resource is not found', 'description' => ''], ], 403 => [ ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => 'You are not authorized to manage the specified resource.'], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ChangeResourceGroup', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:ChangeResourceGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'Instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FAED4C02-AF99-5015-A075-692DE9C99630\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\\\"AuthAction\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"AuthPrincipalDisplayName\\\\\\":\\\\\\"222\\\\\\",\\\\\\"AuthPrincipalOwnerId\\\\\\":\\\\\\"111\\\\\\",\\\\\\"AuthPrincipalType\\\\\\":\\\\\\"SubUser\\\\\\",,\\\\\\"NoPermissionType\\\\\\":\\\\\\"ImplicitDeny\\\\\\",\\\\\\"PolicyType\\\\\\":\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\\\"EncodedDiagnosticMessage\\\\\\":\\\\\\"xxxxxx\\\\\\"}\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'CreateLindormInstance' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '64027', 'abilityTreeNodes' => ['FEATUREhitsdbUE1KPV'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region in which to create the instance. You can call the [DescribeRegions](~~426062~~) operation to query the latest region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the zone where you want to create the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai-f', 'title' => ''], ], [ 'name' => 'InstanceAlias', 'in' => 'query', 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'lindorm_test', 'title' => ''], ], [ 'name' => 'InstanceStorage', 'in' => 'query', 'schema' => ['description' => 'The storage capacity of the instance, in GB.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '480', 'title' => ''], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => ['description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'- **PREPAY**: Subscription.'."\n" ."\n" .'- **POSTPAY**: Pay-As-You-Go.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'POSTPAY', 'title' => ''], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => ['description' => 'The ID of the VPC where you want to create the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-bp1nme44gek34slfc****', 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The ID of the VSwitch.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vsw-bp1e7clcw529l773d****', 'title' => ''], ], [ 'name' => 'PricingCycle', 'in' => 'query', 'schema' => ['description' => 'The billing cycle for the Subscription instance. Valid values:'."\n" ."\n" .'- **Month**'."\n" ."\n" .'- **Year**'."\n" ."\n" .'> This parameter is required if you set **PayType** to **PREPAY**.', 'type' => 'string', 'required' => false, 'example' => 'Month', 'title' => ''], ], [ 'name' => 'Duration', 'in' => 'query', 'schema' => ['description' => 'The subscription duration for the instance. Valid values:'."\n" ."\n" .'- If **PricingCycle** is set to **Month**, the value can range from **1** to **9**.'."\n" ."\n" .'- If **PricingCycle** is set to **Year**, the value can range from **1** to **3**.'."\n" ."\n" .'> This parameter is required if you set **PayType** to **PREPAY**.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'DiskCategory', 'in' => 'query', 'schema' => ['description' => 'The storage type of the instance. Valid values:'."\n" ."\n" .'- **cloud\\_efficiency**: Efficiency cloud disk.'."\n" ."\n" .'- **cloud\\_ssd**: Performance cloud disk.'."\n" ."\n" .'- **cloud\\_essd**: Enhanced SSD (ESSD).'."\n" ."\n" .'- **cloud\\_essd\\_pl0**: ESSD PL0.'."\n" ."\n" .'- **capacity\\_cloud\\_storage**: Capacity-optimized cloud storage. (Not available for multi-zone instances.)'."\n" ."\n" .'- **local\\_ssd\\_pro**: Local SSD. (Not available for multi-zone instances.)'."\n" ."\n" .'- **local\\_hdd\\_pro**: Local HDD. (Not available for multi-zone instances.)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cloud_efficiency', 'title' => ''], ], [ 'name' => 'CoreSpec', 'in' => 'query', 'schema' => ['description' => 'The node specification for an instance that uses local disks.'."\n" ."\n" .'If the storage type is **local\\_ssd\\_pro**, valid values include the following: Note that I3-family specifications are available only for Subscription instances.'."\n" ."\n" .'- **lindorm.i4.xlarge**: 4 cores, 32 GB memory (I4).'."\n" ."\n" .'- **lindorm.i4.2xlarge**: 8 cores, 64 GB memory (I4).'."\n" ."\n" .'- **lindorm.i4.4xlarge**: 16 cores, 128 GB memory (I4).'."\n" ."\n" .'- **lindorm.i4.8xlarge**: 32 cores, 256 GB memory (I4).'."\n" ."\n" .'- **lindorm.i3.xlarge**: 4 cores, 32 GB memory (I3).'."\n" ."\n" .'- **lindorm.i3.2xlarge**: 8 cores, 64 GB memory (I3).'."\n" ."\n" .'- **lindorm.i3.4xlarge**: 16 cores, 128 GB memory (I3).'."\n" ."\n" .'- **lindorm.i3.8xlarge**: 32 cores, 256 GB memory (I3).'."\n" ."\n" .'- **lindorm.i2.xlarge**: 4 cores, 32 GB memory (I2).'."\n" ."\n" .'- **lindorm.i2.2xlarge**: 8 cores, 64 GB memory (I2).'."\n" ."\n" .'- **lindorm.i2.4xlarge**: 16 cores, 128 GB memory (I2).'."\n" ."\n" .'- **lindorm.i2.8xlarge**: 32 cores, 256 GB memory (I2).'."\n" ."\n" .'If the storage type is **local\\_hdd\\_pro**, valid values include:'."\n" ."\n" .'- **lindorm.sd3c.3xlarge**: 14 cores, 56 GB memory (D3C PRO).'."\n" ."\n" .'- **lindorm.sd3c.7xlarge**: 28 cores, 112 GB memory (D3C PRO).'."\n" ."\n" .'- **lindorm.sd3c.14xlarge**: 56 cores, 224 GB memory (D3C PRO).'."\n" ."\n" .'- **lindorm.d2c.6xlarge**: 24 cores, 88 GB memory (D2C).'."\n" ."\n" .'- **lindorm.d2c.12xlarge**: 48 cores, 176 GB memory (D2C).'."\n" ."\n" .'- **lindorm.d2c.24xlarge**: 96 cores, 352 GB memory (D2C).'."\n" ."\n" .'- **lindorm.d2s.5xlarge**: 20 cores, 88 GB memory (D2S).'."\n" ."\n" .'- **lindorm.d2s.10xlarge**: 40 cores, 176 GB memory (D2S).'."\n" ."\n" .'- **lindorm.d1.2xlarge**: 8 cores, 32 GB memory (D1NE).'."\n" ."\n" .'- **lindorm.d1.4xlarge**: 16 cores, 64 GB memory (D1NE).'."\n" ."\n" .'- **lindorm.d1.6xlarge**: 24 cores, 96 GB memory (D1NE).', 'type' => 'string', 'required' => false, 'example' => 'lindorm.i2.xlarge', 'title' => ''], ], [ 'name' => 'LindormNum', 'in' => 'query', 'schema' => ['description' => 'The number of nodes in the wide table engine.'."\n" ."\n" .'For a single-zone instance, the value of this parameter ranges from **0** to **90**.'."\n" ."\n" .'**This parameter is required for multi-zone instances.** For an instance that uses cloud disks, the value ranges from **4** to **400**. For an instance that uses local disks, the value ranges from **6** to **400**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'SolrSpec', 'in' => 'query', 'schema' => ['description' => 'The specification of the search engine nodes. Valid values:'."\n" ."\n" .'- **lindorm.g.xlarge**: 4 cores, 16 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.c.2xlarge**: 8 cores, 16 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.g.2xlarge**: 8 cores, 32 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.c.4xlarge**: 16 cores, 32 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.g.4xlarge**: 16 cores, 64 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.c.8xlarge**: 32 cores, 64 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.g.8xlarge**: 32 cores, 128 GB memory (dedicated).', 'type' => 'string', 'required' => false, 'example' => 'lindorm.g.xlarge', 'title' => ''], ], [ 'name' => 'SolrNum', 'in' => 'query', 'schema' => ['description' => 'The number of search engine nodes. The value of this parameter ranges from **0** to **60**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'ColdStorage', 'in' => 'query', 'schema' => ['description' => 'The cold storage capacity of the instance, in GB. The value of this parameter ranges from **800** to **1,000,000**. If you do not specify this parameter, cold storage is not enabled.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '800', 'title' => ''], ], [ 'name' => 'TsdbSpec', 'in' => 'query', 'schema' => ['description' => 'The specification of the time series engine nodes. Valid values:'."\n" ."\n" .'- **lindorm.g.xlarge**: 4 cores, 16 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.g.2xlarge**: 8 cores, 32 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.g.4xlarge**: 16 cores, 64 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.g.8xlarge**: 32 cores, 128 GB memory (dedicated).', 'type' => 'string', 'required' => false, 'example' => 'lindorm.g.xlarge', 'title' => ''], ], [ 'name' => 'TsdbNum', 'in' => 'query', 'schema' => ['description' => 'The number of nodes in the time series engine. Valid values:'."\n" ."\n" .'- For a Subscription instance, the value of this parameter ranges from **0** to **24**.'."\n" ."\n" .'- For a Pay-As-You-Go instance, the value of this parameter ranges from **0** to **32**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'LindormSpec', 'in' => 'query', 'schema' => ['description' => 'The specification of the wide table engine nodes. Valid values:'."\n" ."\n" .'- **lindorm.g.xlarge**: 4 cores, 16 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.c.2xlarge**: 8 cores, 16 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.g.2xlarge**: 8 cores, 32 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.c.4xlarge**: 16 cores, 32 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.g.4xlarge**: 16 cores, 64 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.c.8xlarge**: 32 cores, 64 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.g.8xlarge**: 32 cores, 128 GB memory (dedicated).', 'type' => 'string', 'required' => false, 'example' => 'lindorm.c.xlarge', 'title' => ''], ], [ 'name' => 'FilestoreNum', 'in' => 'query', 'schema' => ['description' => 'The number of nodes in the file engine. Valid values:'."\n" ."\n" .'- For a Subscription instance, the value of this parameter ranges from **0** to **60**.'."\n" ."\n" .'- For a Pay-As-You-Go instance, the value of this parameter ranges from **0** to **8**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'FilestoreSpec', 'in' => 'query', 'schema' => ['description' => 'The specification of the file engine nodes. Valid values:'."\n" ."\n" .'- **lindorm.c.xlarge**: 4 cores, 8 GB memory (standard).', 'type' => 'string', 'required' => false, 'example' => 'lindorm.c.xlarge', 'title' => ''], ], [ 'name' => 'StreamNum', 'in' => 'query', 'schema' => ['description' => 'The number of nodes in the stream engine. The value of this parameter ranges from **0** to **60**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'StreamSpec', 'in' => 'query', 'schema' => ['description' => 'The specification of the stream engine nodes. Valid values:'."\n" ."\n" .'- **lindorm.g.xlarge**: 4 cores, 16 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.c.2xlarge**: 8 cores, 16 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.g.2xlarge**: 8 cores, 32 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.c.4xlarge**: 16 cores, 32 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.g.4xlarge**: 16 cores, 64 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.c.8xlarge**: 32 cores, 64 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.g.8xlarge**: 32 cores, 128 GB memory (dedicated).', 'type' => 'string', 'required' => false, 'example' => 'lindorm.g.xlarge', 'title' => ''], ], [ 'name' => 'ArchVersion', 'in' => 'query', 'schema' => ['description' => 'The deployment architecture of the instance. Valid values:'."\n" ."\n" .'- **1.0**: Single-zone deployment.'."\n" ."\n" .'- **2.0**: Multi-zone deployment.'."\n" ."\n" .'The default value is 1.0. To create a multi-zone instance, set this parameter to 2.0. **This parameter is required for multi-zone instances.**', 'type' => 'string', 'required' => false, 'example' => '2.0', 'title' => ''], ], [ 'name' => 'PrimaryZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the primary zone for the multi-zone instance. **This parameter is required for multi-zone instances.**', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-e', 'title' => ''], ], [ 'name' => 'StandbyZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the standby zone for the multi-zone instance. **This parameter is required for multi-zone instances.**', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-f', 'title' => ''], ], [ 'name' => 'ArbiterZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the arbiter zone for the multi-zone instance. **This parameter is required for multi-zone instances.**', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-g', 'title' => ''], ], [ 'name' => 'MultiZoneCombination', 'in' => 'query', 'schema' => ['description' => 'The combination of zones for the multi-zone instance. For a list of supported combinations, refer to the instance purchase page.'."\n" ."\n" .'- **ap-southeast-5abc-aliyun**: Indonesia (Jakarta) A+B+C.'."\n" ."\n" .'- **cn-hangzhou-ehi-aliyun**: China (Hangzhou) E+H+I.'."\n" ."\n" .'- **cn-beijing-acd-aliyun**: China (Beijing) A+C+D.'."\n" ."\n" .'- **ap-southeast-1-abc-aliyun**: Singapore A+B+C.'."\n" ."\n" .'- **cn-zhangjiakou-abc-aliyun**: China (Zhangjiakou) A+B+C.'."\n" ."\n" .'- **cn-shanghai-efg-aliyun**: China (Shanghai) E+F+G.'."\n" ."\n" .'- **cn-shanghai-abd-aliyun**: China (Shanghai) A+B+D.'."\n" ."\n" .'- **cn-hangzhou-bef-aliyun**: China (Hangzhou) B+E+F.'."\n" ."\n" .'- **cn-hangzhou-bce-aliyun**: China (Hangzhou) B+C+E.'."\n" ."\n" .'- **cn-beijing-fgh-aliyun**: China (Beijing) F+G+H.'."\n" ."\n" .'- **cn-shenzhen-abc-aliyun**: China (Shenzhen) A+B+C.'."\n" ."\n" .'**This parameter is required for multi-zone instances.**', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-efg-aliyun', 'title' => ''], ], [ 'name' => 'PrimaryVSwitchId', 'in' => 'query', 'schema' => ['description' => 'The ID of the VSwitch for the primary zone of the multi-zone instance. The VSwitch must be in the zone specified by `PrimaryZoneId`. **This parameter is required for multi-zone instances.**', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6fdqa7c0pipnqzq****', 'title' => ''], ], [ 'name' => 'StandbyVSwitchId', 'in' => 'query', 'schema' => ['description' => 'The ID of the VSwitch for the standby zone of the multi-zone instance. The VSwitch must be in the zone specified by `StandbyZoneId`. **This parameter is required for multi-zone instances.**', 'type' => 'string', 'required' => false, 'example' => 'vsw-2zec0kcn08cgdtr6****', 'title' => ''], ], [ 'name' => 'ArbiterVSwitchId', 'in' => 'query', 'schema' => ['description' => 'The ID of the VSwitch for the arbiter zone of the multi-zone instance. The VSwitch must be in the zone specified by `ArbiterZoneId`. **This parameter is required for multi-zone instances.**', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6664pqjawb87k36****', 'title' => ''], ], [ 'name' => 'CoreSingleStorage', 'in' => 'query', 'schema' => ['description' => 'The storage capacity of a single core node in the multi-zone instance. Unit: GB. The value of this parameter ranges from 400 to 64,000. **This parameter is required for multi-zone instances.**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '400', 'title' => ''], ], [ 'name' => 'LogDiskCategory', 'in' => 'query', 'schema' => ['description' => 'The storage type of the log nodes for the multi-zone instance. Valid values:'."\n" ."\n" .'- **cloud\\_efficiency**: Efficiency cloud disk.'."\n" ."\n" .'- **cloud\\_ssd**: Performance cloud disk.'."\n" ."\n" .'**This parameter is required for multi-zone instances.**', 'type' => 'string', 'required' => false, 'example' => 'cloud_ssd', 'title' => ''], ], [ 'name' => 'LogSpec', 'in' => 'query', 'schema' => ['description' => 'The specification of the log nodes for the multi-zone instance. Valid values:'."\n" ."\n" .'- **lindorm.sn1.large**: 4 cores, 8 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.sn1.2xlarge**: 8 cores, 16 GB memory (dedicated).'."\n" ."\n" .'**This parameter is required for multi-zone instances.**', 'type' => 'string', 'required' => false, 'example' => 'lindorm.sn1.large', 'title' => ''], ], [ 'name' => 'LogNum', 'in' => 'query', 'schema' => ['description' => 'The number of log nodes for the multi-zone instance. The value of this parameter ranges from 4 to 400. **This parameter is required for multi-zone instances.**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4', 'title' => ''], ], [ 'name' => 'LogSingleStorage', 'in' => 'query', 'schema' => ['description' => 'The storage capacity of a single log node in the multi-zone instance. Unit: GB. The value of this parameter ranges from 400 to 64,000. **This parameter is required for multi-zone instances.**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '400', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2i6weeb4nfii', 'title' => ''], ], [ 'name' => 'AutoRenewal', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable auto-renewal for the Subscription instance. Valid values:'."\n" ."\n" .'- **true**: Auto-renewal is enabled.'."\n" ."\n" .'- **false**: Auto-renewal is disabled.'."\n" ."\n" .'Default value: false.'."\n" ."\n" .'> This parameter takes effect only when the **PayType** parameter is set to **PREPAY**.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'AutoRenewDuration', 'in' => 'query', 'schema' => ['description' => 'The auto-renewal duration, in months.'."\n" ."\n" .'The value of this parameter ranges from **1** to **12**.'."\n" ."\n" .'> This parameter takes effect only when **AutoRenewal** is set to **true**.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'LtsSpec', 'in' => 'query', 'schema' => ['description' => 'The specification of the LTS engine nodes. Valid values:'."\n" ."\n" .'- **lindorm.c.xlarge**: 4 cores, 8 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.g.xlarge**: 4 cores, 16 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.c.2xlarge**: 8 cores, 16 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.g.2xlarge**: 8 cores, 32 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.c.4xlarge**: 16 cores, 32 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.g.4xlarge**: 16 cores, 64 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.c.8xlarge**: 32 cores, 64 GB memory (dedicated).'."\n" ."\n" .'- **lindorm.g.8xlarge**: 32 cores, 128 GB memory (dedicated).', 'type' => 'string', 'required' => false, 'example' => 'lindorm.g.xlarge', 'title' => ''], ], [ 'name' => 'LtsNum', 'in' => 'query', 'schema' => ['description' => 'The number of nodes in the LTS engine. The value of this parameter ranges from **0** to **60**.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags to add to the instance. You can add up to 20 tags.', 'type' => 'array', 'items' => [ 'description' => 'The list of tags.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of a tag.'."\n" ."\n" .'> You can specify the keys of multiple tags. For example, `Tag.1.Key` specifies the key of the first tag and `Tag.2.Key` specifies the key of the second tag.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], 'Value' => ['description' => 'The value of a tag.'."\n" ."\n" .'> You can specify the values of multiple tags. For example, `Tag.1.Value` specifies the value of the first tag and `Tag.2.Value` specifies the value of the second tag.', 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 100, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '93BE8227-3406-4D7A-883D-9A421D42****', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the created instance.', 'type' => 'string', 'example' => 'ld-bp1o3y0yme2i2****', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '111111111111111', 'title' => ''], 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Lindorm.Errorcode.ParameterInvaild', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ['errorCode' => 'LindormErrorCode.%s', 'errorMessage' => '%s.', 'description' => '%s.'], ], 403 => [ ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => ''], ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ], ], 'title' => 'CreateLindormInstance', 'summary' => 'Create a Lindorm instance.', 'description' => 'To create an instance, you must specify at least one data engine. For example, to create a wide table engine, you must specify both the **LindormNum** (node count) and **LindormSpec** (node specification) parameters. For details on data engines and storage specifications, see [How to select a data engine](~~174643~~) and [How to select a storage specification](~~181971~~).'."\n" ."\n" .'>'."\n" ."\n" .'If you do not specify any data engine parameters when you create an instance, the API call fails.'."\n" ."\n" .'>', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-06-04T12:13:27.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2025-05-27T03:40:19.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-05-26T08:56:43.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-05-26T08:56:35.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-05-26T07:57:09.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-05-26T07:57:02.000Z', 'description' => 'OpenAPI offline'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'lindorm:CreateLindormInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"93BE8227-3406-4D7A-883D-9A421D42****\\",\\n \\"InstanceId\\": \\"ld-bp1o3y0yme2i2****\\",\\n \\"OrderId\\": 111111111111111,\\n \\"AccessDeniedDetail\\": \\"{\\\\\\"AuthAction\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"AuthPrincipalDisplayName\\\\\\":\\\\\\"222\\\\\\",\\\\\\"AuthPrincipalOwnerId\\\\\\":\\\\\\"111\\\\\\",\\\\\\"AuthPrincipalType\\\\\\":\\\\\\"SubUser\\\\\\",,\\\\\\"NoPermissionType\\\\\\":\\\\\\"ImplicitDeny\\\\\\",\\\\\\"PolicyType\\\\\\":\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\\\"EncodedDiagnosticMessage\\\\\\":\\\\\\"xxxxxx\\\\\\"}\\"\\n}","type":"json"}]', ], 'CreateLindormV2Instance' => [ 'summary' => 'Creates a Lindorm V2 instance.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeCode' => '251726', 'abilityTreeNodes' => ['FEATUREhitsdbUE1KPV'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where you want to create the instance. To query the available regions, call the [DescribeRegions](~~426062~~) operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the zone for the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai-f', 'title' => ''], ], [ 'name' => 'InstanceAlias', 'in' => 'query', 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'lindorm-test', 'title' => ''], ], [ 'name' => 'CloudStorageType', 'in' => 'query', 'schema' => [ 'description' => 'The storage class. This parameter is not required if you select **Big Data** or **Local SSD**.'."\n" ."\n" .'- **PerformanceStorage**: performance cloud storage'."\n" ."\n" .'- **StandardStorage**: standard cloud storage', 'type' => 'string', 'required' => false, 'docRequired' => true, 'enum' => ['StandardStorage', 'PerformanceStorage', 'CapacityStorage'], 'example' => 'PerformanceStorage', 'title' => '', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => ['description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'- **PREPAY**: subscription.'."\n" ."\n" .'- **POSTPAY**: pay-as-you-go.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PREPAY', 'title' => ''], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => ['description' => 'The ID of the virtual private cloud (VPC) for the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-wz9ydz3vg93s1ozsd****', 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vsw-bp1e7clcw529l773d****', 'title' => ''], ], [ 'name' => 'PricingCycle', 'in' => 'query', 'schema' => [ 'description' => 'The subscription period of the instance. Valid values:'."\n" ."\n" .'- **Month**: The unit is month.'."\n" ."\n" .'- **Year**: The unit is year.'."\n" ."\n" .'> This parameter is required only when you set PayType to **PREPAY**.', 'type' => 'string', 'required' => false, 'enum' => ['Month', 'Year'], 'example' => 'Month', 'title' => '', ], ], [ 'name' => 'Duration', 'in' => 'query', 'schema' => ['description' => 'The subscription duration of the instance. Valid values:'."\n" ."\n" .'- If you set PricingCycle to **Month**, the valid values are **1** to **9**.'."\n" ."\n" .'- If you set PricingCycle to **Year**, the valid values are **1** to **3**.'."\n" ."\n" .'> This parameter is required only when you set PayType to **PREPAY**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'CloudStorageSize', 'in' => 'query', 'schema' => ['description' => 'The size of the cloud storage. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => true, 'required' => true, 'example' => '320', 'title' => ''], ], [ 'name' => 'ArchVersion', 'in' => 'query', 'schema' => ['description' => 'The deployment architecture. Valid values:'."\n" ."\n" .'- **1.0**: single zone.'."\n" ."\n" .'- **2.0**: multi-zone Basic Edition.'."\n" ."\n" .'- **3.0**: multi-zone High-availability Edition.', 'type' => 'string', 'required' => false, 'example' => '2.0', 'title' => ''], ], [ 'name' => 'PrimaryZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the primary zone for a multi-zone instance. **This parameter is required if you want to create a multi-zone instance.**', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-e', 'title' => ''], ], [ 'name' => 'StandbyZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the secondary zone for a multi-zone instance. **This parameter is required if you want to create a multi-zone instance.**', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-f', 'title' => ''], ], [ 'name' => 'ArbiterZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the arbiter zone for a multi-zone instance. **This parameter is required if you want to create a multi-zone instance.**', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-g', 'title' => ''], ], [ 'name' => 'PrimaryVSwitchId', 'in' => 'query', 'schema' => ['description' => 'The ID of the vSwitch in the primary zone for a multi-zone instance. The vSwitch must be in the zone specified by PrimaryZoneId. **This parameter is required if you want to create a multi-zone instance.**', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6fdqa7c0pipnqzq****', 'title' => ''], ], [ 'name' => 'StandbyVSwitchId', 'in' => 'query', 'schema' => ['description' => 'The ID of the vSwitch in the secondary zone for a multi-zone instance. The vSwitch must be in the zone specified by StandbyZoneId. **This parameter is required if you want to create a multi-zone instance.**', 'type' => 'string', 'required' => false, 'example' => 'vsw-2zec0kcn08cgdtr6****', 'title' => ''], ], [ 'name' => 'ArbiterVSwitchId', 'in' => 'query', 'schema' => ['description' => 'The ID of the vSwitch in the arbiter zone for a multi-zone instance. The vSwitch must be in the zone specified by ArbiterZoneId. **This parameter is required if you want to create a multi-zone instance.**', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6664pqjawb87k36****', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2i6weeb4nfii', 'title' => ''], ], [ 'name' => 'AutoRenewal', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable auto-renewal for the instance. Valid values:'."\n" ."\n" .'- **true**: Enable auto-renewal.'."\n" ."\n" .'- **false**: Disable auto-renewal.'."\n" ."\n" .'The default value is false.'."\n" ."\n" .'> This parameter is valid only when you set **PayType** to **PREPAY**.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'AutoRenewDuration', 'in' => 'query', 'schema' => ['description' => 'The auto-renewal duration. Unit: month.'."\n" ."\n" .'Valid values: **1** to **12**.'."\n" ."\n" .'> This parameter is valid only when you set **AutoRenewal** to **true**.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ClusterPattern', 'in' => 'query', 'schema' => [ 'description' => 'The cluster type. Valid value:'."\n" ."\n" .'- **basic**: production', 'type' => 'string', 'required' => false, 'default' => 'basic', 'enum' => ['basic', 'light'], 'example' => 'basic', 'title' => '', ], ], [ 'name' => 'ClusterMode', 'in' => 'query', 'schema' => [ 'description' => 'The instance mode. This parameter is not required.'."\n" ."\n" .'- **BASIC**: general-purpose mode', 'type' => 'string', 'required' => false, 'default' => 'BASIC', 'enum' => ['BASIC'], 'example' => 'BASIC ', 'title' => '', ], ], [ 'name' => 'EnableCapacityStorage', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable storage-optimized storage.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'CapacityStorageSize', 'in' => 'query', 'schema' => ['description' => 'The size of the storage-optimized storage. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000', 'title' => ''], ], [ 'name' => 'EngineList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'EngineType' => [ 'description' => 'The engine type. Valid values:'."\n" ."\n" .'- **TABLE**: LindormTable.'."\n" ."\n" .'- **TSDB**: LindormTSDB.'."\n" ."\n" .'- **LSEARCH**: search engine.'."\n" ."\n" .'- **LTS**: LTS engine.'."\n" ."\n" .'- **LVECTOR**: vector engine.'."\n" ."\n" .'- **LCOLUMN**: column store engine.'."\n" ."\n" .'- **LAI**: AI engine.', 'type' => 'string', 'required' => true, 'enum' => ['TABLE', 'TSDB', 'LTS', 'LSEARCH', 'LSTREAM', 'LVECTOR', 'LMESSAGE', 'LAI', 'LCOLUMN'], 'example' => 'TABLE', 'title' => '', ], 'NodeGroupList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'NodeSpec' => ['description' => 'The node specifications.'."\n" ."\n" .'If you select performance cloud storage or standard cloud storage, set this parameter to one of the following values:'."\n" ."\n" .'- **lindorm.c.2xlarge**: 8 cores, 16 GB.'."\n" ."\n" .'- **lindorm.g.2xlarge**: 8 cores, 32 GB.'."\n" ."\n" .'- **lindorm.c.4xlarge**: 16 cores, 32 GB.'."\n" ."\n" .'- **lindorm.g.4xlarge**: 16 cores, 64 GB.'."\n" ."\n" .'- **lindorm.c.8xlarge**: 32 cores, 64 GB.'."\n" ."\n" .'- **lindorm.g.8xlarge**: 32 cores, 128 GB.'."\n" ."\n" .'- **lindorm.r.2xlarge**: 8 cores, 64 GB.'."\n" ."\n" .'- **lindorm.r.4xlarge**: 16 cores, 128 GB.'."\n" ."\n" .'- **lindorm.r.8xlarge**: 32 cores, 256 GB.'."\n" ."\n" .'If you select the local SSD type, set this parameter to one of the following values:'."\n" ."\n" .'- **lindorm.i4.xlarge**: 4 cores, 32 GB (I4).'."\n" ."\n" .'- **lindorm.i4.2xlarge**: 8 cores, 64 GB (I4).'."\n" ."\n" .'- **lindorm.i4.4xlarge**: 16 cores, 128 GB (I4).'."\n" ."\n" .'- **lindorm.i4.8xlarge**: 32 cores, 256 GB (I4).'."\n" ."\n" .'- **lindorm.i3.xlarge**: 4 cores, 32 GB (I3).'."\n" ."\n" .'- **lindorm.i3.2xlarge**: 8 cores, 64 GB (I3).'."\n" ."\n" .'- **lindorm.i3.4xlarge**: 16 cores, 128 GB (I3).'."\n" ."\n" .'- **lindorm.i3.8xlarge**: 32 cores, 256 GB (I3).'."\n" ."\n" .'- **lindorm.i2.xlarge**: 4 cores, 32 GB (I2).'."\n" ."\n" .'- **lindorm.i2.2xlarge**: 8 cores, 64 GB (I2).'."\n" ."\n" .'- **lindorm.i2.4xlarge**: 16 cores, 128 GB (I2).'."\n" ."\n" .'- **lindorm.i2.8xlarge**: 32 cores, 256 GB (I2).'."\n" ."\n" .'If you select the big data type, set this parameter to one of the following values:'."\n" ."\n" .'- **lindorm.sd3c.3xlarge**: 14 cores, 56 GB (D3C PRO).'."\n" ."\n" .'- **lindorm.sd3c.7xlarge**: 28 cores, 112 GB (D3C PRO).'."\n" ."\n" .'- **lindorm.sd3c.14xlarge**: 56 cores, 224 GB (D3C PRO).'."\n" ."\n" .'- **lindorm.d2c.6xlarge**: 24 cores, 88 GB (D2C).'."\n" ."\n" .'- **lindorm.d2c.12xlarge**: 48 cores, 176 GB (D2C).'."\n" ."\n" .'- **lindorm.d2c.24xlarge**: 96 cores, 352 GB (D2C).'."\n" ."\n" .'- **lindorm.d2s.5xlarge**: 20 cores, 88 GB (D2S).'."\n" ."\n" .'- **lindorm.d2s.10xlarge**: 40 cores, 176 GB (D2S).'."\n" ."\n" .'- **lindorm.d1.2xlarge**: 8 cores, 32 GB (D1NE).'."\n" ."\n" .'- **lindorm.d1.4xlarge**: 16 cores, 64 GB (D1NE).'."\n" ."\n" .'- **lindorm.d1.6xlarge**: 24 cores, 96 GB (D1NE).', 'type' => 'string', 'required' => true, 'example' => 'lindorm.g.2xlarge', 'title' => ''], 'NodeCount' => ['description' => 'The number of nodes in the cluster.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '7', 'title' => ''], 'NodeDiskType' => [ 'description' => 'The disk type of the node. This parameter is not required. **This parameter is available only for specific scenarios. To use this parameter, you must be added to the whitelist.**', 'type' => 'string', 'default' => 'cloud_essd', 'enum' => ['cloud_essd', 'cloud_efficiency'], 'required' => false, 'example' => 'cloud_essd', 'title' => '', ], 'NodeDiskSize' => ['description' => 'The disk size of a single node. The default unit is GB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], 'ResourceGroupName' => ['description' => 'The name of the node group. **This parameter is required.**', 'type' => 'string', 'required' => false, 'example' => 'group_name_01', 'title' => ''], ], 'description' => 'The list of engine nodes.', 'required' => false, 'title' => '', 'example' => '', ], 'maxItems' => 12, 'minItems' => 1, 'description' => 'The list of engine nodes.', 'required' => false, 'title' => '', 'example' => '', ], ], 'description' => 'The list of engine information.', 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'maxItems' => 100, 'description' => 'The list of engine information.', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1556DCB0-043A-4444-8BD9-CF4A68E7EE64', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ld-bp1mq0tdzbx1m****', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '211110656240000', 'title' => ''], 'AccessDeniedDetail' => ['description' => 'The detailed reason why the access was denied.', 'type' => 'string', 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Lindorm.Errorcode.ParameterInvaild', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ['errorCode' => 'LindormErrorCode.%s', 'errorMessage' => '%s.', 'description' => '%s.'], ], 403 => [ ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => ''], ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ], ], 'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'hitsdb::2020-06-15::GetLindormV2Instance', 'callbackInterval' => 300000, 'maxCallbackTimes' => 12], 'title' => 'CreateLindormV2Instance', 'description' => 'You must specify at least one DPI engine when you create an instance. For more information about DPI engines and storage specifications, see [How to select a DPI engine](~~174643~~) and [How to select storage specifications](~~181971~~).'."\n" ."\n" .'>'."\n" ."\n" .'If you do not specify a DPI engine parameter when you create an instance, the API call fails.'."\n" ."\n" .'>', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'lindorm:CreateLindormV2Instance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1556DCB0-043A-4444-8BD9-CF4A68E7EE64\\",\\n \\"InstanceId\\": \\"ld-bp1mq0tdzbx1m****\\",\\n \\"OrderId\\": 211110656240000,\\n \\"AccessDeniedDetail\\": \\"{\\\\\\"AuthAction\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"AuthPrincipalDisplayName\\\\\\":\\\\\\"222\\\\\\",\\\\\\"AuthPrincipalOwnerId\\\\\\":\\\\\\"111\\\\\\",\\\\\\"AuthPrincipalType\\\\\\":\\\\\\"SubUser\\\\\\",,\\\\\\"NoPermissionType\\\\\\":\\\\\\"ImplicitDeny\\\\\\",\\\\\\"PolicyType\\\\\\":\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\\\"EncodedDiagnosticMessage\\\\\\":\\\\\\"xxxxxx\\\\\\"}\\"\\n}","type":"json"}]', ], 'DescribeRegions' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '64039', 'abilityTreeNodes' => ['FEATUREhitsdbUE1KPV'], ], 'parameters' => [ [ 'name' => 'AcceptLanguage', 'in' => 'query', 'schema' => ['description' => 'The language to use for the region name (LocalName) in the response. Valid values:'."\n" ."\n" .'- **zh-CN**: Chinese. This is the default value.'."\n" ."\n" .'- **en-US**: English.', 'type' => 'string', 'required' => false, 'example' => 'en-US', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '73F6E6DA-9AE5-5548-9E07-761A554DAF2E', 'title' => ''], 'Regions' => [ 'description' => 'The list of regions.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RegionEndpoint' => ['description' => 'The endpoint of the region.', 'type' => 'string', 'example' => 'hitsdb.cn-hangzhou.aliyuncs.com', 'title' => ''], 'LocalName' => ['description' => 'The name of the region.', 'type' => 'string', 'example' => 'China (Hangzhou)', 'title' => ''], 'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => '400', 'errorMessage' => 'Parameter is not valid', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73F6E6DA-9AE5-5548-9E07-761A554DAF2E\\",\\n \\"Regions\\": [\\n {\\n \\"RegionEndpoint\\": \\"hitsdb.cn-hangzhou.aliyuncs.com\\",\\n \\"LocalName\\": \\"China (Hangzhou)\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeRegions', 'summary' => 'Queries all regions where Lindorm is available.', 'changeSet' => [], 'ramActions' => [], 'extraInfo' => ' ', ], 'GetInstanceIpWhiteList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '76391', 'abilityTreeNodes' => ['FEATUREhitsdb3JDHWG'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. To obtain the ID, call the [GetLindormInstanceList](~~426068~~) operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp1z3506imz2g****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ld-bp1z3506imz2f****', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1D1F6F4D-9203-53E7-84E9-5376B4657E63', 'title' => ''], 'IpList' => [ 'description' => 'A list of IP addresses in the whitelist.', 'type' => 'array', 'items' => ['description' => 'An IP address in the whitelist.', 'type' => 'string', 'example' => '192.168.0.0/24', 'title' => ''], 'title' => '', 'example' => '', ], 'GroupList' => [ 'description' => 'A list of whitelist groups.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GroupName' => ['description' => 'The name of the whitelist group.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'SecurityIpList' => ['description' => 'The IP address whitelist.', 'type' => 'string', 'example' => '192.168.1.0/24', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AccessDeniedDetail' => ['description' => 'The details about why the access was denied.', 'type' => 'string', 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Lindorm.Errorcode.ParameterInvaild', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ['errorCode' => 'Instance.IsDeleted', 'errorMessage' => 'The instance is deleted.', 'description' => 'The specified instance is already deleted.'], ['errorCode' => 'Instance.IsNotValid', 'errorMessage' => 'The instance is invalid.', 'description' => 'The specified instance is invalid.'], ], 403 => [ ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => ''], ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ], ], 'title' => 'GetInstanceIpWhiteList', 'summary' => 'Retrieves the access whitelist for a Lindorm instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'lindorm:GetInstanceIpWhiteList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceId\\": \\"ld-bp1z3506imz2f****\\",\\n \\"RequestId\\": \\"1D1F6F4D-9203-53E7-84E9-5376B4657E63\\",\\n \\"IpList\\": [\\n \\"192.168.0.0/24\\"\\n ],\\n \\"GroupList\\": [\\n {\\n \\"GroupName\\": \\"test\\",\\n \\"SecurityIpList\\": \\"192.168.1.0/24\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\\\"AuthAction\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"AuthPrincipalDisplayName\\\\\\":\\\\\\"222\\\\\\",\\\\\\"AuthPrincipalOwnerId\\\\\\":\\\\\\"111\\\\\\",\\\\\\"AuthPrincipalType\\\\\\":\\\\\\"SubUser\\\\\\",,\\\\\\"NoPermissionType\\\\\\":\\\\\\"ImplicitDeny\\\\\\",\\\\\\"PolicyType\\\\\\":\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\\\"EncodedDiagnosticMessage\\\\\\":\\\\\\"xxxxxx\\\\\\"}\\"\\n}","type":"json"}]', ], 'GetInstanceSummary' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '76394', 'abilityTreeNodes' => ['FEATUREhitsdbUE1KPV'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'LockingCount' => ['description' => 'The number of instances that are about to expire.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1556DCB0-043A-4444-8BD9-CF4A68E7EE64', 'title' => ''], 'Total' => ['description' => 'The total number of instances that are running or about to expire.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'RunningCount' => ['description' => 'The number of running instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '9', 'title' => ''], 'RegionalSummary' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'LockingCount' => ['description' => 'The number of instances in `{RegionId}` that are about to expire.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Total' => ['description' => 'The total number of instances in `{RegionId}` that are running or about to expire.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'RunningCount' => ['description' => 'The number of running instances in `{RegionId}`.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], ], 'description' => 'A region summary.', 'title' => '', 'example' => '', ], 'description' => 'An array of region summaries.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Lindorm.Errorcode.ParameterInvaild', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ], 403 => [ ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => ''], ], ], 'title' => 'GetInstanceSummary', 'summary' => 'Retrieves a summary of Lindorm instances in your account.', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'lindorm:GetInstanceSummary', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LockingCount\\": 1,\\n \\"RequestId\\": \\"1556DCB0-043A-4444-8BD9-CF4A68E7EE64\\",\\n \\"Total\\": 10,\\n \\"RunningCount\\": 9,\\n \\"RegionalSummary\\": [\\n {\\n \\"LockingCount\\": 1,\\n \\"Total\\": 6,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RunningCount\\": 5\\n }\\n ]\\n}","type":"json"}]', ], 'GetLindormFsUsedDetail' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '121530', 'abilityTreeNodes' => ['FEATUREhitsdbDXDFAS'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the instance is located. Call the [DescribeRegions](~~426062~~) API to obtain it.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. Call the [GetLindormInstanceList](~~426069~~) API to obtain it.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-xxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request. This unique identifier is generated by Alibaba Cloud for each request and is used for troubleshooting.', 'type' => 'string', 'example' => '4F23D50C-400C-592C-9486-9D1E10179065', 'title' => ''], 'Valid' => ['description' => 'Indicates whether the response is valid. A value of `false` indicates that an error occurred, and you must provide the request ID for troubleshooting.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'FsCapacity' => ['description' => 'The total storage capacity of the cluster, in bytes.', 'type' => 'string', 'example' => '85899345920', 'title' => ''], 'FsCapacityHot' => ['description' => 'The hot storage capacity of the cluster, in bytes.', 'type' => 'string', 'example' => '85899345920', 'title' => ''], 'FsCapacityCold' => ['description' => 'The cold storage capacity of the cluster, in bytes.', 'type' => 'string', 'example' => '85899345920', 'title' => ''], 'FsUsedHot' => ['description' => 'The hot storage used by the cluster, in bytes.', 'type' => 'string', 'example' => '33269', 'title' => ''], 'FsUsedCold' => ['description' => 'The cold storage used by the cluster, in bytes.', 'type' => 'string', 'example' => '33269', 'title' => ''], 'FsUsedOnLindormTable' => ['description' => 'The storage space used by the wide-column engine in the cluster, in bytes.', 'type' => 'string', 'example' => '33269', 'title' => ''], 'FsUsedOnLindormTableData' => ['description' => 'The storage space used by table data of the wide-column engine, in bytes.', 'type' => 'string', 'example' => '33269', 'title' => ''], 'FsUsedOnLindormTableWAL' => ['description' => 'The storage space used by log data of the wide-column engine, in bytes.', 'type' => 'string', 'example' => '33269', 'title' => ''], 'FsUsedOnLindormSearch' => ['description' => 'The storage space used by the search engine in the cluster, in bytes.', 'type' => 'string', 'example' => '33269', 'title' => ''], 'FsUsedOnLindormTSDB' => ['description' => 'The storage space used by the time series engine in the cluster, in bytes.', 'type' => 'string', 'example' => '33269', 'title' => ''], 'FsUsedHotOnLindormTable' => ['description' => 'The hot storage space used by table data of the wide-column engine, in bytes.', 'type' => 'string', 'example' => '33269', 'title' => ''], 'FsUsedColdOnLindormTable' => ['description' => 'The cold storage space used by table data of the wide-column engine, in bytes.', 'type' => 'string', 'example' => '33269', 'title' => ''], 'FsUsedHotOnLindormSearch' => ['description' => 'The hot storage space used by table data of the search engine, in bytes.', 'type' => 'string', 'example' => '33269', 'title' => ''], 'FsUsedColdOnLindormSearch' => ['description' => 'The cold storage space used by table data of the search engine, in bytes.', 'type' => 'string', 'example' => '33269', 'title' => ''], 'FsUsedHotOnLindormTSDB' => ['description' => 'The hot storage space used by table data of the time series engine, in bytes.', 'type' => 'string', 'example' => '33269', 'title' => ''], 'FsUsedColdOnLindormTSDB' => ['description' => 'The cold storage space used by table data of the time series engine, in bytes.', 'type' => 'string', 'example' => '33269', 'title' => ''], 'LStorageUsageList' => [ 'description' => 'For clusters that run storage engine v4.1.9 or later, this parameter provides authoritative storage details categorized by storage medium.', 'type' => 'array', 'items' => [ 'description' => 'The storage details for a specific storage medium.', 'type' => 'object', 'properties' => [ 'DiskType' => ['description' => 'The storage type of the cluster. Valid values:'."\n" ."\n" .'- `StandardCloudStorage`: standard cloud storage.'."\n" ."\n" .'- `PerformanceCloudStorage`: performance cloud storage.'."\n" ."\n" .'- `CapacityCloudStorage`: capacity cloud storage.'."\n" ."\n" .'- `LocalSsdStorage`: local SSD.'."\n" ."\n" .'- `LocalHddStorage`: local HDD.'."\n" ."\n" .'- `LocalEbsStorage`: local block storage.', 'type' => 'string', 'example' => 'StandardCloudStorage', 'title' => ''], 'Capacity' => ['description' => 'The total storage capacity for this storage medium, in bytes.', 'type' => 'string', 'example' => '85899345920', 'title' => ''], 'Used' => ['description' => 'The storage used on this storage medium, in bytes.', 'type' => 'string', 'example' => '33269', 'title' => ''], 'UsedLindormTable' => ['description' => 'The storage used by the wide-column engine on this storage medium, in bytes.', 'type' => 'string', 'example' => '33269', 'title' => ''], 'UsedLindormTsdb' => ['description' => 'The storage used by the time series engine on this storage medium, in bytes.', 'type' => 'string', 'example' => '33269', 'title' => ''], 'UsedLindormSearch' => ['description' => 'The storage used by the search engine on this storage medium, in bytes.', 'type' => 'string', 'example' => '33269', 'title' => ''], 'UsedLindormSpark' => ['description' => 'The storage used by the compute engine on this storage medium, in bytes.', 'type' => 'string', 'example' => '33269', 'title' => ''], 'UsedOther' => ['description' => 'The storage used by other components, such as logs and trash, on this storage medium, in bytes.', 'type' => 'string', 'example' => '33269', 'title' => ''], 'UsedLindormMessage3' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'UsedLindormColumn3' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'UsedLindormVector3' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AccessDeniedDetail' => ['description' => 'Details on why access was denied.', 'type' => 'string', 'example' => '{}', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Lindorm.Errorcode.ParameterInvaild', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ], 403 => [ ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => 'You are not authorized to manage the specified resource.'], ], ], 'title' => 'GetLindormFsUsedDetail', 'summary' => 'Retrieves the storage details for each storage medium in a specified Lindorm instance.', 'description' => 'For Lindorm clusters with a storage version of 4.1.9 or later, storage usage details are available in the list returned by `LStorageUsageList`.', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'lindorm:GetLindormFsUsedDetail', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4F23D50C-400C-592C-9486-9D1E10179065\\",\\n \\"Valid\\": \\"true\\",\\n \\"FsCapacity\\": \\"85899345920\\",\\n \\"FsCapacityHot\\": \\"85899345920\\",\\n \\"FsCapacityCold\\": \\"85899345920\\",\\n \\"FsUsedHot\\": \\"33269\\",\\n \\"FsUsedCold\\": \\"33269\\",\\n \\"FsUsedOnLindormTable\\": \\"33269\\",\\n \\"FsUsedOnLindormTableData\\": \\"33269\\",\\n \\"FsUsedOnLindormTableWAL\\": \\"33269\\",\\n \\"FsUsedOnLindormSearch\\": \\"33269\\",\\n \\"FsUsedOnLindormTSDB\\": \\"33269\\",\\n \\"FsUsedHotOnLindormTable\\": \\"33269\\",\\n \\"FsUsedColdOnLindormTable\\": \\"33269\\",\\n \\"FsUsedHotOnLindormSearch\\": \\"33269\\",\\n \\"FsUsedColdOnLindormSearch\\": \\"33269\\",\\n \\"FsUsedHotOnLindormTSDB\\": \\"33269\\",\\n \\"FsUsedColdOnLindormTSDB\\": \\"33269\\",\\n \\"LStorageUsageList\\": [\\n {\\n \\"DiskType\\": \\"StandardCloudStorage\\",\\n \\"Capacity\\": \\"85899345920\\",\\n \\"Used\\": \\"33269\\",\\n \\"UsedLindormTable\\": \\"33269\\",\\n \\"UsedLindormTsdb\\": \\"33269\\",\\n \\"UsedLindormSearch\\": \\"33269\\",\\n \\"UsedLindormSpark\\": \\"33269\\",\\n \\"UsedOther\\": \\"33269\\",\\n \\"UsedLindormMessage3\\": \\"\\",\\n \\"UsedLindormColumn3\\": \\"\\",\\n \\"UsedLindormVector3\\": \\"\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{}\\"\\n}","type":"json"}]', ], 'GetLindormInstance' => [ 'summary' => 'Retrieves detailed information about a Lindorm instance, including its instance type, billing method, and VPC.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '64062', 'abilityTreeNodes' => ['FEATUREhitsdbDXDFAS', 'FEATUREhitsdb6YHIIK'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID. Call [GetLindormInstanceList](~~426069~~) to obtain the ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp1o3y0yme2i2****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'VpcId' => ['description' => 'The ID of the virtual private cloud (VPC) to which the instance belongs.', 'type' => 'string', 'example' => 'vpc-bp1n3i15v90el48nx****', 'title' => ''], 'VswitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-bp1vbjzmod9q3l9eo****', 'title' => ''], 'CreateTime' => ['description' => 'The time at which the instance was created. The time is displayed in the **yyyy-MM-dd HH:mm:ss** format.', 'type' => 'string', 'example' => '2021-07-26 17:10:26', 'title' => ''], 'PayType' => ['description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'- **PREPAY**: subscription'."\n" ."\n" .'- **POSTPAY**: pay-as-you-go', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''], 'NetworkType' => ['description' => 'The network type of the instance.', 'type' => 'string', 'example' => 'vpc', 'title' => ''], 'ServiceType' => ['description' => 'The type of the instance. Valid values:'."\n" ."\n" .'- **lindorm**: a single-zone instance.'."\n" ."\n" .'- **lindorm\\_multizone**: a multi-zone instance.'."\n" ."\n" .'- **serverless\\_lindorm**: a serverless instance.'."\n" ."\n" .'- **lindorm\\_standalone**: a single-node instance.'."\n" ."\n" .'- **lts**: a Lindorm Tunnel Service (LTS) instance.', 'type' => 'string', 'example' => 'lindorm', 'title' => ''], 'EnableKms' => ['description' => 'Indicates whether Key Management Service (KMS) is enabled. Valid values:'."\n" ."\n" .'- **true**: Enabled.'."\n" ."\n" .'- **false**: Disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'EnableStoreTDE' => ['description' => 'Indicates whether Transparent Data Encryption (TDE) is enabled. Valid values:'."\n" ."\n" .'- true: Enabled.'."\n" ."\n" .'- false: Disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'DiskUsage' => ['description' => 'The disk usage.', 'type' => 'string', 'example' => '0.0%', 'title' => ''], 'DiskCategory' => ['description' => 'The storage type. Valid values:'."\n" ."\n" .'- **cloud\\_efficiency**: Standard.'."\n" ."\n" .'- **cloud\\_ssd**: Performance.'."\n" ."\n" .'- **cloud\\_essd**: Enhanced SSD (ESSD).'."\n" ."\n" .'- **cloud\\_essd\\_pl0**: ESSD PL0.'."\n" ."\n" .'- **capacity\\_cloud\\_storage**: Capacity.'."\n" ."\n" .'- **local\\_ssd\\_pro**: local SSD.'."\n" ."\n" .'- **local\\_hdd\\_pro**: local HDD.', 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '633F1BE4-C8DA-5744-8FDF-A3075C3FE37F', 'title' => ''], 'ColdStorage' => ['description' => 'The capacity of the cold storage.', 'type' => 'integer', 'format' => 'int32', 'example' => '0GB', 'title' => ''], 'ArchiveStorage' => ['description' => 'The billable storage capacity of the archive storage. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '0GB', 'title' => ''], 'ExpiredMilliseconds' => ['description' => 'The expiration time of the instance. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1629993600000', 'title' => ''], 'EngineType' => ['description' => 'The types of the engines that are supported by the instance. The value of this parameter is the sum of the values of all supported engine types.'."\n" ."\n" .'- 1: search engine'."\n" ."\n" .'- 2: time series engine'."\n" ."\n" .'- 4: wide table engine'."\n" ."\n" .'- 8: file engine'."\n" ."\n" .'> For example, if the value of this parameter is 15, it indicates that the instance supports the search, time series, wide table, and file engines because 1 + 2 + 4 + 8 = 15. If the value of this parameter is 6, it indicates that the instance supports the time series and wide table engines because 2 + 4 = 6.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], 'ExpireTime' => ['description' => 'The expiration time of the instance. The time is displayed in the **yyyy-MM-dd HH:mm:ss** format.'."\n" ."\n" .'> This parameter is returned only for subscription instances.', 'type' => 'string', 'example' => '2021-08-27 00:00:00', 'title' => ''], 'AutoRenew' => ['description' => 'Indicates whether auto-renewal is enabled for the instance. Valid values:'."\n" ."\n" .'- **true**: Enabled.'."\n" ."\n" .'- **false**: Disabled.'."\n" ."\n" .'> This parameter is returned only for subscription instances.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'DeletionProtection' => ['description' => 'Indicates whether release protection is enabled for the instance. Valid values:'."\n" ."\n" .'- **true**: Enabled.'."\n" ."\n" .'- **false**: Disabled.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'InstanceStorage' => ['description' => 'The storage capacity of the instance.', 'type' => 'string', 'example' => '480', 'title' => ''], 'AliUid' => ['description' => 'The UID of the Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'example' => '164901546557****', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'ld-bp1o3y0yme2i2****', 'title' => ''], 'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'CreateMilliseconds' => ['description' => 'The time at which the instance was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1627290664000', 'title' => ''], 'InstanceAlias' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'test0726', 'title' => ''], 'DiskThreshold' => ['description' => 'The disk space threshold.', 'type' => 'string', 'example' => '80%', 'title' => ''], 'ZoneId' => ['description' => 'The ID of the zone.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], 'InstanceStatus' => ['description' => 'The status of the instance. Valid values:'."\n" ."\n" .'- **CREATING**: The instance is being created.'."\n" ."\n" .'- **ACTIVATION**: The instance is running.'."\n" ."\n" .'- **COLD\\_EXPANDING**: The capacity of the cold storage is being expanded.'."\n" ."\n" .'- **MINOR\\_VERSION\\_TRANSITIONING**: The minor version of the instance is being changed.'."\n" ."\n" .'- **RESIZING**: The number of nodes is being changed.'."\n" ."\n" .'- **SHRINKING**: The number of nodes is being changed.'."\n" ."\n" .'- **CLASS\\_CHANGING**: The specification of the instance is being changed.'."\n" ."\n" .'- **SSL\\_SWITCHING**: SSL is being enabled or disabled.'."\n" ."\n" .'- **CDC\\_OPENING**: The CDC feature is being enabled.'."\n" ."\n" .'- **TRANSFER**: Data is being migrated.'."\n" ."\n" .'- **DATABASE\\_TRANSFER**: Data is being migrated.'."\n" ."\n" .'- **GUARD\\_CREATING**: A disaster recovery instance is being created.'."\n" ."\n" .'- **BACKUP\\_RECOVERING**: Data is being restored from a backup.'."\n" ."\n" .'- **DATABASE\\_IMPORTING**: Data is being imported.'."\n" ."\n" .'- **NET\\_MODIFYING**: The network type is being changed.'."\n" ."\n" .'- **NET\\_SWITCHING**: The network is being switched.'."\n" ."\n" .'- **NET\\_CREATING**: A network connection is being created.'."\n" ."\n" .'- **NET\\_DELETING**: A network connection is being deleted.'."\n" ."\n" .'- **DELETING**: The instance is being deleted.'."\n" ."\n" .'- **RESTARTING**: The instance is being restarted.'."\n" ."\n" .'- **LOCKED**: The instance is locked.', 'type' => 'string', 'example' => 'ACTIVATION', 'title' => ''], 'EngineList' => [ 'description' => 'The information about the engines.', 'type' => 'array', 'items' => [ 'description' => 'The information about the engines.', 'type' => 'object', 'properties' => [ 'Version' => ['description' => 'The version of the engine.', 'type' => 'string', 'example' => '2.2.3', 'title' => ''], 'CpuCount' => ['description' => 'The number of vCPUs for the engine node.', 'type' => 'string', 'example' => '4', 'title' => ''], 'CoreCount' => ['description' => 'The number of engine nodes.', 'type' => 'string', 'example' => '2', 'title' => ''], 'Engine' => ['description' => 'The type of the engine. Valid values:'."\n" ."\n" .'- **lindorm**: the wide table engine.'."\n" ."\n" .'- **tsdb**: the time series engine.'."\n" ."\n" .'- **solr**: the search engine.'."\n" ."\n" .'- **store**: the file engine.'."\n" ."\n" .'- **bds**: the LTS engine.'."\n" ."\n" .'- **compute**: the compute engine.', 'type' => 'string', 'example' => 'lindorm', 'title' => ''], 'Specification' => ['description' => 'The specification of the engine nodes.', 'type' => 'string', 'example' => 'lindorm.g.2xlarge', 'title' => ''], 'MemorySize' => ['description' => 'The memory size of the engine node.', 'type' => 'string', 'example' => '8GB', 'title' => ''], 'IsLastVersion' => ['description' => 'Indicates whether the engine is of the latest version. Valid values:'."\n" ."\n" .'- **true**: The engine is of the latest version.'."\n" ."\n" .'- **false**: The engine is not of the latest version.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'LatestVersion' => ['description' => 'The latest version of the engine.', 'type' => 'string', 'example' => '2.2.19.2', 'title' => ''], 'PrimaryCoreCount' => ['description' => 'The number of nodes in the primary zone.', 'type' => 'string', 'example' => '2', 'title' => ''], 'StandbyCoreCount' => ['description' => 'The number of nodes in the secondary zone.', 'type' => 'string', 'example' => '2', 'title' => ''], 'ArbiterCoreCount' => ['description' => 'The number of nodes in the arbiter zone.', 'type' => 'string', 'example' => '2', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'EnableCompute' => ['description' => 'Indicates whether the compute engine is enabled for the instance. Valid values:'."\n" ."\n" .'- **true**: Enabled.'."\n" ."\n" .'- **false**: Disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'EnableSSL' => ['description' => 'Indicates whether SSL encryption is enabled. Valid values:'."\n" ."\n" .'- **true**: Enabled.'."\n" ."\n" .'- **false**: Disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'EnableMLCtrl' => ['description' => 'Indicates whether the ML node is enabled. Valid values:'."\n" ."\n" .'- true: Enabled.'."\n" ."\n" .'- false: Disabled.', 'type' => 'boolean', 'example' => 'False', 'title' => ''], 'EnableCdc' => ['description' => 'Indicates whether Change Data Capture (CDC) is enabled for the instance. Valid values:'."\n" ."\n" .'- **true**: Enabled.'."\n" ."\n" .'- **false**: Disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'EnableStream' => ['description' => 'Indicates whether the stream engine is enabled for the instance. Valid values:'."\n" ."\n" .'- **true**: Enabled.'."\n" ."\n" .'- **false**: Disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'EnableLTS' => ['description' => 'Indicates whether the LTS engine is enabled for the instance. Valid values:'."\n" ."\n" .'- **true**: Enabled.'."\n" ."\n" .'- **false**: Disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'EnableShs' => ['description' => 'Indicates whether the History Server is enabled for the compute engine.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'EnableBlob' => ['description' => 'Indicates whether LBlob is enabled. Valid values:'."\n" ."\n" .'true: Enabled. false: Disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'MaintainStartTime' => ['description' => 'The start time of the maintenance window.', 'type' => 'string', 'example' => '00:00Z', 'title' => ''], 'MaintainEndTime' => ['description' => 'The end time of the maintenance window.', 'type' => 'string', 'example' => '20:00Z', 'title' => ''], 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-aek2wvd6oia****', 'title' => ''], 'PrimaryZoneId' => ['description' => 'The primary zone ID of the multi-zone instance.', 'type' => 'string', 'example' => 'cn-shanghai-e', 'title' => ''], 'StandbyZoneId' => ['description' => 'The secondary zone ID of the multi-zone instance.', 'type' => 'string', 'example' => 'cn-shanghai-f', 'title' => ''], 'ArbiterZoneId' => ['description' => 'The arbiter zone ID of the multi-zone instance.', 'type' => 'string', 'example' => 'cn-shanghai-g', 'title' => ''], 'PrimaryVSwitchId' => ['description' => 'The ID of the vSwitch in the primary zone for the multi-zone instance. The vSwitch must be deployed in the zone that is specified by `PrimaryZoneId`.', 'type' => 'string', 'example' => 'vsw-uf6fdqa7c0pipnqzq****', 'title' => ''], 'StandbyVSwitchId' => ['description' => 'The ID of the vSwitch in the secondary zone for the multi-zone instance. The vSwitch must be deployed in the zone that is specified by `StandbyZoneId`.', 'type' => 'string', 'example' => 'vsw-2zec0kcn08cgdtr6****', 'title' => ''], 'ArbiterVSwitchId' => ['description' => 'The ID of the vSwitch in the arbiter zone for the multi-zone instance. The vSwitch must be deployed in the zone that is specified by `ArbiterZoneId`.', 'type' => 'string', 'example' => 'vsw-uf6664pqjawb87k36****', 'title' => ''], 'MultiZoneCombination' => ['description' => 'The combination of zones. For more information about the supported zone combinations, see the instance buy page.'."\n" ."\n" .'- **ap-southeast-5abc-aliyun**: Indonesia (Jakarta) Zone A, B, and C.'."\n" ."\n" .'- **cn-hangzhou-ehi-aliyun**: China (Hangzhou) Zone E, H, and I.'."\n" ."\n" .'- **cn-beijing-acd-aliyun**: China (Beijing) Zone A, C, and D.'."\n" ."\n" .'- **ap-southeast-1-abc-aliyun**: Singapore Zone A, B, and C.'."\n" ."\n" .'- **cn-zhangjiakou-abc-aliyun**: China (Zhangjiakou) Zone A, B, and C.'."\n" ."\n" .'- **cn-shanghai-efg-aliyun**: China (Shanghai) Zone E, F, and G.'."\n" ."\n" .'- **cn-shanghai-abd-aliyun**: China (Shanghai) Zone A, B, and D.'."\n" ."\n" .'- **cn-hangzhou-bef-aliyun**: China (Hangzhou) Zone B, E, and F.'."\n" ."\n" .'- **cn-hangzhou-bce-aliyun**: China (Hangzhou) Zone B, C, and E.'."\n" ."\n" .'- **cn-beijing-fgh-aliyun**: China (Beijing) Zone F, G, and H.'."\n" ."\n" .'- **cn-shenzhen-abc-aliyun**: China (Shenzhen) Zone A, B, and C.', 'type' => 'string', 'example' => 'cn-shanghai-efg-aliyun', 'title' => ''], 'CoreDiskCategory' => ['description' => 'The disk type of the core nodes in a multi-zone instance. Valid values:'."\n" ."\n" .'- **cloud\\_efficiency**: Standard.'."\n" ."\n" .'- **cloud\\_ssd**: Performance.'."\n" ."\n" .'- **cloud\\_essd**: ESSD.'."\n" ."\n" .'- **cloud\\_essd\\_pl0**: ESSD PL0.', 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''], 'CoreSpec' => ['description' => 'The specification of the core nodes in the multi-zone instance.', 'type' => 'string', 'example' => 'lindorm.g.xlarge', 'title' => ''], 'CoreNum' => ['description' => 'The number of core nodes in the multi-zone instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], 'CoreSingleStorage' => ['description' => 'The storage capacity of a single core node in the multi-zone instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], 'LogDiskCategory' => ['description' => 'The disk type of the log nodes in the multi-zone instance. Valid values:'."\n" ."\n" .'- **cloud\\_efficiency**: Standard.'."\n" ."\n" .'- **cloud\\_ssd**: Performance.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], 'LogSpec' => ['description' => 'The specification of the log nodes in the multi-zone instance.', 'type' => 'string', 'example' => 'lindorm.sn1.large', 'title' => ''], 'LogNum' => ['description' => 'The number of log nodes in the multi-zone instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], 'LogSingleStorage' => ['description' => 'The storage capacity of a single log node in the multi-zone instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '400GB', 'title' => ''], 'BackupInstance' => ['description' => 'The ID of the backup instance.', 'type' => 'string', 'example' => 'ld-xxxx', 'title' => ''], 'EnableLsqlVersionV3' => ['description' => 'Indicates whether LindormSQL V3.0, which is compatible with the MySQL protocol, is supported by the wide table engine.'."\n" .'This feature is supported by default on instances created after October 24, 2023. For existing instances, contact technical support to enable this feature.'."\n" ."\n" .'- true: Supported.'."\n" ."\n" .'- false: Not supported.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], 'EnableLProxy' => ['description' => 'Specifies whether the wide table engine supports the Thrift and CQL protocols. If this feature is disabled, you can call the SwitchLProxyService operation to enable it.'."\n" ."\n" .'true: Supported.'."\n" ."\n" .'false: Not supported.', 'type' => 'boolean', 'example' => 'False', 'title' => ''], 'ArchVersion' => ['description' => 'The deployment architecture. Valid values:'."\n" ."\n" .'- **1.0**: single-zone deployment.'."\n" ."\n" .'- **2.0**: multi-zone deployment.', 'type' => 'string', 'example' => '1.0', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Instance.IsDeleted', 'errorMessage' => 'The instance is deleted.', 'description' => ''], ['errorCode' => 'Instance.IsNotValid', 'errorMessage' => 'The instance is invalid.', 'description' => 'The specified instance is invalid.'], ['errorCode' => 'LindormErrorCode.%s', 'errorMessage' => '%s.', 'description' => '%s.'], ], 403 => [ ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => ''], ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"VpcId\\": \\"vpc-bp1n3i15v90el48nx****\\",\\n \\"VswitchId\\": \\"vsw-bp1vbjzmod9q3l9eo****\\",\\n \\"CreateTime\\": \\"2021-07-26 17:10:26\\",\\n \\"PayType\\": \\"POSTPAY\\",\\n \\"NetworkType\\": \\"vpc\\",\\n \\"ServiceType\\": \\"lindorm\\",\\n \\"EnableKms\\": false,\\n \\"EnableStoreTDE\\": false,\\n \\"DiskUsage\\": \\"0.0%\\",\\n \\"DiskCategory\\": \\"cloud_efficiency\\",\\n \\"RequestId\\": \\"633F1BE4-C8DA-5744-8FDF-A3075C3FE37F\\",\\n \\"ColdStorage\\": 0,\\n \\"ArchiveStorage\\": 0,\\n \\"ExpiredMilliseconds\\": 1629993600000,\\n \\"EngineType\\": 15,\\n \\"ExpireTime\\": \\"2021-08-27 00:00:00\\",\\n \\"AutoRenew\\": false,\\n \\"DeletionProtection\\": \\"false\\",\\n \\"InstanceStorage\\": \\"480\\",\\n \\"AliUid\\": 0,\\n \\"InstanceId\\": \\"ld-bp1o3y0yme2i2****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"CreateMilliseconds\\": 1627290664000,\\n \\"InstanceAlias\\": \\"test0726\\",\\n \\"DiskThreshold\\": \\"80%\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"InstanceStatus\\": \\"ACTIVATION\\",\\n \\"EngineList\\": [\\n {\\n \\"Version\\": \\"2.2.3\\",\\n \\"CpuCount\\": \\"4\\",\\n \\"CoreCount\\": \\"2\\",\\n \\"Engine\\": \\"lindorm\\",\\n \\"Specification\\": \\"lindorm.g.2xlarge\\",\\n \\"MemorySize\\": \\"8GB\\",\\n \\"IsLastVersion\\": false,\\n \\"LatestVersion\\": \\"2.2.19.2\\",\\n \\"PrimaryCoreCount\\": \\"2\\",\\n \\"StandbyCoreCount\\": \\"2\\",\\n \\"ArbiterCoreCount\\": \\"2\\"\\n }\\n ],\\n \\"EnableCompute\\": true,\\n \\"EnableSSL\\": false,\\n \\"EnableMLCtrl\\": true,\\n \\"EnableCdc\\": false,\\n \\"EnableStream\\": true,\\n \\"EnableLTS\\": true,\\n \\"EnableShs\\": true,\\n \\"EnableBlob\\": true,\\n \\"MaintainStartTime\\": \\"00:00Z\\",\\n \\"MaintainEndTime\\": \\"20:00Z\\",\\n \\"ResourceGroupId\\": \\"rg-aek2wvd6oia****\\",\\n \\"PrimaryZoneId\\": \\"cn-shanghai-e\\",\\n \\"StandbyZoneId\\": \\"cn-shanghai-f\\",\\n \\"ArbiterZoneId\\": \\"cn-shanghai-g\\",\\n \\"PrimaryVSwitchId\\": \\"vsw-uf6fdqa7c0pipnqzq****\\",\\n \\"StandbyVSwitchId\\": \\"vsw-2zec0kcn08cgdtr6****\\",\\n \\"ArbiterVSwitchId\\": \\"vsw-uf6664pqjawb87k36****\\",\\n \\"MultiZoneCombination\\": \\"cn-shanghai-efg-aliyun\\",\\n \\"CoreDiskCategory\\": \\"cloud_efficiency\\",\\n \\"CoreSpec\\": \\"lindorm.g.xlarge\\",\\n \\"CoreNum\\": 4,\\n \\"CoreSingleStorage\\": 400,\\n \\"LogDiskCategory\\": \\"cloud_ssd\\",\\n \\"LogSpec\\": \\"lindorm.sn1.large\\",\\n \\"LogNum\\": 4,\\n \\"LogSingleStorage\\": 0,\\n \\"BackupInstance\\": \\"ld-xxxx\\",\\n \\"EnableLsqlVersionV3\\": true,\\n \\"EnableLProxy\\": true,\\n \\"ArchVersion\\": \\"1.0\\"\\n}","type":"json"}]', 'title' => 'GetLindormInstance', 'requestParamsDescription' => ' ', 'responseParamsDescription' => 'Description', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-06-04T12:13:27.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2025-05-27T03:40:19.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-05-27T03:40:14.000Z', 'description' => 'OpenAPI offline'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'lindorm:GetLindormInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'GetLindormInstanceEngineList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '64064', 'abilityTreeNodes' => ['FEATUREhitsdbUE1KPV'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. To obtain the instance ID, call the [GetLindormInstanceList](~~426069~~) operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp1nq34mv3smk****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ld-bp1nq34mv3smk****', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B496BA0E-520C-59FC-BA04-196D8F3B07EF', 'title' => ''], 'EngineList' => [ 'description' => 'The list of engine types.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'EngineType' => ['description' => 'The engine type. Valid values:'."\n" ."\n" .'- **lindorm**: LindormTable.'."\n" ."\n" .'- **tsdb**: LindormTSDB.'."\n" ."\n" .'- **solr**: Search engine.'."\n" ."\n" .'- **store**: File engine.', 'type' => 'string', 'example' => 'lindorm', 'title' => ''], 'NetInfoList' => [ 'description' => 'The list of database connection information for the engine.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccessType' => ['description' => 'The connection method for LindormTable. Valid values:'."\n" ."\n" .'- **0**: This is the default value and can be ignored.'."\n" ."\n" .'- **1**: Use the HBase Java API to access LindormTable.'."\n" ."\n" .'- **2**: Use a non-Java HBase API to access LindormTable.'."\n" ."\n" .'- **3**: Use CQL to access LindormTable.'."\n" ."\n" .'- **4**: Use the LindormTable SQL endpoint.'."\n" ."\n" .'- **5**: Use the S3-compatible endpoint for LindormTable.'."\n" ."\n" .'- **6**: Use the MySQL-compatible endpoint for LindormTable.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Port' => ['description' => 'The port number of the database endpoint.', 'type' => 'integer', 'format' => 'int32', 'example' => '30020', 'title' => ''], 'ConnectionString' => ['description' => 'The database endpoint.', 'type' => 'string', 'example' => 'ld-bp1nq34mv3smk****-proxy-lindorm.lindorm.rds.aliyuncs.com', 'title' => ''], 'NetType' => ['description' => 'The network type of the database endpoint. Valid values:'."\n" ."\n" .'- **0**: Internet.'."\n" ."\n" .'- **2**: Virtual private cloud (VPC).', 'type' => 'string', 'example' => '2', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AccessDeniedDetail' => ['description' => 'The detailed reason why the access was denied.', 'type' => 'string', 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Instance.IsDeleted', 'errorMessage' => 'The instance is deleted.', 'description' => 'The specified instance is already deleted.'], ['errorCode' => 'Instance.IsNotValid', 'errorMessage' => 'The instance is invalid.', 'description' => 'The specified instance is invalid.'], ], 403 => [ ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => 'You are not authorized to manage the specified resource.'], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ], ], 'title' => 'GetLindormInstanceEngineList', 'summary' => 'Queries the engine types that a Lindorm instance supports.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'lindorm:GetLindormInstanceEngineList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceId\\": \\"ld-bp1nq34mv3smk****\\",\\n \\"RequestId\\": \\"B496BA0E-520C-59FC-BA04-196D8F3B07EF\\",\\n \\"EngineList\\": [\\n {\\n \\"EngineType\\": \\"lindorm\\",\\n \\"NetInfoList\\": [\\n {\\n \\"AccessType\\": 1,\\n \\"Port\\": 30020,\\n \\"ConnectionString\\": \\"ld-bp1nq34mv3smk****-proxy-lindorm.lindorm.rds.aliyuncs.com\\",\\n \\"NetType\\": \\"2\\"\\n }\\n ]\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\\\"AuthAction\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"AuthPrincipalDisplayName\\\\\\":\\\\\\"222\\\\\\",\\\\\\"AuthPrincipalOwnerId\\\\\\":\\\\\\"111\\\\\\",\\\\\\"AuthPrincipalType\\\\\\":\\\\\\"SubUser\\\\\\",,\\\\\\"NoPermissionType\\\\\\":\\\\\\"ImplicitDeny\\\\\\",\\\\\\"PolicyType\\\\\\":\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\\\"EncodedDiagnosticMessage\\\\\\":\\\\\\"xxxxxx\\\\\\"}\\"\\n}","type":"json"}]', ], 'GetLindormInstanceList' => [ 'summary' => 'Queries a list of Lindorm instances.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '76395', 'abilityTreeNodes' => ['FEATUREhitsdbUE1KPV'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the instance is located. Call [DescribeRegions](~~426062~~) to obtain the region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'QueryStr', 'in' => 'query', 'schema' => ['description' => 'A keyword for a fuzzy search on instance names.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page for a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '20', 'default' => '100', 'title' => ''], ], [ 'name' => 'ServiceType', 'in' => 'query', 'schema' => ['description' => 'The type of the instance. Valid values:'."\n" ."\n" .'- **lindorm**: a single-zone Lindorm instance.'."\n" ."\n" .'- **lindorm\\_multizone**: a multi-zone Lindorm instance.'."\n" ."\n" .'- **serverless\\_lindorm**: a Lindorm Serverless instance.'."\n" ."\n" .'- **lindorm\\_standalone**: a Lindorm standalone instance.'."\n" ."\n" .'- **lts**: the Lindorm Tunnel Service (LTS) type.', 'type' => 'string', 'required' => false, 'example' => 'lindorm', 'title' => ''], ], [ 'name' => 'SupportEngine', 'in' => 'query', 'schema' => ['description' => 'The type of the engine supported by the instance that you want to query. Valid values:'."\n" ."\n" .'- **1**: search engine.'."\n" ."\n" .'- **2**: LindormTSDB.'."\n" ."\n" .'- **4**: LindormTable.'."\n" ."\n" .'- **8**: file engine.'."\n" ."\n" .'> For example, a value of 15 (8 + 4 + 2 + 1) indicates that the instance supports the file engine, LindormTable, LindormTSDB, and the search engine. A value of 6 (4 + 2) indicates that the instance supports LindormTSDB and LindormTable.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '7', 'minimum' => '-1', 'default' => '-1', 'example' => '15', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'A list of tags. You can specify up to 20 tags.', 'type' => 'array', 'items' => [ 'description' => 'A list of tags.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag.'."\n" ."\n" .'> You can pass in keys for multiple tags. For example, the Key in the first pair represents the key for the first tag. The Key in the second pair represents the key for the second tag.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], 'Value' => ['description' => 'The value of the tag.'."\n" ."\n" .'> You can provide values for multiple tags. For example, the Value in the first pair is the value for the first tag. The Value in the second pair is the value for the second tag.', 'type' => 'string', 'required' => false, 'example' => '2.2.18', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 21, 'minItems' => 0, 'title' => '', 'example' => '', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek3b63arvg27vi', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CA1FAFD-E8DC-51C2-AA7E-CA6E2D049BA0', 'title' => ''], 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned on the page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'Total' => ['description' => 'The total number of instances found.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'InstanceList' => [ 'description' => 'The list of instances.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VpcId' => ['description' => 'The ID of the virtual private cloud (VPC) in which the instance is deployed.', 'type' => 'string', 'example' => 'vpc-bp1n3i15v90el48nx****', 'title' => ''], 'EngineType' => ['description' => 'The types of engines supported by the instance. The value of this parameter is the sum of the values of the supported engines.'."\n" ."\n" .'- **1**: search engine.'."\n" ."\n" .'- **2**: LindormTSDB.'."\n" ."\n" .'- **4**: LindormTable.'."\n" ."\n" .'- **8**: file engine.'."\n" ."\n" .'> For example, a value of 15 (8 + 4 + 2 + 1) indicates that the instance supports the file engine, LindormTable, LindormTSDB, and the search engine. A value of 6 (4 + 2) indicates that the instance supports LindormTSDB and LindormTable.', 'type' => 'string', 'example' => '15', 'title' => ''], 'ExpireTime' => ['description' => 'The expiration time of the instance.'."\n" ."\n" .'> This parameter is returned only for subscription instances.', 'type' => 'string', 'example' => '2022-04-26 00:00:00', 'title' => ''], 'CreateTime' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2021-09-16 14:13:13', 'title' => ''], 'PayType' => ['description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'- **PREPAY**: subscription.'."\n" ."\n" .'- **POSTPAY**: pay-as-you-go.', 'type' => 'string', 'example' => 'PREPAY', 'title' => ''], 'AliUid' => ['description' => 'The 16-digit ID of the Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'example' => '164901546557****', 'title' => ''], 'InstanceStorage' => ['description' => 'The storage capacity of the instance.', 'type' => 'string', 'example' => '960', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'ld-bp17pwu1541ia****', 'title' => ''], 'NetworkType' => ['description' => 'The network type of the instance.', 'type' => 'string', 'example' => 'vpc', 'title' => ''], 'ServiceType' => ['description' => 'The type of the instance. Valid values:'."\n" ."\n" .'- **lindorm**: a Lindorm instance.'."\n" ."\n" .'- **serverless\\_lindorm**: a Lindorm Serverless instance.'."\n" ."\n" .'- **lindorm\\_standalone**: a Lindorm standalone instance.'."\n" ."\n" .'- **lts**: the Lindorm Tunnel Service type.', 'type' => 'string', 'example' => 'lindorm', 'title' => ''], 'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'CreateMilliseconds' => ['description' => 'The timestamp of when the instance was created. The value is the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1631772842000', 'title' => ''], 'InstanceAlias' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ZoneId' => ['description' => 'The ID of the zone.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], 'InstanceStatus' => ['description' => 'The status of the instance. Valid values:'."\n" ."\n" .'- **CREATING**: The instance is being created.'."\n" ."\n" .'- **ACTIVATION**: The instance is running.'."\n" ."\n" .'- **COLD\\_EXPANDING**: The capacity of the storage-optimized instance is being expanded.'."\n" ."\n" .'- **MINOR\\_VERSION\\_TRANSING**: The minor version of the instance is being upgraded.'."\n" ."\n" .'- **RESIZING**: The instance is scaling up.'."\n" ."\n" .'- **SHRINKING**: The instance is scaling down.'."\n" ."\n" .'- **CLASS\\_CHANGING**: The instance class is being changed.'."\n" ."\n" .'- **SSL\\_SWITCHING**: The SSL certificate is being changed.'."\n" ."\n" .'- **CDC\\_OPENING**: The data subscription feature is being enabled.'."\n" ."\n" .'- **TRANSFER**: Data migration is in progress.'."\n" ."\n" .'- **DATABASE\\_TRANSFER**: Data is being migrated to the database.'."\n" ."\n" .'- **GUARD\\_CREATING**: A disaster recovery instance is being created.'."\n" ."\n" .'- **BACKUP\\_RECOVERING**: A backup is being restored.'."\n" ."\n" .'- **DATABASE\\_IMPORTING**: Data is being imported.'."\n" ."\n" .'- **NET\\_MODIFYING**: The network settings are being modified.'."\n" ."\n" .'- **NET\\_SWITCHING**: The network type is being switched.'."\n" ."\n" .'- **NET\\_CREATING**: A network connection is being created.'."\n" ."\n" .'- **NET\\_DELETING**: A network connection is being deleted.'."\n" ."\n" .'- **DELETING**: The instance is being deleted.'."\n" ."\n" .'- **RESTARTING**: The instance is being restarted.'."\n" ."\n" .'- **LOCKED**: The instance has expired and is locked.', 'type' => 'string', 'example' => 'ACTIVATION', 'title' => ''], 'ExpiredMilliseconds' => ['description' => 'The timestamp of when the instance expires. The value is the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1650902400000', 'title' => ''], 'EnableStream' => ['description' => 'Indicates whether the stream engine is enabled for the instance. Valid values:'."\n" ."\n" .'- **true**: The stream engine is enabled.'."\n" ."\n" .'- **false**: The stream engine is not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Tags' => [ 'description' => 'The list of tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => '2.2.18', 'title' => ''], ], 'description' => 'Tag', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'EnableCompute' => ['description' => 'Indicates whether the compute engine is enabled for the instance. Valid values:'."\n" ."\n" .'- **true**: Enabled.'."\n" ."\n" .'- **false**: Not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-aekzledqeat****', 'title' => ''], 'EnableMessage' => ['description' => 'Indicates whether the messaging engine is enabled. Valid values:'."\n" ."\n" .'- **true**: Enabled.'."\n" ."\n" .'- **false**: Not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'EnableVector' => ['description' => 'Indicates whether the vector engine is enabled. Valid values:'."\n" ."\n" .'- **true**: Enabled.'."\n" ."\n" .'- **false**: Not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'EnableLts' => ['description' => 'Indicates whether the LTS engine is enabled. Valid values:'."\n" ."\n" .'- **true**: Enabled.'."\n" ."\n" .'- **false**: Not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'EnableColumn' => ['description' => 'Indicates whether the column store engine is enabled. Valid values:'."\n" ."\n" .'- **true**: Enabled.'."\n" ."\n" .'- **false**: Not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'EnableRow' => ['description' => 'Indicates whether the LindormTable 3.0 engine is enabled. Valid values:'."\n" ."\n" .'true: Enabled.'."\n" .'false: Not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'CreateErrorCode' => ['description' => 'The reason why the instance failed to be created.', 'type' => 'string', 'example' => 'Resource is not enough', 'title' => ''], ], 'description' => 'Instance', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => 'Response', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Instance.IsDeleted', 'errorMessage' => 'The instance is deleted.', 'description' => 'The specified instance is already deleted.'], ['errorCode' => 'Instance.IsNotAvailable', 'errorMessage' => 'The instance is unavailable.', 'description' => 'The specified instance is unavailable.'], ], 403 => [ ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => ''], ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CA1FAFD-E8DC-51C2-AA7E-CA6E2D049BA0\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 1,\\n \\"InstanceList\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1n3i15v90el48nx****\\",\\n \\"EngineType\\": \\"15\\",\\n \\"ExpireTime\\": \\"2022-04-26 00:00:00\\",\\n \\"CreateTime\\": \\"2021-09-16 14:13:13\\",\\n \\"PayType\\": \\"PREPAY\\",\\n \\"AliUid\\": 0,\\n \\"InstanceStorage\\": \\"960\\",\\n \\"InstanceId\\": \\"ld-bp17pwu1541ia****\\",\\n \\"NetworkType\\": \\"vpc\\",\\n \\"ServiceType\\": \\"lindorm\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"CreateMilliseconds\\": 1631772842000,\\n \\"InstanceAlias\\": \\"test\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"InstanceStatus\\": \\"ACTIVATION\\",\\n \\"ExpiredMilliseconds\\": 1650902400000,\\n \\"EnableStream\\": true,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"test\\",\\n \\"Value\\": \\"2.2.18\\"\\n }\\n ],\\n \\"EnableCompute\\": true,\\n \\"ResourceGroupId\\": \\"rg-aekzledqeat****\\",\\n \\"EnableMessage\\": true,\\n \\"EnableVector\\": true,\\n \\"EnableLts\\": true,\\n \\"EnableColumn\\": true,\\n \\"EnableRow\\": true,\\n \\"CreateErrorCode\\": \\"Resource is not enough\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'GetLindormInstanceList', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'lindorm:GetLindormInstanceList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'Instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'GetLindormV2InstanceDetails' => [ 'summary' => 'Queries the details of an instance that uses the new architecture.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '188570', 'abilityTreeNodes' => ['FEATUREhitsdbUE1KPV'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp1mq0tdzbx1m****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'VpcId' => ['description' => 'The ID of the virtual private cloud (VPC) where the instance resides.', 'type' => 'string', 'example' => 'vpc-bp1xxxxxxxxxxxxxxxxxx', 'title' => ''], 'VswitchId' => ['description' => 'The ID of the virtual switch.', 'type' => 'string', 'example' => 'vsw-bp1xxxxxxxxxxxxxxxxxx', 'title' => ''], 'PayType' => ['description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'- **PREPAY**: subscription.'."\n" ."\n" .'- **POSTPAY**: pay-as-you-go.', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''], 'NetworkType' => ['description' => 'The network type of the instance.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], 'DiskUsage' => ['description' => 'The disk space usage.', 'type' => 'string', 'example' => '0.0%', 'title' => ''], 'DiskCategory' => ['description' => 'The storage class. Valid values:'."\n" ."\n" .'- **StandardStorage**: Standard cloud storage.'."\n" ."\n" .'- **PerformanceStorage**: Performance cloud storage.', 'type' => 'string', 'example' => 'PerformanceStorage', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1556DCB0-043A-4444-8BD9-CF4A68E7EE64', 'title' => ''], 'ColdStorage' => ['description' => 'The capacity of the storage-optimized cloud storage.', 'type' => 'integer', 'format' => 'int32', 'example' => '800', 'title' => ''], 'ExpiredMilliseconds' => ['description' => 'The number of milliseconds between the instance expiration time and 00:00:00 on January 1, 1970.', 'type' => 'integer', 'format' => 'int64', 'example' => '1629993600000', 'title' => ''], 'AutoRenew' => ['description' => 'Indicates whether auto-renewal is enabled. Valid values:'."\n" ."\n" .'- **true**: enabled.'."\n" ."\n" .'- **false**: disabled.'."\n" ."\n" .'> This parameter is returned only for subscription instances.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'DeletionProtection' => ['description' => 'Indicates whether deletion protection is enabled. Valid values:'."\n" ."\n" .'- **true**: enabled.'."\n" ."\n" .'- **false**: disabled.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'AliUid' => ['description' => 'The 16-digit AliUid of the Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'example' => '164901546557****', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'ld-bp1mq0tdzbx1m****', 'title' => ''], 'InstanceType' => ['description' => 'The instance type. Valid value:'."\n" ."\n" .'- basic: Production.', 'type' => 'string', 'example' => 'basic', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'CreateMilliseconds' => ['description' => 'The number of milliseconds between the instance creation time and 00:00:00 on January 1, 1970.', 'type' => 'integer', 'format' => 'int64', 'example' => '1627290664000', 'title' => ''], 'InstanceAlias' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'lindorm-test', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], 'InstanceStatus' => ['description' => 'The instance status. Valid values:'."\n" ."\n" .'- **CREATING**: The instance is being created.'."\n" ."\n" .'- **ACTIVATION**: The instance is running.'."\n" ."\n" .'- **COLD\\_EXPANDING**: The storage-optimized cloud storage is being scaled out.'."\n" ."\n" .'- **MINOR\\_VERSION\\_TRANSING**: The minor version is being upgraded.'."\n" ."\n" .'- **RESIZING**: The nodes are being scaled out.'."\n" ."\n" .'- **SHRINKING**: The nodes are being scaled in.'."\n" ."\n" .'- **CLASS\\_CHANGING**: The instance specifications are being upgraded or downgraded.'."\n" ."\n" .'- **SSL\\_SWITCHING**: The SSL certificate is being changed.'."\n" ."\n" .'- **CDC\\_OPENING**: The data subscription feature is being enabled.'."\n" ."\n" .'- **TRANSFER**: Data is being migrated.'."\n" ."\n" .'- **DATABASE\\_TRANSFER**: Data is being migrated to the database.'."\n" ."\n" .'- **GUARD\\_CREATING**: A disaster recovery instance is being created.'."\n" ."\n" .'- **BACKUP\\_RECOVERING**: Data is being restored from a backup.'."\n" ."\n" .'- **DATABASE\\_IMPORTING**: Data is being imported.'."\n" ."\n" .'- **NET\\_MODIFYING**: The network is being modified.'."\n" ."\n" .'- **NET\\_SWITCHING**: The network is being switched between the private network and the public network.'."\n" ."\n" .'- **NET\\_CREATING**: A network connection is being created.'."\n" ."\n" .'- **NET\\_DELETING**: A network connection is being deleted.'."\n" ."\n" .'- **DELETING**: The instance is being deleted.'."\n" ."\n" .'- **RESTARTING**: The instance is being restarted.'."\n" ."\n" .'- **LOCKED**: The instance has expired and is locked.', 'type' => 'string', 'example' => 'ACTIVATION', 'title' => ''], 'PrimaryZoneId' => ['description' => 'For a multi-zone instance, this is the ID of the primary zone.', 'type' => 'string', 'example' => 'cn-shanghai-e', 'title' => ''], 'PrimaryVSwitchId' => ['description' => 'For a multi-zone instance, this is the ID of the virtual switch in the primary zone. The vSwitch must be in the zone specified by PrimaryZoneId.', 'type' => 'string', 'example' => 'vsw-uf6fdqa7c0pipnqzq****', 'title' => ''], 'StandbyZoneId' => ['description' => 'For a multi-zone instance, this is the ID of the secondary zone.', 'type' => 'string', 'example' => 'cn-shanghai-f', 'title' => ''], 'StandbyVSwitchId' => ['description' => 'For a multi-zone instance, this is the ID of the virtual switch in the secondary zone. The vSwitch must be in the zone specified by StandbyZoneId.', 'type' => 'string', 'example' => 'vsw-2zec0kcn08cgdtr6****', 'title' => ''], 'ArbiterZoneId' => ['description' => 'For a multi-zone instance, this is the ID of the arbiter zone.', 'type' => 'string', 'example' => 'cn-shanghai-g', 'title' => ''], 'ArbiterVSwitchId' => ['description' => 'For a multi-zone instance, this is the ID of the virtual switch in the arbiter zone. The vSwitch must be in the zone specified by ArbiterZoneId.', 'type' => 'string', 'example' => 'vsw-uf6664pqjawb87k36****', 'title' => ''], 'EngineList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Version' => ['description' => 'The version number of the engine type.', 'type' => 'string', 'example' => '2.2.3', 'title' => ''], 'Engine' => ['description' => 'The engine type. Valid values:'."\n" ."\n" .'- **TABLE**: LindormTable.'."\n" ."\n" .'- **TSDB**: LindormTSDB.'."\n" ."\n" .'- **LSEARCH**: Search engine.'."\n" ."\n" .'- **LTS**: LTS engine.'."\n" ."\n" .'- **LVECTOR**: Vector engine.'."\n" ."\n" .'- **LCOLUMN**: Column store.', 'type' => 'string', 'example' => 'TABLE', 'title' => ''], 'IsLastVersion' => ['description' => 'Indicates whether the engine is the latest version. Valid values:'."\n" ."\n" .'- **true**: The engine is the latest version.'."\n" ."\n" .'- **false**: The engine is not the latest version.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'LatestVersion' => ['description' => 'The latest version number for the engine type.', 'type' => 'string', 'example' => '2.2.19.2', 'title' => ''], 'ConnectAddressList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Address' => ['description' => 'The endpoint.', 'type' => 'string', 'example' => 'ld-mxj9asg***-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060', 'title' => ''], 'Type' => ['description' => 'The endpoint type.'."\n" ."\n" .'- INTRANET: VPC private endpoint.'."\n" ."\n" .'- INTERNET: Public endpoint.', 'type' => 'string', 'example' => 'INTRANET', 'title' => ''], 'Port' => ['description' => 'The port number of the database endpoint.', 'type' => 'string', 'example' => '33060', 'title' => ''], ], 'description' => 'A list of engine endpoints.', 'title' => '', 'example' => '', ], 'description' => 'A list of engine endpoints.', 'title' => '', 'example' => '', ], 'NodeGroup' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'NodeSpec' => ['description' => 'The node specifications.'."\n" ."\n" .'If you select Performance cloud storage or Standard cloud storage, this parameter can be set to one of the following values:'."\n" ."\n" .'- lindorm.c.2xlarge: 8 vCPUs, 16 GB memory.'."\n" ."\n" .'- lindorm.g.2xlarge: 8 vCPUs, 32 GB memory.'."\n" ."\n" .'- lindorm.c.4xlarge: 16 vCPUs, 32 GB memory.'."\n" ."\n" .'- lindorm.g.4xlarge: 16 vCPUs, 64 GB memory.'."\n" ."\n" .'- lindorm.c.8xlarge: 32 vCPUs, 64 GB memory.'."\n" ."\n" .'- lindorm.g.8xlarge: 32 vCPUs, 128 GB memory.'."\n" ."\n" .'- lindorm.r.2xlarge: 8 vCPUs, 64 GB memory.'."\n" ."\n" .'- lindorm.r.4xlarge: 16 vCPUs, 128 GB memory.'."\n" ."\n" .'- lindorm.r.8xlarge: 32 vCPUs, 256 GB memory.'."\n" ."\n" .'If you select Local SSD, this parameter can be set to one of the following values:'."\n" ."\n" .'- lindorm.i4.xlarge: 4 vCPUs, 32 GB memory (I4).'."\n" ."\n" .'- lindorm.i4.2xlarge: 8 vCPUs, 64 GB memory (I4).'."\n" ."\n" .'- lindorm.i4.4xlarge: 16 vCPUs, 128 GB memory (I4).'."\n" ."\n" .'- lindorm.i4.8xlarge: 32 vCPUs, 256 GB memory (I4).'."\n" ."\n" .'- lindorm.i3.xlarge: 4 vCPUs, 32 GB memory (I3).'."\n" ."\n" .'- lindorm.i3.2xlarge: 8 vCPUs, 64 GB memory (I3).'."\n" ."\n" .'- lindorm.i3.4xlarge: 16 vCPUs, 128 GB memory (I3).'."\n" ."\n" .'- lindorm.i3.8xlarge: 32 vCPUs, 256 GB memory (I3).'."\n" ."\n" .'- lindorm.i2.xlarge: 4 vCPUs, 32 GB memory (I2).'."\n" ."\n" .'- lindorm.i2.2xlarge: 8 vCPUs, 64 GB memory (I2).'."\n" ."\n" .'- lindorm.i2.4xlarge: 16 vCPUs, 128 GB memory (I2).'."\n" ."\n" .'- lindorm.i2.8xlarge: 32 vCPUs, 256 GB memory (I2).'."\n" ."\n" .'If you select Big Data, this parameter can be set to one of the following values:'."\n" ."\n" .'- lindorm.sd3c.3xlarge: 14 vCPUs, 56 GB memory (D3C PRO).'."\n" ."\n" .'- lindorm.sd3c.7xlarge: 28 vCPUs, 112 GB memory (D3C PRO).'."\n" ."\n" .'- lindorm.sd3c.14xlarge: 56 vCPUs, 224 GB memory (D3C PRO).'."\n" ."\n" .'- lindorm.d2c.6xlarge: 24 vCPUs, 88 GB memory (D2C).'."\n" ."\n" .'- lindorm.d2c.12xlarge: 48 vCPUs, 176 GB memory (D2C).'."\n" ."\n" .'- lindorm.d2c.24xlarge: 96 vCPUs, 352 GB memory (D2C).'."\n" ."\n" .'- lindorm.d2s.5xlarge: 20 vCPUs, 88 GB memory (D2S).'."\n" ."\n" .'- lindorm.d2s.10xlarge: 40 vCPUs, 176 GB memory (D2S).'."\n" ."\n" .'- lindorm.d1.2xlarge: 8 vCPUs, 32 GB memory (D1NE).'."\n" ."\n" .'- lindorm.d1.4xlarge: 16 vCPUs, 64 GB memory (D1NE).'."\n" ."\n" .'- lindorm.d1.6xlarge: 24 vCPUs, 96 GB memory (D1NE).', 'type' => 'string', 'example' => 'lindorm.g.2xlarge', 'title' => ''], 'EnableAttachLocalDisk' => ['description' => 'Indicates whether a local disk is attached to the node.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'LocalDiskCategory' => ['description' => 'The type of the local cloud disk.'."\n" ."\n" .'- cloud\\_essd: performance cloud disk'."\n" ."\n" .'- cloud\\_efficiency: standard cloud disk', 'type' => 'string', 'example' => 'cloud_essd', 'title' => ''], 'LocalDiskCapacity' => ['description' => 'The capacity of the local disk in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CpuCoreCount' => ['description' => 'The number of vCPUs for the node.', 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => ''], 'MemorySizeGiB' => ['description' => 'The memory size of the node in GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '64', 'title' => ''], 'Quantity' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Category' => ['description' => 'Deprecated.', 'type' => 'string', 'example' => 'caculated', 'title' => ''], 'ResourceGroupName' => ['description' => 'The name of the node group. **Required**. This must be the same as the name used during creation.', 'type' => 'string', 'example' => 'job_debug', 'title' => ''], 'SpecId' => ['description' => 'The unique ID that corresponds to the delivery group ID.', 'type' => 'string', 'example' => 'ecs.c6.large', 'title' => ''], 'Status' => ['description' => 'The node status.', 'type' => 'string', 'example' => 'ACTIVATION', 'title' => ''], ], 'description' => 'A list of engine node groups.', 'title' => '', 'example' => '', ], 'description' => 'A list of engine node groups.', 'title' => '', 'example' => '', ], ], 'description' => 'The list of engine information.', 'title' => '', 'example' => '', ], 'description' => 'The list of engine information.', 'title' => '', 'example' => '', ], 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-aek2i6weeb4nfii', 'title' => ''], 'ServiceType' => ['description' => 'The instance type. Valid values:'."\n" ."\n" .'- **lindorm\\_v2**: Lindorm V2 single-zone instance.'."\n" ."\n" .'- **lindorm\\_v2\\_multizone**: Lindorm V2 Multi-zone Deployment (Basic) instance.'."\n" ."\n" .'- **lindorm\\_v2\\_multizone\\_ha**: Lindorm V2 multi-zone High-availability Edition instance.', 'type' => 'string', 'example' => 'lindorm_v2', 'title' => ''], 'WhiteIpList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GroupName' => ['description' => 'The group name. The name can contain only letters, digits, and underscores (\\_).', 'type' => 'string', 'example' => 'swhy', 'title' => ''], 'IpList' => ['description' => 'The IP addresses in the whitelist.', 'type' => 'string', 'example' => '[\'10.2.0.0/18\', \'10.0.0.0/24\', \'119.23.188.139/32\']', 'title' => ''], ], 'description' => 'The instance access whitelist.', 'title' => '', 'example' => '', ], 'description' => 'The instance access whitelist.', 'title' => '', 'example' => '', ], 'StorageUsage' => [ 'type' => 'object', 'properties' => [ 'CapacityByDiskCategory' => [ 'type' => 'array', 'items' => ['description' => 'The instance storage usage.', 'type' => 'object', 'example' => 'Capacity', 'title' => ''], 'description' => 'The instance storage usage.', 'title' => '', 'example' => '', ], 'EngineUsage' => ['description' => 'The storage usage of each engine.', 'type' => 'object', 'example' => '16', 'title' => ''], ], 'description' => 'The instance storage usage.', 'title' => '', 'example' => '', ], 'ZoneEngineInfoMap' => ['description' => 'The deployment details of the engine in the zone.', 'type' => 'object', 'example' => 'ZoneEngineInfoMap', 'title' => ''], 'InitialRootPassword' => ['description' => 'The default initial password.', 'type' => 'string', 'example' => '*****', 'title' => ''], 'DiskThreshold' => ['description' => 'The disk space threshold.', 'type' => 'string', 'example' => '80%', 'title' => ''], 'EnableCompute' => ['description' => 'Indicates whether the compute engine is enabled for the instance. Valid values:'."\n" ."\n" .'- **true**: enabled.'."\n" ."\n" .'- **false**: disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'MaintainStartTime' => ['description' => 'The start time of the maintenance window.', 'type' => 'string', 'example' => '00:00Z', 'title' => ''], 'MaintainEndTime' => ['description' => 'The end time of the maintenance window.', 'type' => 'string', 'example' => '20:00Z', 'title' => ''], 'CloudStorageSize' => ['description' => 'The cloud storage capacity in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '480', 'title' => ''], 'EnableFs' => ['description' => 'Indicates whether the file engine is enabled.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'EnableStoreTDE' => ['description' => 'Indicates whether transparent data encryption (TDE) is enabled for storage.', 'type' => 'string', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Lindorm.Errorcode.ParameterInvaild', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ['errorCode' => 'Instance.IsDeleted', 'errorMessage' => 'The instance is deleted.', 'description' => ''], ['errorCode' => 'Instance.IsNotValid', 'errorMessage' => 'The instance is invalid.', 'description' => 'The specified instance is invalid.'], ['errorCode' => 'LindormErrorCode.%s', 'errorMessage' => '%s.', 'description' => '%s.'], ], 403 => [ ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => ''], ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetLindormV2InstanceDetails', 'description' => 'For Lindorm clusters with an underlying storage version of 4.1.9 or later, refer to the values in the list returned by LStorageUsageList for storage usage details.', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'lindorm:GetLindormV2InstanceDetails', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"VpcId\\": \\"vpc-bp1xxxxxxxxxxxxxxxxxx\\",\\n \\"VswitchId\\": \\"vsw-bp1xxxxxxxxxxxxxxxxxx\\",\\n \\"PayType\\": \\"POSTPAY\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"DiskUsage\\": \\"0.0%\\",\\n \\"DiskCategory\\": \\"PerformanceStorage\\",\\n \\"RequestId\\": \\"1556DCB0-043A-4444-8BD9-CF4A68E7EE64\\",\\n \\"ColdStorage\\": 800,\\n \\"ExpiredMilliseconds\\": 1629993600000,\\n \\"AutoRenew\\": true,\\n \\"DeletionProtection\\": \\"false\\",\\n \\"AliUid\\": 0,\\n \\"InstanceId\\": \\"ld-bp1mq0tdzbx1m****\\",\\n \\"InstanceType\\": \\"basic\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"CreateMilliseconds\\": 1627290664000,\\n \\"InstanceAlias\\": \\"lindorm-test\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"InstanceStatus\\": \\"ACTIVATION\\",\\n \\"PrimaryZoneId\\": \\"cn-shanghai-e\\",\\n \\"PrimaryVSwitchId\\": \\"vsw-uf6fdqa7c0pipnqzq****\\",\\n \\"StandbyZoneId\\": \\"cn-shanghai-f\\",\\n \\"StandbyVSwitchId\\": \\"vsw-2zec0kcn08cgdtr6****\\",\\n \\"ArbiterZoneId\\": \\"cn-shanghai-g\\",\\n \\"ArbiterVSwitchId\\": \\"vsw-uf6664pqjawb87k36****\\",\\n \\"EngineList\\": [\\n {\\n \\"Version\\": \\"2.2.3\\",\\n \\"Engine\\": \\"TABLE\\",\\n \\"IsLastVersion\\": false,\\n \\"LatestVersion\\": \\"2.2.19.2\\",\\n \\"ConnectAddressList\\": [\\n {\\n \\"Address\\": \\"ld-mxj9asg***-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060\\",\\n \\"Type\\": \\"INTRANET\\",\\n \\"Port\\": \\"33060\\"\\n }\\n ],\\n \\"NodeGroup\\": [\\n {\\n \\"NodeSpec\\": \\"lindorm.g.2xlarge\\",\\n \\"EnableAttachLocalDisk\\": false,\\n \\"LocalDiskCategory\\": \\"cloud_essd\\",\\n \\"LocalDiskCapacity\\": 100,\\n \\"CpuCoreCount\\": 32,\\n \\"MemorySizeGiB\\": 64,\\n \\"Quantity\\": 10,\\n \\"Category\\": \\"caculated\\",\\n \\"ResourceGroupName\\": \\"job_debug\\",\\n \\"SpecId\\": \\"ecs.c6.large\\",\\n \\"Status\\": \\"ACTIVATION\\"\\n }\\n ]\\n }\\n ],\\n \\"ResourceGroupId\\": \\"rg-aek2i6weeb4nfii\\",\\n \\"ServiceType\\": \\"lindorm_v2\\",\\n \\"WhiteIpList\\": [\\n {\\n \\"GroupName\\": \\"swhy\\",\\n \\"IpList\\": \\"[\'10.2.0.0/18\', \'10.0.0.0/24\', \'119.23.188.139/32\']\\"\\n }\\n ],\\n \\"StorageUsage\\": {\\n \\"CapacityByDiskCategory\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"EngineUsage\\": 16\\n },\\n \\"ZoneEngineInfoMap\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"InitialRootPassword\\": \\"*****\\",\\n \\"DiskThreshold\\": \\"80%\\",\\n \\"EnableCompute\\": true,\\n \\"MaintainStartTime\\": \\"00:00Z\\",\\n \\"MaintainEndTime\\": \\"20:00Z\\",\\n \\"CloudStorageSize\\": 480,\\n \\"EnableFs\\": \\"false\\",\\n \\"EnableStoreTDE\\": \\"false\\"\\n}","type":"json"}]', ], 'GetLindormV2StorageUsage' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '194193', 'abilityTreeNodes' => ['FEATUREhitsdbDXDFAS'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-ufxxxxxxxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CapacityByDiskCategory' => [ 'type' => 'array', 'items' => [ 'description' => '- **mode**: The storage mode. Valid values:'."\n" ."\n" .' - **LOCAL\\_DISK**: Local disk'."\n" ."\n" .' - **CLOUD\\_DISK**: Cloud disk'."\n" ."\n" .' - **REMOTE\\_STORAGE**: Storage-optimized or archive cloud storage'."\n" ."\n" .' - **CLOUD\\_STORAGE**: Performance-optimized or standard cloud storage'."\n" ."\n" .'- **category**: The storage class. Valid values:'."\n" ."\n" .' - **LOCAL\\_HDD**: Local HDD'."\n" ."\n" .' - **LOCAL\\_SSD**: Local SSD'."\n" ."\n" .' - **CLOUD\\_ESSD**: ESSD'."\n" ."\n" .' - **CLOUD\\_ESSD\\_PL1**: ESSD PL1'."\n" ."\n" .' - **CLOUD\\_EFFICIENCY**: Ultra disk'."\n" ."\n" .' - **STD\\_CLOUD\\_ESSD\\_PL0**: Standard cloud storage (ESSD PL0)'."\n" ."\n" .' - **PERF\\_CLOUD\\_ESSD\\_PL1**: Performance-optimized cloud storage (ESSD PL1)'."\n" ."\n" .' - **REMOTE\\_CAP\\_OSS**: Remote storage-optimized OSS'."\n" ."\n" .' - **REMOTE\\_ARCHIVE\\_OSS**: Remote archive OSS'."\n" ."\n" .' - **BACKUP\\_OSS**: Backup capacity'."\n" ."\n" .'- **perfLevel**: The performance level of the cloud disk. Valid values:'."\n" ."\n" .' - **PL0**'."\n" ."\n" .' - **PL1**'."\n" ."\n" .' - **PL2**'."\n" ."\n" .' - **PL3**'."\n" ."\n" .' - **AUTO**'."\n" ."\n" .'- **capacity**: The total capacity in GiB.'."\n" ."\n" .'- **usedCapacity**: The used capacity in GiB.', 'enumValueTitles' => [], 'type' => 'object', 'example' => ' {'."\n" .' "mode": "CLOUD_STORAGE",'."\n" .' "perfLevel": "PL1",'."\n" .' "usedCapacity": 0,'."\n" .' "category": "PERF_CLOUD_ESSD_PL1",'."\n" .' "capacity": 4000'."\n" .' }', 'title' => '', ], 'description' => 'The capacity information for each storage medium.', 'title' => '', 'example' => '', ], 'UsageByDiskCategory' => [ 'type' => 'array', 'items' => ['description' => '- **capacity**: The total capacity in bytes.'."\n" ."\n" .'- **used**: The used capacity in bytes.'."\n" ."\n" .'- **diskType**: The storage class. Valid values:'."\n" ."\n" .' - **STANDARD\\_CLOUD\\_STORAGE**: Remote standard cloud storage'."\n" ."\n" .' - **PERFORMANCE\\_CLOUD\\_STORAGE**: Remote performance-optimized cloud storage'."\n" ."\n" .' - **CAPACITY\\_CLOUD\\_STORAGE**: Remote storage-optimized cloud storage'."\n" ."\n" .' - **LOCAL\\_SSD\\_STORAGE**: Local SSD'."\n" ."\n" .' - **LOCAL\\_HDD\\_STORAGE**: Local HDD'."\n" ."\n" .' - **LOCAL\\_EBS\\_STORAGE**: Local data disk'."\n" ."\n" .' - **FOREIGN\\_BUFFER\\_STORAGE**: Local cache disk for storage-optimized cloud storage'."\n" ."\n" .' - **LOCAL\\_EBS\\_STORAGE\\_EFFECTIVE**: Local ultra data disk'."\n" ."\n" .' - **LOCAL\\_EBS\\_STORAGE\\_PL0**: Local PL0 data disk'."\n" ."\n" .' - **LOCAL\\_EBS\\_STORAGE\\_PL1**: Local PL1 data disk'."\n" ."\n" .' - **LOCAL\\_EBS\\_STORAGE\\_PL2**: Local PL2 data disk'."\n" ."\n" .' - **LOCAL\\_EBS\\_STORAGE\\_PL3**: Local PL3 data disk'."\n" ."\n" .'- **usedLindormTable**: The capacity used by LindormTable.'."\n" ."\n" .'- **usedLindormTsdb**: The capacity used by LindormTSDB.'."\n" ."\n" .'- **usedLindormSteam**: The capacity used by the stream engine.'."\n" ."\n" .'- **usedLindormSearch**: The capacity used by the search engine.'."\n" ."\n" .'- **usedLindormSearch3**: The capacity used by the search engine.'."\n" ."\n" .'- **usedLindormVector3**: The capacity used by the vector engine.'."\n" ."\n" .'- **usedLindormColumn3**: The capacity used by the column store engine.'."\n" ."\n" .'- **usedLindormMessage3**: The capacity used by the message engine.'."\n" ."\n" .'- **usedLindormSpark**: The capacity used by the compute engine.'."\n" ."\n" .'- **usedOther**: The capacity used by other services.', 'type' => 'object', 'example' => ' {'."\n" .' "usedLindormColumn3": 688935,'."\n" .' "usedLindormTable": 1086288931872,'."\n" .' "usedLindormTsdb": 0,'."\n" .' "usedOther": 0,'."\n" .' "usedLindormMessage3": 0,'."\n" .' "diskType": "PerformanceCloudStorage",'."\n" .' "used": 1719816329046,'."\n" .' "usedLindormSearch3": 36339905446,'."\n" .' "usedLindormSpark": 2131936938,'."\n" .' "capacity": 4294967296000,'."\n" .' "usedLindormSearch": 0,'."\n" .' "usedLindormVector3": 595054865855'."\n" .' }', 'title' => ''], 'description' => 'The usage information for each storage medium.', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates this unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'BDDB1954-002B-4249-B2DF-2CDDA0259668', 'title' => ''], 'InstanceStorageZoneMap' => ['description' => 'The capacity information for the multi-zone instance.'."\n" ."\n" .'{"ZoneId":{"CapacityByDiskCategory":{...},"UsageByDiskCategory":{...}}}', 'type' => 'object', 'example' => '{'."\n" .' "cn-hangzhou-i": {'."\n" .' "diskTypeCapacity": ['."\n" .' {'."\n" .' "mode": "CLOUD_STORAGE",'."\n" .' "perfLevel": "PL1",'."\n" .' "usedCapacity": 0,'."\n" .' "category": "PERF_CLOUD_ESSD_PL1",'."\n" .' "capacity": 4000'."\n" .' }'."\n" .' ],'."\n" .' "diskTypeUsage": ['."\n" .' {'."\n" .' "usedLindormColumn3": 688935,'."\n" .' "usedLindormTable": 1086288931872,'."\n" .' "usedLindormTsdb": 0,'."\n" .' "usedOther": 0,'."\n" .' "usedLindormMessage3": 0,'."\n" .' "diskType": "PerformanceCloudStorage",'."\n" .' "used": 1719816329046,'."\n" .' "usedLindormSearch3": 36339905446,'."\n" .' "usedLindormSpark": 2131936938,'."\n" .' "capacity": 4294967296000,'."\n" .' "usedLindormSearch": 0,'."\n" .' "usedLindormVector3": 595054865855'."\n" .' }'."\n" .' ]'."\n" .' }'."\n" .' }', 'title' => ''], 'AccessDeniedDetail' => ['description' => 'The detailed reason why the access was denied.', 'type' => 'string', 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Lindorm.Errorcode.ParameterInvaild', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ['errorCode' => 'Instance.IsDeleted', 'errorMessage' => 'The instance is deleted.', 'description' => ''], ['errorCode' => 'Instance.IsNotValid', 'errorMessage' => 'The instance is invalid.', 'description' => 'The specified instance is invalid.'], ], 403 => [ ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => ''], ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetLindormV2StorageUsage', 'summary' => 'Retrieves the storage details for each storage medium of a specific Lindorm instance that uses the new architecture.', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'lindorm:GetLindormV2StorageUsage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CapacityByDiskCategory\\": [\\n {\\n \\"mode\\": \\"CLOUD_STORAGE\\",\\n \\"perfLevel\\": \\"PL1\\",\\n \\"usedCapacity\\": 0,\\n \\"category\\": \\"PERF_CLOUD_ESSD_PL1\\",\\n \\"capacity\\": 4000\\n }\\n ],\\n \\"UsageByDiskCategory\\": [\\n {\\n \\"usedLindormColumn3\\": 688935,\\n \\"usedLindormTable\\": 1086288931872,\\n \\"usedLindormTsdb\\": 0,\\n \\"usedOther\\": 0,\\n \\"usedLindormMessage3\\": 0,\\n \\"diskType\\": \\"PerformanceCloudStorage\\",\\n \\"used\\": 1719816329046,\\n \\"usedLindormSearch3\\": 36339905446,\\n \\"usedLindormSpark\\": 2131936938,\\n \\"capacity\\": 4294967296000,\\n \\"usedLindormSearch\\": 0,\\n \\"usedLindormVector3\\": 595054865855\\n }\\n ],\\n \\"RequestId\\": \\"BDDB1954-002B-4249-B2DF-2CDDA0259668\\",\\n \\"InstanceStorageZoneMap\\": {\\n \\"cn-hangzhou-i\\": {\\n \\"diskTypeCapacity\\": [\\n {\\n \\"mode\\": \\"CLOUD_STORAGE\\",\\n \\"perfLevel\\": \\"PL1\\",\\n \\"usedCapacity\\": 0,\\n \\"category\\": \\"PERF_CLOUD_ESSD_PL1\\",\\n \\"capacity\\": 4000\\n }\\n ],\\n \\"diskTypeUsage\\": [\\n {\\n \\"usedLindormColumn3\\": 688935,\\n \\"usedLindormTable\\": 1086288931872,\\n \\"usedLindormTsdb\\": 0,\\n \\"usedOther\\": 0,\\n \\"usedLindormMessage3\\": 0,\\n \\"diskType\\": \\"PerformanceCloudStorage\\",\\n \\"used\\": 1719816329046,\\n \\"usedLindormSearch3\\": 36339905446,\\n \\"usedLindormSpark\\": 2131936938,\\n \\"capacity\\": 4294967296000,\\n \\"usedLindormSearch\\": 0,\\n \\"usedLindormVector3\\": 595054865855\\n }\\n ]\\n }\\n },\\n \\"AccessDeniedDetail\\": \\"{\\\\\\"AuthAction\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"AuthPrincipalDisplayName\\\\\\":\\\\\\"222\\\\\\",\\\\\\"AuthPrincipalOwnerId\\\\\\":\\\\\\"111\\\\\\",\\\\\\"AuthPrincipalType\\\\\\":\\\\\\"SubUser\\\\\\",,\\\\\\"NoPermissionType\\\\\\":\\\\\\"ImplicitDeny\\\\\\",\\\\\\"PolicyType\\\\\\":\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\\\"EncodedDiagnosticMessage\\\\\\":\\\\\\"xxxxxx\\\\\\"}\\"\\n}","type":"json"}]', ], 'ListTagResources' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the instance is located. Call the [DescribeRegions](~~426062~~) operation to get a list of available regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'A list of resource IDs.', 'type' => 'array', 'items' => ['description' => 'The instance ID. You can specify multiple instance IDs to query their tag bindings. Call the [GetLindormInstanceList](~~426069~~) operation to get the instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'ld-bp17j28j2y7pm****', 'title' => ''], 'required' => false, 'docRequired' => true, 'maxItems' => 51, 'minItems' => 0, 'title' => '', 'example' => '', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The token to retrieve the next page of results.'."\n" ."\n" .'> Do not specify this parameter for your first request. If the response returns a **NextToken**, more results are available. To retrieve the next page, include the returned **NextToken** value in your next request.', 'type' => 'string', 'required' => false, 'example' => '212db86****', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['description' => 'The resource type. Set the value to **INSTANCE**.', 'type' => 'string', 'required' => true, 'example' => 'INSTANCE', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'A list of tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag.'."\n" ."\n" .'> Each tag is a key-value pair. This parameter specifies the key.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], 'Value' => ['description' => 'The value of the tag.'."\n" ."\n" .'> Each tag is a key-value pair. This parameter specifies the value.', 'type' => 'string', 'required' => false, 'example' => '2.2.8', 'title' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 21, 'minItems' => 0, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '05CB115C-91CB-529F-9098-50C1F6CB3BD3', 'title' => ''], 'TagResources' => [ 'description' => 'The list of resources.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ResourceType' => ['description' => 'The resource type. The value is fixed to **ALIYUN::HITSDB::INSTANCE**.', 'type' => 'string', 'example' => 'ALIYUN::HITSDB::INSTANCE', 'title' => ''], 'TagValue' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => '2.2.8', 'title' => ''], 'ResourceId' => ['description' => 'The resource ID, which is the instance ID.', 'type' => 'string', 'example' => 'ld-bp17j28j2y7pm****', 'title' => ''], 'TagKey' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'test', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'NextToken' => ['description' => 'The token that is used to start the next query.'."\n" ."\n" .'> If not all results are returned in a query, the response includes this parameter. You can use the value of this parameter to start the next query.', 'type' => 'string', 'example' => '212db86****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Lindorm.Errorcode.MissingParameter', 'errorMessage' => 'You must specify ResourceId.N or Tags', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded.', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.NumberExceed.ResourceIds', 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', 'description' => ''], ], 403 => [ ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => 'You are not authorized to manage the specified resource.'], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ], [ ['errorCode' => 'Lindorm.Errorcode.InstanceNotFound', 'errorMessage' => 'The instance is not found.', 'description' => 'The specified instance does not exist.'], ], ], 'title' => 'ListTagResources', 'summary' => 'Get Lindorm instance-to-tag bindings.', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'lindorm:ListTagResources', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05CB115C-91CB-529F-9098-50C1F6CB3BD3\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceType\\": \\"ALIYUN::HITSDB::INSTANCE\\",\\n \\"TagValue\\": \\"2.2.8\\",\\n \\"ResourceId\\": \\"ld-bp17j28j2y7pm****\\",\\n \\"TagKey\\": \\"test\\"\\n }\\n ],\\n \\"NextToken\\": \\"212db86****\\"\\n}","type":"json"}]', ], 'ModifyInstancePayType' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '158675', 'abilityTreeNodes' => ['FEATUREhitsdb6YHIIK'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp1z3506imz2f****', 'title' => ''], ], [ 'name' => 'Duration', 'in' => 'query', 'schema' => ['description' => 'The subscription duration. This parameter is required when you change the billing method to subscription.'."\n" ."\n" .'- If \\`PricingCycle\\` is \\`Month\\`, the valid values are 1 to 9.'."\n" ."\n" .'- If \\`PricingCycle\\` is \\`Year\\`, the valid values are 1 to 3.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => true, 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PricingCycle', 'in' => 'query', 'schema' => ['description' => 'The unit of the subscription duration. This parameter is required when you change the billing method to subscription.'."\n" ."\n" .'- Month: The unit is month.'."\n" ."\n" .'- Year: The unit is year.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Month', 'title' => ''], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => ['description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'- **PREPAY**: subscription.'."\n" ."\n" .'- **POSTPAY**: pay-as-you-go.', 'type' => 'string', 'required' => true, 'example' => 'POSTPAY', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '587BCA54-50DA-4885-ADE9-80A848339151', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '211662251220224', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ld-bp1z3506imz2f****', 'title' => ''], 'AccessDeniedDetail' => ['description' => 'The detailed reason why the access is denied.', 'type' => 'string', 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Instance.IsDeleted', 'errorMessage' => 'The instance is deleted.', 'description' => 'The specified instance is already deleted.'], ['errorCode' => 'Instance.IsNotAvailable', 'errorMessage' => 'The instance is unavailable.', 'description' => 'The specified instance is unavailable.'], ], 403 => [ ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => 'You are not authorized to manage the specified resource.'], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ], [ ['errorCode' => 'Lindorm.Errorcode.InstanceNotFound', 'errorMessage' => 'The instance is not found.', 'description' => 'The specified instance does not exist.'], ], ], 'title' => 'ModifyInstancePayType', 'summary' => 'Changes the billing method of a Lindorm instance.', 'description' => 'Switches the billing method of an instance between subscription and pay-as-you-go.'."\n" ."\n" .'Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.aliyun.com/price/product?spm=openapi-amp.newDocPublishment.0.0.6345281fu63xJ3#/hitsdb/detail/hitsdb_lindormpre_public_cn)'."\n" .'[pricing](https://www.alibabacloud.com/zh/pricing-calculator?_p_lc=1\\&spm=a2796.7960336.3034855210.1.7396b91aC5VjZ7#/commodity/vm_intl) of Lindorm.', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:ModifyInstancePayType', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"587BCA54-50DA-4885-ADE9-80A848339151\\",\\n \\"OrderId\\": 211662251220224,\\n \\"InstanceId\\": \\"ld-bp1z3506imz2f****\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\\\"AuthAction\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"AuthPrincipalDisplayName\\\\\\":\\\\\\"222\\\\\\",\\\\\\"AuthPrincipalOwnerId\\\\\\":\\\\\\"111\\\\\\",\\\\\\"AuthPrincipalType\\\\\\":\\\\\\"SubUser\\\\\\",,\\\\\\"NoPermissionType\\\\\\":\\\\\\"ImplicitDeny\\\\\\",\\\\\\"PolicyType\\\\\\":\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\\\"EncodedDiagnosticMessage\\\\\\":\\\\\\"xxxxxx\\\\\\"}\\"\\n}","type":"json"}]', ], 'ReleaseLindormInstance' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeCode' => '64084', 'abilityTreeNodes' => ['FEATUREhitsdbUE1KPV'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID. You can call the [GetLindormInstanceList](~~426069~~) operation to obtain the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp1z3506imz2f****', 'title' => ''], ], [ 'name' => 'Immediately', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to release the instance immediately. If set to true, the instance and its data are deleted immediately. If set to false (the default), the instance is retained for seven days before being permanently deleted.', 'type' => 'boolean', 'required' => false, 'docRequired' => true, 'default' => 'true', 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F67BFFF3-F5C2-45B5-9C28-6E4A1E51****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ChargeType.IsNotValid', 'errorMessage' => 'The charge type is invalid.', 'description' => 'The specified charge type is invalid.'], ['errorCode' => 'Instance.IsNotPostPay', 'errorMessage' => 'The instance billing type is not pay as you go.', 'description' => ''], ['errorCode' => 'Instance.DeleteProtection', 'errorMessage' => 'Instance deletion is protected. Please disable delete protection before deleting the instance.', 'description' => 'If the instance has deletion protection enabled, disable deletion protection before deleting the instance.'], ], 403 => [ ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => 'You are not authorized to manage the specified resource.'], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ], [ ['errorCode' => 'Lindorm.Errorcode.InstanceNotFound', 'errorMessage' => 'The instance is not found.', 'description' => 'The specified instance does not exist.'], ], ], 'title' => 'ReleaseLindormInstance', 'summary' => 'Releases a Lindorm instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => 'Description', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-05-26T12:59:31.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-05-26T12:55:38.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-05-26T12:55:30.000Z', 'description' => 'OpenAPI offline'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'lindorm:ReleaseLindormInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'Instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F67BFFF3-F5C2-45B5-9C28-6E4A1E51****\\"\\n}","type":"json"}]', ], 'ReleaseLindormV2Instance' => [ 'summary' => 'Releases a Lindorm instance.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeCode' => '253512', 'abilityTreeNodes' => ['FEATUREhitsdbUE1KPV'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. Call the [GetLindormInstanceList](~~190281~~) operation to obtain the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp1o3y0yme2i2****', 'title' => ''], ], [ 'name' => 'Immediately', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to immediately release the instance. Default value: false. If this parameter is set to false, the instance data is retained for 7 days before it is deleted. If this parameter is set to true, the instance data is deleted immediately.', 'type' => 'boolean', 'required' => false, 'docRequired' => true, 'default' => 'true', 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0A7153E4-8354-497E-87E5-5D0EBEF5AEB1', 'title' => ''], 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ChargeType.IsNotValid', 'errorMessage' => 'The charge type is invalid.', 'description' => 'The specified charge type is invalid.'], ['errorCode' => 'Instance.IsNotPostPay', 'errorMessage' => 'The instance billing type is not pay as you go.', 'description' => ''], ['errorCode' => 'Instance.IsDeleted', 'errorMessage' => 'The instance is deleted.', 'description' => 'The specified instance is already deleted.'], ['errorCode' => 'Instance.DeleteProtection', 'errorMessage' => 'Instance deletion is protected. Please disable delete protection before deleting the instance.', 'description' => 'If the instance has deletion protection enabled, disable deletion protection before deleting the instance.'], ], 403 => [ ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => 'You are not authorized to manage the specified resource.'], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ], [ ['errorCode' => 'Lindorm.Errorcode.InstanceNotFound', 'errorMessage' => 'The instance is not found.', 'description' => 'The specified instance does not exist.'], ], ], 'title' => 'ReleaseLindormV2Instance', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'lindorm:ReleaseLindormV2Instance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'Instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0A7153E4-8354-497E-87E5-5D0EBEF5AEB1\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\\\"AuthAction\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"AuthPrincipalDisplayName\\\\\\":\\\\\\"222\\\\\\",\\\\\\"AuthPrincipalOwnerId\\\\\\":\\\\\\"111\\\\\\",\\\\\\"AuthPrincipalType\\\\\\":\\\\\\"SubUser\\\\\\",,\\\\\\"NoPermissionType\\\\\\":\\\\\\"ImplicitDeny\\\\\\",\\\\\\"PolicyType\\\\\\":\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\\\"EncodedDiagnosticMessage\\\\\\":\\\\\\"xxxxxx\\\\\\"}\\"\\n}","type":"json"}]', ], 'RenewLindormInstance' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '158636', 'abilityTreeNodes' => ['FEATUREhitsdb6YHIIK'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the instance is located. Call the [DescribeRegions](~~426062~~) operation to obtain the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. Call the [GetLindormInstanceList](~~426069~~) operation to obtain the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ld-bp1z3506imz2f****', 'title' => ''], ], [ 'name' => 'PricingCycle', 'in' => 'query', 'schema' => [ 'description' => 'The billing cycle for the instance renewal. Valid values:'."\n" ."\n" .'- **Month**: The instance is renewed by month.'."\n" ."\n" .'- **Year**: The instance is renewed by year.', 'type' => 'string', 'required' => true, 'enum' => ['Month', 'Year'], 'example' => 'Month', 'title' => '', ], ], [ 'name' => 'Duration', 'in' => 'query', 'schema' => ['description' => 'The subscription duration. Valid values:'."\n" ."\n" .'- If you set PricingCycle to **Month**, the valid values for this parameter are **1** to **9**.'."\n" ."\n" .'- If you set PricingCycle to **Year**, the valid values for this parameter are **1** to **3**.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '9', 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response that is returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1556DCB0-043A-4444-8BD9-CF4A68E7EE64', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'ld-bp1z3506imz2f****', 'title' => ''], 'OrderId' => ['description' => 'The ID of the order. You can find the order ID in the Order Management section of Expenses and Costs.', 'type' => 'integer', 'format' => 'int64', 'example' => '213465921640411', 'title' => ''], 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Lindorm.Errorcode.ParameterInvaild', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.Order.CreateFailed', 'errorMessage' => 'Create order failed.', 'description' => ''], ], 403 => [ ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => ''], ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ], [ ['errorCode' => 'Lindorm.Errorcode.PayType.IsNotValid', 'errorMessage' => 'Pay type is not valid.', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.Commodity.NotFound', 'errorMessage' => 'Commodity is not found.', 'description' => ''], ], ], 'title' => 'RenewLindormInstance', 'summary' => 'Renews a subscription Lindorm instance.', 'description' => 'You can renew a subscription instance for a specific duration. The renewal period can be specified in months (1 to 9) or years (1 to 3).'."\n" ."\n" .'Before you call this operation, make sure that you fully understand the billing methods and pricing of Lindorm.', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:RenewLindormInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1556DCB0-043A-4444-8BD9-CF4A68E7EE64\\",\\n \\"InstanceId\\": \\"ld-bp1z3506imz2f****\\",\\n \\"OrderId\\": 213465921640411,\\n \\"AccessDeniedDetail\\": \\"{\\\\\\"AuthAction\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"AuthPrincipalDisplayName\\\\\\":\\\\\\"222\\\\\\",\\\\\\"AuthPrincipalOwnerId\\\\\\":\\\\\\"111\\\\\\",\\\\\\"AuthPrincipalType\\\\\\":\\\\\\"SubUser\\\\\\",,\\\\\\"NoPermissionType\\\\\\":\\\\\\"ImplicitDeny\\\\\\",\\\\\\"PolicyType\\\\\\":\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\\\"EncodedDiagnosticMessage\\\\\\":\\\\\\"xxxxxx\\\\\\"}\\"\\n}","type":"json"}]', ], 'SwitchLSQLV3MySQLService' => [ 'summary' => 'Enables or disables the Lindorm protocol that is compatible with MySQL.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '195286', 'abilityTreeNodes' => ['FEATUREhitsdb7G1Y1A'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp1o3y0yme2i2****', 'title' => ''], ], [ 'name' => 'ActionType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the operation. Valid values:'."\n" ."\n" .'- 1: Enable'."\n" ."\n" .'- 0: Disable', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'enum' => ['0', '1'], 'example' => '1', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1556DCB0-043A-4444-8BD9-CF4A68E7EE64', 'title' => ''], 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'MinorVersion.TooLow', 'errorMessage' => 'The minor version is too low. Please upgrade.', 'description' => 'The minor version is an earlier one. Update the minor version.'], ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => 'You are not authorized to manage the specified resource.'], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ], ], 'title' => 'SwitchLSQLV3MySQLService', 'description' => 'Before you call this operation, make sure that the following requirements are met:'."\n" ."\n" .'- The version of LindormTable for the instance is 2.6.0 or later.'."\n" ."\n" .'- LindormTable supports Lindorm SQL (LSQL) V3. You can check whether LSQL V3 is supported by calling the GetLindormInstance operation. If the EnableLsqlVersionV3 parameter in the response is true, LSQL V3 is supported. For instances that are purchased after October 24, 2023, this feature is enabled by default. For existing instances, contact Alibaba Cloud support for an evaluation before enabling this feature.'."\n" ."\n" .'You can enable the MySQL protocol only if the two preceding conditions are met.', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:SwitchLSQLV3MySQLService', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1556DCB0-043A-4444-8BD9-CF4A68E7EE64\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\\\"AuthAction\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"AuthPrincipalDisplayName\\\\\\":\\\\\\"222\\\\\\",\\\\\\"AuthPrincipalOwnerId\\\\\\":\\\\\\"111\\\\\\",\\\\\\"AuthPrincipalType\\\\\\":\\\\\\"SubUser\\\\\\",,\\\\\\"NoPermissionType\\\\\\":\\\\\\"ImplicitDeny\\\\\\",\\\\\\"PolicyType\\\\\\":\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\\\"EncodedDiagnosticMessage\\\\\\":\\\\\\"xxxxxx\\\\\\"}\\"\\n}","type":"json"}]', ], 'TagResources' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '128918', 'abilityTreeNodes' => ['FEATUREhitsdbI6NK1A'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the instance. Call the [DescribeRegions](~~426062~~) operation to obtain the region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the resource. Set the value to **INSTANCE**.', 'type' => 'string', 'required' => true, 'example' => 'INSTANCE', 'title' => ''], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'A list of resource IDs.', 'type' => 'array', 'items' => ['description' => 'The ID of the instance. To attach tags to multiple instances, pass multiple instance IDs. Call the [GetLindormInstanceList](~~426069~~) operation to obtain the instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'ld-bp17j28j2y7pm****', 'title' => ''], 'required' => true, 'maxItems' => 51, 'minItems' => 1, 'title' => '', 'example' => '', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'A list of tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key.'."\n" ."\n" .'> You can specify the keys for multiple tags. For example, the Key in the first pair is the key for the first tag, and the Key in the second pair is the key for the second tag.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], 'Value' => ['description' => 'The tag value.'."\n" ."\n" .'> You can specify the values for multiple tags. For example, the Value in the first pair is the value for the first tag, and the Value in the second pair is the value for the second tag.', 'type' => 'string', 'required' => false, 'example' => '2.2.8', 'title' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => true, 'maxItems' => 21, 'minItems' => 1, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4F23D50C-400C-592C-9486-9D1E10179065', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Lindorm.Errorcode.ParameterInvaild', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.InvalidParameter.TagValue', 'errorMessage' => 'The Tag.N.Value parameter is invalid.', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.InvalidParameter.TagKey', 'errorMessage' => 'The Tag.N.Key parameter is invalid.', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.NumberExceed.ResourceIds', 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded.', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.QuotaExceed.TagsPerResource', 'errorMessage' => 'The maximum number of tags for each resource is exceeded', 'description' => ''], ], 403 => [ ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => ''], ], [ ['errorCode' => 'Lindorm.Errorcode.InvalidResourceId', 'errorMessage' => 'The specified ResourceIds are not found in our records.', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.MissingParameter.TagKey', 'errorMessage' => 'You must specify Tag.N.Key.', 'description' => ''], ], ], 'title' => 'TagResources', 'summary' => 'Attaches tags to one or more Lindorm instances.', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:TagResources', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'Instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4F23D50C-400C-592C-9486-9D1E10179065\\"\\n}","type":"json"}]', ], 'UntagResources' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '129417', 'abilityTreeNodes' => ['FEATUREhitsdbI6NK1A'], ], 'parameters' => [ [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['description' => 'The resource type. The value is fixed to **INSTANCE**.', 'type' => 'string', 'required' => true, 'example' => 'INSTANCE', 'title' => ''], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'A list of instance IDs.', 'type' => 'array', 'items' => ['description' => 'The instance ID. To detach tags from multiple instances, specify multiple instance IDs. Call the [GetLindormInstanceList](~~426069~~) operation to obtain the instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'ld-bp17j28j2y7pm****', 'title' => ''], 'required' => true, 'maxItems' => 51, 'minItems' => 1, 'title' => '', 'example' => '', ], ], [ 'name' => 'TagKey', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'A list of tag keys.', 'type' => 'array', 'items' => ['description' => 'The key of the tag.'."\n" ."\n" .'> To detach multiple tags from the instances, specify multiple tag keys.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], 'required' => false, 'maxItems' => 21, 'minItems' => 1, 'title' => '', 'example' => '', ], ], [ 'name' => 'All', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to detach all tags from the instances. Valid values:'."\n" ."\n" .'- **true**: Detach all tags from the instances.'."\n" ."\n" .'- **false**: Do not detach all tags from the instances.'."\n" ."\n" .'> * The default value is false.'."\n" ."\n" .'- If TagKey is specified, this parameter is ignored.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8CACBBCE-7519-545C-8695-86D4F09CED7E', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Lindorm.Errorcode.ParameterInvaild', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.InvalidParameter.TagKey', 'errorMessage' => 'The Tag.N.Key parameter is invalid.', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.Tags.ExceedLimitation', 'errorMessage' => 'The maximum number of Tags is exceeded.', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.InvalidTagKey.Malformed', 'errorMessage' => 'The Tag.N.Key parameter is invalid.', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.ParameterInvaild.TagKeysOrDeleteAll', 'errorMessage' => 'The TagKeys or DeleteAll parameter is invalid.', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.InvalidResourceId.NotFound', 'errorMessage' => 'The specified ResourceIds are not found in our records.', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.NumberExceed.ResourceIds', 'errorMessage' => 'The ResourceIds parameter\'s number is exceed.', 'description' => ''], ], 403 => [ ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => ''], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => ''], ], ], 'title' => 'UntagResources', 'summary' => 'Detaches tags from Lindorm instances.', 'description' => 'If a tag is not attached to any Lindorm instance, the tag is deleted.', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:UntagResources', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'Instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8CACBBCE-7519-545C-8695-86D4F09CED7E\\"\\n}","type":"json"}]', ], 'UpdateInstanceIpWhiteList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '64089', 'abilityTreeNodes' => ['FEATUREhitsdb3JDHWG'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. Call the [GetLindormInstanceList](~~426069~~) operation to obtain the ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp1z3506imz2f****', 'title' => ''], ], [ 'name' => 'SecurityIpList', 'in' => 'query', 'schema' => ['description' => 'The IP addresses to add to the whitelist.'."\n" ."\n" .'> Set this parameter to 127.0.0.1 to deny access from all IP addresses. For example, 192.168.0.0/24 allows all IP addresses in the 192.168.0.0/24 CIDR block to access the Lindorm instance. Separate multiple IP addresses or CIDR blocks with a comma (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '192.168.0.X/24', 'title' => ''], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => 'The name of the whitelist group. If you leave this parameter empty, the default value user is used.', 'type' => 'string', 'required' => false, 'example' => 'test_group', 'title' => ''], ], [ 'name' => 'Delete', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to clear the whitelist.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4944539D-D27C-458D-95F1-2DCEB5E0EED5', 'title' => ''], 'AccessDeniedDetail' => ['description' => 'The detailed reason why the access is denied.', 'type' => 'string', 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Instance.IsDeleted', 'errorMessage' => 'The instance is deleted.', 'description' => 'The specified instance is already deleted.'], ['errorCode' => 'Instance.IsNotValid', 'errorMessage' => 'The instance is invalid.', 'description' => 'The specified instance is invalid.'], ], 403 => [ ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => 'You are not authorized to manage the specified resource.'], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ], ], 'title' => 'UpdateInstanceIpWhiteList', 'summary' => 'Sets the access whitelist for a Lindorm instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:UpdateInstanceIpWhiteList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4944539D-D27C-458D-95F1-2DCEB5E0EED5\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\\\"AuthAction\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"AuthPrincipalDisplayName\\\\\\":\\\\\\"222\\\\\\",\\\\\\"AuthPrincipalOwnerId\\\\\\":\\\\\\"111\\\\\\",\\\\\\"AuthPrincipalType\\\\\\":\\\\\\"SubUser\\\\\\",,\\\\\\"NoPermissionType\\\\\\":\\\\\\"ImplicitDeny\\\\\\",\\\\\\"PolicyType\\\\\\":\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\\\"EncodedDiagnosticMessage\\\\\\":\\\\\\"xxxxxx\\\\\\"}\\"\\n}","type":"json"}]', ], 'UpdateLindormInstanceAttribute' => [ 'summary' => 'Updates the name or deletion protection settings of an instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '76409', 'abilityTreeNodes' => ['FEATUREhitsdb6YHIIK'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp1z3506imz2f****', 'title' => ''], ], [ 'name' => 'InstanceAlias', 'in' => 'query', 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'lindorm-test', 'title' => ''], ], [ 'name' => 'DeletionProtection', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable deletion protection. Valid values:'."\n" ."\n" .'- **true**: Enabled.'."\n" ."\n" .'- **false**: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1556DCB0-043A-4444-8BD9-CF4A68E7EE64', 'title' => ''], 'AccessDeniedDetail' => ['description' => 'The detailed reason why the access was denied.', 'type' => 'string', 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Lindorm.Errorcode.ParameterInvaild', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ['errorCode' => 'Instance.IsNotValid', 'errorMessage' => 'The instance is invalid.', 'description' => 'The specified instance is invalid.'], ], 403 => [ ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => 'You are not authorized to manage the specified resource.'], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'UpdateLindormInstanceAttribute', 'description' => 'You must select at least one data engine when you create an instance. For example, to create a LindormTable engine, you must specify both the **LindormNum** (number of LindormTable nodes) and **LindormSpec** (node specifications for LindormTable) parameters. For more information, see [How to select a data engine](~~174643~~) and [How to select storage specifications](~~181971~~).'."\n" ."\n" .'>'."\n" ."\n" .'If you do not specify data engine parameters when you create an instance, the API call fails.'."\n" ."\n" .'>', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:UpdateLindormInstanceAttribute', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'Instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1556DCB0-043A-4444-8BD9-CF4A68E7EE64\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\\\"AuthAction\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"AuthPrincipalDisplayName\\\\\\":\\\\\\"222\\\\\\",\\\\\\"AuthPrincipalOwnerId\\\\\\":\\\\\\"111\\\\\\",\\\\\\"AuthPrincipalType\\\\\\":\\\\\\"SubUser\\\\\\",,\\\\\\"NoPermissionType\\\\\\":\\\\\\"ImplicitDeny\\\\\\",\\\\\\"PolicyType\\\\\\":\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\\\"EncodedDiagnosticMessage\\\\\\":\\\\\\"xxxxxx\\\\\\"}\\"\\n}","type":"json"}]', ], 'UpdateLindormV2Instance' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeCode' => '251726', 'abilityTreeNodes' => ['FEATUREhitsdbUE1KPV'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the instance is located. To query the latest region list, call the [DescribeRegions](~~426062~~) operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'CloudStorageType', 'in' => 'query', 'schema' => [ 'description' => 'The cloud storage class.'."\n" ."\n" .'- **PerformanceStorage**: performance cloud storage.'."\n" ."\n" .'- **StandardStorage**: standard cloud storage.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'enum' => ['StandardStorage', 'PerformanceStorage', 'CapacityStorage'], 'example' => 'PerformanceStorage', 'title' => '', ], ], [ 'name' => 'CloudStorageSize', 'in' => 'query', 'schema' => ['description' => 'The cloud storage capacity. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '480', 'title' => ''], ], [ 'name' => 'EnableCapacityStorage', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable storage-optimized storage.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'CapacityStorageSize', 'in' => 'query', 'schema' => ['description' => 'The capacity of the storage-optimized storage.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000', 'title' => ''], ], [ 'name' => 'EngineList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'EngineType' => [ 'description' => 'The engine type. Valid values:'."\n" ."\n" .'- TABLE: LindormTable.'."\n" ."\n" .'- TSDB: LindormTSDB.'."\n" ."\n" .'- LSEARCH: search engine.'."\n" ."\n" .'- LTS: LTS engine.'."\n" ."\n" .'- LVECTOR: vector engine.'."\n" ."\n" .'- LCOLUMN: column store.'."\n" ."\n" .'- LAI: AI engine.', 'type' => 'string', 'required' => true, 'enum' => ['TABLE', 'TSDB', 'LTS', 'LSEARCH', 'LSTREAM', 'LVECTOR', 'LMESSAGE', 'LAI', 'LCOLUMN'], 'example' => 'TABLE', 'title' => '', ], 'NodeGroupList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'NodeSpec' => ['description' => 'The node specifications of the engine.'."\n" ."\n" .'- **lindorm.c.2xlarge**: 8 cores and 16 GB of memory.'."\n" ."\n" .'- **lindorm.g.2xlarge**: 8 cores and 32 GB of memory.'."\n" ."\n" .'- **lindorm.c.4xlarge**: 16 cores and 32 GB of memory.'."\n" ."\n" .'- **lindorm.g.4xlarge**: 16 cores and 64 GB of memory.'."\n" ."\n" .'- **lindorm.c.8xlarge**: 32 cores and 64 GB of memory.'."\n" ."\n" .'- **lindorm.g.8xlarge**: 32 cores and 128 GB of memory.', 'type' => 'string', 'required' => true, 'example' => 'lindorm.g.2xlarge', 'title' => ''], 'NodeCount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '6', 'title' => ''], 'NodeDiskType' => [ 'description' => 'The disk type of the node. This parameter is not required. **This parameter is available only for specific scenarios and is accessible to users on a whitelist.**', 'type' => 'string', 'default' => 'cloud_essd', 'enum' => ['cloud_essd', 'cloud_efficiency'], 'required' => false, 'example' => 'cloud_essd', 'title' => '', ], 'NodeDiskSize' => ['description' => 'The disk size of a single node. This parameter is not required.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'ResourceGroupName' => ['description' => 'The name of the node group. **This parameter is required.** You can obtain the name by calling the GetLindormV2Instance operation.', 'type' => 'string', 'required' => false, 'example' => 'groupName', 'title' => ''], 'GroupId' => ['description' => 'The ID of the node group.', 'type' => 'string', 'required' => false, 'example' => 'ix90Yes', 'title' => ''], ], 'description' => 'A list of engine node groups.', 'required' => false, 'title' => '', 'example' => '', ], 'maxItems' => 12, 'minItems' => 1, 'description' => 'A list of engine node groups.', 'required' => false, 'title' => '', 'example' => '', ], ], 'description' => 'A list of engine information.', 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'maxItems' => 100, 'description' => 'A list of engine types.', 'title' => '', 'example' => '', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ld-bp1o3y0yme2i2****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1556DCB0-043A-4444-8BD9-CF4A68E7EE64', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ld-bp1478w1603****', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '240136741090345', 'title' => ''], 'AccessDeniedDetail' => ['description' => 'The details of the access denied error.', 'type' => 'string', 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Lindorm.Errorcode.ParameterInvaild', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ['errorCode' => 'LindormErrorCode.%s', 'errorMessage' => '%s.', 'description' => '%s.'], ['errorCode' => 'LindormErrorCode.OperationDenied.OrderProcessing', 'errorMessage' => 'There is an order in process, please confirm that it has been processed and try again.', 'description' => ''], ], 403 => [ ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => ''], ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ], ], 'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'hitsdb::2020-06-15::GetLindormV2Instance', 'callbackInterval' => 300000, 'maxCallbackTimes' => 12], 'title' => 'UpdateLindormV2Instance', 'summary' => 'Updates a Lindorm instance.', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:UpdateLindormV2Instance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1556DCB0-043A-4444-8BD9-CF4A68E7EE64\\",\\n \\"InstanceId\\": \\"ld-bp1478w1603****\\",\\n \\"OrderId\\": 240136741090345,\\n \\"AccessDeniedDetail\\": \\"{\\\\\\"AuthAction\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"AuthPrincipalDisplayName\\\\\\":\\\\\\"222\\\\\\",\\\\\\"AuthPrincipalOwnerId\\\\\\":\\\\\\"111\\\\\\",\\\\\\"AuthPrincipalType\\\\\\":\\\\\\"SubUser\\\\\\",,\\\\\\"NoPermissionType\\\\\\":\\\\\\"ImplicitDeny\\\\\\",\\\\\\"PolicyType\\\\\\":\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\\\"EncodedDiagnosticMessage\\\\\\":\\\\\\"xxxxxx\\\\\\"}\\"\\n}","type":"json"}]', ], 'UpdateLindormV2WhiteIpList' => [ 'summary' => 'Modifies the IP whitelists for a LindormV2 instance.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREhitsdb3JDHWG'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the instance is located. You can call the [DescribeRegions](~~426062~~) operation to obtain this ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. You can call the GetLindormV2InstanceList operation to obtain the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ld-2ze5ipz9zx1e4****', 'title' => ''], ], [ 'name' => 'WhiteIpGroupList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GroupName' => ['description' => 'The name of the IP whitelist group.', 'type' => 'string', 'required' => true, 'example' => 'user001', 'title' => ''], 'WhiteIpList' => ['description' => 'The IP addresses to add to the IP whitelist.'."\n" ."\n" .'> The value 127.0.0.1 denies access from all IP addresses. For example, 192.168.0.0/24 allows all IP addresses in that range to access the Lindorm instance. Use a comma (,) to separate multiple IP addresses or CIDR blocks.', 'type' => 'string', 'required' => true, 'example' => '192.168.0.X/24', 'title' => ''], ], 'description' => 'A single IP whitelist group.', 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'maxItems' => 100, 'description' => 'The list of IP whitelist groups.', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0A7153E4-8354-497E-87E5-5D0EBEF5AEB1'], 'AccessDeniedDetail' => ['description' => 'Details about a failed permission check.', 'type' => 'string', 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', 'title' => ''], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Instance.IsDeleted', 'errorMessage' => 'The instance is deleted.', 'description' => 'The specified instance is already deleted.'], ['errorCode' => 'Instance.IsNotValid', 'errorMessage' => 'The instance is invalid.', 'description' => 'The specified instance is invalid.'], ['errorCode' => 'LindormErrorCode.%s', 'errorMessage' => '%s.', 'description' => '%s.'], ['errorCode' => 'WhiteIpInUpdating', 'errorMessage' => 'Instance is updating whiteIp now, please wait.', 'description' => 'Please wait while the instance whitelist is updated.'], ], 403 => [ ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => 'You are not authorized to manage the specified resource.'], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdateLindormV2WhiteIpList', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'lindorm:UpdateLindormV2WhiteIpList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0A7153E4-8354-497E-87E5-5D0EBEF5AEB1\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\\\"AuthAction\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"AuthPrincipalDisplayName\\\\\\":\\\\\\"222\\\\\\",\\\\\\"AuthPrincipalOwnerId\\\\\\":\\\\\\"111\\\\\\",\\\\\\"AuthPrincipalType\\\\\\":\\\\\\"SubUser\\\\\\",,\\\\\\"NoPermissionType\\\\\\":\\\\\\"ImplicitDeny\\\\\\",\\\\\\"PolicyType\\\\\\":\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\\\"EncodedDiagnosticMessage\\\\\\":\\\\\\"xxxxxx\\\\\\"}\\"\\n}","type":"json"}]', ], 'UpgradeLindormInstance' => [ 'summary' => 'Enable cold storage for a Lindorm instance, change the node specification or the number of nodes, and adjust the storage space.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREhitsdbNQ2Q4L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the instance is located. You can call the [DescribeRegions](~~426062~~) operation to obtain the latest region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the availability zone. You can call the [GetLindormInstance](~~426067~~) operation to obtain this ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai-f', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. You can call the [GetLindormInstanceList](~~426069~~) operation to obtain this ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp1o3y0yme2i2****', 'title' => ''], ], [ 'name' => 'UpgradeType', 'in' => 'query', 'schema' => ['description' => 'The type of the upgrade. For details about the supported types, see the description of the UpgradeType parameter in the "Additional information about request parameters" section.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'upgrade-cold-storage', 'title' => ''], ], [ 'name' => 'ClusterStorage', 'in' => 'query', 'schema' => ['description' => 'The new storage capacity of the instance. Unit: GB. Valid values: **480** to **1017600**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '480', 'title' => ''], ], [ 'name' => 'ColdStorage', 'in' => 'query', 'schema' => ['description' => 'The new cold storage capacity of the instance. Unit: GB. Valid values: **800** to **1000000**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '800', 'title' => ''], ], [ 'name' => 'SolrSpec', 'in' => 'query', 'schema' => ['description' => 'The new specification of the search engine nodes. Valid values:'."\n" ."\n" .'- **lindorm.g.xlarge**: 4 CPU cores, 16 GB of memory (dedicated specification).'."\n" ."\n" .'- **lindorm.g.2xlarge**: 8 CPU cores, 32 GB of memory (dedicated specification).'."\n" ."\n" .'- **lindorm.g.4xlarge**: 16 CPU cores, 64 GB of memory (dedicated specification).'."\n" ."\n" .'- **lindorm.g.8xlarg**e: 32 CPU cores, 128 GB of memory (dedicated specification).', 'type' => 'string', 'required' => false, 'example' => 'lindorm.g.xlarge', 'title' => ''], ], [ 'name' => 'SolrNum', 'in' => 'query', 'schema' => ['description' => 'The new number of search engine nodes. Valid values: **0** to **60**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'LindormSpec', 'in' => 'query', 'schema' => ['description' => 'The new specification of the wide table engine nodes. Valid values:'."\n" ."\n" .'- **lindorm.c.xlarge**: 4 CPU cores, 8 GB of memory (dedicated specification).'."\n" ."\n" .'- **lindorm.c.2xlarge**: 8 CPU cores, 16 GB of memory (dedicated specification).'."\n" ."\n" .'- **lindorm.c.4xlarge**: 16 CPU cores, 32 GB of memory (dedicated specification).'."\n" ."\n" .'- **lindorm.c.8xlarge**: 32 CPU cores, 64 GB of memory (dedicated specification).', 'type' => 'string', 'required' => false, 'example' => 'lindorm.c.xlarge', 'title' => ''], ], [ 'name' => 'LindormNum', 'in' => 'query', 'schema' => ['description' => 'The new number of wide table engine nodes. Valid values: **0** to **90**.'."\n" ."\n" .'> If you specify this parameter, the LindormSpec parameter is also required.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'TsdbSpec', 'in' => 'query', 'schema' => ['description' => 'The new specification of the time series engine nodes. Valid values:'."\n" ."\n" .'- **lindorm.g.xlarge**: 4 CPU cores, 16 GB of memory (dedicated specification).'."\n" ."\n" .'- **lindorm.g.2xlarge**: 8 CPU cores, 32 GB of memory (dedicated specification).'."\n" ."\n" .'- **lindorm.g.4xlarge**: 16 CPU cores, 64 GB of memory (dedicated specification).'."\n" ."\n" .'- **lindorm.g.8xlarge**: 32 CPU cores, 128 GB of memory (dedicated specification).', 'type' => 'string', 'required' => false, 'example' => 'lindorm.g.xlarge', 'title' => ''], ], [ 'name' => 'TsdbNum', 'in' => 'query', 'schema' => ['description' => 'The new number of time series engine nodes. Valid values: **0** to **24**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'FilestoreSpec', 'in' => 'query', 'schema' => ['description' => 'The new specification of the file engine nodes. Valid value:'."\n" ."\n" .'**lindorm.c.xlarge**: 4 CPU cores, 8 GB of memory (standard specification).', 'type' => 'string', 'required' => false, 'example' => 'lindorm.c.xlarge', 'title' => ''], ], [ 'name' => 'FilestoreNum', 'in' => 'query', 'schema' => ['description' => 'The new number of file engine nodes. Valid values: **0** to **60**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'StreamSpec', 'in' => 'query', 'schema' => ['description' => 'The new specification of the stream engine nodes. Valid values:'."\n" ."\n" .'- **lindorm.c.2xlarge**: 8 CPU cores, 16 GB of memory (dedicated specification).'."\n" ."\n" .'- **lindorm.c.4xlarge**: 16 CPU cores, 32 GB of memory (dedicated specification).'."\n" ."\n" .'- **lindorm.c.8xlarge**: 32 CPU cores, 64 GB of memory (dedicated specification).', 'type' => 'string', 'required' => false, 'example' => 'lindorm.g.xlarge', 'title' => ''], ], [ 'name' => 'StreamNum', 'in' => 'query', 'schema' => ['description' => 'The new number of stream engine nodes. Valid values: **0** to **90**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'LtsCoreSpec', 'in' => 'query', 'schema' => ['description' => 'The new specification of the LTS nodes. Valid values:'."\n" ."\n" .'- **lindorm.g.xlarge**: 4 CPU cores, 16 GB of memory (dedicated specification).'."\n" ."\n" .'- **lindorm.g.2xlarge**: 8 CPU cores, 32 GB of memory (dedicated specification).', 'type' => 'string', 'required' => false, 'example' => 'lindorm.g.xlarge', 'title' => ''], ], [ 'name' => 'LtsCoreNum', 'in' => 'query', 'schema' => ['description' => 'The new number of LTS nodes. Valid values: **0** to **50**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'CoreSingleStorage', 'in' => 'query', 'schema' => ['description' => 'The new storage capacity of a single core node in a multi-zone instance. Unit: GB. Valid values: 400 to 64000. **This parameter is optional.**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '400GB', 'title' => ''], ], [ 'name' => 'LogSpec', 'in' => 'query', 'schema' => ['description' => 'The new specification of the log nodes for a multi-zone instance. Valid values:'."\n" ."\n" .'- **lindorm.sn1.large**: 4 CPU cores, 8 GB of memory (dedicated specification).'."\n" ."\n" .'- **lindorm.sn1.2xlarge**: 8 CPU cores, 16 GB of memory (dedicated specification).'."\n" ."\n" .'**This parameter is optional.**', 'type' => 'string', 'required' => false, 'example' => 'lindorm.sn1.large', 'title' => ''], ], [ 'name' => 'LogNum', 'in' => 'query', 'schema' => ['description' => 'The new number of log nodes for a multi-zone instance. Valid values: 4 to 400. **This parameter is optional.**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4', 'title' => ''], ], [ 'name' => 'LogSingleStorage', 'in' => 'query', 'schema' => ['description' => 'The new disk capacity of a single log node for a multi-zone instance. Unit: GB. Valid values: 400 to 64000. **This parameter is optional.**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '400GB', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '111111111111111', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2A7D4F9D-AA26-4E15-A2B1-3E4792C6****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Lindorm.Errorcode.InstanceStorageInvalid', 'errorMessage' => 'The instance storage parameter is invalid: %s', 'description' => ''], ['errorCode' => 'Instance.IsDeleted', 'errorMessage' => 'The instance is deleted.', 'description' => 'The specified instance is already deleted.'], ['errorCode' => 'Instance.IsNotValid', 'errorMessage' => 'The instance is invalid.', 'description' => 'The specified instance is invalid.'], ['errorCode' => 'InstanceConfig.NotChanged', 'errorMessage' => 'The upgrade or downgrade configuration is not changed, please check.', 'description' => 'The upgrade or downgrade configuration is not changed, please check.'], ], 403 => [ ['errorCode' => 'API.Forbidden', 'errorMessage' => 'The API operation is forbidden in this environment.', 'description' => 'This operation is not supported in the current environment.'], ['errorCode' => 'Lindorm.Errorcode.OperationDenied', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => 'You are not authorized to manage the specified resource.'], ['errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'errorMessage' => 'No permission to create service linked role.', 'description' => 'You are not authorized to create the service-linked role.'], ['errorCode' => 'Instance.NotActive', 'errorMessage' => 'Instance is not active.', 'description' => 'Instance status is not running'], ['errorCode' => 'OperationDenied.OrderProcessing', 'errorMessage' => 'Order in process, please try again later.', 'description' => 'Order in process, please try again later.'], ], ], 'title' => 'UpgradeLindormInstance', 'description' => 'For information about how to select the data engine and storage type for a Lindorm instance, see [Select a data engine](~~174643~~) and [Select a storage type](~~181971~~).', 'requestParamsDescription' => '## UpgradeType parameter'."\n" ."\n" .'When you specify the upgrade type for an instance with the `UpgradeType` parameter in the `UpgradeLindormInstance` operation, you must also set the required parameters to the new specifications. For more information, see the following table.'."\n" ."\n" .'| UpgradeType parameter | Type | Required parameters | Description |'."\n" .'| -------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| `upgrade-cold-storage` | String | `ColdStorage` | Enables or expands cold storage. |'."\n" .'| `upgrade-disk-size` | String | `ClusterStorage` | Expands the capacity of cloud disks. |'."\n" .'| `open-search-engine` | String | **Instance with local disks**: `SolrNum`
**Instance with cloud disks**: `SolrNum`, `SolrSpec`, and `ClusterStorage` | Enables the search engine. |'."\n" .'| `upgrade-search-engine` | String | `SolrSpec` | Upgrades the search engine specification. **Note:** This upgrade type is not supported for an instance with local disks. |'."\n" .'| `upgrade-search-core-num` | String | `SolrNum` and `ClusterStorage` | Changes the number of search engine nodes. |'."\n" .'| `open-lindorm-engine` | String | **Instance with local disks**: `LindormNum`
**Instance with cloud disks**: `LindormNum`, `LindormSpec`, and `ClusterStorage` | Enables the wide-column engine. |'."\n" .'| `upgrade-lindorm-engine` | String | `LindormSpec` | Upgrades the wide-column engine specification. **Note:** This upgrade type is not supported for an instance with local disks. |'."\n" .'| `upgrade-lindorm-core-num` | String | `LindormNum` and `ClusterStorage` | Changes the number of wide-column engine nodes. |'."\n" .'| `open-tsdb-engine` | String | `TsdbSpec`, `TsdbNum`, and `ClusterStorage` | Enables the TSDB engine. |'."\n" .'| `upgrade-tsdb-engine` | String | `TsdbSpec` | Upgrades the TSDB engine specification. **Note:** This upgrade type is not supported for an instance with local disks. |'."\n" .'| `upgrade-tsdb-core-num` | String | `TsdbNum` and `ClusterStorage` | Changes the number of TSDB engine nodes. |'."\n" .'| `open-stream-engine` | String | `StreamSpec`, `StreamNum`, and `ClusterStorage` | Enables the stream engine. |'."\n" .'| `upgrade-stream-engine` | String | `StreamSpec` | Upgrades the stream engine specification. **Note:** This upgrade type is not supported for an instance with local disks. |'."\n" .'| `upgrade-stream-core-num` | String | `StreamNum` and `ClusterStorage` | Changes the number of stream engine nodes. |'."\n" .'| `upgrade-file-engine` | String | `FilestoreSpec` | Upgrades the file engine specification. **Note:** This upgrade type is not supported for an instance with local disks. |'."\n" .'| `upgrade-file-core-num` | String | `FilestoreNum` | Changes the number of file engine nodes. |'."\n" .'| `open-bds-transfer` | String | **Instance with local disks**: `LtsCoreNum`, `LtsCoreSpec`, and `SolrNum`
**Instance with cloud disks**: `LtsCoreNum`, `LtsCoreSpec`, `SolrNum`, and `SolrSpec` | Enables the BDS (LTS) engine and the search engine. |'."\n" .'| `upgrade-bds-transfer` | String | `LtsCoreSpec` | Upgrades the BDS (LTS) engine specification. |'."\n" .'| `upgrade-bds-core-num` | String | `LtsCoreNum` | Changes the number of BDS (LTS) engine nodes. |'."\n" .'| `open-bds-transfer-only` | String | `LtsCoreNum` and `LtsCoreSpec` | Enables the BDS (LTS) engine on an instance that already has the search engine enabled. |'."\n" ."\n" .'For a multi-AZ instance, see the following table.'."\n" ."\n" .'| UpgradeType parameter | Type | Required parameters | Description |'."\n" .'| -------------------------- | ------ | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| `upgrade-disk-size` | String | `CoreSingleStorage` and `LogSingleStorage` | Expands the disk capacity per core node or per log node. |'."\n" .'| `upgrade-lindorm-engine` | String | `LindormSpec` and `LogSpec` | Upgrades the specification of core nodes or log nodes. **Note:** This upgrade type is not supported for an instance with local disks. |'."\n" .'| `upgrade-lindorm-core-num` | String | `LindormNum` and `LogNum` | Changes the number of core nodes or log nodes. |', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:UpgradeLindormInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'Instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": 111111111111111,\\n \\"RequestId\\": \\"2A7D4F9D-AA26-4E15-A2B1-3E4792C6****\\"\\n}","type":"json"}]', ], ], 'endpoints' => [ ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hitsdb.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'hitsdb.cn-wulanchabu.aliyuncs.com', 'vpc' => 'hitsdb-vpc.cn-wulanchabu.aliyuncs.com'], ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hitsdb.cn-beijing.aliyuncs.com', 'endpoint' => 'hitsdb.cn-beijing.aliyuncs.com', 'vpc' => 'hitsdb-vpc.cn-beijing.aliyuncs.com'], ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hitsdb.cn-qingdao.aliyuncs.com', 'endpoint' => 'hitsdb.cn-qingdao.aliyuncs.com', 'vpc' => 'hitsdb-vpc.cn-qingdao.aliyuncs.com'], ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hitsdb.cn-shanghai.aliyuncs.com', 'endpoint' => 'hitsdb.cn-shanghai.aliyuncs.com', 'vpc' => 'hitsdb-vpc.cn-shanghai.aliyuncs.com'], ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hitsdb.cn-hongkong.aliyuncs.com', 'endpoint' => 'hitsdb.cn-hongkong.aliyuncs.com', 'vpc' => 'hitsdb-vpc.cn-hongkong.aliyuncs.com'], ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hitsdb.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'hitsdb.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'hitsdb-vpc.cn-zhangjiakou.aliyuncs.com'], ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hitsdb.cn-shenzhen.aliyuncs.com', 'endpoint' => 'hitsdb.cn-shenzhen.aliyuncs.com', 'vpc' => 'hitsdb-vpc.cn-shenzhen.aliyuncs.com'], ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hitsdb.ap-northeast-1.aliyuncs.com', 'endpoint' => 'hitsdb.ap-northeast-1.aliyuncs.com', 'vpc' => 'hitsdb-vpc.ap-northeast-1.aliyuncs.com'], ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hitsdb.cn-chengdu.aliyuncs.com', 'endpoint' => 'hitsdb.cn-chengdu.aliyuncs.com', 'vpc' => 'hitsdb-vpc.cn-chengdu.aliyuncs.com'], ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hitsdb.ap-southeast-1.aliyuncs.com', 'endpoint' => 'hitsdb.ap-southeast-1.aliyuncs.com', 'vpc' => 'hitsdb-vpc.ap-southeast-1.aliyuncs.com'], ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hitsdb.ap-southeast-3.aliyuncs.com', 'endpoint' => 'hitsdb.ap-southeast-3.aliyuncs.com', 'vpc' => 'hitsdb-vpc.ap-southeast-3.aliyuncs.com'], ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hitsdb.cn-huhehaote.aliyuncs.com', 'endpoint' => 'hitsdb.cn-huhehaote.aliyuncs.com', 'vpc' => 'hitsdb-vpc.cn-huhehaote.aliyuncs.com'], ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hitsdb.ap-southeast-5.aliyuncs.com', 'endpoint' => 'hitsdb.ap-southeast-5.aliyuncs.com', 'vpc' => 'hitsdb-vpc.ap-southeast-5.aliyuncs.com'], ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hitsdb.cn-hangzhou.aliyuncs.com', 'endpoint' => 'hitsdb.cn-hangzhou.aliyuncs.com', 'vpc' => 'hitsdb-vpc.cn-hangzhou.aliyuncs.com'], ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'hitsdb.us-east-1.aliyuncs.com', 'endpoint' => 'hitsdb.us-east-1.aliyuncs.com', 'vpc' => 'hitsdb-vpc.us-east-1.aliyuncs.com'], ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'hitsdb.eu-west-1.aliyuncs.com', 'endpoint' => 'hitsdb.eu-west-1.aliyuncs.com', 'vpc' => 'hitsdb-vpc.eu-west-1.aliyuncs.com'], ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'hitsdb.us-west-1.aliyuncs.com', 'endpoint' => 'hitsdb.us-west-1.aliyuncs.com', 'vpc' => 'hitsdb-vpc.us-west-1.aliyuncs.com'], ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'hitsdb.eu-central-1.aliyuncs.com', 'endpoint' => 'hitsdb.eu-central-1.aliyuncs.com', 'vpc' => 'hitsdb-vpc.eu-central-1.aliyuncs.com'], ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'hitsdb.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'hitsdb.cn-hangzhou-finance.aliyuncs.com', 'vpc' => 'hitsdb-vpc.cn-hangzhou-finance.aliyuncs.com'], ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'hitsdb.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'hitsdb.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'hitsdb-vpc.cn-shenzhen-finance-1.aliyuncs.com'], ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'hitsdb.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'hitsdb.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'hitsdb-vpc.cn-shanghai-finance-1.aliyuncs.com'], ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'hitsdb.cn-north-2-gov-1.aliyuncs.com', 'endpoint' => 'hitsdb.cn-north-2-gov-1.aliyuncs.com', 'vpc' => 'hitsdb-vpc.cn-north-2-gov-1.aliyuncs.com'], ], 'errorCodes' => [ ['code' => 'API.Forbidden', 'message' => 'The API operation is forbidden in this environment.', 'http_code' => 403, 'description' => 'This operation is not supported in the current environment.'], ['code' => 'ChargeType.IsNotValid', 'message' => 'The charge type is invalid.', 'http_code' => 400, 'description' => 'The specified charge type is invalid.'], ['code' => 'CloudDiskNodes.less', 'message' => 'Nodes too less, please ensure that the number of engine nodes is more than %s', 'http_code' => 400, 'description' => ''], ['code' => 'Commodity.NotFound', 'message' => 'The commodity is not found.', 'http_code' => 400, 'description' => 'The specified commodity is not found.'], ['code' => 'Commodity.NotFound', 'message' => 'Failed to obtain the commodity code, it may be that the current interface does not support the creation of this type of instance.', 'http_code' => 404, 'description' => 'Failed to obtain the commodity code, it may be that the current interface does not support the creation of this type of instance.'], ['code' => 'CurrentEngineType.ClassChangingNotSupported', 'message' => 'The current engine type does not support class changing.', 'http_code' => 400, 'description' => 'The current engine type does not support node specification changes.'], ['code' => 'Forbidden', 'message' => 'User not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => ''], ['code' => 'Instance.DoesNotSupportShrinkStorage', 'message' => 'Storage scale in is not supported.', 'http_code' => 400, 'description' => 'The storage capacity of the instance cannot be reduced.'], ['code' => 'Instance.IsDeleted', 'message' => 'The instance is deleted.', 'http_code' => 400, 'description' => 'The specified instance is already deleted.'], ['code' => 'Instance.IsModifyingClass', 'message' => 'The instance class is being modified and cannot be operated.', 'http_code' => 400, 'description' => 'The node specifications are being modified. Please try again later.'], ['code' => 'Instance.IsNotAvailable', 'message' => 'The instance is unavailable.', 'http_code' => 400, 'description' => 'The specified instance is unavailable.'], ['code' => 'Instance.IsNotPostPay', 'message' => 'The instance billing type is not subscription.', 'http_code' => 400, 'description' => 'This operation is not supported for subscription instances.'], ['code' => 'Instance.IsNotPostPay', 'message' => 'The instance billing type is not pay as you go.', 'http_code' => 400, 'description' => ''], ['code' => 'Instance.IsNotValid', 'message' => 'The instance is invalid.', 'http_code' => 400, 'description' => 'The specified instance is invalid.'], ['code' => 'Instance.NotActive', 'message' => 'Instance is not active.', 'http_code' => 403, 'description' => 'Instance status is not running'], ['code' => 'Instance.RestartError', 'message' => 'An error occurred while restarting the instance.', 'http_code' => 400, 'description' => 'An error occurred while restarting the instance. Please try again later.'], ['code' => 'Instance.SpecIsNotValid', 'message' => 'The instance specification is invalid.', 'http_code' => 400, 'description' => 'The node specification parameter is invalid. Specify valid node specifications.'], ['code' => 'Instance.Upgrade.ParamsIsNotValid', 'message' => 'The instance upgrade parameters are invalid.', 'http_code' => 400, 'description' => 'The instance upgrade parameters are invalid.'], ['code' => 'Instance.Upgrade.ParamsIsNotValid', 'message' => 'The instance upgrade parameters are invalid.', 'http_code' => 400, 'description' => 'The instance upgrade parameters are invalid.'], ['code' => 'InstanceConfig.NotChanged', 'message' => 'The upgrade or downgrade configuration is not changed, please check.', 'http_code' => 400, 'description' => 'The upgrade or downgrade configuration is not changed, please check.'], ['code' => 'Lindorm.Errorcode.Commodity.NotFound', 'message' => 'The specified commodity is not found.', 'http_code' => 404, 'description' => ''], ['code' => 'Lindorm.Errorcode.Duplicate.TagKey', 'message' => 'The Tag.N.Key contains duplicate keys.', 'http_code' => 400, 'description' => ''], ['code' => 'Lindorm.Errorcode.InstanceNotFound', 'message' => 'The instance is not found.', 'http_code' => 404, 'description' => 'The specified instance does not exist.'], ['code' => 'Lindorm.Errorcode.InstanceStorageInvalid', 'message' => 'The instance storage parameter is invalid: %s', 'http_code' => 400, 'description' => 'The storage parameter is invalid. Specify a valid storage capacity.'], ['code' => 'Lindorm.Errorcode.InvalidParameter.TagKey', 'message' => 'The Tag.N.Key parameter is invalid.', 'http_code' => 400, 'description' => ''], ['code' => 'Lindorm.Errorcode.InvalidParameter.TagValue', 'message' => 'The Tag.N.Value parameter is invalid.', 'http_code' => 400, 'description' => ''], ['code' => 'Lindorm.Errorcode.InvalidResourceId', 'message' => 'The specified ResourceIds are not found in our records.', 'http_code' => 404, 'description' => ''], ['code' => 'Lindorm.Errorcode.InvalidResourceId.NotFound', 'message' => 'The specified ResourceIds are not found in our records.', 'http_code' => 400, 'description' => ''], ['code' => 'Lindorm.Errorcode.InvalidTagKey.Malformed', 'message' => 'The Tag.N.Key parameter is invalid.', 'http_code' => 400, 'description' => ''], ['code' => 'Lindorm.Errorcode.MissingParameter', 'message' => 'You must specify ResourceId.N or Tags', 'http_code' => 400, 'description' => ''], ['code' => 'Lindorm.Errorcode.MissingParameter.TagKey', 'message' => 'You must specify Tag.N.Key.', 'http_code' => 404, 'description' => ''], ['code' => 'Lindorm.Errorcode.NotSupportChange', 'message' => 'Does not support change class', 'http_code' => 400, 'description' => ''], ['code' => 'Lindorm.Errorcode.NumberExceed.ResourceIds', 'message' => 'The ResourceIds parameter is number is exceed', 'http_code' => 400, 'description' => ''], ['code' => 'Lindorm.Errorcode.NumberExceed.ResourceIds', 'message' => 'The maximum number of ResourceIds is exceeded.', 'http_code' => 400, 'description' => ''], ['code' => 'Lindorm.Errorcode.NumberExceed.Tags', 'message' => 'The maximum number of Tags is exceeded.', 'http_code' => 400, 'description' => ''], ['code' => 'Lindorm.Errorcode.OperationDenied', 'message' => 'You are not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => 'You are not authorized to manage the specified resource.'], ['code' => 'Lindorm.Errorcode.ParameterInvaild', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => 'The specified parameter is invalid.'], ['code' => 'Lindorm.Errorcode.ParameterInvaild.TagKeysOrDeleteAll', 'message' => 'The TagKeys or DeleteAll parameter is invalid.', 'http_code' => 400, 'description' => ''], ['code' => 'Lindorm.Errorcode.ParameterInvalid', 'message' => 'The parameter is invalid.', 'http_code' => 401, 'description' => 'The operation failed. The specified parameter is invalid. Configure a valid parameter and try again.'], ['code' => 'Lindorm.Errorcode.QuotaExceed.TagsPerResource', 'message' => 'The maximum number of tags for each resource is exceeded', 'http_code' => 400, 'description' => ''], ['code' => 'Lindorm.Errorcode.ResourceNotReady', 'message' => 'Insufficient computing resources in this region. Please submit a ticket.', 'http_code' => 404, 'description' => ''], ['code' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', 'message' => 'No permission to create service linked role.', 'http_code' => 403, 'description' => 'You are not authorized to create the service-linked role.'], ['code' => 'Lindorm.Errorcode.SystemError', 'message' => 'Internal Error', 'http_code' => 500, 'description' => ''], ['code' => 'Lindorm.Errorcode.Tags.ExceedLimitation', 'message' => 'The maximum number of Tags is exceeded.', 'http_code' => 400, 'description' => ''], ['code' => 'Lindorm.ErrorCode.WeakPassword', 'message' => 'Your current password is weak. For better security, please use a strong password that includes a mix of uppercase letters, lowercase letters, numbers, and special characters, and is at least 8 characters long.', 'http_code' => 400, 'description' => 'Your current password is weak. For better security, please use a strong password that includes a mix of uppercase letters, lowercase letters, numbers, and special characters, and is at least 8 characters long.'], ['code' => 'LindormErrorCode.%s', 'message' => '%s.', 'http_code' => 400, 'description' => '%s.'], ['code' => 'MinorVersion.TooLow', 'message' => 'The minor version is too low. Please upgrade.', 'http_code' => 403, 'description' => 'The minor version is an earlier one. Update the minor version.'], ['code' => 'ModifySecurityIpList.AddAclGetNull', 'message' => 'Failed to add access control list.', 'http_code' => 400, 'description' => 'Failed to add the ACL. Check the specified parameters.'], ['code' => 'ModifySecurityIpList.CreateAclGetNull', 'message' => 'Failed to create access control list.', 'http_code' => 400, 'description' => 'Failed to create access control list.'], ['code' => 'ModifySecurityIpList.CreateAclGetNull', 'message' => 'Failed to create access control list.', 'http_code' => 400, 'description' => 'Failed to create the ACL. Check the specified parameters.'], ['code' => 'ModifySecurityIpList.DescribeAclFailed', 'message' => 'Failed to describe access control list.', 'http_code' => 400, 'description' => 'Failed to query the ACL. Check the specified parameters.'], ['code' => 'ModifySecurityIpList.LoadBalancerSizeAbnormal', 'message' => 'The number of load balancers is abnormal.', 'http_code' => 400, 'description' => 'The number of SLB instances is invalid. Specify a valid value.'], ['code' => 'ModifySecurityIpList.QueryIngressFailed', 'message' => 'Failed to query SLB ingress.', 'http_code' => 400, 'description' => 'Failed to query the SLB ingress. Check the specified parameters.'], ['code' => 'ModifySecurityIpList.QueryLoadBalancersFailed', 'message' => 'Failed to query load balancers.', 'http_code' => 400, 'description' => 'Failed to query the SLB information. Check the specified parameters.'], ['code' => 'ModifySecurityIpList.RemoveAclFailed', 'message' => 'Failed to remove access control list.', 'http_code' => 400, 'description' => 'Failed to delete the ACL. Check the specified parameters.'], ['code' => 'ModifySecurityIpList.SetLBTcpListenerFailed', 'message' => 'Failed to set load balancer TCP listener attribute.', 'http_code' => 400, 'description' => 'Failed to configure the TCP listener for SLB. Check the specified parameters.'], ['code' => 'OperationDenied.OrderProcessing', 'message' => 'Order in process, please try again later.', 'http_code' => 403, 'description' => 'Order in process, please try again later.'], ['code' => 'Order.CreateFailed', 'message' => 'Failed to create the order.', 'http_code' => 400, 'description' => 'Failed to create the order. Select order information again.'], ['code' => 'SecurityGroup.DescribeFailed', 'message' => 'Failed to query instance security groups.', 'http_code' => 400, 'description' => 'Failed to query the security group. Enter a security group again.'], ['code' => 'SecurityGroup.UpdateFailed', 'message' => 'Failed to update instance security groups.', 'http_code' => 400, 'description' => 'Failed to add the security group. Select a security group again.'], ['code' => 'TSDB.Errorcode.InstanceClassAndEngineTypeMismatch', 'message' => 'The engine type and instance class parameters do not match. Instance class will take precedence.', 'http_code' => 411, 'description' => 'The engine type and node specification parameters do not match. The node specification parameter takes precedence on this operation.'], ['code' => 'TSDB.Errorcode.InstanceClassInvalid', 'message' => 'The parameter of InstanceClass is invalid.', 'http_code' => 410, 'description' => 'The node specification parameter is invalid. Specify valid node specifications.'], ['code' => 'TSDB.Errorcode.InstanceCreateFailed', 'message' => 'Failed to create the instance.', 'http_code' => 414, 'description' => 'Failed to create the instance.'], ['code' => 'TSDB.Errorcode.InstanceCreateRetrying', 'message' => 'The system is trying to create the instance again.', 'http_code' => 415, 'description' => 'Failed to create the instance. The system is trying to create the instance again.'], ['code' => 'TSDB.Errorcode.InstanceDeleted', 'message' => 'The instance is already deleted.', 'http_code' => 416, 'description' => 'The specified instance is already deleted.'], ['code' => 'TSDB.Errorcode.InstanceNotFound', 'message' => 'The instance is not found', 'http_code' => 404, 'description' => 'The specified instance does not exist.'], ['code' => 'TSDB.Errorcode.InstanceNotFound', 'message' => 'The instance is not found. Please try again later.', 'http_code' => 413, 'description' => 'The specified instance does not exist.'], ['code' => 'TSDB.Errorcode.InstanceStorageInvalid', 'message' => 'The parameter of instance storage is invalid.', 'http_code' => 412, 'description' => 'The storage parameter is invalid. Specify a valid storage capacity.'], ['code' => 'TSDB.Errorcode.ParameterInvaild', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => 'The specified parameter is invalid.'], ['code' => 'UnsupportedServiceType', 'message' => 'The instance service type is not supported.', 'http_code' => 403, 'description' => 'This operation is not supported for the available engine types.'], ['code' => 'VisitInstance.ApiNotSupported', 'message' => 'Action failed. Your instance version is too old.', 'http_code' => 400, 'description' => 'The minor version is an earlier one. Update the minor version.'], ['code' => 'VisitInstance.Failed', 'message' => 'Failed to connect the instance. Please contact our customer service.', 'http_code' => 503, 'description' => 'Failed to connect to the instance. Please submit a ticket.'], ['code' => 'VisitInstance.Timeout', 'message' => 'Timed out connecting the instance. Please check if any time-consuming task was submitted, or contact our customer service.', 'http_code' => 500, 'description' => 'The connection to the instance timed out. Check whether a time-consuming task is being executed or submit a ticket.'], ['code' => 'InvalidDBInstance.NotFound', 'message' => 'Specified instance does not exist or not support.', 'http_code' => 404, 'description' => 'The instance does not exist or does not support the operation.'], ['code' => 'IncorrectDBState', 'message' => 'Can not do this operation, because instance status is not ACTIVATION.', 'http_code' => 403, 'description' => 'The current operation is not allowed because the instance state is not running.'], ['code' => 'Instance.DeleteProtection', 'message' => 'Instance deletion is protected. Please disable delete protection before deleting the instance.', 'http_code' => 400, 'description' => 'If the instance has deletion protection enabled, disable deletion protection before deleting the instance.'], ['code' => 'Resource.ecsResource.closeSale', 'message' => 'This region is currently closed for sale.', 'http_code' => 400, 'description' => 'Instance sales have been disabled in the current region. We recommend selecting another region to create an instance. If you need assistance, please contact technical support.'], ['code' => 'WhiteIpInUpdating', 'message' => 'Instance is updating whiteIp now, please wait.', 'http_code' => 400, 'description' => 'Please wait while the instance whitelist is updated.'], ['code' => 'ScalingRule.ExecutionTimeConflict', 'message' => 'The execution times of the scaling rules conflict.', 'http_code' => 400, 'description' => 'There is a conflict in the execution time of the scheduled tasks.'], ['code' => 'Ranger.NotEnabled', 'message' => 'For your data security, please enable Ranger service before switching public network.', 'http_code' => 403, 'description' => 'For your data security, please enable Ranger service before switching public network.'], ], 'changeSet' => [ [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'GetLindormInstance'], ['description' => 'Error codes changed', 'api' => 'CreateLindormInstance'], ], 'createdAt' => '2025-06-04T12:13:27.000Z', 'description' => '', ], ], 'ram' => [ 'productCode' => 'Lindorm', 'productName' => 'Lindorm', 'ramCodes' => ['lindorm'], 'ramLevel' => 'RESOURCE', 'ramConditions' => [], 'ramActions' => [ [ 'apiName' => 'GetLindormFsUsedDetail', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'lindorm:GetLindormFsUsedDetail', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateLindormV2Instance', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'lindorm:CreateLindormV2Instance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetLindormV2InstanceDetails', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'lindorm:GetLindormV2InstanceDetails', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpgradeLindormInstance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:UpgradeLindormInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'Instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'CreateLindormInstance', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'lindorm:CreateLindormInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateLindormV2Instance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:UpdateLindormV2Instance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UntagResources', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:UntagResources', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'Instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'GetInstanceSummary', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'lindorm:GetInstanceSummary', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetInstanceIpWhiteList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'lindorm:GetInstanceIpWhiteList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'ModifyInstancePayType', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:ModifyInstancePayType', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetLindormInstanceList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'lindorm:GetLindormInstanceList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'Instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'SwitchLSQLV3MySQLService', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:SwitchLSQLV3MySQLService', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateLindormInstanceAttribute', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:UpdateLindormInstanceAttribute', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'Instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'UpdateLindormV2WhiteIpList', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'lindorm:UpdateLindormV2WhiteIpList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListTagResources', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'lindorm:ListTagResources', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateInstanceIpWhiteList', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:UpdateInstanceIpWhiteList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'GetLindormInstance', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'lindorm:GetLindormInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ChangeResourceGroup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:ChangeResourceGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'Instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'ReleaseLindormV2Instance', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'lindorm:ReleaseLindormV2Instance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'Instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'GetLindormInstanceEngineList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'lindorm:GetLindormInstanceEngineList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'RenewLindormInstance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:RenewLindormInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetLindormV2StorageUsage', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'lindorm:GetLindormV2StorageUsage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ReleaseLindormInstance', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'lindorm:ReleaseLindormInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'Instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'TagResources', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'lindorm:TagResources', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Lindorm', 'resourceType' => 'Instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], 'resourceTypes' => [ ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/*'], ['validationType' => 'always', 'resourceType' => 'VSwitch', 'arn' => 'acs:vpc:{#regionId}:{#accountId}:vswitch/*'], ['validationType' => 'conditional', 'resourceType' => 'Instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}'], ['validationType' => 'always', 'resourceType' => 'instance', 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#instanceId}'], ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:lindorm:{#Region}:{#AccountId}:instance/{#InstanceId}'], ], ], ];