'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":"\\n587BCA54-50DA-4885-ADE9-80A848339151\\nts-wz99vz6u8jg39****\\n211110656240000\\n","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":"\\r\\n 1556DCB0-043A-4444-8BD9-CF4A68E7EE64\\r\\n","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":"true\\n2020-11-16 16:22:56\\n2\\n8\\n2020-12-17 00:00:00\\nVPC\\nACTIVATION\\ntsdb_test\\n2400000\\ntsdb_tsdb\\nts-xxxxxxxxxxxxxxxxx.influxdata.rds.aliyuncs.com:3242\\n960000\\n320\\ncn-shanghai-f\\n8D156621-1FCB-414A-BD29-361C3CA4DD56\\nts-xxxxxxxxxxxxxxxxx\\ncloud_efficiency\\ntsdb.96x.large_lindorm\\nvsw-xxxxxxxxxxxxxxxxxxxxx\\n1\\nvpc-xxxxxxxxxxxxxxxxxxxxx\\nPREPAY\\n\\n 0.0.0.0/0\\n\\ntest\\ncn-shanghai\\nts-xxxxxxxxxxxxxxxxx.hitsdb.tsdb.aliyuncs.com:8242","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":"20\\n0A7153E4-8354-497E-87E5-5D0EBEF5AEB1\\n1\\n10\\n\\n 10000\\n 2020-11-16 16:22:56\\n 2020-12-17 00:00:00\\n VPC\\n ACTIVATION\\n test_tsdb\\n 1611417600000\\n PREPAY\\n tsdb_tsdb\\n 960000\\n ACTIVATION\\n 50\\n cn-hongkong-b\\n ts-xxxxxxxxxxxxxxxxx\\n 1603426323000\\n tsdb.1x.basic\\n 0\\n vsw-bp1xxxxxxxxxxxxxxxxxx\\n vpc-bp1xxxxxxxxxxxxxxxxxx\\n POSTPAY\\n 1000000000000000\\n test\\n cn-hangzhou\\n","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":"F2DFDC0B-FE4F-4696-9FD1-2EFDEE8D6C7C\\n\\n 0.0.0.0/0\\n","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":"\\r\\n DBB70386-45C6-4E92-B239-4A764E32CE4C\\r\\n \\r\\n \\r\\n cn-hangzhou\\r\\n hitsdb.aliyuncs.com\\r\\n 华东1(杭州)\\r\\n \\r\\n \\r\\n cn-shanghai\\r\\n hitsdb.aliyuncs.com\\r\\n 华东2(上海)\\r\\n \\r\\n \\r\\n cn-qingdao\\r\\n hitsdb.aliyuncs.com\\r\\n 华北1(青岛)\\r\\n \\r\\n \\r\\n cn-beijing\\r\\n hitsdb.aliyuncs.com\\r\\n 华北2(北京)\\r\\n \\r\\n \\r\\n cn-huhehaote\\r\\n hitsdb.aliyuncs.com\\r\\n 华北5(呼和浩特)\\r\\n \\r\\n \\r\\n cn-shenzhen\\r\\n hitsdb.aliyuncs.com\\r\\n 华南1(深圳)\\r\\n \\r\\n \\r\\n ap-southeast-1\\r\\n hitsdb.aliyuncs.com\\r\\n 新加坡\\r\\n \\r\\n \\r\\n","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":"F67BFFF3-F5C2-45B5-9C28-6E4A1E51449B\\n\\n cn-shanghai-b\\n 华东2可用区B\\n","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":"57540985-3C11-4588-96FD-93413C6282EF","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":"\\r\\n 1556DCB0-043A-4444-8BD9-CF4A68E7EE64\\r\\n","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":"57540985-3C11-4588-96FD-93413C6282EF\\n100000000000000","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}',
],
],
],
];