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/zh_cn/hitsdb/2017-06-01 | |
| download | acs-metadata-full-1.0.0+20260212.tar.gz acs-metadata-full-1.0.0+20260212.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/hitsdb/2017-06-01')
| -rw-r--r-- | data/zh_cn/hitsdb/2017-06-01/api-docs.php | 3128 |
1 files changed, 3128 insertions, 0 deletions
diff --git a/data/zh_cn/hitsdb/2017-06-01/api-docs.php b/data/zh_cn/hitsdb/2017-06-01/api-docs.php new file mode 100644 index 0000000..47df649 --- /dev/null +++ b/data/zh_cn/hitsdb/2017-06-01/api-docs.php @@ -0,0 +1,3128 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'hitsdb', + 'version' => '2017-06-01', + ], + 'directories' => [ + [ + 'children' => [ + 'DescribeRegions', + 'DescribeZones', + ], + 'type' => 'directory', + 'title' => '可用区', + ], + [ + 'children' => [ + 'CreateHiTSDBInstance', + 'DeleteHiTSDBInstance', + 'ModifyHiTSDBInstanceClass', + 'DescribeHiTSDBInstance', + 'DescribeHiTSDBInstanceList', + 'RenameHiTSDBInstanceAlias', + 'RestartHiTSDBInstance', + 'RenewTSDBInstance', + 'SwitchHiTSDBInstancePublicNet', + ], + 'type' => 'directory', + 'title' => '实例', + ], + [ + 'children' => [ + 'ModifyHiTSDBInstanceSecurityIpList', + 'DescribeHiTSDBInstanceSecurityIpList', + ], + 'type' => 'directory', + 'title' => '白名单', + ], + ], + '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' => '区域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'AppKey', + 'in' => 'query', + 'schema' => [ + 'description' => '备用参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'None', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shanghai-b', + ], + ], + [ + 'name' => 'InstanceAlias', + 'in' => 'query', + 'schema' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'tsdb_test', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => '实例规格。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'tsdb.1x.basic', + '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' => '实例存储容量，单位 GB。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '50', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型：'."\n" + ."\n" + .'- PREPAY：包年包月。'."\n" + ."\n" + .'- POSTPAY：按量付费。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PREPAY', + 'enum' => [ + 'POSTPAY', + 'PREPAY', + ], + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-wz9ydz3vg93s1ozsd****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vsw-wz9kv78f9cp47yadu****', + ], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型为包年包月的实例的购买时长单位。'."\n" + ."\n" + .'- Month：月。'."\n" + ."\n" + .'- Year：年。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + 'enum' => [ + 'Month', + 'Year', + ], + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '购买时长。'."\n" + ."\n" + .'- PricingCycle为Month时，取值范围为\\[1,9\\]。'."\n" + ."\n" + .'- PricingCycle为Year时，取值范围为\\[1,3\\]。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DiskCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'TSDB for InfluxDB®️的磁盘类型：'."\n" + ."\n" + .'- cloud_efficiency：高效云盘。'."\n" + ."\n" + .'- cloud_ssd：SSD云盘。'."\n" + ."\n" + .'- cloud_essd：ESSD云盘。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_ssd', + 'enum' => [ + 'cloud_essd', + 'cloud_ssd', + 'cloud_efficiency', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '587BCA54-50DA-4885-ADE9-80A848339151', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'ts-wz99vz6u8jg39****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '211110656240000', + ], + ], + ], + ], + ], + '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":""}]', + 'title' => '创建TSDB实例', + 'summary' => '调用CreateHiTSDBInstance创建一个TSDB实例。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'hitsdb:CreateHiTSDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => '全部资源', + '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' => '实例ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ts-ufxxxxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '1556DCB0-043A-4444-8BD9-CF4A68E7EE64', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝的详细原因。', + 'type' => 'string', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + ], + ], + ], + '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' => '操作失败，当前环境中该API无法使用。', + ], + [ + '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\\": \\"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' => '删除实例', + 'summary' => '调用DeleteHiTSDBInstance删除实例。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + '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' => '实例ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ts-ufxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '实例状态，ACTIVATION-运行中，CREATING-创建中，NET_CREATING-创建网络链接中，CLASS_CHANGING-实例变配中'."\n" + .' ，LOCKED-已锁定，DELETED-已删除', + 'type' => 'string', + 'example' => 'ACTIVATION', + ], + 'VpcId' => [ + 'description' => '专有网络ID', + 'type' => 'string', + 'example' => 'vpc-xxxxxxxxxxxxxxxxxxxxx', + ], + 'PaymentType' => [ + 'description' => '付费类型，PREPAY-包年包月；POSTPAY-按量付费', + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'VswitchId' => [ + 'description' => '专有网络交换机ID', + 'type' => 'string', + 'example' => 'vsw-xxxxxxxxxxxxxxxxxxxxx', + ], + 'CreateTime' => [ + 'description' => '实例创建的时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1603426323000', + ], + 'MemSize' => [ + 'description' => '数据库内存大小，针对TSDB for InfluxDB®️类型实例', + 'type' => 'string', + 'example' => '8', + ], + 'CpuNumber' => [ + 'description' => 'CPU核数', + 'type' => 'string', + 'example' => '2', + ], + 'ChargeType' => [ + 'description' => '付费类型，PREPAY-包年包月；POSTPAY-按量付费', + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'PublicConnectionString' => [ + 'description' => '实例公网连接串', + 'type' => 'string', + 'example' => 'ts-xxxxxxxxxxxxxxxxx.influxdata.rds.aliyuncs.com:3242', + ], + 'NetworkType' => [ + 'description' => '实例网络类型', + 'type' => 'string', + 'example' => 'VPC', + ], + 'MaxTimelineLimit' => [ + 'description' => '实例时间线性能， 单位<条>，针对TSDB类型实例', + 'type' => 'string', + 'example' => '2400000', + ], + 'DiskCategory' => [ + 'description' => '对于TSDB for InfluxDB®️类型，cloud_efficiency-高效云盘，cloud_ssd-SSD云盘', + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '8D156621-1FCB-414A-BD29-361C3CA4DD56', + ], + 'InstanceTps' => [ + 'description' => '实例 Tps 性能， 单位<请求/秒>', + 'type' => 'string', + 'example' => '960000', + ], + 'ConnectionString' => [ + 'description' => '数据库连接地址', + 'type' => 'string', + 'example' => 'ts-xxxxxxxxxxxxxxxxx.hitsdb.tsdb.aliyuncs.com:8242', + ], + 'GmtExpire' => [ + 'description' => '付费类型为包年包月的实例的到期时间，格式为yyyy-MM-dd HH:mm:ss', + 'type' => 'string', + 'example' => '2020-12-17 00:00:00', + ], + 'EngineType' => [ + 'description' => '引擎类型，tsdb_tsdb-tsdb类型，tsdb_influxdb-TSDB for InfluxDB®️类型，tsdb1.5-tsdb1.5类型', + 'type' => 'string', + 'example' => 'tsdb_tsdb', + ], + 'InstanceClass' => [ + 'description' => '实例规格', + 'type' => 'string', + 'example' => 'tsdb.96x.large_lindorm', + ], + 'AutoRenew' => [ + 'description' => '付费类型为包年包月的实例，是否开通自动续费', + 'type' => 'string', + 'example' => 'true', + ], + 'InstanceStorage' => [ + 'description' => '实例存储， 单位 G', + 'type' => 'string', + 'example' => '320', + ], + 'InstanceId' => [ + 'description' => '实例ID', + 'type' => 'string', + 'example' => 'ts-xxxxxxxxxxxxxxxxx', + ], + 'InstanceDescription' => [ + 'description' => '实例描述', + 'type' => 'string', + 'example' => 'test', + ], + 'RegionId' => [ + 'description' => '区域ID', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'GmtCreated' => [ + 'description' => '实例创建时间，格式为yyyy-MM-dd HH:mm:ss', + 'type' => 'string', + 'example' => '2020-11-16 16:22:56', + ], + 'InstanceAlias' => [ + 'description' => '实例名称', + 'type' => 'string', + 'example' => 'tsdb_test', + ], + 'ExpiredTime' => [ + 'description' => '对于包年包月类型，实例过期的时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1611417600000', + ], + 'ZoneId' => [ + 'description' => '实例可用区ID', + 'type' => 'string', + 'example' => 'cn-shanghai-f', + ], + 'InstanceStatus' => [ + 'description' => '实例状态，ACTIVATION-运行中，CREATING-创建中，NET_CREATING-创建网络链接中，CLASS_CHANGING-实例变配中'."\n" + .' ，LOCKED-已锁定，DELETED-已删除', + 'type' => 'string', + 'example' => 'ACTIVATION', + ], + 'Series' => [ + 'description' => 'TSDB for InfluxDB®️类型实例的版本，0-基础版，1-高可用版', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SecurityIpList' => [ + 'description' => '实例白名单列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Ip' => [ + 'description' => '实例白名单 IP'."\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' => '操作失败，请先申请指定资源的操作权限。', + ], + [ + 'errorCode' => 'Lindorm.Errorcode.ServiceLinkedRoleNoPermission', + 'errorMessage' => 'No permission to create service linked role.', + 'description' => '操作失败，请先申请创建服务关联角色的权限。', + ], + [ + 'errorCode' => 'API.Forbidden', + 'errorMessage' => 'The API operation is forbidden in this environment.', + 'description' => '操作失败，当前环境中该API无法使用。', + ], + ], + 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' => '获取实例', + 'summary' => '调用DescribeHiTSDBInstance获取实例详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hitsdb:DescribeHiTSDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => '全部资源', + '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' => '实例名称关键字，可根据该参数做模糊搜索', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'StatusList', + 'in' => 'query', + 'schema' => [ + 'description' => '状态过滤列表，JSON格式，枚举值为InstanceStatus。', + 'type' => 'string', + 'required' => false, + 'example' => '["ACTIVATION", "DELETED"]', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '30', + ], + ], + [ + 'name' => 'EngineType', + 'in' => 'query', + 'schema' => [ + 'description' => '引擎类型，tsdb\\_tsdb-tsdb类型，tsdb\\_influxdb-TSDB for InfluxDB®️类型', + 'type' => 'string', + 'required' => false, + 'example' => 'tsdb_tsdb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '0A7153E4-8354-497E-87E5-5D0EBEF5AEB1', + ], + 'PageNumber' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Total' => [ + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'InstanceList' => [ + 'description' => '实例列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '实例状态，ACTIVATION-运行中，CREATING-创建中，NET_CREATING-创建网络链接中，CLASS_CHANGING-实例变配中，LOCKED-已锁定，DELETED-已删除', + 'type' => 'string', + 'example' => 'ACTIVATION', + ], + 'VpcId' => [ + 'description' => '专有网络（VPC）的ID', + 'type' => 'string', + 'example' => 'vpc-bp1xxxxxxxxxxxxxxxxxx', + ], + 'PaymentType' => [ + 'description' => '付费类型，PREPAY-包年包月；POSTPAY-按量付费', + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'MaxSeriesPerDatabase' => [ + 'description' => '单个数据库时间线的最大数量', + 'type' => 'string', + 'example' => '10000', + ], + 'EngineType' => [ + 'description' => '引擎类型，tsdb_tsdb-tsdb类型，tsdb_influxdb-TSDB for InfluxDB®️类型', + 'type' => 'string', + 'example' => 'tsdb_tsdb', + ], + 'VswitchId' => [ + 'description' => '虚拟交换机的ID', + 'type' => 'string', + 'example' => 'vsw-bp1xxxxxxxxxxxxxxxxxx', + ], + 'InstanceClass' => [ + 'description' => '实例规格', + 'type' => 'string', + 'example' => 'tsdb.1x.basic', + ], + 'CreateTime' => [ + 'description' => '实例创建的时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1603426323000', + ], + 'ChargeType' => [ + 'description' => '付费类型，PREPAY-包年包月；POSTPAY-按量付费', + 'type' => 'string', + 'example' => 'POSTPAY', + ], + 'UserId' => [ + 'description' => '用户ID', + 'type' => 'string', + 'example' => '1000000000000000', + ], + 'InstanceStorage' => [ + 'description' => '实例存储， 单位 G', + 'type' => 'string', + 'example' => '50', + ], + 'NetworkType' => [ + 'description' => '实例网络类型：VPC-专有网络', + 'type' => 'string', + 'example' => 'VPC', + ], + 'InstanceId' => [ + 'description' => '实例ID', + 'type' => 'string', + 'example' => 'ts-xxxxxxxxxxxxxxxxx', + ], + 'LockMode' => [ + 'description' => '实例是否被锁定，0-未锁定，1-锁定', + 'type' => 'string', + 'example' => '0', + ], + 'InstanceDescription' => [ + 'description' => '实例描述', + 'type' => 'string', + 'example' => 'test', + ], + 'RegionId' => [ + 'description' => '实例所在地域ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GmtCreated' => [ + 'description' => '实例创建时间，格式为yyyy-MM-dd HH:mm:ss', + 'type' => 'string', + 'example' => '2020-11-16 16:22:56', + ], + 'InstanceAlias' => [ + 'description' => '实例名称', + 'type' => 'string', + 'example' => 'test_tsdb', + ], + 'InstanceTps' => [ + 'description' => '实例 Tps 性能， 单位<请求/秒>', + 'type' => 'string', + 'example' => '960000', + ], + 'ExpiredTime' => [ + 'description' => '对于包年包月类型，实例过期的时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1611417600000', + ], + 'ZoneId' => [ + 'description' => '实例可用区ID', + 'type' => 'string', + 'example' => 'cn-hongkong-b', + ], + 'InstanceStatus' => [ + 'description' => '实例状态， 枚举', + 'type' => 'string', + 'example' => 'ACTIVATION', + ], + 'GmtExpire' => [ + 'description' => '付费类型为包年包月的实例的到期时间，格式为yyyy-MM-dd HH:mm:ss', + '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' => '获取实例列表', + 'summary' => '调用DescribeHiTSDBInstanceList查询数据库获取实例列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'hitsdb:DescribeHiTSDBInstanceList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => '全部资源', + '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' => '实例ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ts-xxxxxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '分组名称，只允许包含字母、数字、下划线。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_group', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F2DFDC0B-FE4F-4696-9FD1-2EFDEE8D6C7C', + ], + 'SecurityIpList' => [ + 'description' => '网络白名单列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Ip' => [ + 'description' => '白名单IP', + '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' => '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' => '调用DescribeHiTSDBInstanceSecurityIpList获取实例白名单列表。', + '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' => '返回值的语言，取值范围：'."\n" + ."\n" + .'- zh-CN：中文'."\n" + .'- en-US：英文'."\n" + .'- ja：日文'."\n" + ."\n" + .'默认值：zh-CN。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'BDDB1954-002B-4249-B2DF-2CDDA0259668', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => '地域信息的集合', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionEndpoint' => [ + 'description' => '地域对应的接入地址（Endpoint）', + 'type' => 'string', + 'example' => 'hitsdb.aliyuncs.com', + ], + 'LocalName' => [ + 'description' => '地域名称', + 'type' => 'string', + 'example' => '华东1（杭州）', + ], + 'RegionId' => [ + 'description' => '地域ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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":""}]', + 'title' => '查看用户可选的地域和可用区', + 'summary' => '调用DescribeRegions查询可部署时序数据库的Region列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + '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' => '语言环境，zh_CN-中文，en_US-英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh_CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F67BFFF3-F5C2-45B5-9C28-6E4A1E51449B', + ], + 'ZoneList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ZoneModel' => [ + 'description' => '可用区列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => '可用区ID', + 'type' => 'string', + 'example' => 'cn-shanghai-b', + ], + 'LocalName' => [ + 'description' => '可用区名称', + 'type' => 'string', + 'example' => '华东2可用区B', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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":""}]', + 'title' => '查询某一阿里云地域下的可用区', + 'summary' => '调用DescribeZones获取实例支持的可用区信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + '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' => '实例ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ts-xxxxxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => '实例规格', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'tsdb.1x.basic', + ], + ], + [ + 'name' => 'InstanceStorage', + 'in' => 'query', + 'schema' => [ + 'description' => '实例存储容量，单位GB', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '500', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '57540985-3C11-4588-96FD-93413C6282EF', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝的详细原因。', + 'type' => 'string', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + ], + ], + ], + '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' => '修改实例规格', + 'summary' => '调用ModifyHiTSDBInstanceClass修改实例规格。', + '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' => '实例ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ts-ufxxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'SecurityIpList', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP pattern的列表，JSON格式的字符串。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[“127.0.0.1”, “192.168.0.1/24”]', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '分组名称，只允许包含字母、数字、下划线。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_group', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '1556DCB0-043A-4444-8BD9-CF4A68E7EE64', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝的详细原因。', + 'type' => 'string', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + ], + ], + ], + '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' => '调用ModifyHiTSDBInstanceSecurityIpList设置实例的IP白名单。', + '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' => '实例ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ts-ufxxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'InstanceAlias', + 'in' => 'query', + 'schema' => [ + 'description' => '实例别名', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vme', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '1556DCB0-043A-4444-8BD9-CF4A68E7EE64', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝的详细原因。', + 'type' => 'string', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + ], + ], + ], + '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' => '操作失败，当前环境中该API无法使用。', + ], + [ + '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\\": \\"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' => '修改实例别名', + 'summary' => '调用RenameHiTSDBInstanceAlias修改实例别名。', + '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' => '区域ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ts-xxxxxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型为包年包月的实例的购买时长单位，Month-月，Year-年', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Month', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '购买时长，PricingCycle为Month时，取值范围为\\[1,9\\]，PricingCycle为Year时，取值范围为\\[1,3\\]', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '订单ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000000000000', + ], + 'RequestId' => [ + 'description' => '请求ID', + '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' => '为包年包月付费类型实例进行续费操作', + 'summary' => '调用RenewTSDBInstance为包年包月付费类型实例进行续费操作。', + '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' => '实例ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ts-ufxxxxxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '1556DCB0-043A-4444-8BD9-CF4A68E7EE64', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝的详细原因。', + 'type' => 'string', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + ], + ], + ], + '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' => '操作失败，请先申请创建服务关联角色的权限。', + ], + [ + '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' => '操作失败，当前环境中该API无法使用。', + ], + ], + ], + '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' => '重启数据库实例', + 'summary' => '调用RestartHiTSDBInstance重启实例。', + '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' => '实例id', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ts-ufxxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'SwitchAction', + 'in' => 'query', + 'schema' => [ + 'description' => '-**1**：开启公网链接-**0**：关闭公网链接', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'EC6A17BC-B326-4626-B3BE-932B003DB3A9', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝的详细原因。', + 'type' => 'string', + 'example' => '{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}', + ], + ], + ], + ], + ], + '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' => '切换实例公网链接状态', + 'summary' => '调用SwitchHiTSDBInstancePublicNet切换实例公网链接状态。', + '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' => '华北6（乌兰察布）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'hitsdb.cn-wulanchabu.aliyuncs.com', + 'endpoint' => 'hitsdb.cn-wulanchabu.aliyuncs.com', + 'vpc' => 'hitsdb-vpc.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'regionName' => '华北2（北京）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'hitsdb.cn-beijing.aliyuncs.com', + 'endpoint' => 'hitsdb.cn-beijing.aliyuncs.com', + 'vpc' => 'hitsdb-vpc.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'regionName' => '华北1（青岛）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'hitsdb.cn-qingdao.aliyuncs.com', + 'endpoint' => 'hitsdb.cn-qingdao.aliyuncs.com', + 'vpc' => 'hitsdb-vpc.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'regionName' => '华东2（上海）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'hitsdb.cn-shanghai.aliyuncs.com', + 'endpoint' => 'hitsdb.cn-shanghai.aliyuncs.com', + 'vpc' => 'hitsdb-vpc.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'regionName' => '中国香港', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'hitsdb.cn-hongkong.aliyuncs.com', + 'endpoint' => 'hitsdb.cn-hongkong.aliyuncs.com', + 'vpc' => 'hitsdb-vpc.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'regionName' => '华北3（张家口）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'hitsdb.cn-zhangjiakou.aliyuncs.com', + 'endpoint' => 'hitsdb.cn-zhangjiakou.aliyuncs.com', + 'vpc' => 'hitsdb-vpc.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'regionName' => '华南1（深圳）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'hitsdb.cn-shenzhen.aliyuncs.com', + 'endpoint' => 'hitsdb.cn-shenzhen.aliyuncs.com', + 'vpc' => 'hitsdb-vpc.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'regionName' => '日本（东京）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '西南1（成都）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'hitsdb.cn-chengdu.aliyuncs.com', + 'endpoint' => 'hitsdb.cn-chengdu.aliyuncs.com', + 'vpc' => 'hitsdb-vpc.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'regionName' => '新加坡', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '马来西亚（吉隆坡）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华北5（呼和浩特）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'hitsdb.cn-huhehaote.aliyuncs.com', + 'endpoint' => 'hitsdb.cn-huhehaote.aliyuncs.com', + 'vpc' => 'hitsdb-vpc.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'regionName' => '印度尼西亚（雅加达）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + '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' => '华东1（杭州）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'hitsdb.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'hitsdb.cn-hangzhou.aliyuncs.com', + 'vpc' => 'hitsdb-vpc.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'regionName' => '美国（弗吉尼亚）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + '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' => '英国（伦敦）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + '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' => '美国（硅谷）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + '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' => '德国（法兰克福）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + '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' => '华东1 金融云', + 'areaId' => 'industryCloud', + 'areaName' => '行业云', + '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' => '华南1 金融云', + 'areaId' => 'industryCloud', + 'areaName' => '行业云', + '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' => '华东2 金融云', + 'areaId' => 'industryCloud', + 'areaName' => '行业云', + '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' => '北京政务云', + 'areaId' => 'industryCloud', + 'areaName' => '行业云', + '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' => '操作失败，当前环境中该API无法使用。', + ], + [ + 'code' => 'ChargeType.IsNotValid', + 'message' => 'The charge type is invalid.', + 'http_code' => 400, + 'description' => '操作失败，实例的付费类型无效，请重新设置付费类型。', + ], + [ + 'code' => 'CloudDiskNodes.less', + 'message' => 'Nodes too less, please ensure that the number of engine nodes is more than %s', + 'http_code' => 400, + 'description' => '请确保所选数据库引擎节点总数大于等于%s个', + ], + [ + 'code' => 'Commodity.NotFound', + 'message' => 'The commodity is not found.', + 'http_code' => 400, + 'description' => '操作失败，商品信息未找到，请输入正确的商品信息。', + ], + [ + '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' => '获取商品信息失败，可能当前类型实例并不支持通过API创建。', + ], + [ + 'code' => 'CurrentEngineType.ClassChangingNotSupported', + 'message' => 'The current engine type does not support class changing.', + 'http_code' => 400, + 'description' => '操作失败，当前实例的引擎类型不支持变配操作。', + ], + [ + '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' => '操作失败，不支持减少实例的存储容量。', + ], + [ + 'code' => 'Instance.IsDeleted', + 'message' => 'The instance is deleted.', + 'http_code' => 400, + 'description' => '操作失败，该实例已删除。', + ], + [ + 'code' => 'Instance.IsModifyingClass', + 'message' => 'The instance class is being modified and cannot be operated.', + 'http_code' => 400, + 'description' => '操作失败，实例正在执行变配操作，请变配操作结束后再重试。', + ], + [ + 'code' => 'Instance.IsNotAvailable', + 'message' => 'The instance is unavailable.', + 'http_code' => 400, + 'description' => '操作失败，实例不可用。', + ], + [ + 'code' => 'Instance.IsNotPostPay', + 'message' => 'The instance billing type is not subscription.', + 'http_code' => 400, + 'description' => '操作失败，付费类型为包年包月不支持该操作。', + ], + [ + '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' => '操作失败，实例无效。', + ], + [ + 'code' => 'Instance.NotActive', + 'message' => 'Instance is not active.', + 'http_code' => 403, + 'description' => '实例状态不是运行中', + ], + [ + 'code' => 'Instance.RestartError', + 'message' => 'An error occurred while restarting the instance.', + 'http_code' => 400, + 'description' => '操作失败，重启实例出错，请重试。', + ], + [ + 'code' => 'Instance.SpecIsNotValid', + 'message' => 'The instance specification is invalid.', + 'http_code' => 400, + 'description' => '操作失败，当前实例的引擎规格参数无效，请检查输入的参数。', + ], + [ + 'code' => 'Instance.Upgrade.ParamsIsNotValid', + 'message' => 'The instance upgrade parameters are invalid.', + 'http_code' => 400, + 'description' => '实例升级参数不合法。', + ], + [ + 'code' => 'Instance.Upgrade.ParamsIsNotValid', + 'message' => 'The instance upgrade parameters are invalid.', + 'http_code' => 400, + 'description' => '操作失败，实例的升级规格参数无效，请输入正确的升级规格。', + ], + [ + 'code' => 'InstanceConfig.NotChanged', + 'message' => 'The upgrade or downgrade configuration is not changed, please check.', + 'http_code' => 400, + 'description' => '升级或降配的配置未改变，请重新选择', + ], + [ + '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' => '存在重复标签Key。', + ], + [ + 'code' => 'Lindorm.Errorcode.InstanceNotFound', + 'message' => 'The instance is not found.', + 'http_code' => 404, + 'description' => '操作失败，该实例不存在。', + ], + [ + 'code' => 'Lindorm.Errorcode.InstanceStorageInvalid', + 'message' => 'The instance storage parameter is invalid: %s', + 'http_code' => 400, + 'description' => '操作失败，实例的存储空间参数无效，请输入正确的存储空间数。', + ], + [ + 'code' => 'Lindorm.Errorcode.InvalidParameter.TagKey', + 'message' => 'The Tag.N.Key parameter is invalid.', + 'http_code' => 400, + 'description' => '输入的标签Key无效。', + ], + [ + 'code' => 'Lindorm.Errorcode.InvalidParameter.TagValue', + 'message' => 'The Tag.N.Value parameter is invalid.', + 'http_code' => 400, + 'description' => '输入的标签Value无效', + ], + [ + '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' => '无效的标签Key', + ], + [ + 'code' => 'Lindorm.Errorcode.MissingParameter', + 'message' => 'You must specify ResourceId.N or Tags', + 'http_code' => 400, + 'description' => '请指定实例ID或标签。', + ], + [ + 'code' => 'Lindorm.Errorcode.MissingParameter.TagKey', + 'message' => 'You must specify Tag.N.Key.', + 'http_code' => 404, + 'description' => '请指定标签Key', + ], + [ + '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' => '实例数量超限，最多不超过50个。', + ], + [ + 'code' => 'Lindorm.Errorcode.NumberExceed.ResourceIds', + 'message' => 'The maximum number of ResourceIds is exceeded.', + 'http_code' => 400, + 'description' => '实例ID数量超过限制，最多不超过50个', + ], + [ + 'code' => 'Lindorm.Errorcode.NumberExceed.Tags', + 'message' => 'The maximum number of Tags is exceeded.', + 'http_code' => 400, + 'description' => '标签数量超过限制，最多不超过20个。', + ], + [ + 'code' => 'Lindorm.Errorcode.OperationDenied', + 'message' => 'You are not authorized to operate on the specified resource.', + 'http_code' => 403, + 'description' => '操作失败，请先申请指定资源的操作权限。', + ], + [ + 'code' => 'Lindorm.Errorcode.ParameterInvaild', + 'message' => 'The parameter is invalid.', + 'http_code' => 400, + 'description' => '操作失败，当前参数无效，请重新设置。', + ], + [ + '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' => '操作失败，当前参数无效，请重新设置。', + ], + [ + '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' => '操作失败，请先申请创建服务关联角色的权限。', + ], + [ + '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' => '当前密码安全性较弱，处于安全考虑，请重新设置密码', + ], + [ + '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' => '操作失败，引擎版本过低，请升级引擎版本。', + ], + [ + 'code' => 'ModifySecurityIpList.AddAclGetNull', + 'message' => 'Failed to add access control list.', + 'http_code' => 400, + 'description' => '添加访问控制策略失败，请检查输入的参数。', + ], + [ + 'code' => 'ModifySecurityIpList.CreateAclGetNull', + 'message' => 'Failed to create access control list.', + 'http_code' => 400, + 'description' => '创建访问控制策略失败。', + ], + [ + 'code' => 'ModifySecurityIpList.CreateAclGetNull', + 'message' => 'Failed to create access control list.', + 'http_code' => 400, + 'description' => '创建访问控制策略失败，请检查输入的参数。', + ], + [ + 'code' => 'ModifySecurityIpList.DescribeAclFailed', + 'message' => 'Failed to describe access control list.', + 'http_code' => 400, + 'description' => '查询访问控制策略失败，请检查输入的参数。', + ], + [ + 'code' => 'ModifySecurityIpList.LoadBalancerSizeAbnormal', + 'message' => 'The number of load balancers is abnormal.', + 'http_code' => 400, + 'description' => '操作失败，负载均衡器数量输入异常，请检查输入的数量。', + ], + [ + 'code' => 'ModifySecurityIpList.QueryIngressFailed', + 'message' => 'Failed to query SLB ingress.', + 'http_code' => 400, + 'description' => '查询负载均衡器的Ingress策略失败，请检查输入的参数。', + ], + [ + 'code' => 'ModifySecurityIpList.QueryLoadBalancersFailed', + 'message' => 'Failed to query load balancers.', + 'http_code' => 400, + 'description' => '查询负载均衡器信息失败，请检查输入的参数。', + ], + [ + 'code' => 'ModifySecurityIpList.RemoveAclFailed', + 'message' => 'Failed to remove access control list.', + 'http_code' => 400, + 'description' => '删除访问控制策略失败，请检查输入的参数。', + ], + [ + 'code' => 'ModifySecurityIpList.SetLBTcpListenerFailed', + 'message' => 'Failed to set load balancer TCP listener attribute.', + 'http_code' => 400, + 'description' => '设置负载均衡器TCP监听器配置失败，请检查输入的参数。', + ], + [ + 'code' => 'OperationDenied.OrderProcessing', + 'message' => 'Order in process, please try again later.', + 'http_code' => 403, + 'description' => '存在处理中的订单，请稍后重试', + ], + [ + 'code' => 'Order.CreateFailed', + 'message' => 'Failed to create the order.', + 'http_code' => 400, + 'description' => '创建订单失败，请重新选择订单信息。', + ], + [ + 'code' => 'SecurityGroup.DescribeFailed', + 'message' => 'Failed to query instance security groups.', + 'http_code' => 400, + 'description' => '查询实例的安全组失败，请重新输入安全组。', + ], + [ + 'code' => 'SecurityGroup.UpdateFailed', + 'message' => 'Failed to update instance security groups.', + 'http_code' => 400, + 'description' => '添加实例的安全组失败，请重新选择安全组。', + ], + [ + 'code' => 'TSDB.Errorcode.InstanceClassAndEngineTypeMismatch', + 'message' => 'The engine type and instance class parameters do not match. Instance class will take precedence.', + 'http_code' => 411, + 'description' => '实例的引擎类型和引擎规格不匹配，执行该操作以实例的引擎规格为准。', + ], + [ + 'code' => 'TSDB.Errorcode.InstanceClassInvalid', + 'message' => 'The parameter of InstanceClass is invalid.', + 'http_code' => 410, + 'description' => '操作失败，实例的引擎规格族参数无效，请输入正确的规格。', + ], + [ + 'code' => 'TSDB.Errorcode.InstanceCreateFailed', + 'message' => 'Failed to create the instance.', + 'http_code' => 414, + 'description' => '创建实例操作失败。', + ], + [ + 'code' => 'TSDB.Errorcode.InstanceCreateRetrying', + 'message' => 'The system is trying to create the instance again.', + 'http_code' => 415, + 'description' => '创建实例操作失败，重试中。', + ], + [ + 'code' => 'TSDB.Errorcode.InstanceDeleted', + 'message' => 'The instance is already deleted.', + 'http_code' => 416, + 'description' => '操作失败，该实例已删除。', + ], + [ + 'code' => 'TSDB.Errorcode.InstanceNotFound', + 'message' => 'The instance is not found', + 'http_code' => 404, + 'description' => '操作失败，该实例不存在。', + ], + [ + 'code' => 'TSDB.Errorcode.InstanceNotFound', + 'message' => 'The instance is not found. Please try again later.', + 'http_code' => 413, + 'description' => '操作失败，该实例不存在。', + ], + [ + 'code' => 'TSDB.Errorcode.InstanceStorageInvalid', + 'message' => 'The parameter of instance storage is invalid.', + 'http_code' => 412, + 'description' => '操作失败，实例的存储空间参数无效，请输入正确的存储空间数。', + ], + [ + 'code' => 'TSDB.Errorcode.ParameterInvaild', + 'message' => 'The parameter is invalid.', + 'http_code' => 400, + 'description' => '操作失败，当前参数无效，请重新设置。', + ], + [ + 'code' => 'UnsupportedServiceType', + 'message' => 'The instance service type is not supported.', + 'http_code' => 403, + 'description' => '操作失败，该实例已开通的引擎模式不支持此功能。', + ], + [ + 'code' => 'VisitInstance.ApiNotSupported', + 'message' => 'Action failed. Your instance version is too old.', + 'http_code' => 400, + 'description' => '操作失败，该实例引擎版本过低不支持此功能，请升级引擎版本。', + ], + [ + 'code' => 'VisitInstance.Failed', + 'message' => 'Failed to connect the instance. Please contact our customer service.', + 'http_code' => 503, + 'description' => '连接实例失败，请提交工单处理。', + ], + [ + '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' => '操作失败，连接实例超时，请检查该实例是否正在执行耗时的任务，或者请提交工单处理。', + ], + [ + 'code' => 'InvalidDBInstance.NotFound', + 'message' => 'Specified instance does not exist or not support.', + 'http_code' => 404, + 'description' => '该实例不存在或者不支持该操作。', + ], + [ + 'code' => 'IncorrectDBState', + 'message' => 'Can not do this operation, because instance status is not ACTIVATION.', + 'http_code' => 403, + 'description' => '不允许做当前操作，因为实例状态不是运行中。', + ], + [ + 'code' => 'Instance.DeleteProtection', + 'message' => 'Instance deletion is protected. Please disable delete protection before deleting the instance.', + 'http_code' => 400, + 'description' => '实例已启用删除保护，在删除实例之前先禁用删除保护。', + ], + [ + 'code' => 'Resource.ecsResource.closeSale', + 'message' => 'This region is currently closed for sale.', + 'http_code' => 400, + 'description' => '当前区域已关闭实例售卖功能，建议选择其他区域创建实例。如需协助，请咨询技术支持。', + ], + [ + 'code' => 'WhiteIpInUpdating', + 'message' => 'Instance is updating whiteIp now, please wait.', + 'http_code' => 400, + 'description' => '实例白名单更新中，请稍候。', + ], + [ + 'code' => 'ScalingRule.ExecutionTimeConflict', + 'message' => 'The execution times of the scaling rules conflict.', + 'http_code' => 400, + 'description' => '弹性伸缩定时任务的执行时间存在冲突', + ], + [ + 'code' => 'Ranger.NotEnabled', + 'message' => 'For your data security, please enable Ranger service before switching public network.', + 'http_code' => 403, + 'description' => '为了您的数据安全，请在开通公网地址前先开通Ranger服务。', + ], + ], + 'changeSet' => [], + 'ram' => [ + 'productCode' => 'TSDB', + 'productName' => '云原生多模数据库 Lindorm', + 'ramCodes' => [ + 'hitsdb', + ], + 'ramLevel' => '操作级', + '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' => 'ModifyHiTSDBInstanceSecurityIpList', + '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' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateHiTSDBInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'hitsdb:CreateHiTSDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'TSDB', + 'resourceType' => '全部资源', + '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' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeHiTSDBInstanceSecurityIpList', + 'description' => 'DescribeHiTSDBInstanceSecurityIpList', + '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}', + ], + ], + ], +]; |