diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/hitsdb | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/hitsdb')
| -rw-r--r-- | data/en_us/hitsdb/2017-06-01/api-docs.php | 3111 | ||||
| -rw-r--r-- | data/en_us/hitsdb/2020-06-15/api-docs.php | 8689 |
2 files changed, 11800 insertions, 0 deletions
diff --git a/data/en_us/hitsdb/2017-06-01/api-docs.php b/data/en_us/hitsdb/2017-06-01/api-docs.php new file mode 100644 index 0000000..e05fd9b --- /dev/null +++ b/data/en_us/hitsdb/2017-06-01/api-docs.php @@ -0,0 +1,3111 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'hitsdb', + 'version' => '2017-06-01', + ], + 'directories' => [ + 'CreateHiTSDBInstance', + 'DeleteHiTSDBInstance', + 'DescribeHiTSDBInstance', + 'DescribeHiTSDBInstanceList', + 'DescribeHiTSDBInstanceSecurityIpList', + 'DescribeRegions', + 'DescribeZones', + 'ModifyHiTSDBInstanceClass', + 'ModifyHiTSDBInstanceSecurityIpList', + 'RenameHiTSDBInstanceAlias', + 'RenewTSDBInstance', + 'RestartHiTSDBInstance', + 'SwitchHiTSDBInstancePublicNet', + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateHiTSDBInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '75169', + 'abilityTreeNodes' => [ + 'FEATUREhitsdbUE1KPV', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'docRequired' => true, + 'example' => 'cn-shanghai', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'AppKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the zone in which you want to create the instance.'."\n", + 'example' => 'None', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the instance .'."\n", + 'docRequired' => true, + 'example' => 'cn-shanghai-b', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'InstanceAlias', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the instance.'."\n", + 'docRequired' => false, + 'example' => 'tsdb_test', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage capacity of the instance. Unit: GB.'."\n", + 'docRequired' => true, + 'example' => 'tsdb.1x.basic', + 'required' => true, + 'type' => 'string', + 'enum' => [ + 'influxdata.n1.xlarge', + 'influxdata.n1.2xlarge', + 'influxdata.n1.4xlarge', + 'influxdata.n1.8xlarge', + 'influxdata.n1.16xlarge', + 'influxdata.n1.mxlarge', + 'influxdata.n1.xlarge_ha', + 'influxdata.n1.2xlarge_ha', + 'influxdata.n1.4xlarge_ha', + 'influxdata.n1.8xlarge_ha', + 'influxdata.n1.16xlarge_ha', + 'influxdata.n1.mxlarge_ha', + 'tsdb.1x.basic', + 'tsdb.3x.basic', + 'tsdb.4x.basic', + 'tsdb.12x.standard', + 'tsdb.24x.standard', + 'tsdb.48x.large', + 'tsdb.96x.large', + 'tsdb.iot.1x.small', + ], + ], + ], + [ + 'name' => 'InstanceStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'* PREPAY: subscription'."\n" + .'* POSTPAY: pay-as-you-go'."\n", + 'docRequired' => true, + 'example' => '50', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the VPC in which the instances reside.'."\n", + 'docRequired' => true, + 'example' => 'PREPAY', + 'required' => true, + 'type' => 'string', + 'enum' => [ + 'POSTPAY', + 'PREPAY', + ], + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch to which the instance connects to.'."\n", + 'docRequired' => true, + 'example' => 'vpc-wz9ydz3vg93s1ozsd****', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unit of the subscription duration of the instance. Valid values:'."\n" + ."\n" + .'* Month'."\n" + .'* Year'."\n", + 'docRequired' => true, + 'example' => 'vsw-wz9kv78f9cp47yadu****', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subscription duration of the instance.'."\n" + ."\n" + .'* If PricingCycle is set to Month, set this parameter to an integer that ranges from 1 to 9.'."\n" + .'* If PricingCycle is set to Year, set this parameter to an integer that ranges from 1 to 3.'."\n", + 'example' => 'Month', + 'required' => false, + 'type' => 'string', + 'enum' => [ + 'Month', + 'Year', + ], + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The disk type of TSDB for InfluxDB️®️.'."\n" + ."\n" + .'* cloud_efficiency: ultra disk'."\n" + .'* cloud_ssd: standard SSD.'."\n" + .'* cloud_essd: ESSD cloud_auto: ESSD AutoPL disk'."\n", + 'example' => '1', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'DiskCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the request.'."\n", + 'example' => 'cloud_ssd', + 'required' => false, + 'type' => 'string', + 'enum' => [ + 'cloud_essd', + 'cloud_ssd', + 'cloud_efficiency', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the instance.'."\n", + 'example' => '587BCA54-50DA-4885-ADE9-80A848339151', + 'type' => 'string', + ], + 'InstanceId' => [ + 'description' => 'The ID of the order.'."\n", + 'example' => 'ts-wz99vz6u8jg39****', + 'type' => 'string', + ], + 'OrderId' => [ + 'description' => 'Creates a Time Series Database (TSDB) instance.'."\n", + 'example' => '211110656240000', + 'format' => 'int64', + 'type' => 'integer', + ], + ], + 'type' => 'object', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'TSDB.Errorcode.ParameterInvaild', + 'errorMessage' => 'The parameter is invalid.', + 'description' => '', + ], + ], + 404 => [ + [ + 'errorCode' => 'TSDB.Errorcode.InstanceNotFound', + 'errorMessage' => 'The instance is not found', + 'description' => '', + ], + ], + 411 => [ + [ + 'errorCode' => 'TSDB.Errorcode.InstanceClassAndEngineTypeMismatch', + 'errorMessage' => 'The engine type and instance class parameters do not match. Instance class will take precedence.', + 'description' => '', + ], + ], + [ + [ + 'errorCode' => 'TSDB.Errorcode.InstanceStorageInvalid', + 'errorMessage' => 'The parameter of instance storage is invalid.', + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"587BCA54-50DA-4885-ADE9-80A848339151\\",\\n \\"InstanceId\\": \\"ts-wz99vz6u8jg39****\\",\\n \\"OrderId\\": 211110656240000\\n}","errorExample":""},{"type":"xml","example":"<CreateHiTSDBInstance>\\n<RequestId>587BCA54-50DA-4885-ADE9-80A848339151</RequestId>\\n<InstanceId>ts-wz99vz6u8jg39****</InstanceId>\\n<OrderId>211110656240000</OrderId>\\n</CreateHiTSDBInstance>","errorExample":""}]', + 'extraInfo' => ' ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'summary' => 'Creates a Time Series Database (TSDB) instance.', + 'title' => 'CreateHiTSDBInstance', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'hitsdb:CreateHiTSDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DeleteHiTSDBInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '75170', + 'abilityTreeNodes' => [ + 'FEATUREhitsdbUE1KPV', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ts-ufxxxxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1556DCB0-043A-4444-8BD9-CF4A68E7EE64', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The detailed reason why the access was denied.'."\n", + 'type' => 'string', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Instance.IsNotPostPay', + 'errorMessage' => 'The instance billing type is not subscription.', + 'description' => '', + ], + [ + 'errorCode' => 'Instance.IsNotAvailable', + 'errorMessage' => 'The instance is unavailable.', + 'description' => '', + ], + [ + 'errorCode' => 'Instance.IsNotValid', + 'errorMessage' => 'The instance is invalid.', + '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.ServiceLinkedRoleNoPermission', + 'errorMessage' => 'No permission to create service linked role.', + 'description' => 'You are not authorized to create the service-linked role.', + ], + [ + '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.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<DeleteHiTSDBInstanceResponse>\\r\\n <RequestId>1556DCB0-043A-4444-8BD9-CF4A68E7EE64</RequestId>\\r\\n</DeleteHiTSDBInstanceResponse>","errorExample":""}]', + 'title' => 'DeleteHiTSDBInstance', + 'summary' => 'Deletes a Time Series Database (TSDB) instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'translator' => 'machine', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'hitsdb:DeleteHiTSDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'instance', + 'arn' => 'acs:hitsdb:{#regionId}:{#accountId}:instance/{#instanceId}', + ], + ], + ], + ], + ], + ], + 'DescribeHiTSDBInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ts-ufxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the instance. Valid values: ACTIVATION, CREATING, NET_CREATING, CLASS_CHANGING, LOCKED, and DELETED. ACTIVATION indicates that the instance is running. CREATING indicates that the instance is being created. NET_CREATING indicates that a network connection to the instance is being created. CLASS_CHANGING indicates that the configuration of the instance is being modified. LOCKED indicates that the instance is locked. DELETED indicates that the instance is deleted.'."\n", + 'type' => 'string', + 'example' => 'ACTIVATION', + ], + 'VpcId' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-xxxxxxxxxxxxxxxxxxxxx', + ], + 'PaymentType' => [ + 'description' => 'The billing method of the instance. Valid values: PREPAY and POSTPAY. The PREPAY value indicates the subscription billing method. The POSTPAY value indicates the pay-as-you-go billing method.'."\n", + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'VswitchId' => [ + 'description' => 'The ID of the vSwitch to which the instance connects.'."\n", + 'type' => 'string', + 'example' => 'vsw-xxxxxxxxxxxxxxxxxxxxx', + ], + 'CreateTime' => [ + 'description' => 'The timestamp when the instance is created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1603426323000', + ], + 'MemSize' => [ + 'description' => 'The memory size of the instance. This parameter is returned only if the instance is a TSDB for InfluxDB®️ instance.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'CpuNumber' => [ + 'description' => 'The number of CPU cores of the instance.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'ChargeType' => [ + 'description' => 'The billing method of the instance. Valid values: PREPAY and POSTPAY. The PREPAY value indicates the subscription billing method. The POSTPAY value indicates the pay-as-you-go billing method.'."\n", + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'PublicConnectionString' => [ + 'description' => 'The public endpoint of the instance. You can use the public endpoint to access the instance over the Internet.'."\n", + 'type' => 'string', + 'example' => 'ts-xxxxxxxxxxxxxxxxx.influxdata.rds.aliyuncs.com:3242', + ], + 'NetworkType' => [ + 'description' => 'The network type of the instance.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'MaxTimelineLimit' => [ + 'description' => 'The number of time series supported by the instance. This parameter is returned only if the instance is a TSDB instance.'."\n", + 'type' => 'string', + 'example' => '2400000', + ], + 'DiskCategory' => [ + 'description' => 'The disk type of the instance. For a TSDB for InfluxDB®️ instance, the valid values are cloud_efficiency and cloud_ssd. The cloud_efficiency value indicates ultra disks. The cloud_ssd value indicates standard SSDs.'."\n", + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8D156621-1FCB-414A-BD29-361C3CA4DD56', + ], + 'InstanceTps' => [ + 'description' => 'The transactions per second (TPS) of the instance. Unit: TPS.'."\n", + 'type' => 'string', + 'example' => '960000', + ], + 'ConnectionString' => [ + 'description' => 'The endpoint of the database.'."\n", + 'type' => 'string', + 'example' => 'ts-xxxxxxxxxxxxxxxxx.hitsdb.tsdb.aliyuncs.com:8242', + ], + 'GmtExpire' => [ + 'description' => 'The time when the instance expires. This parameter is returned only when the instance uses the subscription billing method. The time is in the yyyy-MM-dd HH:mm:ss format.'."\n", + 'type' => 'string', + 'example' => '2020-12-17 00:00:00', + ], + 'EngineType' => [ + 'description' => 'The engine type of the instance. Valid values: tsdb_tsdb, tsdb_influxdb, and tsdb1.5. The tsdb_tsdb value indicates the OpenTSDB engine. The tsdb_influxdb value indicates the InfluxDB®️ engine. The tsdb1.5 value indicates the tsdb1.5 engine.'."\n", + 'type' => 'string', + 'example' => 'tsdb_tsdb', + ], + 'InstanceClass' => [ + 'description' => 'The type of the instance.'."\n", + 'type' => 'string', + 'example' => 'tsdb.96x.large_lindorm', + ], + 'AutoRenew' => [ + 'description' => 'Indicates whether auto-renewal is enabled for the instance that uses the subscription billing method.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'InstanceStorage' => [ + 'description' => 'The storage capacity of the instance. Unit: GB.'."\n", + 'type' => 'string', + 'example' => '320', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'ts-xxxxxxxxxxxxxxxxx', + ], + 'InstanceDescription' => [ + 'description' => 'The description of the instance.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'RegionId' => [ + 'description' => 'The ID of the region in which the instance is located.'."\n", + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'GmtCreated' => [ + 'description' => 'The time when the instance is created. The time is in the yyyy-MM-dd HH:mm:ss format.'."\n", + 'type' => 'string', + 'example' => '2020-11-16 16:22:56', + ], + 'InstanceAlias' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'tsdb_test', + ], + 'ExpiredTime' => [ + 'description' => 'The timestamp when the instance expires. This parameter is returned only when the instance uses the subscription billing method.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1611417600000', + ], + 'ZoneId' => [ + 'description' => 'The ID of the zone in which the instance is deployed.'."\n", + 'type' => 'string', + 'example' => 'cn-shanghai-f', + ], + 'InstanceStatus' => [ + 'description' => 'The status of the instance. Valid values: ACTIVATION, CREATING, NET_CREATING, CLASS_CHANGING, LOCKED, and DELETED. ACTIVATION indicates that the instance is running. CREATING indicates that the instance is being created. NET_CREATING indicates that a network connection to the instance is being created. CLASS_CHANGING indicates that the configuration of the instance is being modified. LOCKED indicates that the instance is locked. DELETED indicates that the instance is deleted.'."\n", + 'type' => 'string', + 'example' => 'ACTIVATION', + ], + 'Series' => [ + 'description' => 'The edition of the TSDB for InfluxDB®️ instance. Valid values: 0 and 1. The 0 value indicates the Standard Edition. The 1 value indicates the High-availability Edition.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SecurityIpList' => [ + 'description' => 'The IP address whitelist of the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Ip' => [ + 'description' => 'The IP address in the whitelist of the instance.'."\n", + 'type' => 'string', + 'example' => '0.0.0.0/0', + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝的详细原因。', + 'type' => 'string', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'TSDB.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' => '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.', + ], + ], + 413 => [ + [ + 'errorCode' => 'TSDB.Errorcode.InstanceNotFound', + 'errorMessage' => 'The instance is not found. Please try again later.', + 'description' => '', + ], + ], + [ + [ + 'errorCode' => 'TSDB.Errorcode.InstanceCreateFailed', + 'errorMessage' => 'Failed to create the instance.', + 'description' => '', + ], + ], + [ + [ + 'errorCode' => 'TSDB.Errorcode.InstanceCreateRetrying', + 'errorMessage' => 'The system is trying to create the instance again.', + 'description' => '', + ], + ], + [ + [ + 'errorCode' => 'TSDB.Errorcode.InstanceDeleted', + 'errorMessage' => 'The instance is already deleted.', + 'description' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"VpcId\\": \\"vpc-xxxxxxxxxxxxxxxxxxxxx\\",\\n \\"PaymentType\\": \\"PREPAY\\",\\n \\"VswitchId\\": \\"vsw-xxxxxxxxxxxxxxxxxxxxx\\",\\n \\"CreateTime\\": 1603426323000,\\n \\"MemSize\\": \\"8\\",\\n \\"CpuNumber\\": \\"2\\",\\n \\"ChargeType\\": \\"PREPAY\\",\\n \\"PublicConnectionString\\": \\"ts-xxxxxxxxxxxxxxxxx.influxdata.rds.aliyuncs.com:3242\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"MaxTimelineLimit\\": \\"2400000\\",\\n \\"DiskCategory\\": \\"cloud_efficiency\\",\\n \\"RequestId\\": \\"8D156621-1FCB-414A-BD29-361C3CA4DD56\\",\\n \\"InstanceTps\\": \\"960000\\",\\n \\"ConnectionString\\": \\"ts-xxxxxxxxxxxxxxxxx.hitsdb.tsdb.aliyuncs.com:8242\\",\\n \\"GmtExpire\\": \\"2020-12-17 00:00:00\\",\\n \\"EngineType\\": \\"tsdb_tsdb\\",\\n \\"InstanceClass\\": \\"tsdb.96x.large_lindorm\\",\\n \\"AutoRenew\\": \\"true\\",\\n \\"InstanceStorage\\": \\"320\\",\\n \\"InstanceId\\": \\"ts-xxxxxxxxxxxxxxxxx\\",\\n \\"InstanceDescription\\": \\"test\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"GmtCreated\\": \\"2020-11-16 16:22:56\\",\\n \\"InstanceAlias\\": \\"tsdb_test\\",\\n \\"ExpiredTime\\": 1611417600000,\\n \\"ZoneId\\": \\"cn-shanghai-f\\",\\n \\"InstanceStatus\\": \\"ACTIVATION\\",\\n \\"Series\\": 1,\\n \\"SecurityIpList\\": [\\n {\\n \\"Ip\\": \\"0.0.0.0/0\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\\\"AuthAction\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"AuthPrincipalDisplayName\\\\\\":\\\\\\"222\\\\\\",\\\\\\"AuthPrincipalOwnerId\\\\\\":\\\\\\"111\\\\\\",\\\\\\"AuthPrincipalType\\\\\\":\\\\\\"SubUser\\\\\\",,\\\\\\"NoPermissionType\\\\\\":\\\\\\"ImplicitDeny\\\\\\",\\\\\\"PolicyType\\\\\\":\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\\\"EncodedDiagnosticMessage\\\\\\":\\\\\\"xxxxxx\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"<AutoRenew>true</AutoRenew>\\n<GmtCreated>2020-11-16 16:22:56</GmtCreated>\\n<CpuNumber>2</CpuNumber>\\n<MemSize>8</MemSize>\\n<GmtExpire>2020-12-17 00:00:00</GmtExpire>\\n<NetworkType>VPC</NetworkType>\\n<InstanceStatus>ACTIVATION</InstanceStatus>\\n<InstanceAlias>tsdb_test</InstanceAlias>\\n<MaxTimelineLimit>2400000</MaxTimelineLimit>\\n<EngineType>tsdb_tsdb</EngineType>\\n<PublicConnectionString>ts-xxxxxxxxxxxxxxxxx.influxdata.rds.aliyuncs.com:3242</PublicConnectionString>\\n<InstanceTps>960000</InstanceTps>\\n<InstanceStorage>320</InstanceStorage>\\n<ZoneId>cn-shanghai-f</ZoneId>\\n<RequestId>8D156621-1FCB-414A-BD29-361C3CA4DD56</RequestId>\\n<InstanceId>ts-xxxxxxxxxxxxxxxxx</InstanceId>\\n<DiskCategory>cloud_efficiency</DiskCategory>\\n<InstanceClass>tsdb.96x.large_lindorm</InstanceClass>\\n<VswitchId>vsw-xxxxxxxxxxxxxxxxxxxxx</VswitchId>\\n<Series>1</Series>\\n<VpcId>vpc-xxxxxxxxxxxxxxxxxxxxx</VpcId>\\n<ChargeType>PREPAY</ChargeType>\\n<SecurityIpList>\\n <Ip>0.0.0.0/0</Ip>\\n</SecurityIpList>\\n<InstanceDescription>test</InstanceDescription>\\n<RegionId>cn-shanghai</RegionId>\\n<ConnectionString>ts-xxxxxxxxxxxxxxxxx.hitsdb.tsdb.aliyuncs.com:8242</ConnectionString>","errorExample":""}]', + 'title' => 'DescribeHiTSDBInstance', + 'summary' => 'Queries the details about a Time Series Database (TSDB) instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hitsdb:DescribeHiTSDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DescribeHiTSDBInstanceList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '63916', + 'abilityTreeNodes' => [ + 'FEATUREhitsdbI6NK1A', + ], + ], + 'parameters' => [ + [ + 'name' => 'QueryStr', + 'in' => 'query', + 'schema' => [ + 'description' => 'The states of the instances you want to query. Specify this parameter in the JSON format. The InstanceStatus parameter enumerates the instances of the specified states.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'StatusList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["ACTIVATION", "DELETED"]', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of instances to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The engine type of the instances that you want to query. Valid values: tsdb_tsdb and tsdb_influxdb. The tsdb_tsdb value indicates the OpenTSDB engine. The tsdb_influxdb value indicates the InfluxDB®️ engine.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '30', + ], + ], + [ + 'name' => 'EngineType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tsdb_tsdb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'string', + 'example' => '0A7153E4-8354-497E-87E5-5D0EBEF5AEB1', + ], + 'PageNumber' => [ + 'description' => 'The number of instances returned on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The total number of returned instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Total' => [ + 'description' => 'The list of queried instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'InstanceList' => [ + 'description' => 'The status of the instance. Valid values: ACTIVATION, CREATING, NET_CREATING, CLASS_CHANGING, LOCKED, and DELETED. ACTIVATION: The instance is running. CREATING: The instance is being created. NET_CREATING: A network connection is being established. CLASS_CHANGING: The configuration of the instance is being modified. LOCKED: The instance is locked. DELETED: The instance is deleted.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'ACTIVATION', + ], + 'VpcId' => [ + 'description' => 'The billing method of the instance. Valid values: PREPAY and POSTPAY. The PREPAY value indicates the subscription billing method. The POSTPAY value indicates the pay-as-you-go billing method.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp1xxxxxxxxxxxxxxxxxx', + ], + 'PaymentType' => [ + 'description' => 'The maximum number of time series that can be stored in a database.'."\n", + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'MaxSeriesPerDatabase' => [ + 'description' => 'The engine type of the instance. Valid values: tsdb_tsdb and tsdb_influxdb. The tsdb_tsdb value indicates the OpenTSDB engine. The tsdb_influxdb value indicates the InfluxDB®️ engine.'."\n", + 'type' => 'string', + 'example' => '10000', + ], + 'EngineType' => [ + 'description' => 'The ID of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'tsdb_tsdb', + ], + 'VswitchId' => [ + 'description' => 'The type of the instance.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1xxxxxxxxxxxxxxxxxx', + ], + 'InstanceClass' => [ + 'description' => 'The timestamp when the instance was created.'."\n", + 'type' => 'string', + 'example' => 'tsdb.1x.basic', + ], + 'CreateTime' => [ + 'description' => 'The billing method of the instance. Valid values: PREPAY and POSTPAY. The PREPAY value indicates the subscription billing method. The POSTPAY value indicates the pay-as-you-go billing method.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1603426323000', + ], + 'ChargeType' => [ + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => 'POSTPAY', + ], + 'UserId' => [ + 'description' => 'The storage capacity of the instance. Unit: GB.'."\n", + 'type' => 'string', + 'example' => '1000000000000000', + ], + 'InstanceStorage' => [ + 'description' => 'The network type of the instance. The VPC value indicates a virtual private cloud (VPC).'."\n", + 'type' => 'string', + 'example' => '50', + ], + 'NetworkType' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'InstanceId' => [ + 'description' => 'Indicates whether the instance is locked. Valid values: 0 and 1. The value 0 indicates that the instance is not locked. The value 1 indicates that the instance is locked.'."\n", + 'type' => 'string', + 'example' => 'ts-xxxxxxxxxxxxxxxxx', + ], + 'LockMode' => [ + 'description' => 'The description of the instance.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'InstanceDescription' => [ + 'description' => 'The region ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'RegionId' => [ + 'description' => 'The time when the instance was created. The time is in the yyyy-MM-dd HH:mm:ss format.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GmtCreated' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => '2020-11-16 16:22:56', + ], + 'InstanceAlias' => [ + 'description' => 'The transactions per second (TPS) of the instance. Unit: TPS.'."\n", + 'type' => 'string', + 'example' => 'test_tsdb', + ], + 'InstanceTps' => [ + 'description' => 'The timestamp when the instance expires. This parameter is returned only when the instance uses the subscription billing method.'."\n", + 'type' => 'string', + 'example' => '960000', + ], + 'ExpiredTime' => [ + 'description' => 'The ID of the zone in which the instance is deployed.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1611417600000', + ], + 'ZoneId' => [ + 'description' => 'The state of the instance. The value of this parameter is an enumerated string.'."\n", + 'type' => 'string', + 'example' => 'cn-hongkong-b', + ], + 'InstanceStatus' => [ + 'description' => 'The time when the instance expires. This parameter is returned only when the instance uses the subscription billing method. The time is in the yyyy-MM-dd HH:mm:ss format.'."\n", + 'type' => 'string', + 'example' => 'ACTIVATION', + ], + 'GmtExpire' => [ + 'description' => 'Queries the list of Time Series Database (TSDB) instances.'."\n", + 'type' => 'string', + 'example' => '2020-12-17 00:00:00', + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝的详细原因。', + 'type' => 'string', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'TSDB.Errorcode.ParameterInvaild', + 'errorMessage' => 'The parameter is invalid.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'API.Forbidden', + 'errorMessage' => 'The API operation is forbidden in this environment.', + 'description' => '', + ], + [ + 'errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', + 'errorMessage' => 'No permission to create service linked role.', + 'description' => '', + ], + [ + 'errorCode' => 'Lindorm.Errorcode.OperationDenied', + 'errorMessage' => 'You are not authorized to operate on the specified resource.', + 'description' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0A7153E4-8354-497E-87E5-5D0EBEF5AEB1\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 10,\\n \\"InstanceList\\": [\\n {\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"VpcId\\": \\"vpc-bp1xxxxxxxxxxxxxxxxxx\\",\\n \\"PaymentType\\": \\"PREPAY\\",\\n \\"MaxSeriesPerDatabase\\": \\"10000\\",\\n \\"EngineType\\": \\"tsdb_tsdb\\",\\n \\"VswitchId\\": \\"vsw-bp1xxxxxxxxxxxxxxxxxx\\",\\n \\"InstanceClass\\": \\"tsdb.1x.basic\\",\\n \\"CreateTime\\": 1603426323000,\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"UserId\\": \\"1000000000000000\\",\\n \\"InstanceStorage\\": \\"50\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"InstanceId\\": \\"ts-xxxxxxxxxxxxxxxxx\\",\\n \\"LockMode\\": \\"0\\",\\n \\"InstanceDescription\\": \\"test\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"GmtCreated\\": \\"2020-11-16 16:22:56\\",\\n \\"InstanceAlias\\": \\"test_tsdb\\",\\n \\"InstanceTps\\": \\"960000\\",\\n \\"ExpiredTime\\": 1611417600000,\\n \\"ZoneId\\": \\"cn-hongkong-b\\",\\n \\"InstanceStatus\\": \\"ACTIVATION\\",\\n \\"GmtExpire\\": \\"2020-12-17 00:00:00\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\\\"AuthAction\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"AuthPrincipalDisplayName\\\\\\":\\\\\\"222\\\\\\",\\\\\\"AuthPrincipalOwnerId\\\\\\":\\\\\\"111\\\\\\",\\\\\\"AuthPrincipalType\\\\\\":\\\\\\"SubUser\\\\\\",,\\\\\\"NoPermissionType\\\\\\":\\\\\\"ImplicitDeny\\\\\\",\\\\\\"PolicyType\\\\\\":\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\\\"EncodedDiagnosticMessage\\\\\\":\\\\\\"xxxxxx\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"<PageSize>20</PageSize>\\n<RequestId>0A7153E4-8354-497E-87E5-5D0EBEF5AEB1</RequestId>\\n<PageNumber>1</PageNumber>\\n<Total>10</Total>\\n<InstanceList>\\n <MaxSeriesPerDatabase>10000</MaxSeriesPerDatabase>\\n <GmtCreated>2020-11-16 16:22:56</GmtCreated>\\n <GmtExpire>2020-12-17 00:00:00</GmtExpire>\\n <NetworkType>VPC</NetworkType>\\n <InstanceStatus>ACTIVATION</InstanceStatus>\\n <InstanceAlias>test_tsdb</InstanceAlias>\\n <ExpiredTime>1611417600000</ExpiredTime>\\n <PaymentType>PREPAY</PaymentType>\\n <EngineType>tsdb_tsdb</EngineType>\\n <InstanceTps>960000</InstanceTps>\\n <Status>ACTIVATION</Status>\\n <InstanceStorage>50</InstanceStorage>\\n <ZoneId>cn-hongkong-b</ZoneId>\\n <InstanceId>ts-xxxxxxxxxxxxxxxxx</InstanceId>\\n <CreateTime>1603426323000</CreateTime>\\n <InstanceClass>tsdb.1x.basic</InstanceClass>\\n <LockMode>0</LockMode>\\n <VswitchId>vsw-bp1xxxxxxxxxxxxxxxxxx</VswitchId>\\n <VpcId>vpc-bp1xxxxxxxxxxxxxxxxxx</VpcId>\\n <ChargeType>POSTPAY</ChargeType>\\n <UserId>1000000000000000</UserId>\\n <InstanceDescription>test</InstanceDescription>\\n <RegionId>cn-hangzhou</RegionId>\\n</InstanceList>","errorExample":""}]', + 'title' => 'DescribeHiTSDBInstanceList', + 'summary' => 'Queries the list of Time Series Database (TSDB) instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hitsdb:DescribeHiTSDBInstanceList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DescribeHiTSDBInstanceSecurityIpList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '75172', + 'abilityTreeNodes' => [ + 'FEATUREhitsdbI6NK1A', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the group to which the instance belongs. The group name can contain only letters, digits, and underscores (\\_).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ts-xxxxxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_group', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The IP address whitelist of the instance.'."\n", + 'type' => 'string', + 'example' => 'F2DFDC0B-FE4F-4696-9FD1-2EFDEE8D6C7C', + ], + 'SecurityIpList' => [ + 'description' => 'The IP address in the whitelist.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Ip' => [ + 'description' => 'auditing', + 'type' => 'string', + 'example' => '0.0.0.0/0', + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'type' => 'string', + 'description' => 'The details about the access denial.'."\n", + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Instance.IsNotAvailable', + 'errorMessage' => 'The instance is unavailable.', + 'description' => '', + ], + [ + 'errorCode' => 'Instance.IsNotValid', + 'errorMessage' => 'The instance is invalid.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'API.Forbidden', + 'errorMessage' => 'The API operation is forbidden in this environment.', + 'description' => '', + ], + [ + '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' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F2DFDC0B-FE4F-4696-9FD1-2EFDEE8D6C7C\\",\\n \\"SecurityIpList\\": [\\n {\\n \\"Ip\\": \\"0.0.0.0/0\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{\\\\\\"AuthAction\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"AuthPrincipalDisplayName\\\\\\":\\\\\\"222\\\\\\",\\\\\\"AuthPrincipalOwnerId\\\\\\":\\\\\\"111\\\\\\",\\\\\\"AuthPrincipalType\\\\\\":\\\\\\"SubUser\\\\\\",,\\\\\\"NoPermissionType\\\\\\":\\\\\\"ImplicitDeny\\\\\\",\\\\\\"PolicyType\\\\\\":\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\\\"EncodedDiagnosticMessage\\\\\\":\\\\\\"xxxxxx\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>F2DFDC0B-FE4F-4696-9FD1-2EFDEE8D6C7C</RequestId>\\n<SecurityIpList>\\n <Ip>0.0.0.0/0</Ip>\\n</SecurityIpList>","errorExample":""}]', + 'title' => 'DescribeHiTSDBInstanceSecurityIpList', + 'summary' => 'Queries the IP address whitelist of a Time Series Database (TSDB) instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hitsdb:DescribeHiTSDBInstanceSecurityIpList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'instance', + 'arn' => 'acs:hitsdb:{#regionId}:{#accountId}:instance/{#instanceId}', + ], + ], + ], + ], + ], + ], + 'DescribeRegions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '63941', + 'abilityTreeNodes' => [ + 'FEATUREhitsdbBWSQMK', + ], + ], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the values to return. Valid values:'."\n" + ."\n" + .'* zh-CN: Chinese'."\n" + .'* en-US: English'."\n" + .'* ja: Japanese'."\n" + ."\n" + .'Default value: en-US'."\n", + 'example' => 'zh-CN', + 'required' => false, + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'example' => 'BDDB1954-002B-4249-B2DF-2CDDA0259668', + 'type' => 'string', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => 'The collection of regions.'."\n", + 'type' => 'array', + 'items' => [ + 'properties' => [ + 'RegionEndpoint' => [ + 'description' => 'The endpoint of the region.'."\n", + 'example' => 'hitsdb.aliyuncs.com', + 'type' => 'string', + ], + 'LocalName' => [ + 'description' => 'The name of the region.'."\n", + 'example' => 'China (Hangzhou)'."\n", + 'type' => 'string', + ], + 'RegionId' => [ + 'description' => 'The ID of the region.'."\n", + 'example' => 'cn-hangzhou', + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + ], + ], + 'type' => 'object', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '400', + 'errorMessage' => 'Parameter is not valid', + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BDDB1954-002B-4249-B2DF-2CDDA0259668\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionEndpoint\\": \\"hitsdb.aliyuncs.com\\",\\n \\"LocalName\\": \\"华东1（杭州）\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeRegionsResponse>\\r\\n <RequestId>DBB70386-45C6-4E92-B239-4A764E32CE4C</RequestId>\\r\\n <Regions>\\r\\n <Region>\\r\\n <RegionId>cn-hangzhou</RegionId>\\r\\n <RegionEndpoint>hitsdb.aliyuncs.com</RegionEndpoint>\\r\\n <LocalName>华东1（杭州）</LocalName>\\r\\n </Region>\\r\\n <Region>\\r\\n <RegionId>cn-shanghai</RegionId>\\r\\n <RegionEndpoint>hitsdb.aliyuncs.com</RegionEndpoint>\\r\\n <LocalName>华东2（上海）</LocalName>\\r\\n </Region>\\r\\n <Region>\\r\\n <RegionId>cn-qingdao</RegionId>\\r\\n <RegionEndpoint>hitsdb.aliyuncs.com</RegionEndpoint>\\r\\n <LocalName>华北1（青岛）</LocalName>\\r\\n </Region>\\r\\n <Region>\\r\\n <RegionId>cn-beijing</RegionId>\\r\\n <RegionEndpoint>hitsdb.aliyuncs.com</RegionEndpoint>\\r\\n <LocalName>华北2（北京）</LocalName>\\r\\n </Region>\\r\\n <Region>\\r\\n <RegionId>cn-huhehaote</RegionId>\\r\\n <RegionEndpoint>hitsdb.aliyuncs.com</RegionEndpoint>\\r\\n <LocalName>华北5（呼和浩特）</LocalName>\\r\\n </Region>\\r\\n <Region>\\r\\n <RegionId>cn-shenzhen</RegionId>\\r\\n <RegionEndpoint>hitsdb.aliyuncs.com</RegionEndpoint>\\r\\n <LocalName>华南1（深圳）</LocalName>\\r\\n </Region>\\r\\n <Region>\\r\\n <RegionId>ap-southeast-1</RegionId>\\r\\n <RegionEndpoint>hitsdb.aliyuncs.com</RegionEndpoint>\\r\\n <LocalName>新加坡</LocalName>\\r\\n </Region>\\r\\n </Regions>\\r\\n</DescribeRegionsResponse>","errorExample":""}]', + 'extraInfo' => ' ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'summary' => 'Queries the regions in which Time Series Database (TSDB) instances can be deployed.', + 'title' => 'DescribeRegions', + 'changeSet' => [], + 'ramActions' => [], + ], + 'DescribeZones' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '63958', + 'abilityTreeNodes' => [ + 'FEATUREhitsdbBWSQMK', + ], + ], + 'parameters' => [ + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the request.'."\n", + 'example' => 'zh_CN', + 'required' => false, + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'RequestId' => [ + 'description' => 'The list of available zones.'."\n", + 'example' => 'F67BFFF3-F5C2-45B5-9C28-6E4A1E51449B', + 'type' => 'string', + ], + 'ZoneList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ZoneModel' => [ + 'description' => 'The ID of the zone.'."\n", + 'type' => 'array', + 'items' => [ + 'properties' => [ + 'ZoneId' => [ + 'description' => 'The name of the zone'."\n", + 'example' => 'cn-shanghai-b', + 'type' => 'string', + ], + 'LocalName' => [ + 'description' => 'Shanghai Zone B'."\n", + 'example' => 'Queries zones that are available in a specified region.'."\n", + 'type' => 'string', + ], + ], + 'type' => 'object', + ], + ], + ], + ], + ], + 'type' => 'object', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F67BFFF3-F5C2-45B5-9C28-6E4A1E51449B\\",\\n \\"ZoneList\\": {\\n \\"ZoneModel\\": [\\n {\\n \\"ZoneId\\": \\"cn-shanghai-b\\",\\n \\"LocalName\\": \\"华东2可用区B\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>F67BFFF3-F5C2-45B5-9C28-6E4A1E51449B</RequestId>\\n<ZoneList>\\n <ZoneId>cn-shanghai-b</ZoneId>\\n <LocalName>华东2可用区B</LocalName>\\n</ZoneList>","errorExample":""}]', + 'extraInfo' => ' ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'summary' => 'Queries zones that are available in a specified region.', + 'title' => 'DescribeZones', + 'changeSet' => [], + 'ramActions' => [], + ], + 'ModifyHiTSDBInstanceClass' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '75175', + 'abilityTreeNodes' => [ + 'FEATUREhitsdb6YHIIK', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ts-xxxxxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage capacity of the instance. Unit: GB.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'tsdb.1x.basic', + ], + ], + [ + 'name' => 'InstanceStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '500', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '57540985-3C11-4588-96FD-93413C6282EF', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The detailed reason why the access was denied.'."\n", + 'type' => 'string', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Instance.IsModifyingClass', + 'errorMessage' => 'The instance class is being modified and cannot be operated.', + 'description' => '', + ], + [ + 'errorCode' => 'Instance.SpecIsNotValid', + 'errorMessage' => 'The instance specification is invalid.', + 'description' => '', + ], + [ + 'errorCode' => 'Instance.IsNotAvailable', + 'errorMessage' => 'The instance is unavailable.', + 'description' => '', + ], + [ + 'errorCode' => 'Instance.DoesNotSupportShrinkStorage', + 'errorMessage' => 'Storage scale in is not supported.', + 'description' => '', + ], + [ + 'errorCode' => 'Instance.Upgrade.ParamsIsNotValid', + 'errorMessage' => 'The instance upgrade parameters are invalid.', + 'description' => '', + ], + [ + 'errorCode' => 'CurrentEngineType.ClassChangingNotSupported', + 'errorMessage' => 'The current engine type does not support class changing.', + 'description' => '', + ], + [ + 'errorCode' => 'Commodity.NotFound', + 'errorMessage' => 'The commodity is not found.', + 'description' => '', + ], + [ + 'errorCode' => 'Order.CreateFailed', + 'errorMessage' => 'Failed to create the order.', + 'description' => '', + ], + [ + 'errorCode' => 'Instance.IsNotValid', + 'errorMessage' => 'The instance is invalid.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'API.Forbidden', + 'errorMessage' => 'The API operation is forbidden in this environment.', + 'description' => '', + ], + [ + 'errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', + 'errorMessage' => 'No permission to create service linked role.', + 'description' => '', + ], + [ + 'errorCode' => 'Lindorm.Errorcode.OperationDenied', + 'errorMessage' => 'You are not authorized to operate on the specified resource.', + 'description' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"57540985-3C11-4588-96FD-93413C6282EF\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\\\"AuthAction\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"AuthPrincipalDisplayName\\\\\\":\\\\\\"222\\\\\\",\\\\\\"AuthPrincipalOwnerId\\\\\\":\\\\\\"111\\\\\\",\\\\\\"AuthPrincipalType\\\\\\":\\\\\\"SubUser\\\\\\",,\\\\\\"NoPermissionType\\\\\\":\\\\\\"ImplicitDeny\\\\\\",\\\\\\"PolicyType\\\\\\":\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\\\"EncodedDiagnosticMessage\\\\\\":\\\\\\"xxxxxx\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>57540985-3C11-4588-96FD-93413C6282EF</RequestId>","errorExample":""}]', + 'title' => 'ModifyHiTSDBInstanceClass', + 'summary' => 'Modifies the type of a Time Series Database (TSDB) instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hitsdb:ModifyHiTSDBInstanceClass', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'instance', + 'arn' => 'acs:hitsdb:{#regionId}:{#accountId}:instance/{#instanceId}', + ], + ], + ], + ], + ], + ], + 'ModifyHiTSDBInstanceSecurityIpList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '75176', + 'abilityTreeNodes' => [ + 'FEATUREhitsdbIFW1Z6', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the group to which the instance belongs. The group name can contain only letters, digits, and underscores (\\_).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ts-ufxxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'SecurityIpList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[“127.0.0.1”, “192.168.0.1/24”]', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'auditing', + 'type' => 'string', + 'required' => false, + 'example' => 'test_group', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'Configures the whitelist of a Time Series Database (TSDB) instance. The IP addresses in the whitelist are allowed to connect to the instance.'."\n", + 'type' => 'string', + 'example' => '1556DCB0-043A-4444-8BD9-CF4A68E7EE64', + ], + 'AccessDeniedDetail' => [ + 'type' => 'string', + 'description' => 'The detailed reason why the access was denied.'."\n", + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ModifySecurityIpList.CreateAclGetNull', + 'errorMessage' => 'Failed to create access control list.', + 'description' => '', + ], + [ + 'errorCode' => 'ModifySecurityIpList.QueryIngressFailed', + 'errorMessage' => 'Failed to query SLB ingress.', + 'description' => '', + ], + [ + 'errorCode' => 'ModifySecurityIpList.QueryLoadBalancersFailed', + 'errorMessage' => 'Failed to query load balancers.', + 'description' => '', + ], + [ + 'errorCode' => 'ModifySecurityIpList.LoadBalancerSizeAbnormal', + 'errorMessage' => 'The number of load balancers is abnormal.', + 'description' => '', + ], + [ + 'errorCode' => 'ModifySecurityIpList.AddAclGetNull', + 'errorMessage' => 'Failed to add access control list.', + 'description' => '', + ], + [ + 'errorCode' => 'ModifySecurityIpList.SetLBTcpListenerFailed', + 'errorMessage' => 'Failed to set load balancer TCP listener attribute.', + 'description' => '', + ], + [ + 'errorCode' => 'ModifySecurityIpList.DescribeAclFailed', + 'errorMessage' => 'Failed to describe access control list.', + 'description' => '', + ], + [ + 'errorCode' => 'ModifySecurityIpList.RemoveAclFailed', + 'errorMessage' => 'Failed to remove access control list.', + 'description' => '', + ], + [ + 'errorCode' => 'Instance.IsNotAvailable', + 'errorMessage' => 'The instance is unavailable.', + 'description' => '', + ], + [ + 'errorCode' => 'Instance.IsNotValid', + 'errorMessage' => 'The instance is invalid.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'API.Forbidden', + 'errorMessage' => 'The API operation is forbidden in this environment.', + 'description' => '', + ], + [ + 'errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', + 'errorMessage' => 'No permission to create service linked role.', + 'description' => '', + ], + [ + 'errorCode' => 'Lindorm.Errorcode.OperationDenied', + 'errorMessage' => 'You are not authorized to operate on the specified resource.', + 'description' => '', + ], + ], + ], + '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"}]', + 'title' => 'ModifyHiTSDBInstanceSecurityIpList', + 'summary' => 'Configures the whitelist of a Time Series Database (TSDB) instance. The IP addresses in the whitelist are allowed to connect to the instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hitsdb:ModifyHiTSDBInstanceSecurityIpList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'instance', + 'arn' => 'acs:hitsdb:{#regionId}:{#accountId}:instance/{#instanceId}', + ], + ], + ], + ], + ], + ], + 'RenameHiTSDBInstanceAlias' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '75177', + 'abilityTreeNodes' => [ + 'FEATUREhitsdbI6NK1A', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ts-ufxxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'InstanceAlias', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance Alias', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vme', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '1556DCB0-043A-4444-8BD9-CF4A68E7EE64', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Instance.IsNotAvailable', + 'errorMessage' => 'The instance is unavailable.', + 'description' => '', + ], + [ + 'errorCode' => 'Instance.IsNotValid', + 'errorMessage' => 'The instance is invalid.', + '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.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<RenameHiTSDBInstanceAliasResponse>\\r\\n <RequestId>1556DCB0-043A-4444-8BD9-CF4A68E7EE64</RequestId>\\r\\n</RenameHiTSDBInstanceAliasResponse>","errorExample":""}]', + 'title' => 'RenameHiTSDBInstanceAlias', + 'summary' => 'Invoke RenameHiTSDBInstanceAlias to modify the instance alias.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hitsdb:RenameHiTSDBInstanceAlias', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'instance', + 'arn' => 'acs:hitsdb:{#regionId}:{#accountId}:instance/{#instanceId}', + ], + ], + ], + ], + ], + ], + 'RenewTSDBInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ts-xxxxxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unit of the subscription duration. Valid values: Month and Year. This parameter is valid only for an instance that uses the subscription billing method.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Month', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subscription duration of the instance. If you set PricingCycle to Month, set Duration to an integer that ranges from 1 to 9. If you set PricingCycle to Year, set Duration to an integer that ranges from 1 to 3.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000000000000', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '57540985-3C11-4588-96FD-93413C6282EF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ChargeType.IsNotValid', + 'errorMessage' => 'The charge type is invalid.', + 'description' => '', + ], + [ + 'errorCode' => 'Commodity.NotFound', + 'errorMessage' => 'The commodity is not found.', + 'description' => '', + ], + [ + 'errorCode' => 'Order.CreateFailed', + 'errorMessage' => 'Failed to create the order.', + 'description' => '', + ], + [ + 'errorCode' => 'Instance.IsNotValid', + 'errorMessage' => 'The instance is invalid.', + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": 100000000000000,\\n \\"RequestId\\": \\"57540985-3C11-4588-96FD-93413C6282EF\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>57540985-3C11-4588-96FD-93413C6282EF</RequestId>\\n<OrderId>100000000000000</OrderId>","errorExample":""}]', + 'title' => 'RenewTSDBInstance', + 'summary' => 'Renews a subscription Time Series Database (TSDB) instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'hitsdb:RenewTSDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:hitsdb:{#regionId}:{#accountId}:instance/{#InstanceId}', + ], + ], + ], + ], + ], + ], + 'RestartHiTSDBInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '75179', + 'abilityTreeNodes' => [ + 'FEATUREhitsdbNQ2Q4L', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ts-ufxxxxxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1556DCB0-043A-4444-8BD9-CF4A68E7EE64', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The detailed reason why the access was denied.'."\n", + 'type' => 'string', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Instance.IsNotValid', + 'errorMessage' => 'The instance is invalid.', + 'description' => '', + ], + [ + 'errorCode' => 'Instance.IsNotAvailable', + 'errorMessage' => 'The instance is unavailable.', + 'description' => '', + ], + [ + 'errorCode' => 'Instance.RestartError', + 'errorMessage' => 'An error occurred while restarting the instance.', + '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' => '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' => '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' => [], + ], + '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"}]', + 'title' => 'RestartHiTSDBInstance', + 'summary' => 'Restarts a Time Series Database (TSDB) instance.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hitsdb:RestartHiTSDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'instance', + 'arn' => 'acs:hitsdb:{#regionId}:{#accountId}:instance/{#instanceId}', + ], + ], + ], + ], + ], + ], + 'SwitchHiTSDBInstancePublicNet' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '75180', + 'abilityTreeNodes' => [ + 'FEATUREhitsdb6YHIIK', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ts-ufxxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'SwitchAction', + 'in' => 'query', + 'schema' => [ + 'description' => '**1**: opens the Internet link. **0**: closes the Internet link.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EC6A17BC-B326-4626-B3BE-932B003DB3A9', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The detailed reason why the access was denied.'."\n", + 'type' => 'string', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Instance.IsNotAvailable', + 'errorMessage' => 'The instance is unavailable.', + 'description' => '', + ], + [ + 'errorCode' => 'Instance.IsNotValid', + 'errorMessage' => 'The instance is invalid.', + 'description' => '', + ], + ], + 403 => [ + [ + 'errorCode' => 'API.Forbidden', + 'errorMessage' => 'The API operation is forbidden in this environment.', + 'description' => '', + ], + [ + 'errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', + 'errorMessage' => 'No permission to create service linked role.', + 'description' => '', + ], + [ + 'errorCode' => 'Lindorm.Errorcode.OperationDenied', + 'errorMessage' => 'You are not authorized to operate on the specified resource.', + 'description' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EC6A17BC-B326-4626-B3BE-932B003DB3A9\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\\\"AuthAction\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"AuthPrincipalDisplayName\\\\\\":\\\\\\"222\\\\\\",\\\\\\"AuthPrincipalOwnerId\\\\\\":\\\\\\"111\\\\\\",\\\\\\"AuthPrincipalType\\\\\\":\\\\\\"SubUser\\\\\\",,\\\\\\"NoPermissionType\\\\\\":\\\\\\"ImplicitDeny\\\\\\",\\\\\\"PolicyType\\\\\\":\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\",\\\\\\"EncodedDiagnosticMessage\\\\\\":\\\\\\"xxxxxx\\\\\\"}\\"\\n}","type":"json"}]', + 'title' => 'SwitchHiTSDBInstancePublicNet', + 'summary' => 'Switches the Internet connection status of a Time Series Database (TSDB) instance.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hitsdb:SwitchHiTSDBInstancePublicNet', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'instance', + 'arn' => 'acs:hitsdb:{#regionId}:{#accountId}:instance/{#instanceId}', + ], + ], + ], + ], + ], + ], + ], + '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' => [], + 'ram' => [ + 'productCode' => 'TSDB', + 'productName' => 'Lindorm', + 'ramCodes' => [ + 'hitsdb', + ], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'RestartHiTSDBInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hitsdb:RestartHiTSDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'instance', + 'arn' => 'acs:hitsdb:{#regionId}:{#accountId}:instance/{#instanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'RenameHiTSDBInstanceAlias', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hitsdb:RenameHiTSDBInstanceAlias', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'instance', + 'arn' => 'acs:hitsdb:{#regionId}:{#accountId}:instance/{#instanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyHiTSDBInstanceSecurityIpList', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hitsdb:ModifyHiTSDBInstanceSecurityIpList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'instance', + 'arn' => 'acs:hitsdb:{#regionId}:{#accountId}:instance/{#instanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteHiTSDBInstance', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'hitsdb:DeleteHiTSDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'instance', + 'arn' => 'acs:hitsdb:{#regionId}:{#accountId}:instance/{#instanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeHiTSDBInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hitsdb:DescribeHiTSDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateHiTSDBInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'hitsdb:CreateHiTSDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyHiTSDBInstanceClass', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hitsdb:ModifyHiTSDBInstanceClass', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'instance', + 'arn' => 'acs:hitsdb:{#regionId}:{#accountId}:instance/{#instanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'RenewTSDBInstance', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'hitsdb:RenewTSDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'Instance', + 'arn' => 'acs:hitsdb:{#regionId}:{#accountId}:instance/{#InstanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeHiTSDBInstanceList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hitsdb:DescribeHiTSDBInstanceList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeHiTSDBInstanceSecurityIpList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hitsdb:DescribeHiTSDBInstanceSecurityIpList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'instance', + 'arn' => 'acs:hitsdb:{#regionId}:{#accountId}:instance/{#instanceId}', + ], + ], + ], + ], + [ + 'apiName' => 'SwitchHiTSDBInstancePublicNet', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'hitsdb:SwitchHiTSDBInstancePublicNet', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => 'instance', + 'arn' => 'acs:hitsdb:{#regionId}:{#accountId}:instance/{#instanceId}', + ], + ], + ], + ], + ], + 'resourceTypes' => [ + [ + 'validationType' => 'always', + 'resourceType' => 'instance', + 'arn' => 'acs:hitsdb:{#regionId}:{#accountId}:instance/{#instanceId}', + ], + [ + 'validationType' => 'conditional', + 'resourceType' => 'instance', + 'arn' => 'acs:hitsdb:{#regionId}:{#accountId}:instance/*', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'Instance', + 'arn' => 'acs:hitsdb:{#regionId}:{#accountId}:instance/{#InstanceId}', + ], + ], + ], +]; diff --git a/data/en_us/hitsdb/2020-06-15/api-docs.php b/data/en_us/hitsdb/2020-06-15/api-docs.php new file mode 100644 index 0000000..250919a --- /dev/null +++ b/data/en_us/hitsdb/2020-06-15/api-docs.php @@ -0,0 +1,8689 @@ +<?php return [ + 'version' => '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 where you want to create the instance. To query the available regions, call the [DescribeRegions](~~426062~~) operation.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'title' => '', + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the zone for the instance.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'title' => '', + 'example' => 'cn-shanghai-f', + ], + ], + [ + 'name' => 'InstanceAlias', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the instance.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'title' => '', + 'example' => 'lindorm_test', + ], + ], + [ + 'name' => 'InstanceStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage capacity of the instance. Unit: GB.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'title' => '', + 'example' => '480', + ], + ], + [ + '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, + 'title' => '', + 'example' => 'POSTPAY', + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the virtual private cloud (VPC) for the instance.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'title' => '', + 'example' => 'vpc-bp1nme44gek34slfc****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'title' => '', + 'example' => 'vsw-bp1e7clcw529l773d****', + ], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unit of the subscription duration. Valid values:'."\n" + ."\n" + .'- **Month**: The unit is month.'."\n" + ."\n" + .'- **Year**: The unit is year.'."\n" + ."\n" + .'> This parameter is available and required only when PayType is set to **PREPAY**.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'Month', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subscription duration of the instance. Valid values:'."\n" + ."\n" + .'- If PricingCycle is set to **Month**, the valid values are **1** to **9**.'."\n" + ."\n" + .'- If PricingCycle is set to **Year**, the valid values are **1** to **3**.'."\n" + ."\n" + .'> This parameter is available and required only when PayType is set to **PREPAY**.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '1', + ], + ], + [ + 'name' => 'DiskCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage class of the instance. Valid values:'."\n" + ."\n" + .'- **cloud\\_efficiency**: standard cloud storage.'."\n" + ."\n" + .'- **cloud\\_ssd**: performance cloud storage.'."\n" + ."\n" + .'- **cloud\\_essd**: enhanced SSD (ESSD) cloud storage.'."\n" + ."\n" + .'- **cloud\\_essd\\_pl0**: ESSD PL0 cloud storage.'."\n" + ."\n" + .'- **capacity\\_cloud\\_storage**: capacity-optimized cloud storage. This storage class is not supported for multi-zone instances.'."\n" + ."\n" + .'- **local\\_ssd\\_pro**: local SSD. This storage class is not supported for multi-zone instances.'."\n" + ."\n" + .'- **local\\_hdd\\_pro**: local HDD. This storage class is not supported for multi-zone instances.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'title' => '', + 'example' => 'cloud_efficiency', + ], + ], + [ + 'name' => 'CoreSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'The node specifications of the instance that uses local disks.'."\n" + ."\n" + .'If the storage class of the instance is local\\_ssd\\_pro, valid values for this parameter are as follows. The I3 instance family is available only for subscription instances.'."\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 the storage class of the instance is local\\_hdd\\_pro, valid values for this parameter are:'."\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' => false, + 'title' => '', + 'example' => 'lindorm.i2.xlarge', + ], + ], + [ + 'name' => 'LindormNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of LindormTable nodes in the instance.'."\n" + ."\n" + .'For a single-zone instance, the valid values are **0** to **90**.'."\n" + ."\n" + .'**This parameter is required if you create a multi-zone instance**. For an instance that uses cloud disks, the valid values are **4** to **400**. For an instance that uses local disks, the valid values are **6** to **400**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'title' => '', + 'example' => '2', + ], + ], + [ + 'name' => 'SolrSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'The node specifications for the search engine. Valid values:'."\n" + ."\n" + .'- **lindorm.g.xlarge**: 4 cores, 16 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.c.2xlarge**: 8 cores, 16 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.g.2xlarge**: 8 cores, 32 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.c.4xlarge**: 16 cores, 32 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.g.4xlarge**: 16 cores, 64 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.c.8xlarge**: 32 cores, 64 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.g.8xlarge**: 32 cores, 128 GB (Dedicated).', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'lindorm.g.xlarge', + ], + ], + [ + 'name' => 'SolrNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of search engine nodes in the instance. Valid values: **0** to **60**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'title' => '', + 'example' => '2', + ], + ], + [ + 'name' => 'ColdStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage capacity of the capacity-optimized cloud storage for the instance. Unit: GB. If you do not specify this parameter, capacity-optimized cloud storage is not enabled for the instance. Valid values: **800** to **1000000**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'title' => '', + 'example' => '800', + ], + ], + [ + 'name' => 'TsdbSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'The node specifications for LindormTSDB. Valid values:'."\n" + ."\n" + .'- **lindorm.g.xlarge**: 4 cores, 16 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.g.2xlarge**: 8 cores, 32 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.g.4xlarge**: 16 cores, 64 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.g.8xlarge**: 32 cores, 128 GB (Dedicated).', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'lindorm.g.xlarge', + ], + ], + [ + 'name' => 'TsdbNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of LindormTSDB nodes in the instance. Valid values:'."\n" + ."\n" + .'- If the billing method of the instance is **PREPAY**, the valid values are **0** to **24**.'."\n" + ."\n" + .'- If the billing method of the instance is **POSTPAY**, the valid values are **0** to **32**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'title' => '', + 'example' => '2', + ], + ], + [ + 'name' => 'LindormSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'The node specifications for LindormTable. Valid values:'."\n" + ."\n" + .'- **lindorm.g.xlarge**: 4 cores, 16 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.c.2xlarge**: 8 cores, 16 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.g.2xlarge**: 8 cores, 32 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.c.4xlarge**: 16 cores, 32 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.g.4xlarge**: 16 cores, 64 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.c.8xlarge**: 32 cores, 64 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.g.8xlarge**: 32 cores, 128 GB (Dedicated).', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'lindorm.c.xlarge', + ], + ], + [ + 'name' => 'FilestoreNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of file engine nodes in the instance. Valid values:'."\n" + ."\n" + .'- If the billing method of the instance is **PREPAY**, the valid values are **0** to **60**.'."\n" + ."\n" + .'- If the billing method of the instance is **POSTPAY**, the valid values are **0** to **8**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'title' => '', + 'example' => '2', + ], + ], + [ + 'name' => 'FilestoreSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'The node specifications for the file engine. Valid values:'."\n" + ."\n" + .'- **lindorm.c.xlarge**: 4 cores, 8 GB (Standard).', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'lindorm.c.xlarge', + ], + ], + [ + 'name' => 'StreamNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of stream engine nodes in the instance. Valid values: **0** to **60**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'title' => '', + 'example' => '2', + ], + ], + [ + 'name' => 'StreamSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'The node specifications for the stream engine. Valid values:'."\n" + ."\n" + .'- **lindorm.g.xlarge**: 4 cores, 16 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.c.2xlarge**: 8 cores, 16 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.g.2xlarge**: 8 cores, 32 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.c.4xlarge**: 16 cores, 32 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.g.4xlarge**: 16 cores, 64 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.c.8xlarge**: 32 cores, 64 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.g.8xlarge**: 32 cores, 128 GB (Dedicated).', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'lindorm.g.xlarge', + ], + ], + [ + 'name' => 'ArchVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The deployment architecture. Valid values:'."\n" + ."\n" + .'- **1.0**: single zone.'."\n" + ."\n" + .'- **2.0**: multi-zone.'."\n" + ."\n" + .'The default value is 1.0. To create a multi-zone instance, set this parameter to 2.0. **This parameter is required if you want to create a multi-zone instance.**', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '2.0', + ], + ], + [ + 'name' => 'PrimaryZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the primary zone for the multi-zone instance. **This parameter is required if you want to create a multi-zone instance.**', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'cn-shanghai-e', + ], + ], + [ + 'name' => 'StandbyZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the secondary zone for the multi-zone instance. **This parameter is required if you want to create a multi-zone instance.**', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'cn-shanghai-f', + ], + ], + [ + 'name' => 'ArbiterZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the arbiter zone for the multi-zone instance. **This parameter is required if you want to create a multi-zone instance.**', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'cn-shanghai-g', + ], + ], + [ + 'name' => 'MultiZoneCombination', + 'in' => 'query', + 'schema' => [ + 'description' => 'The combination of zones for the multi-zone instance. To view the supported zone combinations, go to the instance buy 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 if you want to create a multi-zone instance.**', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'cn-shanghai-efg-aliyun', + ], + ], + [ + 'name' => 'PrimaryVSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch in the primary zone for the 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, + 'title' => '', + 'example' => 'vsw-uf6fdqa7c0pipnqzq****', + ], + ], + [ + 'name' => 'StandbyVSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch in the secondary zone for the 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, + 'title' => '', + 'example' => 'vsw-2zec0kcn08cgdtr6****', + ], + ], + [ + 'name' => 'ArbiterVSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch in the arbiter zone for the 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, + 'title' => '', + 'example' => 'vsw-uf6664pqjawb87k36****', + ], + ], + [ + 'name' => 'CoreSingleStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage capacity of a single core node in the multi-zone instance. Unit: GB. Valid values: 400 to 64000. **This parameter is required if you want to create a multi-zone instance.**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'title' => '', + 'example' => '400', + ], + ], + [ + 'name' => 'LogDiskCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The disk type of the log nodes in the multi-zone instance. Valid values:'."\n" + ."\n" + .'- **cloud\\_efficiency**: standard cloud storage.'."\n" + ."\n" + .'- **cloud\\_ssd**: performance cloud storage.'."\n" + ."\n" + .'**This parameter is required if you want to create a multi-zone instance.**', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'cloud_ssd', + ], + ], + [ + 'name' => 'LogSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications of the log nodes in the multi-zone instance. Valid values:'."\n" + ."\n" + .'- **lindorm.sn1.large**: 4 cores, 8 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.sn1.2xlarge**: 8 cores, 16 GB (Dedicated).'."\n" + ."\n" + .'**This parameter is required if you want to create a multi-zone instance.**', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'lindorm.sn1.large', + ], + ], + [ + 'name' => 'LogNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of log nodes in the multi-zone instance. Valid values: 4 to 400. **This parameter is required if you want to create a multi-zone instance.**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'title' => '', + 'example' => '4', + ], + ], + [ + 'name' => 'LogSingleStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage capacity of a single log node in the multi-zone instance. Unit: GB. Valid values: 400 to 64000. **This parameter is required if you want to create a multi-zone instance.**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'title' => '', + 'example' => '400', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'rg-aek2i6weeb4nfii', + ], + ], + [ + 'name' => 'AutoRenewal', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable auto-renewal for the instance. Valid values:'."\n" + ."\n" + .'- **true**: enables auto-renewal.'."\n" + ."\n" + .'- **false**: disables auto-renewal.'."\n" + ."\n" + .'Default value: false'."\n" + ."\n" + .'> This parameter is available only when **PayType** is set to **PREPAY**.', + 'type' => 'boolean', + 'required' => false, + 'title' => '', + 'example' => 'false', + ], + ], + [ + 'name' => 'AutoRenewDuration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The auto-renewal duration. Unit: month.'."\n" + ."\n" + .'Valid values: **1** to **12**.'."\n" + ."\n" + .'> This parameter is available only when **AutoRenewal** is set to **true**.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '1', + ], + ], + [ + 'name' => 'LtsSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'The node specifications for the LTS engine. Valid values:'."\n" + ."\n" + .'- **lindorm.c.xlarge**: 4 cores, 8 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.g.xlarge**: 4 cores, 16 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.c.2xlarge**: 8 cores, 16 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.g.2xlarge**: 8 cores, 32 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.c.4xlarge**: 16 cores, 32 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.g.4xlarge**: 16 cores, 64 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.c.8xlarge**: 32 cores, 64 GB (Dedicated).'."\n" + ."\n" + .'- **lindorm.g.8xlarge**: 32 cores, 128 GB (Dedicated).', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'lindorm.g.xlarge', + ], + ], + [ + 'name' => 'LtsNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of LTS engine nodes in the instance. Valid values: **0** to **60**.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '2', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag. You can specify up to 20 tags.'."\n" + ."\n" + .'> You can pass keys for multiple tags. For example, the Key in the first pair specifies the key for the first tag. The Key in the second pair specifies the key for the second tag.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'test', + ], + 'Value' => [ + 'description' => 'The value of the tag. You can specify up to 20 tags.'."\n" + ."\n" + .'> You can pass values for multiple tags. For example, the Value in the first pair specifies the value for the first tag. The Value in the second pair specifies the value for the second tag.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'value', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'title' => '', + 'example' => '93BE8227-3406-4D7A-883D-9A421D42****', + ], + 'InstanceId' => [ + 'description' => 'The ID of the created instance.', + 'type' => 'string', + 'title' => '', + 'example' => 'ld-bp1o3y0yme2i2****', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.', + 'type' => 'integer', + 'format' => 'int64', + 'title' => '', + 'example' => '111111111111111', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.', + 'type' => 'string', + 'title' => '', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + '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' => 'Creates a Lindorm instance.', + 'description' => 'Select at least one data engine when you create an instance.'."\n" + .'For example, to create an instance that uses LindormTable, specify both the **LindormNum** and **LindormSpec** parameters. For more information about data engines and storage specifications, see [Select a data engine](~~174643~~) and [Select storage specifications](~~181971~~).'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'If you do not specify the parameters for a data engine when creating an instance, the API call fails.'."\n" + ."\n" + .'></notice>', + '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' => [], + '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" + .'><notice>'."\n" + ."\n" + .'If you do not specify a DPI engine parameter when you create an instance, the API call fails.'."\n" + ."\n" + .'></notice>', + '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, + 'title' => '', + 'example' => 'en-US', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'title' => '', + 'example' => '73F6E6DA-9AE5-5548-9E07-761A554DAF2E', + ], + 'Regions' => [ + 'description' => 'The list of regions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionEndpoint' => [ + 'description' => 'The endpoint of the region.', + 'type' => 'string', + 'title' => '', + 'example' => 'hitsdb.cn-hangzhou.aliyuncs.com', + ], + 'LocalName' => [ + 'description' => 'The name of the region.', + 'type' => 'string', + 'title' => '', + 'example' => 'China (Hangzhou)', + ], + 'RegionId' => [ + 'description' => 'The ID of the region.', + 'type' => 'string', + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '400', + 'errorMessage' => 'Parameter is not valid', + 'description' => '', + ], + ], + ], + 'title' => 'DescribeRegions', + 'summary' => 'Queries all regions where Lindorm is available.', + 'changeSet' => [], + 'ramActions' => [], + '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"}]', + '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, + 'title' => '', + 'example' => 'ld-bp1z3506imz2g****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'title' => '', + 'example' => 'ld-bp1z3506imz2f****', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => '1D1F6F4D-9203-53E7-84E9-5376B4657E63', + ], + 'IpList' => [ + 'description' => 'A list of IP addresses in the whitelist.', + 'type' => 'array', + 'items' => [ + 'description' => 'An IP address in the whitelist.', + 'type' => 'string', + 'title' => '', + 'example' => '192.168.0.0/24', + ], + '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', + 'title' => '', + 'example' => 'test', + ], + 'SecurityIpList' => [ + 'description' => 'The IP address whitelist.', + 'type' => 'string', + 'title' => '', + 'example' => '192.168.1.0/24', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The details about why the access was denied.', + 'type' => 'string', + 'title' => '', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + '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' => [], + '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 running instances and instances that are 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 that are about to expire in the `{RegionId}` region.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'Total' => [ + 'description' => 'The total number of running instances and instances that are about to expire in the `{RegionId}` region.', + '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 the `{RegionId}` region.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + ], + 'description' => 'A collection of regional information.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A collection of regional information.', + '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 an overview of the Lindorm instances in your account.', + 'changeSet' => [], + 'ramActions' => [], + '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~~) operation to obtain the region ID.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + [ + '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, + 'docRequired' => true, + 'title' => '', + 'example' => 'ld-xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. Alibaba Cloud generates this unique identifier for each request. Use this ID to troubleshoot issues.', + 'type' => 'string', + 'title' => '', + 'example' => '4F23D50C-400C-592C-9486-9D1E10179065', + ], + 'Valid' => [ + 'description' => 'Indicates whether the return value is valid. A value of \\`true\\` indicates a valid value. A value of \\`false\\` indicates that an exception was returned. If an exception is returned, provide the request ID for troubleshooting.', + 'type' => 'string', + 'title' => '', + 'example' => 'true', + ], + 'FsCapacity' => [ + 'description' => 'The total storage capacity of the cluster, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '85899345920', + ], + 'FsCapacityHot' => [ + 'description' => 'The hot storage capacity of the cluster, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '85899345920', + ], + 'FsCapacityCold' => [ + 'description' => 'The cold storage capacity of the cluster, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '85899345920', + ], + 'FsUsedHot' => [ + 'description' => 'The used hot storage of the cluster, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '33269', + ], + 'FsUsedCold' => [ + 'description' => 'The used cold storage of the cluster, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '33269', + ], + 'FsUsedOnLindormTable' => [ + 'description' => 'The storage usage of LindormTable, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '33269', + ], + 'FsUsedOnLindormTableData' => [ + 'description' => 'The storage usage of table data in LindormTable, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '33269', + ], + 'FsUsedOnLindormTableWAL' => [ + 'description' => 'The storage usage of log data in LindormTable, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '33269', + ], + 'FsUsedOnLindormSearch' => [ + 'description' => 'The storage usage of the search engine, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '33269', + ], + 'FsUsedOnLindormTSDB' => [ + 'description' => 'The storage usage of LindormTSDB, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '33269', + ], + 'FsUsedHotOnLindormTable' => [ + 'description' => 'The used hot storage for table data in LindormTable, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '33269', + ], + 'FsUsedColdOnLindormTable' => [ + 'description' => 'The used cold storage for table data in LindormTable, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '33269', + ], + 'FsUsedHotOnLindormSearch' => [ + 'description' => 'The used hot storage for table data in the search engine, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '33269', + ], + 'FsUsedColdOnLindormSearch' => [ + 'description' => 'The used cold storage for table data in the search engine, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '33269', + ], + 'FsUsedHotOnLindormTSDB' => [ + 'description' => 'The used hot storage for table data in LindormTSDB, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '33269', + ], + 'FsUsedColdOnLindormTSDB' => [ + 'description' => 'The used cold storage for table data in LindormTSDB, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '33269', + ], + 'LStorageUsageList' => [ + 'description' => 'A list of storage details categorized by storage medium. This parameter is returned for clusters that use an underlying storage engine of version 4.1.9 or later.', + 'type' => 'array', + 'items' => [ + 'description' => 'The storage details for a type of storage medium.', + 'type' => 'object', + 'properties' => [ + 'DiskType' => [ + 'description' => 'The storage class of the cluster. Valid values:'."\n" + ."\n" + .'- StandardCloudStorage: Standard cloud storage.'."\n" + ."\n" + .'- PerformanceCloudStorage: Performance cloud storage.'."\n" + ."\n" + .'- CapacityCloudStorage: Capacity-optimized cloud storage.'."\n" + ."\n" + .'- LocalSsdStorage: Local SSD.'."\n" + ."\n" + .'- LocalHddStorage: Local HDD.'."\n" + ."\n" + .'- LocalEbsStorage: Local cloud storage.', + 'type' => 'string', + 'title' => '', + 'example' => 'StandardCloudStorage', + ], + 'Capacity' => [ + 'description' => 'The total storage capacity of this storage medium type, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '85899345920', + ], + 'Used' => [ + 'description' => 'The used storage of this storage medium type, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '33269', + ], + 'UsedLindormTable' => [ + 'description' => 'The storage usage of LindormTable on this storage medium type, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '33269', + ], + 'UsedLindormTsdb' => [ + 'description' => 'The storage usage of LindormTSDB on this storage medium type, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '33269', + ], + 'UsedLindormSearch' => [ + 'description' => 'The storage usage of the search engine on this storage medium type, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '33269', + ], + 'UsedLindormSpark' => [ + 'description' => 'The storage usage of the compute engine on this storage medium type, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '33269', + ], + 'UsedOther' => [ + 'description' => 'The storage usage for other purposes, such as logs and recycle bin storage, on this storage medium type, in bytes.', + 'type' => 'string', + 'title' => '', + 'example' => '33269', + ], + 'UsedLindormMessage3' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'UsedLindormColumn3' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'UsedLindormVector3' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The detailed reason why the access was denied.', + 'type' => 'string', + 'title' => '', + 'example' => '{}', + ], + ], + '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 usage details for each storage medium of a specific Lindorm instance.', + 'description' => 'For Lindorm clusters that use storage engine version 4.1.9 or later, refer to the LStorageUsageList parameter for detailed storage usage information.', + 'changeSet' => [], + 'ramActions' => [], + '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' => 'Retrieve detailed information about a Lindorm instance, such as the instance type, billing method, and associated virtual private cloud (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' => 'Instance ID. Call the [GetLindormInstanceList](~~426069~~) operation to get this value.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ld-bp1o3y0yme2i2****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'ID of the VPC that hosts the instance.', + 'type' => 'string', + 'example' => 'vpc-bp1n3i15v90el48nx****', + 'title' => '', + ], + 'VswitchId' => [ + 'description' => 'ID of the vSwitch.', + 'type' => 'string', + 'example' => 'vsw-bp1vbjzmod9q3l9eo****', + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'Time when the instance was created, in **yyyy-MM-dd HH:mm:ss** format.', + 'type' => 'string', + 'example' => '2021-07-26 17:10:26', + 'title' => '', + ], + 'PayType' => [ + 'description' => 'Billing method for the instance. Valid values:'."\n" + ."\n" + .'- **PREPAY**: subscription.'."\n" + ."\n" + .'- **POSTPAY**: pay-as-you-go.', + 'type' => 'string', + 'example' => 'POSTPAY', + 'title' => '', + ], + 'NetworkType' => [ + 'description' => 'Network type of the instance.', + 'type' => 'string', + 'example' => 'vpc', + 'title' => '', + ], + 'ServiceType' => [ + 'description' => 'Instance type. Valid values:'."\n" + ."\n" + .'- **lindorm**: single-zone Lindorm instance.'."\n" + ."\n" + .'- **lindorm\\_multizone**: multi-zone Lindorm instance.'."\n" + ."\n" + .'- **serverless\\_lindorm**: serverless Lindorm instance.'."\n" + ."\n" + .'- **lindorm\\_standalone**: standalone Lindorm instance.'."\n" + ."\n" + .'- **lts**: Lindorm Tunnel Service (LTS) instance.', + 'type' => 'string', + 'example' => 'lindorm', + 'title' => '', + ], + 'EnableKms' => [ + 'description' => 'Whether Key Management Service (KMS) is enabled. Valid values:'."\n" + ."\n" + .'- **true**: enabled.'."\n" + ."\n" + .'- **false**: disabled.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'EnableStoreTDE' => [ + 'description' => 'Whether storage encryption is enabled. Valid values:'."\n" + ."\n" + .'- true: enabled.'."\n" + ."\n" + .'- false: disabled.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'DiskUsage' => [ + 'description' => 'Disk usage percentage.', + 'type' => 'string', + 'example' => '0.0%', + 'title' => '', + ], + 'DiskCategory' => [ + 'description' => 'Storage class. Valid values:'."\n" + ."\n" + .'- **cloud\\_efficiency**: standard cloud storage.'."\n" + ."\n" + .'- **cloud\\_ssd**: compute-optimized cloud storage.'."\n" + ."\n" + .'- **cloud\\_essd**: enhanced compute-optimized cloud storage.'."\n" + ."\n" + .'- **cloud\\_essd\\_pl0**: compute-optimized cloud storage pl0.'."\n" + ."\n" + .'- **capacity\\_cloud\\_storage**: storage-optimized cloud storage.'."\n" + ."\n" + .'- **local\\_ssd\\_pro**: local SSD.'."\n" + ."\n" + .'- **local\\_hdd\\_pro**: local HDD.', + 'type' => 'string', + 'example' => 'cloud_efficiency', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '633F1BE4-C8DA-5744-8FDF-A3075C3FE37F', + 'title' => '', + ], + 'ColdStorage' => [ + 'description' => 'Capacity of capacity cloud storage, in GB.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0GB', + 'title' => '', + ], + 'ArchiveStorage' => [ + 'description' => 'Billing size of Archive Storage, in GB.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0GB', + 'title' => '', + ], + 'ExpiredMilliseconds' => [ + 'description' => 'Number of milliseconds between the instance expiration time and 1970-01-01 00:00:00 UTC.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1629993600000', + 'title' => '', + ], + 'EngineType' => [ + 'description' => 'Type of engines supported by the instance. This value is the sum of engine type values.'."\n" + ."\n" + .'- 1: search engine.'."\n" + ."\n" + .'- 2: time-series engine.'."\n" + ."\n" + .'- 4: wide-column engine.'."\n" + ."\n" + .'- 8: file engine.'."\n" + ."\n" + .'> For example, if EngineType is 15, then 15 = 8 + 4 + 2 + 1. This means the instance supports the search engine, time-series engine, wide-column engine, and file engine. If EngineType is 6, then 6 = 4 + 2. This means the instance supports the time-series engine and wide-column engine.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + 'title' => '', + ], + 'ExpireTime' => [ + 'description' => 'Expiration time of the instance, in **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' => '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' => 'false', + 'title' => '', + ], + 'DeletionProtection' => [ + 'description' => 'Whether deletion protection is enabled. Valid values:'."\n" + ."\n" + .'- **true**: enabled.'."\n" + ."\n" + .'- **false**: disabled.', + 'type' => 'string', + 'example' => 'false', + 'title' => '', + ], + 'InstanceStorage' => [ + 'description' => 'Storage capacity of the instance.', + 'type' => 'string', + 'example' => '480', + 'title' => '', + ], + 'AliUid' => [ + 'description' => '16-digit AliUid of the Alibaba Cloud account (root account).', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '164901546557****', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID.', + 'type' => 'string', + 'example' => 'ld-bp1o3y0yme2i2****', + 'title' => '', + ], + 'RegionId' => [ + 'description' => 'Region ID.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '', + ], + 'CreateMilliseconds' => [ + 'description' => 'Number of milliseconds between the instance creation time and 1970-01-01 00:00:00 UTC.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1627290664000', + 'title' => '', + ], + 'InstanceAlias' => [ + 'description' => 'Instance name.', + 'type' => 'string', + 'example' => 'test0726', + 'title' => '', + ], + 'DiskThreshold' => [ + 'description' => 'Disk usage threshold.', + 'type' => 'string', + 'example' => '80%', + 'title' => '', + ], + 'ZoneId' => [ + 'description' => 'Zone ID.', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + 'title' => '', + ], + 'InstanceStatus' => [ + 'description' => 'Status of the instance. Valid values:'."\n" + ."\n" + .'- **CREATING**: creating.'."\n" + ."\n" + .'- **ACTIVATION**: running.'."\n" + ."\n" + .'- **COLD\\_EXPANDING**: expanding capacity cloud storage.'."\n" + ."\n" + .'- **MINOR\\_VERSION\\_TRANSING**: upgrading minor version.'."\n" + ."\n" + .'- **RESIZING**: scaling up nodes.'."\n" + ."\n" + .'- **SHRINKING**: scaling down nodes.'."\n" + ."\n" + .'- **CLASS\\_CHANGING**: changing specifications (upgrading or downgrading).'."\n" + ."\n" + .'- **SSL\\_SWITCHING**: changing SSL settings.'."\n" + ."\n" + .'- **CDC\\_OPENING**: enabling change tracking.'."\n" + ."\n" + .'- **TRANSFER**: migrating data.'."\n" + ."\n" + .'- **DATABASE\\_TRANSFER**: migrating data to a database.'."\n" + ."\n" + .'- **GUARD\\_CREATING**: creating disaster recovery instance.'."\n" + ."\n" + .'- **BACKUP\\_RECOVERING**: restoring from backup.'."\n" + ."\n" + .'- **DATABASE\\_IMPORTING**: importing data.'."\n" + ."\n" + .'- **NET\\_MODIFYING**: modifying network settings.'."\n" + ."\n" + .'- **NET\\_SWITCHING**: switching between internal and external networks.'."\n" + ."\n" + .'- **NET\\_CREATING**: creating network connection.'."\n" + ."\n" + .'- **NET\\_DELETING**: deleting network connection.'."\n" + ."\n" + .'- **DELETING**: deleting.'."\n" + ."\n" + .'- **RESTARTING**: restarting.'."\n" + ."\n" + .'- **LOCKED**: locked due to expiration.', + 'type' => 'string', + 'example' => 'ACTIVATION', + 'title' => '', + ], + 'EngineList' => [ + 'description' => 'List of engine information.', + 'type' => 'array', + 'items' => [ + 'description' => 'Engine information.', + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => 'Version number of the engine type.', + 'type' => 'string', + 'example' => '2.2.3', + 'title' => '', + ], + 'CpuCount' => [ + 'description' => 'Number of CPUs per engine node.', + 'type' => 'string', + 'example' => '4', + 'title' => '', + ], + 'CoreCount' => [ + 'description' => 'Number of engine nodes.', + 'type' => 'string', + 'example' => '2', + 'title' => '', + ], + 'Engine' => [ + 'description' => 'Type of engine. Valid values:'."\n" + ."\n" + .'- **lindorm**: wide-column engine.'."\n" + ."\n" + .'- **tsdb**: time-series engine.'."\n" + ."\n" + .'- **solr**: search engine.'."\n" + ."\n" + .'- **store**: file engine.'."\n" + ."\n" + .'- **bds**: LTS engine.'."\n" + ."\n" + .'- **compute**: compute engine.', + 'type' => 'string', + 'example' => 'lindorm', + 'title' => '', + ], + 'Specification' => [ + 'description' => 'Node specification for the engine.', + 'type' => 'string', + 'example' => 'lindorm.g.2xlarge', + 'title' => '', + ], + 'MemorySize' => [ + 'description' => 'Memory size per engine node.', + 'type' => 'string', + 'example' => '8GB', + 'title' => '', + ], + 'IsLastVersion' => [ + 'description' => 'Whether the engine type is at the latest version. Valid values:'."\n" + ."\n" + .'- **true**: latest version.'."\n" + ."\n" + .'- **false**: not the latest version.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'LatestVersion' => [ + 'description' => 'Latest version number for the engine type.', + 'type' => 'string', + 'example' => '2.2.19.2', + 'title' => '', + ], + 'PrimaryCoreCount' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'StandbyCoreCount' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ArbiterCoreCount' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'EnableCompute' => [ + 'description' => 'Whether the compute engine is enabled. Valid values:'."\n" + ."\n" + .'- **true**: enabled.'."\n" + ."\n" + .'- **false**: disabled.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'EnableSSL' => [ + 'description' => 'Whether SSL link encryption is enabled. Valid values:'."\n" + ."\n" + .'- **true**: enabled.'."\n" + ."\n" + .'- **false**: disabled.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'EnableMLCtrl' => [ + 'description' => 'Whether AI control node is enabled.'."\n" + ."\n" + .'- True: enabled.'."\n" + ."\n" + .'- False: disabled.', + 'type' => 'boolean', + 'example' => 'False', + 'title' => '', + ], + 'EnableCdc' => [ + 'description' => 'Whether change tracking is enabled. Valid values:'."\n" + ."\n" + .'- **true**: enabled.'."\n" + ."\n" + .'- **false**: disabled.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'EnableStream' => [ + 'description' => 'Whether the stream engine is enabled. Valid values:'."\n" + ."\n" + .'- **true**: enabled.'."\n" + ."\n" + .'- **false**: disabled.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'EnableLTS' => [ + 'description' => 'Whether the LTS engine is enabled. Valid values:'."\n" + ."\n" + .'- **true**: enabled.'."\n" + ."\n" + .'- **false**: disabled.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'EnableShs' => [ + 'description' => 'Whether the compute engine History Server is enabled.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'EnableBlob' => [ + 'description' => 'true: enabled.'."\n" + ."\n" + .'false: disabled.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'MaintainStartTime' => [ + 'description' => 'Maintenance window start time.', + 'type' => 'string', + 'example' => '00:00Z', + 'title' => '', + ], + 'MaintainEndTime' => [ + 'description' => 'Maintenance window end time.', + 'type' => 'string', + 'example' => '20:00Z', + 'title' => '', + ], + 'ResourceGroupId' => [ + 'description' => 'Resource group ID.', + 'type' => 'string', + 'example' => 'rg-aek2wvd6oia****', + 'title' => '', + ], + 'PrimaryZoneId' => [ + 'description' => 'Zone ID of the primary zone for a multi-zone instance.', + 'type' => 'string', + 'example' => 'cn-shanghai-e', + 'title' => '', + ], + 'StandbyZoneId' => [ + 'description' => 'Zone ID of the secondary zone for a multi-zone instance.', + 'type' => 'string', + 'example' => 'cn-shanghai-f', + 'title' => '', + ], + 'ArbiterZoneId' => [ + 'description' => 'Zone ID of the arbiter zone for a multi-zone instance.', + 'type' => 'string', + 'example' => 'cn-shanghai-g', + 'title' => '', + ], + 'PrimaryVSwitchId' => [ + 'description' => 'vSwitch ID of the primary zone for a multi-zone instance. The vSwitch must be in the zone specified by PrimaryZoneId.', + 'type' => 'string', + 'example' => 'vsw-uf6fdqa7c0pipnqzq****', + 'title' => '', + ], + 'StandbyVSwitchId' => [ + 'description' => 'vSwitch ID of the secondary zone for a multi-zone instance. The vSwitch must be in the zone specified by StandbyZoneId.', + 'type' => 'string', + 'example' => 'vsw-2zec0kcn08cgdtr6****', + 'title' => '', + ], + 'ArbiterVSwitchId' => [ + 'description' => 'vSwitch ID of the arbiter zone for a multi-zone instance. The vSwitch must be in the zone specified by ArbiterZoneId.', + 'type' => 'string', + 'example' => 'vsw-uf6664pqjawb87k36****', + 'title' => '', + ], + 'MultiZoneCombination' => [ + 'description' => 'Multi-zone combination. For supported combinations, see the product page.'."\n" + ."\n" + .'- **ap-southeast-5abc-aliyun**: Jakarta A+B+C.'."\n" + ."\n" + .'- **cn-hangzhou-ehi-aliyun**: Hangzhou E+H+I.'."\n" + ."\n" + .'- **cn-beijing-acd-aliyun**: Beijing A+C+D.'."\n" + ."\n" + .'- **ap-southeast-1-abc-aliyun**: Singapore A+B+C.'."\n" + ."\n" + .'- **cn-zhangjiakou-abc-aliyun**: Zhangjiakou A+B+C.'."\n" + ."\n" + .'- **cn-shanghai-efg-aliyun**: Shanghai E+F+G.'."\n" + ."\n" + .'- **cn-shanghai-abd-aliyun**: Shanghai A+B+D.'."\n" + ."\n" + .'- **cn-hangzhou-bef-aliyun**: Hangzhou B+E+F.'."\n" + ."\n" + .'- **cn-hangzhou-bce-aliyun**: Hangzhou B+C+E.'."\n" + ."\n" + .'- **cn-beijing-fgh-aliyun**: Beijing F+G+H.'."\n" + ."\n" + .'- **cn-shenzhen-abc-aliyun**: Shenzhen A+B+C.', + 'type' => 'string', + 'example' => 'cn-shanghai-efg-aliyun', + 'title' => '', + ], + 'CoreDiskCategory' => [ + 'description' => 'Disk type for core nodes in a multi-zone instance. Valid values:'."\n" + ."\n" + .'- **cloud\\_efficiency**: standard cloud storage.'."\n" + ."\n" + .'- **cloud\\_ssd**: compute-optimized cloud storage.'."\n" + ."\n" + .'- **cloud\\_essd**: enhanced compute-optimized cloud storage.'."\n" + ."\n" + .'- **cloud\\_essd\\_pl0**: compute-optimized cloud storage pl0.', + 'type' => 'string', + 'example' => 'cloud_efficiency', + 'title' => '', + ], + 'CoreSpec' => [ + 'description' => 'Node specification for core nodes in a multi-zone instance.', + 'type' => 'string', + 'example' => 'lindorm.g.xlarge', + 'title' => '', + ], + 'CoreNum' => [ + 'description' => 'Number of core nodes in a multi-zone instance.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + 'title' => '', + ], + 'CoreSingleStorage' => [ + 'description' => 'Disk capacity per core node in a multi-zone instance.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + 'title' => '', + ], + 'LogDiskCategory' => [ + 'description' => 'Disk type for log nodes in a multi-zone instance. Valid values:'."\n" + ."\n" + .'- **cloud\\_efficiency**: standard cloud storage.'."\n" + ."\n" + .'- **cloud\\_ssd**: compute-optimized cloud storage.', + 'type' => 'string', + 'example' => 'cloud_ssd', + 'title' => '', + ], + 'LogSpec' => [ + 'description' => 'Node specification for log nodes in a multi-zone instance.', + 'type' => 'string', + 'example' => 'lindorm.sn1.large', + 'title' => '', + ], + 'LogNum' => [ + 'description' => 'Number of log nodes in a multi-zone instance.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + 'title' => '', + ], + 'LogSingleStorage' => [ + 'description' => 'Disk capacity per log node in a multi-zone instance.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400GB', + 'title' => '', + ], + 'BackupInstance' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'EnableLsqlVersionV3' => [ + 'description' => 'Whether the wide-column engine supports LindormSQL-V3, which is compatible with MySQL protocol. Instances purchased after October 24, 2023 support this feature by default. For existing instances, contact Alibaba Cloud support to evaluate before enabling.'."\n" + ."\n" + .'- True: supported.'."\n" + ."\n" + .'- False: not supported.', + 'type' => 'boolean', + 'example' => 'True', + 'title' => '', + ], + 'EnableLProxy' => [ + 'description' => 'Whether the wide-column engine supports Thrift and CQL protocols. If not supported, use the SwitchLProxyService operation to enable or disable it.'."\n" + ."\n" + .'True: supported.'."\n" + ."\n" + .'False: not supported.', + 'type' => 'boolean', + 'example' => 'False', + 'title' => '', + ], + 'ArchVersion' => [ + 'description' => 'Deployment architecture. Valid values:'."\n" + ."\n" + .'- **1.0**: single-zone.'."\n" + ."\n" + .'- **2.0**: multi-zone.', + '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.', + ], + ], + ], + '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' => '*', + ], + ], + ], + ], + ], + '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\\": \\"\\",\\n \\"StandbyCoreCount\\": \\"\\",\\n \\"ArbiterCoreCount\\": \\"\\"\\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\\": \\"\\",\\n \\"EnableLsqlVersionV3\\": true,\\n \\"EnableLProxy\\": true,\\n \\"ArchVersion\\": \\"1.0\\"\\n}","type":"json"}]', + ], + 'GetLindormInstanceEngineList' => [ + 'summary' => 'Queries the engine types that a Lindorm instance supports.', + '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, + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + [ + '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, + 'title' => '', + 'example' => 'ld-bp1nq34mv3smk****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'title' => '', + 'example' => 'ld-bp1nq34mv3smk****', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => 'B496BA0E-520C-59FC-BA04-196D8F3B07EF', + ], + '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', + 'title' => '', + 'example' => 'lindorm', + ], + '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', + 'title' => '', + 'example' => '1', + ], + 'Port' => [ + 'description' => 'The port number of the database endpoint.', + 'type' => 'integer', + 'format' => 'int32', + 'title' => '', + 'example' => '30020', + ], + 'ConnectionString' => [ + 'description' => 'The database endpoint.', + 'type' => 'string', + 'title' => '', + 'example' => 'ld-bp1nq34mv3smk****-proxy-lindorm.lindorm.rds.aliyuncs.com', + ], + 'NetType' => [ + 'description' => 'The network type of the database endpoint. Valid values:'."\n" + ."\n" + .'- **0**: Internet.'."\n" + ."\n" + .'- **2**: Virtual private cloud (VPC).', + 'type' => 'string', + 'title' => '', + 'example' => '2', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The detailed reason why the access was denied.', + 'type' => 'string', + 'title' => '', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + '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', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [], + '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' => [ + '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 the [DescribeRegions](~~426062~~) operation to obtain the region ID.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'QueryStr', + 'in' => 'query', + 'schema' => [ + 'description' => 'A keyword for fuzzy search of instance names.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'test', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number to return.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'default' => '1', + 'title' => '', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'default' => '100', + 'title' => '', + 'example' => '20', + ], + ], + [ + 'name' => 'ServiceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type. 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 standalone Lindorm instance.'."\n" + ."\n" + .'- **lts**: the Lindorm Tunnel Service (LTS) type.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'lindorm', + ], + ], + [ + 'name' => 'SupportEngine', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data engine types supported by the instances that you want to query. Valid values:'."\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 you set SupportEngine to 15, which is the sum of 8, 4, 2, and 1, the instance supports the Search Engine, Time Series Engine, Wide Table Engine, and File Engine. If you set SupportEngine to 6, which is the sum of 4 and 2, the instance supports the Time Series Engine and Wide Table Engine.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '7', + 'minimum' => '-1', + 'default' => '-1', + 'title' => '', + 'example' => '15', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of tags.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag. The value of N can be from 1 to 20.'."\n" + ."\n" + .'> You can specify the keys of multiple tags. For example, the first \\`Key\\` parameter specifies the key of the first tag, and the second \\`Key\\` parameter specifies the key of the second tag.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'test', + ], + 'Value' => [ + 'description' => 'The value of the tag. The value of N can be from 1 to 20.'."\n" + ."\n" + .'> You can specify the values of multiple tags. For example, the first \\`Value\\` parameter specifies the value of the first tag, and the second \\`Value\\` parameter specifies the value of the second tag.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '2.2.18', + ], + ], + '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, + 'title' => '', + 'example' => 'rg-aek3b63arvg27vi', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => '1CA1FAFD-E8DC-51C2-AA7E-CA6E2D049BA0', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.', + 'type' => 'integer', + 'format' => 'int32', + 'title' => '', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned on the current page.', + 'type' => 'integer', + 'format' => 'int32', + 'title' => '', + 'example' => '20', + ], + 'Total' => [ + 'description' => 'The total number of instances found.', + 'type' => 'integer', + 'format' => 'int32', + 'title' => '', + 'example' => '1', + ], + 'InstanceList' => [ + 'description' => 'The list of instances.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC) to which the instance belongs.', + 'type' => 'string', + 'title' => '', + 'example' => 'vpc-bp1n3i15v90el48nx****', + ], + 'EngineType' => [ + 'description' => 'The types of engines supported by the instance. The return value is the sum of the values of the following 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 EngineType is 15, which is the sum of 8, 4, 2, and 1, the instance supports the Search Engine, Time Series Engine, Wide Table Engine, and File Engine. If the value of EngineType is 6, which is the sum of 4 and 2, the instance supports the Time Series Engine and Wide Table Engine.', + 'type' => 'string', + 'title' => '', + 'example' => '15', + ], + 'ExpireTime' => [ + 'description' => 'The expiration time of the instance.'."\n" + ."\n" + .'> This parameter is returned only for subscription instances.', + 'type' => 'string', + 'title' => '', + 'example' => '2022-04-26 00:00:00', + ], + 'CreateTime' => [ + 'description' => 'The time when the instance was created.', + 'type' => 'string', + 'title' => '', + 'example' => '2021-09-16 14:13:13', + ], + 'PayType' => [ + 'description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- **PREPAY**: subscription.'."\n" + ."\n" + .'- **POSTPAY**: pay-as-you-go.', + 'type' => 'string', + 'title' => '', + 'example' => 'PREPAY', + ], + 'AliUid' => [ + 'description' => 'The 16-digit AliUid of the Alibaba Cloud account.', + 'type' => 'integer', + 'format' => 'int64', + 'title' => '', + 'example' => '164901546557****', + ], + 'InstanceStorage' => [ + 'description' => 'The storage capacity of the instance.', + 'type' => 'string', + 'title' => '', + 'example' => '960', + ], + 'InstanceId' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'title' => '', + 'example' => 'ld-bp17pwu1541ia****', + ], + 'NetworkType' => [ + 'description' => 'The network type of the instance.', + 'type' => 'string', + 'title' => '', + 'example' => 'vpc', + ], + 'ServiceType' => [ + 'description' => 'The instance type. Valid values:'."\n" + ."\n" + .'- **lindorm**: a Lindorm instance.'."\n" + ."\n" + .'- **serverless\\_lindorm**: a Lindorm Serverless instance.'."\n" + ."\n" + .'- **lindorm\\_standalone**: a standalone Lindorm instance.'."\n" + ."\n" + .'- **lts**: the Lindorm Tunnel Service type.', + 'type' => 'string', + 'title' => '', + 'example' => 'lindorm', + ], + 'RegionId' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'title' => '', + 'example' => 'cn-hangzhou', + ], + 'CreateMilliseconds' => [ + 'description' => 'The timestamp of when the instance was created. The value is the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.', + 'type' => 'integer', + 'format' => 'int64', + 'title' => '', + 'example' => '1631772842000', + ], + 'InstanceAlias' => [ + 'description' => 'The instance name.', + 'type' => 'string', + 'title' => '', + 'example' => 'test', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.', + 'type' => 'string', + 'title' => '', + 'example' => 'cn-hangzhou-h', + ], + '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 expanded.'."\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 is being upgraded or downgraded.'."\n" + ."\n" + .'- **SSL\\_SWITCHING**: The SSL certificate is being changed.'."\n" + ."\n" + .'- **CDC\\_OPENING**: The change tracking 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 changed.'."\n" + ."\n" + .'- **NET\\_SWITCHING**: The network is being switched between the internal network and the internet.'."\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', + 'title' => '', + 'example' => 'ACTIVATION', + ], + 'ExpiredMilliseconds' => [ + 'description' => 'The timestamp of when the instance expires. The value is the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.', + 'type' => 'integer', + 'format' => 'int64', + 'title' => '', + 'example' => '1650902400000', + ], + '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', + 'title' => '', + 'example' => 'true', + ], + 'Tags' => [ + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag.', + 'type' => 'string', + 'title' => '', + 'example' => 'test', + ], + 'Value' => [ + 'description' => 'The value of the tag.', + 'type' => 'string', + 'title' => '', + 'example' => '2.2.18', + ], + ], + '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', + 'title' => '', + 'example' => 'true', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'title' => '', + 'example' => 'rg-aekzledqeat****', + ], + 'EnableMessage' => [ + 'description' => 'Indicates whether the message engine is enabled. Valid values:'."\n" + ."\n" + .'- **true**: Enabled.'."\n" + ."\n" + .'- **false**: Not enabled.', + 'type' => 'boolean', + 'title' => '', + 'example' => 'true', + ], + 'EnableVector' => [ + 'description' => 'Indicates whether the vector engine is enabled. Valid values:'."\n" + ."\n" + .'- **true**: Enabled.'."\n" + ."\n" + .'- **false**: Not enabled.', + 'type' => 'boolean', + 'title' => '', + 'example' => 'true', + ], + 'EnableLts' => [ + 'description' => 'Indicates whether the LTS engine is enabled. Valid values:'."\n" + ."\n" + .'- **true**: Enabled.'."\n" + ."\n" + .'- **false**: Not enabled.', + 'type' => 'boolean', + 'title' => '', + 'example' => 'true', + ], + 'EnableColumn' => [ + 'description' => 'Indicates whether the column store engine is enabled. Valid values:'."\n" + ."\n" + .'- **true**: Enabled.'."\n" + ."\n" + .'- **false**: Not enabled.', + 'type' => 'boolean', + 'title' => '', + 'example' => 'true', + ], + 'EnableRow' => [ + 'type' => 'boolean', + 'description' => 'Indicates whether Wide Table Engine 3.0 is enabled. Valid values:'."\n" + ."\n" + .'true: Enabled.'."\n" + .'false: Not enabled.', + 'title' => '', + 'example' => 'true', + ], + 'CreateErrorCode' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '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.', + ], + ], + ], + 'title' => 'GetLindormInstanceList', + 'summary' => 'Retrieves a list of Lindorm instances.', + '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}', + ], + ], + ], + ], + ], + '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\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetLindormV2InstanceDetails' => [ + '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 instance ID.', + '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 virtual switch ID.', + '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 ID of the Alibaba Cloud account.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '164901546557****', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'The instance ID.', + '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 change tracking 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 disk.'."\n" + ."\n" + .'- cloud\\_essd: performance disk.'."\n" + ."\n" + .'- cloud\\_efficiency: standard 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.', + '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 Basic Edition 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' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'EnableStoreTDE' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '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', + 'summary' => 'Queries the details of a new architecture instance.', + 'description' => 'For Lindorm clusters with an underlying storage version of 4.1.9 or later, refer to the LStorageUsageList parameter 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\\": \\"\\",\\n \\"EnableStoreTDE\\": \\"\\"\\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' => [], + '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 the region ID.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'A list of resource IDs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the instance. To query the relationships between multiple instances and their tags, pass multiple instance IDs. Call the [GetLindormInstanceList](~~426069~~) operation to get the instance IDs.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'ld-bp17j28j2y7pm****', + ], + 'required' => false, + 'docRequired' => true, + 'maxItems' => 51, + 'minItems' => 0, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token to start the next query to retrieve more results.'."\n" + ."\n" + .'> This parameter is not required for the first query. If a query does not return all results, pass the **NextToken** value from the previous response in the next query to continue.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '212db86****', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Set the value to **INSTANCE**.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'INSTANCE', + ], + ], + [ + '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" + .'> You can specify multiple tag keys. For example, the Key in the first key-value pair specifies the key of the first tag, and the Key in the second key-value pair specifies the key of the second tag.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'test', + ], + 'Value' => [ + 'description' => 'The value of the tag.'."\n" + ."\n" + .'> You can specify multiple tag values. For example, the Value in the first key-value pair specifies the value of the first tag, and the Value in the second key-value pair specifies the value of the second tag.', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '2.2.8', + ], + ], + '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', + 'title' => '', + 'example' => '05CB115C-91CB-529F-9098-50C1F6CB3BD3', + ], + 'TagResources' => [ + 'description' => 'A list of resources.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => 'The resource type. The value is always **ALIYUN::HITSDB::INSTANCE**.', + 'type' => 'string', + 'title' => '', + 'example' => 'ALIYUN::HITSDB::INSTANCE', + ], + 'TagValue' => [ + 'description' => 'The value of the tag.', + 'type' => 'string', + 'title' => '', + 'example' => '2.2.8', + ], + 'ResourceId' => [ + 'description' => 'The resource ID. This is the instance ID.', + 'type' => 'string', + 'title' => '', + 'example' => 'ld-bp17j28j2y7pm****', + ], + 'TagKey' => [ + 'description' => 'The key of the tag.', + 'type' => 'string', + 'title' => '', + 'example' => 'test', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'NextToken' => [ + 'description' => 'The token for the next query.'."\n" + ."\n" + .'> This parameter is returned if a query does not return all results. Pass the value of this parameter in the next query to continue.', + 'type' => 'string', + 'title' => '', + 'example' => '212db86****', + ], + ], + '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' => 'Queries for Lindorm instances and their associated tags.', + 'changeSet' => [], + 'ramActions' => [], + '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, + 'title' => '', + 'example' => 'ld-bp1z3506imz2f****', + ], + ], + [ + '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', + 'required' => true, + 'docRequired' => true, + 'title' => '', + 'example' => '1', + ], + ], + [ + '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, + 'title' => '', + 'example' => 'Month', + ], + ], + [ + '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, + 'title' => '', + 'example' => 'POSTPAY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => '587BCA54-50DA-4885-ADE9-80A848339151', + ], + 'OrderId' => [ + 'description' => 'The order ID.', + 'type' => 'integer', + 'format' => 'int64', + 'title' => '', + 'example' => '211662251220224', + ], + 'InstanceId' => [ + 'description' => 'The instance ID.', + 'type' => 'string', + 'title' => '', + 'example' => 'ld-bp1z3506imz2f****', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The detailed reason why the access is denied.', + 'type' => 'string', + 'title' => '', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + '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' => 'You can call this operation to switch 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 <props="china">[pricing](https://www.aliyun.com/price/product?spm=openapi-amp.newDocPublishment.0.0.6345281fu63xJ3#/hitsdb/detail/hitsdb_lindormpre_public_cn)</props>'."\n" + .'<props="intl">[pricing](https://www.alibabacloud.com/zh/pricing-calculator?_p_lc=1\\&spm=a2796.7960336.3034855210.1.7396b91aC5VjZ7#/commodity/vm_intl)</props> of Lindorm.', + 'changeSet' => [], + 'ramActions' => [], + '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 ID of the instance. To obtain the instance ID, call the [GetLindormInstanceList](~~426069~~) operation.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'title' => '', + 'example' => 'ld-bp1z3506imz2f****', + ], + ], + [ + 'name' => 'Immediately', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to release the instance immediately. The default value is 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', + 'title' => '', + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => 'F67BFFF3-F5C2-45B5-9C28-6E4A1E51****', + ], + ], + '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"}]', + 'translator' => 'machine', + ], + '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, + 'title' => '', + 'example' => 'cn-shanghai', + ], + ], + [ + '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, + 'title' => '', + 'example' => 'ld-bp1z3506imz2f****', + ], + ], + [ + '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', + ], + 'title' => '', + 'example' => 'Month', + ], + ], + [ + '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', + 'title' => '', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response that is returned.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'title' => '', + 'example' => '1556DCB0-043A-4444-8BD9-CF4A68E7EE64', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'title' => '', + 'example' => 'ld-bp1z3506imz2f****', + ], + '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', + 'title' => '', + 'example' => '213465921640411', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.', + 'type' => 'string', + 'title' => '', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + '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' => [], + '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, + 'title' => '', + 'example' => 'ld-bp1o3y0yme2i2****', + ], + ], + [ + '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', + ], + 'title' => '', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'title' => '', + 'example' => '1556DCB0-043A-4444-8BD9-CF4A68E7EE64', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.', + 'type' => 'string', + 'title' => '', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + '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' => [], + '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, + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Set the value to **INSTANCE**.', + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'INSTANCE', + ], + ], + [ + '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, + 'title' => '', + 'example' => 'ld-bp17j28j2y7pm****', + ], + '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, + 'title' => '', + 'example' => 'test', + ], + '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, + 'title' => '', + 'example' => '2.2.8', + ], + ], + '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', + 'title' => '', + 'example' => '4F23D50C-400C-592C-9486-9D1E10179065', + ], + ], + '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' => [], + '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, + 'title' => '', + 'example' => 'INSTANCE', + ], + ], + [ + '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, + 'title' => '', + 'example' => 'ld-bp17j28j2y7pm****', + ], + '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, + 'title' => '', + 'example' => 'test', + ], + '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', + 'required' => false, + 'default' => 'false', + 'title' => '', + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => '8CACBBCE-7519-545C-8695-86D4F09CED7E', + ], + ], + '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' => [], + '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, + 'title' => '', + 'example' => 'ld-bp1z3506imz2f****', + ], + ], + [ + '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, + 'title' => '', + 'example' => '192.168.0.X/24', + ], + ], + [ + '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, + 'title' => '', + 'example' => 'test_group', + ], + ], + [ + 'name' => 'Delete', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to clear the whitelist.', + 'type' => 'boolean', + 'required' => false, + 'title' => '', + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'title' => '', + 'example' => '4944539D-D27C-458D-95F1-2DCEB5E0EED5', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The detailed reason why the access is denied.', + 'type' => 'string', + 'title' => '', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + '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' => [], + '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" + .'><notice>'."\n" + ."\n" + .'If you do not specify data engine parameters when you create an instance, the API call fails.'."\n" + ."\n" + .'></notice>', + '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"}]', + 'translator' => 'machine', + ], + 'UpdateLindormV2Instance' => [ + 'summary' => 'Updates a Lindorm instance.', + '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' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'description' => 'The ID of the region where the instance is located. To query the latest region list, call the [DescribeRegions](~~426062~~) operation.', + 'title' => '', + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'CloudStorageType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'enum' => [ + 'StandardStorage', + 'PerformanceStorage', + 'CapacityStorage', + ], + 'description' => 'The cloud storage class.'."\n" + ."\n" + .'- **PerformanceStorage**: performance cloud storage.'."\n" + ."\n" + .'- **StandardStorage**: standard cloud storage.', + 'title' => '', + 'example' => 'PerformanceStorage', + ], + ], + [ + 'name' => 'CloudStorageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'description' => 'The cloud storage capacity. Unit: GB.', + 'title' => '', + 'example' => '480', + ], + ], + [ + 'name' => 'EnableCapacityStorage', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'description' => 'Specifies whether to enable storage-optimized storage.', + 'required' => false, + 'title' => '', + 'example' => 'false', + ], + ], + [ + 'name' => 'CapacityStorageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'description' => 'The capacity of the storage-optimized storage.', + 'required' => false, + 'title' => '', + 'example' => '10000', + ], + ], + [ + 'name' => 'EngineList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EngineType' => [ + 'type' => 'string', + 'required' => true, + 'enum' => [ + 'TABLE', + 'TSDB', + 'LTS', + 'LSEARCH', + 'LSTREAM', + 'LVECTOR', + 'LMESSAGE', + 'LAI', + 'LCOLUMN', + ], + '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.', + 'title' => '', + 'example' => 'TABLE', + ], + 'NodeGroupList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NodeSpec' => [ + 'type' => 'string', + 'required' => true, + '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.', + 'title' => '', + 'example' => 'lindorm.g.2xlarge', + ], + 'NodeCount' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'description' => 'The number of nodes.', + 'title' => '', + 'example' => '6', + ], + 'NodeDiskType' => [ + 'type' => 'string', + 'default' => 'cloud_essd', + 'enum' => [ + 'cloud_essd', + 'cloud_efficiency', + ], + '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.**', + 'required' => false, + 'title' => '', + 'example' => 'cloud_essd', + ], + 'NodeDiskSize' => [ + 'type' => 'integer', + 'format' => 'int32', + 'description' => 'The disk size of a single node. This parameter is not required.', + 'required' => false, + 'title' => '', + 'example' => '0', + ], + 'ResourceGroupName' => [ + 'type' => 'string', + 'description' => 'The name of the node group. **This parameter is required.** You can obtain the name by calling the GetLindormV2Instance operation.', + 'required' => false, + 'title' => '', + 'example' => 'groupName', + ], + 'GroupId' => [ + 'type' => 'string', + 'description' => 'The ID of the node group.', + 'required' => false, + 'title' => '', + 'example' => 'ix90Yes', + ], + ], + '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' => [ + 'type' => 'string', + 'required' => true, + 'description' => 'The instance ID.', + 'title' => '', + 'example' => 'ld-bp1o3y0yme2i2****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + 'description' => 'The request ID.', + 'title' => '', + 'example' => '1556DCB0-043A-4444-8BD9-CF4A68E7EE64', + ], + 'InstanceId' => [ + 'type' => 'string', + 'description' => 'The instance ID.', + 'title' => '', + 'example' => 'ld-bp1478w1603****', + ], + 'OrderId' => [ + 'type' => 'integer', + 'format' => 'int64', + 'description' => 'The order ID.', + 'title' => '', + 'example' => '240136741090345', + ], + 'AccessDeniedDetail' => [ + 'type' => 'string', + 'description' => 'The details of the access denied error.', + 'title' => '', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + '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', + 'changeSet' => [], + 'ramActions' => [], + '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' => 'Updates the IP whitelist 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. Call the [DescribeRegions](~~426062~~) operation to get the region ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance. Call the GetLindormV2InstanceList operation to get 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 whitelist group.', + 'type' => 'string', + 'required' => true, + 'example' => 'user001', + 'title' => '', + ], + 'WhiteIpList' => [ + '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 from 192.168.0.X to access the Lindorm instance. Separate multiple IP addresses or CIDR blocks with a comma (,).', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.X/24', + 'title' => '', + ], + ], + 'description' => 'The list of whitelist groups.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 100, + 'description' => 'The list of whitelist groups.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'title' => '', + 'example' => '0A7153E4-8354-497E-87E5-5D0EBEF5AEB1', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The details of the access denial.', + 'type' => 'string', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + 'title' => '', + ], + ], + 'title' => '', + 'description' => 'The response schema.', + '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' => [], + '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' => [ + '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. Call the [DescribeRegions](~~426062~~) operation to obtain the region ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'title' => '', + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the zone. Call the [GetLindormInstance](~~426067~~) operation to obtain the zone ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'title' => '', + 'example' => 'cn-shanghai-f', + ], + ], + [ + '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, + 'docRequired' => true, + 'title' => '', + 'example' => 'ld-bp1o3y0yme2i2****', + ], + ], + [ + 'name' => 'UpgradeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the upgrade. For more information about the supported upgrade types, see the description of the UpgradeType parameter.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'title' => '', + 'example' => 'upgrade-cold-storage', + ], + ], + [ + 'name' => 'ClusterStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage capacity of the instance after the upgrade. Unit: GB. Valid values: **480** to **1017600**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'title' => '', + 'example' => '480', + ], + ], + [ + 'name' => 'ColdStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cold storage capacity of the instance after the upgrade. Unit: GB. Valid values: **800** to **1000000**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'title' => '', + 'example' => '800', + ], + ], + [ + 'name' => 'SolrSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications of the search engine nodes of the instance after the upgrade. Valid values:'."\n" + ."\n" + .'- **lindorm.g.xlarge**: 4 cores, 16 GB (Dedicated)'."\n" + ."\n" + .'- **lindorm.g.2xlarge**: 8 cores, 32 GB (Dedicated)'."\n" + ."\n" + .'- **lindorm.g.4xlarge**: 16 cores, 64 GB (Dedicated)'."\n" + ."\n" + .'- **lindorm.g.8xlarg**e: 32 cores, 128 GB (Dedicated)', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'lindorm.g.xlarge', + ], + ], + [ + 'name' => 'SolrNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of search engine nodes in the instance after the upgrade. Valid values: **0** to **60**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'title' => '', + 'example' => '2', + ], + ], + [ + 'name' => 'LindormSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications of the LindormTable nodes of the instance after the upgrade. Valid values:'."\n" + ."\n" + .'- **lindorm.c.xlarge**: 4 cores, 8 GB (Dedicated)'."\n" + ."\n" + .'- **lindorm.c.2xlarge**: 8 cores, 16 GB (Dedicated)'."\n" + ."\n" + .'- **lindorm.c.4xlarge**: 16 cores, 32 GB (Dedicated)'."\n" + ."\n" + .'- **lindorm.c.8xlarge**: 32 cores, 64 GB (Dedicated)', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'lindorm.c.xlarge', + ], + ], + [ + 'name' => 'LindormNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of LindormTable nodes in the instance after the upgrade. Valid values: **0** to **90**.'."\n" + ."\n" + .'> This parameter must be specified with the LindormSpec parameter.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'title' => '', + 'example' => '2', + ], + ], + [ + 'name' => 'TsdbSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications of the LindormTSDB nodes of the instance after the upgrade. Valid values:'."\n" + ."\n" + .'- **lindorm.g.xlarge**: 4 cores, 16 GB (Dedicated)'."\n" + ."\n" + .'- **lindorm.g.2xlarge**: 8 cores, 32 GB (Dedicated)'."\n" + ."\n" + .'- **lindorm.g.4xlarge**: 16 cores, 64 GB (Dedicated)'."\n" + ."\n" + .'- **lindorm.g.8xlarge**: 32 cores, 128 GB (Dedicated)', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'lindorm.g.xlarge', + ], + ], + [ + 'name' => 'TsdbNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of LindormTSDB nodes in the instance after the upgrade. Valid values: **0** to **24**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'title' => '', + 'example' => '2', + ], + ], + [ + 'name' => 'FilestoreSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications of the file engine nodes of the instance after the upgrade. Valid value:'."\n" + ."\n" + .'**lindorm.c.xlarge**: 4 cores, 8 GB (Standard)', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'lindorm.c.xlarge', + ], + ], + [ + 'name' => 'FilestoreNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of file engine nodes in the instance after the upgrade. Valid values: **0** to **60**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'title' => '', + 'example' => '2', + ], + ], + [ + 'name' => 'StreamSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications of the stream engine nodes of the instance after the upgrade. Valid values:'."\n" + ."\n" + .'- **lindorm.c.2xlarge**: 8 cores, 16 GB (Dedicated)'."\n" + ."\n" + .'- **lindorm.c.4xlarge**: 16 cores, 32 GB (Dedicated)'."\n" + ."\n" + .'- **lindorm.c.8xlarge**: 32 cores, 64 GB (Dedicated)', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'lindorm.g.xlarge', + ], + ], + [ + 'name' => 'StreamNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of stream engine nodes in the instance after the upgrade. Valid values: **0** to **90**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'title' => '', + 'example' => '2', + ], + ], + [ + 'name' => 'LtsCoreSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications of the Lindorm Tunnel Service (LTS) nodes of the instance after the upgrade. Valid values:'."\n" + ."\n" + .'- **lindorm.g.xlarge**: 4 cores, 16 GB (Dedicated)'."\n" + ."\n" + .'- **lindorm.g.2xlarge**: 8 cores, 32 GB (Dedicated)', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'lindorm.g.xlarge', + ], + ], + [ + 'name' => 'LtsCoreNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of LTS nodes in the instance after the upgrade. Valid values: **0** to **50**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'title' => '', + 'example' => '2', + ], + ], + [ + 'name' => 'CoreSingleStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage capacity of a single core node in the multi-zone instance after the upgrade. Valid values: 400 to 64000. Unit: GB. **This parameter is available only for multi-zone instances.**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'title' => '', + 'example' => '400GB', + ], + ], + [ + 'name' => 'LogSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications of the log nodes in the multi-zone instance after the upgrade. Valid values:'."\n" + ."\n" + .'- **lindorm.sn1.large**: 4 cores, 8 GB (Dedicated)'."\n" + ."\n" + .'- **lindorm.sn1.2xlarge**: 8 cores, 16 GB (Dedicated)'."\n" + ."\n" + .'**This parameter is available only for multi-zone instances.**', + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => 'lindorm.sn1.large', + ], + ], + [ + 'name' => 'LogNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of log nodes in the multi-zone instance after the upgrade. Valid values: 4 to 400. **This parameter is available only for multi-zone instances.**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'title' => '', + 'example' => '4', + ], + ], + [ + 'name' => 'LogSingleStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The disk capacity of a single log node in the multi-zone instance after the upgrade. Valid values: 400 to 64000. Unit: GB. **This parameter is available only for multi-zone instances.**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'title' => '', + 'example' => '400GB', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => 'The ID of the order.', + 'type' => 'integer', + 'format' => 'int64', + 'title' => '', + 'example' => '111111111111111', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'title' => '', + 'example' => '2A7D4F9D-AA26-4E15-A2B1-3E4792C6****', + ], + ], + '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', + 'summary' => 'Enables cold storage for a Lindorm instance, or changes the node specifications, the number of nodes, or the storage capacity.', + 'description' => 'For more information about the data engines and storage specifications of Lindorm instances, see [Select data engines](~~174643~~) and [Select storage specifications](~~181971~~).', + 'requestParamsDescription' => '## Description of the UpgradeType parameter'."\n" + ."\n" + .'When you call the UpgradeLindormInstance operation, you must set the UpgradeType parameter to specify the upgrade type. You must also configure the parameters required for that upgrade type. The following table lists the required parameters for each upgrade type.'."\n" + ."\n" + .'| UpgradeType parameter | Type | Required parameters | Description |'."\n" + .'| ------------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| upgrade-cold-storage | String | ColdStorage | Enable or scale out cold storage. |'."\n" + .'| upgrade-disk-size | String | ClusterStorage | Scale out disks. |'."\n" + .'| open-search-engine | String | **For instances that use local disks**: SolrNum<br>**For other instances**: SolrNum, SolrSpec, and ClusterStorage | Enable the search engine. |'."\n" + .'| upgrade-search-engine | String | SolrSpec | Upgrade the specifications of the search engine. **Note** This parameter is not supported for instances that use local disks. |'."\n" + .'| upgrade-search-core-num | String | SolrNum and ClusterStorage | Change the number of search engine nodes. |'."\n" + .'| open-lindorm-engine | String | **For instances that use local disks**: LindormNum<br>**For other instances**: LindormNum, LindormSpec, and ClusterStorage | Enable the LindormTable engine. |'."\n" + .'| upgrade-lindorm-engine | String | LindormSpec | Upgrade the specifications of the LindormTable engine. **Note** This parameter is not supported for instances that use local disks. |'."\n" + .'| upgrade-lindorm-core-num | String | LindormNum and ClusterStorage | Change the number of LindormTable nodes. |'."\n" + .'| open-tsdb-engine | String | TsdbSpec, TsdbNum, and ClusterStorage | Enable the LindormTSDB engine. |'."\n" + .'| upgrade-tsdb-engine | String | TsdbSpec | Upgrade the specifications of the LindormTSDB engine. **Note** This parameter is not supported for instances that use local disks. |'."\n" + .'| upgrade-tsdb-core-num | String | TsdbNum and ClusterStorage | Change the number of LindormTSDB nodes. |'."\n" + .'| open-stream-engine | String | StreamSpec, StreamNum, and ClusterStorage | Enable the stream engine. |'."\n" + .'| upgrade-stream-engine | String | StreamSpec | Upgrade the specifications of the stream engine. **Note** This parameter is not supported for instances that use local disks. |'."\n" + .'| upgrade-stream-core-num | String | StreamNum and ClusterStorage | Change the number of stream engine nodes. |'."\n" + .'| upgrade-file-engine | String | FilestoreSpec | Upgrade the specifications of the file engine. **Note** This parameter is not supported for instances that use local disks. |'."\n" + .'| upgrade-file-core-num | String | FilestoreNum | Change the number of file engine nodes. |'."\n" + .'| open-bds-transfer | String | **For instances that use local disks**: LtsCoreNum, LtsCoreSpec, and SolrNum<br>**For other instances**: LtsCoreNum, LtsCoreSpec, SolrNum, and SolrSpec | Enable the BDS (LTS) engine and the search engine. |'."\n" + .'| upgrade-bds-transfer | String | LtsCoreSpec | Change the specifications of the BDS (LTS) engine. |'."\n" + .'| upgrade-bds-core-num | String | LtsCoreNum | Change the number of BDS (LTS) engine nodes. |'."\n" + .'| open-bds-transfer-only | String | LtsCoreNum and LtsCoreSpec | Enable the BDS (LTS) engine for an instance for which the search engine is already enabled. |'."\n" + ."\n" + .'For multi-zone instances, see the following table.'."\n" + ."\n" + .'| UpgradeType parameter | Type | Required parameters | Description |'."\n" + .'| ------------------------ | ------ | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| upgrade-disk-size | String | CoreSingleStorage and LogSingleStorage | Scale out the disk capacity of a single core node or a single log node. |'."\n" + .'| upgrade-lindorm-engine | String | LindormSpec and LogSpec | Upgrade the specifications of core nodes or log nodes. **Note** This parameter is not supported for instances that use local disks. |'."\n" + .'| upgrade-lindorm-core-num | String | LindormNum and LogNum | Change the number of core nodes or log nodes. |', + 'changeSet' => [], + 'ramActions' => [], + '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' => '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' => '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' => 'ModifyInstancePayType', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'lindorm:ModifyInstancePayType', + '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' => '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' => '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' => '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' => 'GetLindormInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'lindorm:GetLindormInstance', + 'authLevel' => 'resource', + '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' => 'CreateLindormV2Instance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'lindorm:CreateLindormV2Instance', + 'authLevel' => 'resource', + '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' => 'GetInstanceSummary', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'lindorm:GetInstanceSummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'Lindorm', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'RenewLindormInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'lindorm:RenewLindormInstance', + 'authLevel' => 'operate', + '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' => 'ListTagResources', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'lindorm:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'Lindorm', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateLindormV2WhiteIpList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'lindorm:UpdateLindormV2WhiteIpList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'Lindorm', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateLindormInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'lindorm:CreateLindormInstance', + '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' => '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' => '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' => 'UpdateLindormV2Instance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'lindorm:UpdateLindormV2Instance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'Lindorm', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetLindormFsUsedDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'lindorm:GetLindormFsUsedDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'Lindorm', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + '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/{#instanceId}', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'Instance', + 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'Instance', + 'arn' => 'acs:lindorm:{#regionId}:{#accountId}:instance/*', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'VSwitch', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:vswitch/*', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'Instance', + 'arn' => 'acs:lindorm:{#Region}:{#AccountId}:instance/{#InstanceId}', + ], + ], + ], +]; |