summaryrefslogtreecommitdiff
path: root/data/en_us/hbase/2019-01-01/api-docs.php
diff options
context:
space:
mode:
Diffstat (limited to 'data/en_us/hbase/2019-01-01/api-docs.php')
-rw-r--r--data/en_us/hbase/2019-01-01/api-docs.php17293
1 files changed, 8135 insertions, 9158 deletions
diff --git a/data/en_us/hbase/2019-01-01/api-docs.php b/data/en_us/hbase/2019-01-01/api-docs.php
index f5778a0..2384f86 100644
--- a/data/en_us/hbase/2019-01-01/api-docs.php
+++ b/data/en_us/hbase/2019-01-01/api-docs.php
@@ -1,337 +1,157 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'HBase',
- 'version' => '2019-01-01',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'HBase', 'version' => '2019-01-01'],
'directories' => [
[
- 'id' => 77177,
- 'title' => null,
- 'type' => 'directory',
- 'children' => [
- 'DescribeRegions',
- ],
- ],
- [
- 'id' => 77179,
- 'title' => null,
+ 'children' => ['CreateMultiZoneCluster', 'DeleteMultiZoneCluster', 'ResizeMultiZoneClusterDiskSize', 'ResizeMultiZoneClusterNodeCount', 'UpgradeMultiZoneCluster', 'DescribeMultiZoneAvailableRegions', 'DescribeMultiZoneCluster', 'EvaluateMultiZoneResource'],
'type' => 'directory',
- 'children' => [
- 'CreateMultiZoneCluster',
- 'DeleteMultiZoneCluster',
- 'ResizeMultiZoneClusterDiskSize',
- 'ResizeMultiZoneClusterNodeCount',
- 'UpgradeMultiZoneCluster',
- 'DescribeMultiZoneAvailableRegions',
- 'DescribeMultiZoneCluster',
- 'EvaluateMultiZoneResource',
- ],
+ 'title' => 'Multi-zone cluster',
],
[
- 'id' => 77188,
- 'title' => null,
+ 'children' => ['DescribeIpWhitelist'],
'type' => 'directory',
- 'children' => [
- 'DescribeDeletedInstances',
- 'DescribeIpWhitelist',
- ],
+ 'title' => 'Cluster',
],
[
- 'id' => 77191,
- 'title' => null,
- 'type' => 'directory',
'children' => [
- 'CreateCluster',
- 'AddUserHdfsInfo',
- 'DeleteInstance',
- 'DeleteHBaseHaDB',
- 'DeleteUserHdfsInfo',
- 'ModifyInstanceMaintainTime',
- 'ModifyInstanceType',
- 'EnableHBaseueModule',
- 'ModifyInstanceName',
- 'ModifyDiskWarningLine',
- 'ModifyUIAccountPassword',
- 'DescribeInstance',
- 'DescribeInstances',
- 'DescribeInstanceType',
- 'DescribeClusterConnection',
- 'DescribeAvailableResource',
- 'DescribeSubDomain',
- 'QueryXpackRelateDB',
- 'DescribeDiskWarningLine',
- 'ResizeNodeCount',
- 'ResizeColdStorageSize',
- 'RestartInstance',
- 'MoveResourceGroup',
- 'PurgeInstance',
- 'RenewInstance',
- 'ResizeDiskSize',
- 'UpgradeMinorVersion',
- 'XpackRelateDB',
+ 'AddUserHdfsInfo', 'DeleteHBaseHaDB', 'DeleteUserHdfsInfo', 'ModifyInstanceType', 'EnableHBaseueModule', 'ModifyInstanceName', 'ModifyDiskWarningLine', 'ModifyUIAccountPassword', 'DescribeInstance', 'DescribeInstanceType', 'DescribeClusterConnection', 'DescribeSubDomain', 'QueryXpackRelateDB', 'DescribeDiskWarningLine', 'ResizeNodeCount', 'ResizeColdStorageSize', 'PurgeInstance', 'ResizeDiskSize', 'UpgradeMinorVersion', 'XpackRelateDB',
'ConvertInstance',
],
+ 'type' => 'directory',
+ 'title' => 'Instance',
],
[
- 'id' => 77221,
- 'title' => null,
+ 'children' => ['ModifyIpWhitelist', 'ModifySecurityGroups'],
'type' => 'directory',
- 'children' => [
- 'ModifyIpWhitelist',
- 'ModifySecurityGroups',
- 'DescribeSecurityGroups',
- ],
+ 'title' => 'Security',
],
[
- 'id' => 77225,
- 'title' => null,
+ 'children' => ['CreateBackupPlan', 'EnableHBaseueBackup', 'ModifyBackupPlanConfig', 'DescribeBackupPlanConfig', 'DescribeBackupStatus', 'DescribeBackupSummary', 'DescribeBackupTables', 'DescribeRecoverableTimeRange', 'CloseBackup', 'OpenBackup'],
'type' => 'directory',
- 'children' => [
- 'CreateBackupPlan',
- 'EnableHBaseueBackup',
- 'ModifyBackupPlanConfig',
- 'ModifyBackupPolicy',
- 'DescribeBackupPlanConfig',
- 'DescribeBackupPolicy',
- 'DescribeBackups',
- 'DescribeBackupStatus',
- 'DescribeBackupSummary',
- 'DescribeBackupTables',
- 'DescribeRecoverableTimeRange',
- 'CloseBackup',
- 'OpenBackup',
- ],
+ 'title' => 'Backup',
],
[
- 'id' => 77239,
- 'title' => null,
+ 'children' => ['CreateRestorePlan', 'DescribeRestoreFullDetails', 'DescribeRestoreIncrDetail', 'DescribeRestoreSchemaDetails', 'DescribeRestoreSummary', 'DescribeRestoreTables'],
'type' => 'directory',
- 'children' => [
- 'CreateRestorePlan',
- 'DescribeRestoreFullDetails',
- 'DescribeRestoreIncrDetail',
- 'DescribeRestoreSchemaDetails',
- 'DescribeRestoreSummary',
- 'DescribeRestoreTables',
- ],
+ 'title' => 'Recovery',
],
[
- 'id' => 77246,
- 'title' => null,
+ 'children' => ['AllocatePublicNetworkAddress', 'ReleasePublicNetworkAddress', 'DescribeEndpoints'],
'type' => 'directory',
- 'children' => [
- 'AllocatePublicNetworkAddress',
- 'ReleasePublicNetworkAddress',
- 'DescribeEndpoints',
- ],
+ 'title' => 'Network',
],
[
- 'id' => 191553,
- 'title' => null,
+ 'children' => ['Grant', 'Revoke'],
'type' => 'directory',
- 'children' => [
- 'DescribeAccounts',
- 'CreateAccount',
- 'ModifyAccountPassword',
- 'DeleteAccount',
- 'Grant',
- 'Revoke',
- ],
+ 'title' => 'User',
],
[
- 'id' => 77250,
- 'title' => null,
+ 'children' => ['CreateServerlessCluster', 'DeleteServerlessCluster', 'DescribeServerlessCluster'],
'type' => 'directory',
- 'children' => [
- 'TagResources',
- 'UnTagResources',
- 'ListTagResources',
- 'ListTags',
- ],
+ 'title' => 'Serverless cluster',
],
[
- 'id' => 77255,
- 'title' => null,
+ 'children' => ['CreateHbaseHaSlb', 'DeleteHbaseHaSlb', 'SwitchHbaseHaSlb'],
'type' => 'directory',
- 'children' => [
- 'CreateServerlessCluster',
- 'DeleteServerlessCluster',
- 'DescribeServerlessCluster',
- ],
+ 'title' => 'HA load balancing',
],
[
- 'id' => 77259,
- 'title' => null,
+ 'children' => ['CreateGlobalResource', 'DeleteGlobalResource'],
'type' => 'directory',
- 'children' => [
- 'CreateHbaseHaSlb',
- 'DeleteHbaseHaSlb',
- 'SwitchHbaseHaSlb',
- ],
+ 'title' => 'Global resource',
],
[
- 'id' => 77263,
- 'title' => null,
+ 'children' => ['DescribeDBInstanceUsage', 'DescribeMultiZoneAvailableResource', 'ModifyClusterDeletionProtection', 'ModifyMultiZoneClusterNodeType', 'QueryHBaseHaDB', 'CheckComponentsVersion', 'CreateHBaseSlbServer', 'DeleteHBaseSlbServer', 'DescribeColdStorage', 'GetMultimodeCmsUrl', 'ListHBaseInstances', 'ListInstanceServiceConfigHistories', 'ListInstanceServiceConfigurations', 'ModifyInstanceServiceConfig', 'RelateDbForHBaseHa', 'DescribeActiveOperationTaskType', 'SwitchService'],
'type' => 'directory',
- 'children' => [
- 'CreateGlobalResource',
- 'DeleteGlobalResource',
- ],
+ 'title' => 'Other',
],
[
- 'id' => 175972,
- 'title' => null,
- 'type' => 'directory',
'children' => [
- 'DescribeDBInstanceUsage',
- 'DescribeMultiZoneAvailableResource',
- 'ModifyClusterDeletionProtection',
- 'ModifyMultiZoneClusterNodeType',
- 'QueryHBaseHaDB',
- 'CheckComponentsVersion',
- 'CreateHBaseSlbServer',
- 'DeleteHBaseSlbServer',
- 'DescribeColdStorage',
- 'GetMultimodeCmsUrl',
- 'ListHBaseInstances',
- 'ListInstanceServiceConfigHistories',
- 'ListInstanceServiceConfigurations',
- 'ModifyInstanceServiceConfig',
- 'RelateDbForHBaseHa',
- 'CancelActiveOperationTasks',
- 'DescribeActiveOperationTaskType',
- 'ModifyActiveOperationTasks',
- 'DescribeActiveOperationTasks',
- 'SwitchService',
+ 'CancelActiveOperationTasks', 'CreateAccount', 'CreateCluster', 'DeleteAccount', 'DeleteInstance', 'DescribeAccounts', 'DescribeActiveOperationTasks', 'DescribeAvailableResource', 'DescribeBackupPolicy', 'DescribeBackups', 'DescribeDeletedInstances', 'DescribeInstances', 'DescribeRegions', 'DescribeSecurityGroups', 'ListTagResources', 'ListTags', 'ModifyAccountPassword', 'ModifyActiveOperationTasks', 'ModifyBackupPolicy', 'ModifyInstanceMaintainTime',
+ 'MoveResourceGroup', 'RenewInstance', 'RestartInstance', 'TagResources', 'UnTagResources',
],
+ 'title' => 'Others',
+ 'type' => 'directory',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'DescribeRegions' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AddUserHdfsInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'AcceptLanguage',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'zh-CN',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The cluster ID. You can call the [DescribeInstances](~~144595~~) operation to obtain the cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-bp16o0pd5****582s', 'title' => ''],
],
[
- 'name' => 'Engine',
+ 'name' => 'ExtInfo',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'hbase',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'dfs.nameservices specifies the nameservices name of DFS. dfs.ha.namenodes specifies the DFS nodes, such as nn1 and nn2.'."\n"
+ .'dfs.namenode.http-address.{dfs.nameservices}.nn1 specifies the port 50070 connection of HDFS nn1.'."\n"
+ .'dfs.namenode.http-address.{dfs.nameservices}.nn2 specifies the port 50070 connection of HDFS nn2.'."\n"
+ .'dfs.namenode.rpc-address.{dfs.nameservices}.nn1 specifies the port 8020 connection of HDFS nn1.'."\n"
+ .'dfs.namenode.rpc-address.{dfs.nameservices}.nn2 specifies the port 8020 connection of HDFS nn2.'."\n"
+ .'Port 50070 connections and port 8020 connections exist on each HDFS node. The number of port 50070 and port 8020 connection pairs equals the number of HDFS nodes.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"dfs.nameservices":"hdfs_test","dfs.ha.namenodes":"nn1,nn2","dfs.namenode.http-address.hdfs_test.nn1":"TEST-xxx1.com:50070","dfs.namenode.http-address.hdfs_test.nn2":"TEST-xxx2.com:50070","dfs.namenode.rpc-address.hdfs_test.nn1":"TEST-xxx1.com:8020","dfs.namenode.rpc-address.hdfs_test.nn2":"TEST-xxx2.com:8020"}', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'example' => '14D3924C-4FD8-4EE9-9B34-DA949D104F42',
- 'type' => 'string',
- ],
- 'Regions' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Region' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'properties' => [
- 'RegionEndpoint' => [
- 'description' => '',
- 'example' => 'hbase.aliyuncs.com',
- 'type' => 'string',
- ],
- 'LocalName' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'RegionId' => [
- 'description' => '',
- 'example' => 'cn-hangzhou',
- 'type' => 'string',
- ],
- 'Zones' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Zone' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'properties' => [
- 'Id' => [
- 'description' => '',
- 'example' => 'cn-hangzhou-b',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- ],
- ],
- ],
- ],
- 'type' => 'object',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FB0B7918-198C-46A8-AB9B-FE15403B1F0A', 'title' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"14D3924C-4FD8-4EE9-9B34-DA949D104F42\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionEndpoint\\": \\"hbase.aliyuncs.com\\",\\n \\"LocalName\\": \\"华东1(杭州)\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"Id\\": \\"cn-hangzhou-b\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>8D354E7A-E7F4-4A1D-A5D9-159DAC29FEA6</RequestId>\\n<Regions>\\n <Region>\\n <RegionId>cn-hangzhou</RegionId>\\n <RegionEndpoint>hbase.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东1(杭州)</LocalName>\\n <Zones>\\n <Zone>\\n <Id>cn-hangzhou-h</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-hangzhou-i</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-hangzhou-b</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-hangzhou-e</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-hangzhou-f</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-hangzhou-g</Id>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-shanghai</RegionId>\\n <RegionEndpoint>hbase.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东2(上海)</LocalName>\\n <Zones>\\n <Zone>\\n <Id>cn-shanghai-g</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shanghai-e</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shanghai-f</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shanghai-a</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shanghai-b</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shanghai-c</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shanghai-d</Id>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-qingdao</RegionId>\\n <RegionEndpoint>hbase.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北1(青岛)</LocalName>\\n <Zones>\\n <Zone>\\n <Id>cn-qingdao-b</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-qingdao-c</Id>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-beijing</RegionId>\\n <RegionEndpoint>hbase.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北2(北京)</LocalName>\\n <Zones>\\n <Zone>\\n <Id>cn-beijing-h</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-beijing-g</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-beijing-f</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-beijing-a</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-beijing-b</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-beijing-c</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-beijing-d</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-beijing-e</Id>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-shenzhen</RegionId>\\n <RegionEndpoint>hbase.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南1(深圳)</LocalName>\\n <Zones>\\n <Zone>\\n <Id>cn-shenzhen-d</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shenzhen-e</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shenzhen-a</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shenzhen-b</Id>\\n </Zone>\\n <Zone>\\n <Id>cn-shenzhen-c</Id>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-1</RegionId>\\n <RegionEndpoint>hbase.aliyuncs.com</RegionEndpoint>\\n <LocalName>新加坡</LocalName>\\n <Zones>\\n <Zone>\\n <Id>ap-southeast-1c</Id>\\n </Zone>\\n <Zone>\\n <Id>ap-southeast-1a</Id>\\n </Zone>\\n <Zone>\\n <Id>ap-southeast-1b</Id>\\n </Zone>\\n </Zones>\\n </Region>\\n</Regions>","errorExample":""}]',
- 'extraInfo' => ' ',
+ 'errorCodes' => [],
+ 'title' => 'Add a self-managed HDFS address',
+ 'summary' => 'Adds a self-managed HDFS address to Xpack.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- 'title' => 'DescribeRegions',
- ],
- 'CreateMultiZoneCluster' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hbase:AddUserHdfsInfo',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FB0B7918-198C-46A8-AB9B-FE15403B1F0A\\"\\n}","type":"json"}]',
+ ],
+ 'AllocatePublicNetworkAddress' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -339,329 +159,302 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'Engine',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hbaseue',
- ],
- ],
- [
- 'name' => 'EngineVersion',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2.0',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-t4naqsay5gn******', 'title' => ''],
],
[
- 'name' => 'ArchVersion',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2.0',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests. The token can contain only ASCII characters. If you do not specify this parameter, the system automatically uses the value of RequestId as the value of ClientToken. The value of RequestId may be different for each API request.', 'type' => 'string', 'required' => false, 'example' => '83b2b5e117a5b8bce0fae88d90576a84_6452320_82718582', 'title' => ''],
],
- [
- 'name' => 'ClusterName',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'hbaseue_test',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'title' => 'Apply for a public endpoint for an instance',
+ 'summary' => 'Applies for a public endpoint.',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-07T16:51:27.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hbase:AllocatePublicNetworkAddress',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","type":"json"}]',
+ ],
+ 'CancelActiveOperationTasks' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'VpcId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'vpc-bp120k6ixs4eog****',
- ],
+ 'AK' => [],
],
+ ],
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
[
- 'name' => 'MultiZoneCombination',
+ 'name' => 'Ids',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou-bef-aliyun-com',
- ],
+ 'schema' => ['description' => 'The O&M task IDs. Separate multiple IDs with commas (,).'."\n"
+ ."\n"
+ .'> You can call [DescribeActiveOperationTasks](~~414458~~) to obtain O&M task IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '11111,22222', 'title' => ''],
],
- [
- 'name' => 'PrimaryZoneId',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Ids' => ['description' => 'The O&M task IDs. Multiple IDs are separated by commas (,).', 'type' => 'string', 'example' => '11111,22222', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'AE4F6C34-065F-45AA-F5BN-4B8D816F6305', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou-e',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'PrimaryVSwitchId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'vsw-hangxzhouxe****',
- ],
+ ],
+ 'title' => 'CancelActiveOperationTasks',
+ 'summary' => 'Cancels O&M event tasks by calling the CancelActiveOperationTasks operation.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelActiveOperationTasks'],
],
+ ],
+ 'ramActions' => [
[
- 'name' => 'StandbyZoneId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou-f',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:CancelActiveOperationTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"11111,22222\\",\\n \\"RequestId\\": \\"AE4F6C34-065F-45AA-F5BN-4B8D816F6305\\"\\n}","type":"json"}]',
+ ],
+ 'CheckComponentsVersion' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'StandbyVSwitchId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'vsw-hangxzhouxf****',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
[
- 'name' => 'ArbiterZoneId',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou-b',
- ],
+ 'schema' => ['description' => 'The cluster ID. You can call the [DescribeInstances](~~144595~~) operation to obtain the cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-t4naqsay5gn****', 'title' => ''],
],
[
- 'name' => 'ArbiterVSwitchId',
+ 'name' => 'Components',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'vsw-hangxzhouxb*****',
- ],
+ 'schema' => ['description' => 'The component to check. Valid values:'."\n"
+ ."\n"
+ .'- **HBASE**'."\n"
+ .'- **HADOOP**'."\n"
+ .'- **PHOENIX**'."\n"
+ .'- **SOLR**'."\n"
+ .'- **THRIFT**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HBASE,HADOOP', 'title' => ''],
],
- [
- 'name' => 'MasterInstanceType',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E3537EB4-1100-41CA-A147-C74CCC8BB12C', 'title' => ''],
+ 'Components' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Component' => [
+ 'description' => 'The list of information about whether each component is the latest version.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'IsLatestVersion' => ['description' => 'Indicates whether the component version is the latest version.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'Component' => ['description' => 'The component name.', 'type' => 'string', 'example' => 'HBASE', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hbase.sn1.medium',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'title' => 'Check component versions',
+ 'summary' => 'Checks whether the versions of components are the latest versions by calling CheckComponentsVersion.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-06T09:46:56.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'CoreInstanceType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hbase.sn1.medium',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:CheckComponentsVersion',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E3537EB4-1100-41CA-A147-C74CCC8BB12C\\",\\n \\"Components\\": {\\n \\"Component\\": [\\n {\\n \\"IsLatestVersion\\": \\"true\\",\\n \\"Component\\": \\"HBASE\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'CloseBackup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'CoreDiskType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cloud_ssd',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
[
- 'name' => 'CoreDiskSize',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '400',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-t4naqsay5gn****', 'title' => ''],
],
- [
- 'name' => 'CoreNodeCount',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F1A11940-0C34-4385-864F-A01E29B55F6A', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '4',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'LogInstanceType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hbase.sn1.medium',
+ ],
+ 'errorCodes' => [],
+ 'title' => 'Disable backup',
+ 'summary' => 'Disables the backup and recovery feature for an HBase cluster by calling CloseBackup.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:CloseBackup',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F1A11940-0C34-4385-864F-A01E29B55F6A\\"\\n}","type":"json"}]',
+ ],
+ 'ConvertInstance' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'LogDiskType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cloud_ssd',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
[
- 'name' => 'LogDiskSize',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '400',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-bp16o0pd52e3y****', 'title' => ''],
],
[
- 'name' => 'LogNodeCount',
+ 'name' => 'PricingCycle',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '4',
- ],
+ 'schema' => ['description' => 'The unit of the subscription period. Valid values:'."\n"
+ .'- year: year.'."\n"
+ .'- month: month.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'month', 'title' => ''],
],
[
- 'name' => 'SecurityIPList',
+ 'name' => 'Duration',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '127.0.0.1',
- ],
+ 'schema' => ['description' => 'The subscription duration. Valid values:'."\n"
+ .'- If PricingCycle is set to year, the value ranges from 1 to 3.'."\n"
+ .'- If PricingCycle is set to month, the value ranges from 1 to 9.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '7', 'title' => ''],
],
[
'name' => 'PayType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Postpaid',
- ],
- ],
- [
- 'name' => 'PeriodUnit',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'month',
- ],
- ],
- [
- 'name' => 'Period',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'AutoRenewPeriod',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dfh3sf5gslfksfk****',
- ],
- ],
- [
- 'name' => 'ResourceGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-gg3f4f5d5g5w****',
- ],
+ 'schema' => ['description' => 'The billing method of the instance. Valid values:'."\n"
+ ."\n"
+ .'- **Prepaid**: subscription.'."\n"
+ .'- **Postpaid**: pay-as-you-go.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Prepaid', 'title' => ''],
],
],
'responses' => [
@@ -669,41 +462,45 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '7F68E8F5-0377-4CF8-8B1D-FFFD6F5804D5',
- ],
- 'OrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '23232453****',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ld-t4nn71xa0yn56****',
- ],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '54124548879', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7F68E8F5-0377-4CF8-8B1D-FFFD6F5804D5\\",\\n \\"OrderId\\": \\"23232453****\\",\\n \\"ClusterId\\": \\"ld-t4nn71xa0yn56****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateMultiZoneClusterResponse>\\n <RequestId>7F68E8F5-0377-4CF8-8B1D-FFFD6F5804D5</RequestId>\\n <OrderId>23232453****</OrderId>\\n <ClusterId>ld-t4nn71xa0yn56****</ClusterId>\\n</CreateMultiZoneClusterResponse>","errorExample":""}]',
- 'title' => 'CreateMultiZoneCluster',
+ 'title' => 'ConvertInstance',
+ 'summary' => 'Converts an instance from pay-as-you-go to subscription billing.',
+ 'description' => 'Note: This operation can be called only when payType is set to Postpaid.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DeleteMultiZoneCluster' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:ConvertInstance',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": 54124548879,\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","type":"json"}]',
+ ],
+ 'CreateAccount' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -711,34 +508,30 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'd-t4nn71xa0yn56****',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp150tns0sjxs****', 'title' => ''],
],
[
- 'name' => 'ImmediateDeleteFlag',
+ 'name' => 'AccountName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'enum' => [
- 'false',
- 'true',
- ],
- ],
+ 'schema' => ['description' => 'The account name. The name must meet the following requirements:'."\n"
+ ."\n"
+ .'* Starts with a lowercase letter and ends with a letter or digit.'."\n"
+ .'* Contains only lowercase letters, digits, or underscores.'."\n"
+ .'* Is 2 to 16 characters in length.'."\n"
+ .'* Cannot be a reserved username such as root or admin.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test01', 'title' => ''],
+ ],
+ [
+ 'name' => 'AccountPassword',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The password of the database account. The password must meet the following requirements:'."\n"
+ .'- Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n"
+ .'- The supported special characters are `!@#$%^&*()_+-=`.'."\n"
+ .'- Is 8 to 32 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test*****', 'title' => ''],
],
],
'responses' => [
@@ -746,79 +539,51 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '169A3910-A39E-4BC2-AA9F-E7AD8D473527',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '50373857-C47B-4B64-9332-D0B5280*****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"169A3910-A39E-4BC2-AA9F-E7AD8D473527\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>169A3910-A39E-4BC2-AA9F-E7AD8D473527</RequestId>","errorExample":""}]',
- 'title' => 'DeleteMultiZoneCluster',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ResizeMultiZoneClusterDiskSize' => [
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Create a database account',
+ 'summary' => 'Creates a wide table account.',
+ 'description' => 'Only ApsaraDB for HBase Performance-enhanced Edition is supported.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:CreateAccount',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280*****\\"\\n}","type":"json"}]',
+ ],
+ 'CreateBackupPlan' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-f5d6vc2r8d6****',
- ],
- ],
- [
- 'name' => 'CoreDiskSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'maximum' => '64000',
- 'minimum' => '400',
- 'example' => '480',
- ],
- ],
- [
- 'name' => 'LogDiskSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '64000',
- 'minimum' => '400',
- 'example' => '440',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-wz94lbcqc****4x93', 'title' => ''],
],
],
'responses' => [
@@ -826,36 +591,44 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'OrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123412341****',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '568339C4-9F71-43D0-994E-E039CD826E56',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"123412341****\\",\\n \\"RequestId\\": \\"568339C4-9F71-43D0-994E-E039CD826E56\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>568339C4-9F71-43D0-994E-E039CD826E56</RequestId>\\n<OrderId>123412341****</OrderId>","errorExample":""}]',
- 'title' => 'ResizeMultiZoneClusterDiskSize',
+ 'title' => 'Create a backup plan',
+ 'summary' => 'Creates a backup plan. Currently, only HBaseue is supported.',
+ 'description' => 'Currently, this operation supports only HBaseue clusters. The EnableHBaseueBackup operation is compatible with this operation and performs automatic creation of a backup plan after a BDS cluster is created.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ResizeMultiZoneClusterNodeCount' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-06T09:46:56.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:CreateBackupPlan',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","type":"json"}]',
+ ],
+ 'CreateCluster' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -863,109 +636,174 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-f5d8d6s4s2a1****',
- ],
+ 'schema' => ['description' => 'The region ID of the instance. You can call the [DescribeRegions](~~144489~~) operation to query the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'PrimaryVSwitchId',
+ 'name' => 'ZoneId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'vsw-hangxzhouxe*****',
- ],
+ 'schema' => ['description' => 'The zone ID. You can call the [DescribeRegions](~~144489~~) operation to query the zone ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-f', 'title' => ''],
],
[
- 'name' => 'StandbyVSwitchId',
+ 'name' => 'ClusterName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'vsw-hangxzhouxf****',
- ],
+ 'schema' => ['description' => 'The name of the instance. The name must meet the following requirements:'."\n"
+ ."\n"
+ .'- The name must be 2 to 128 characters in length.'."\n"
+ .'- The name must start with an uppercase letter, a lowercase letter, or a Chinese character.'."\n"
+ .'- The name can contain digits and special characters, including periods (.), hyphens (-), and underscores (_).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'hbase_test', 'title' => ''],
],
[
- 'name' => 'ArbiterVSwitchId',
+ 'name' => 'VpcId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'vsw-hangxzhouxb*****',
- ],
+ 'schema' => ['description' => 'The VPC ID.'."\n"
+ ."\n"
+ .'> If both this parameter and the VswitchId parameter are left empty, the network type of the instance is classic network.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vpc-bp120k6ixs4eog****', 'title' => ''],
],
[
- 'name' => 'CoreNodeCount',
+ 'name' => 'VSwitchId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'maximum' => '1000',
- 'minimum' => '2',
- 'example' => '6',
- ],
+ 'schema' => ['description' => 'The vSwitch ID in the VPC.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vsw-bp191otqj1ssyl****', 'title' => ''],
],
[
- 'name' => 'PrimaryCoreNodeCount',
+ 'name' => 'MasterInstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'maximum' => '750',
- 'minimum' => '1',
- 'example' => '6',
- ],
+ 'schema' => ['description' => 'The node specifications of the master node. You can invoke the [DescribeAvailableResource](~~188244~~) operation to query the specifications.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'hbase.sn1.medium', 'title' => ''],
],
[
- 'name' => 'StandbyCoreNodeCount',
+ 'name' => 'CoreInstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'maximum' => '750',
- 'minimum' => '1',
- 'example' => '6',
- ],
+ 'schema' => ['description' => 'The node specifications of the core node. You can invoke the [DescribeAvailableResource](~~188244~~) operation to query the specifications.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hbase.sn1.medium', 'title' => ''],
],
[
- 'name' => 'LogNodeCount',
+ 'name' => 'DiskType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'maximum' => '500',
- 'minimum' => '4',
- 'example' => '8',
- ],
+ 'schema' => ['description' => 'The cloud disk type of the core node. Valid values:'."\n"
+ .'<ul>'."\n"
+ .' <li>**cloud_efficiency**: ultra cloud disk.</li>'."\n"
+ .'<li>**cloud_ssd**: standard SSD.</li>'."\n"
+ .'<li>**local_hdd_pro**: local HDD.</li>'."\n"
+ .'<li>**local_ssd_pro**: local SSD.</li>'."\n"
+ .'<li>**cloud_essd_pl1**: ESSD.</li>'."\n"
+ .'</ul>.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cloud_ssd', 'title' => ''],
+ ],
+ [
+ 'name' => 'DiskSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The disk size of a single core node. Unit: GB.'."\n"
+ .'<ul>'."\n"
+ .' <li>If the instance is a single-node instance, the disk size of a single core node ranges from 20 to 500 GB, with a step size of 1 GB.</li>'."\n"
+ .' <li>If the instance uses cloud disks, the disk size of a single core node ranges from 400 to 64,000 GB, with a step size of 40 GB.</li>'."\n"
+ .' <li>If the instance uses local disks, the disk size of a single core node depends on the core node specifications:'."\n"
+ .'<ul>'."\n"
+ .' <li>If the core node specifications are hbase.d1.4xlarge, the disk size is 44,000.</li>'."\n"
+ .' <li>If the core node specifications are hbase.d1.6xlarge, the disk size is 66,000.</li>'."\n"
+ .' <li>If the core node specifications are hbase.d1.8xlarge, the disk size is 88,000.</li>'."\n"
+ .' <li>If the core node specifications are hbase.i2.xlarge, the disk size is 894.</li>'."\n"
+ .' <li>If the core node specifications are hbase.i2.2xlarge, the disk size is 1,788.</li>'."\n"
+ .' <li>If the core node specifications are hbase.i2.4xlarge, the disk size is 3,576.</li>'."\n"
+ .' <li>If the core node specifications are hbase.i2.8xlarge, the disk size is 7,152.</li>'."\n"
+ .' <li>If the core node specifications are hbase.d2s.5xlarge, the disk size is 58,400.</li>'."\n"
+ .' <li>If the core node specifications are hbase.d2s.10xlarge, the disk size is 109,500.</li>'."\n"
+ .'</ul>'."\n"
+ .' </li>'."\n"
+ .'</ul>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '400', 'title' => ''],
+ ],
+ [
+ 'name' => 'NodeCount',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of core nodes. Valid values:'."\n"
+ .'<ul>'."\n"
+ .' <li>If the instance is a single-node instance, the number of core nodes is fixed to **1**.</li>'."\n"
+ .' <li>If the instance uses cloud disks, the number of core nodes ranges from **2** to **100**.</li>'."\n"
+ .' <li>If the instance uses local disks, the number of core nodes ranges from **4** to **100**.</li>'."\n"
+ .'</ul>.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '2', 'title' => ''],
+ ],
+ [
+ 'name' => 'PayType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The billing method of the instance. Valid values:'."\n"
+ .'- **Prepaid**: subscription.'."\n"
+ .'- **Postpaid**: pay-as-you-go.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Prepaid', 'title' => ''],
+ ],
+ [
+ 'name' => 'Engine',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The database engine type. Valid values:'."\n"
+ .'- **hbase**: ApsaraDB for HBase Standard Edition or ApsaraDB for HBase single-node edition.'."\n"
+ .'- **hbaseue**: ApsaraDB for HBase Performance-enhanced Edition.'."\n"
+ .'- **bds**: BDS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hbase', 'title' => ''],
+ ],
+ [
+ 'name' => 'SecurityIPList',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The IP addresses in the whitelist of the instance. Separate multiple IP addresses with commas (,).'."\n"
+ ."\n"
+ .'> If the IP address is set to 127.0.0.1, all addresses are denied access to the instance. For example, 192.168.0.0/24 indicates that all IP addresses in the 192.168.0.XX range are allowed to access the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '116.62.XX.XX/24', 'title' => ''],
+ ],
+ [
+ 'name' => 'EngineVersion',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Database engine version of the instance. The value depends on the engine type. Valid values:'."\n"
+ .'- If the engine type is **hbase**, database engine version is **1.1** or **2.0**.'."\n"
+ .'- If the engine type is **hbaseue**, database engine version is **2.0**.'."\n"
+ .'- If the engine type is **bds**, database engine version is **1.0**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2.0', 'title' => ''],
+ ],
+ [
+ 'name' => 'ColdStorageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The cold storage capacity of the instance. Unit: GB. Valid values:'."\n"
+ .'- **0**: Cold storage is disabled.'."\n"
+ .'- **800** to **1000000**: Cold storage is enabled.'."\n"
+ ."\n"
+ .'> Cold storage takes effect only when the engine type is **hbaseue**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024', 'title' => ''],
+ ],
+ [
+ 'name' => 'PeriodUnit',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The unit of the subscription period for the subscription instance. Valid values:'."\n"
+ .'- **year**'."\n"
+ .'- **month**'."\n"
+ ."\n"
+ .'> This parameter is required only when the billing method of the instance is **Prepaid**.', 'type' => 'string', 'required' => false, 'example' => 'month', 'title' => ''],
+ ],
+ [
+ 'name' => 'Period',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The subscription period of the subscription instance. Valid values:'."\n"
+ .'- If PeriodUnit is set to **year**, the valid values are **1** to **3**.'."\n"
+ .'- If PeriodUnit is set to **month**, the valid values are **1** to **9**.'."\n"
+ ."\n"
+ .'> This parameter is required only when the billing method of the instance is **Prepaid**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6', 'title' => ''],
+ ],
+ [
+ 'name' => 'AutoRenewPeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Settings for the auto-renewal period of the instance. Unit: months.'."\n"
+ ."\n"
+ .'> - The default value is **0**, which indicates that the instance is not automatically renewed after the instance expires.'."\n"
+ .'- For example, if the value is set to **2**, the instance is automatically renewed for two months after the instance expires.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. The value is generated by the client and must be unique among different requests. The value can be up to 64 ASCII characters in length and cannot contain non-ASCII characters.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The resource group ID. For more information about resource groups, see [View basic information of a resource group](~~151181~~).', 'type' => 'string', 'required' => false, 'example' => 'rg-j4d53glb3****', 'title' => ''],
+ ],
+ [
+ 'name' => 'EncryptionKey',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The encryption key ID. This parameter is empty if encryption is not enabled.'."\n"
+ ."\n"
+ .'> After cloud disk encryption is enabled, it cannot be disabled.', 'type' => 'string', 'required' => false, 'example' => '0d2470df-da7b-4786-b981-9a164dae****', 'title' => ''],
],
],
'responses' => [
@@ -973,36 +811,45 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'OrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1234123412****',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E2B7E9DA-1575-4B9D-A0E4-9468BAC',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3E19E345-101D-4014-946C-A205', 'title' => ''],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '23232069786****', 'title' => ''],
+ 'ClusterId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'hb-bp1hy2sjf8gd****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"1234123412****\\",\\n \\"RequestId\\": \\"E2B7E9DA-1575-4B9D-A0E4-9468BAC\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>E2B7E9DA-1575-4B9D-A0E4-9468BAC</RequestId>\\n<OrderId>1234123412****</OrderId>","errorExample":""}]',
- 'title' => 'ResizeMultiZoneClusterNodeCount',
+ 'title' => 'Create an hBase cluster',
+ 'summary' => 'Creates an ApsaraDB for HBase cluster by calling CreateCluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'UpgradeMultiZoneCluster' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T12:02:00.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hbase:CreateCluster',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E19E345-101D-4014-946C-A205\\",\\n \\"OrderId\\": \\"23232069786****\\",\\n \\"ClusterId\\": \\"hb-bp1hy2sjf8gd****\\"\\n}","type":"json"}]',
+ ],
+ 'CreateGlobalResource' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1010,76 +857,42 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-***************',
- ],
+ 'schema' => ['description' => 'The ID of the target instance. You can call the DescribeInstances operation to obtain the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-t4naqsay5gn****', 'title' => ''],
],
[
- 'name' => 'RunMode',
+ 'name' => 'ResourceName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'serial',
- 'default' => '',
- 'enum' => [
- 'false',
- 'true',
- ],
- ],
+ 'schema' => ['description' => 'The resource name. Valid values:'."\n"
+ ."\n"
+ .'- HbaseSLBThriftVip: Thrift SLB EPS resource.'."\n"
+ ."\n"
+ .'- SolrSlbVip: Solr SLB EPS resource.'."\n"
+ ."\n"
+ .'- PhoenixSLBQueryServerVip: Phoenix SLB EPS resource.'."\n"
+ ."\n"
+ .'- PubHbaseSLBThriftVip: Thrift SLB public network resource.'."\n"
+ ."\n"
+ .'- PubPhoenixSLBQueryServerVip: Phoenix SLB public network resource.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PubPhoenixSLBQueryServerVip', 'title' => ''],
],
[
- 'name' => 'UpgradeInsName',
+ 'name' => 'ResourceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ld-t4n40m3171t4******-az-b',
- ],
+ 'schema' => ['description' => 'The resource type. Set the value to **GLOBAL_VIP**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GLOBAL_VIP', 'title' => ''],
],
[
- 'name' => 'Components',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'LINDORM',
- ],
+ 'schema' => ['description' => 'This parameter is automatically populated when the request is sent. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'xxxxx-xxxxx-xxxxx', 'title' => ''],
],
[
- 'name' => 'Versions',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 't-apsara-lindorm-2.1.20-20200518175539.alios7.x86_64',
- ],
- ],
- [
- 'name' => 'RestartComponents',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'LPROXY',
- ],
+ 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
@@ -1087,54 +900,66 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'UpgradingComponents' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'LINDORM',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C532A4D4-9451-4460-BB3E-300FEC852D3F',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AB9ABDF-7E1E-44AD-8610-70A005115DD1', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"UpgradingComponents\\": \\"LINDORM\\",\\n \\"RequestId\\": \\"C532A4D4-9451-4460-BB3E-300FEC852D3F\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>C532A4D4-9451-4460-BB3E-300FEC852D3F</RequestId>\\n<UpgradingComponents>LINDORM</UpgradingComponents>","errorExample":""}]',
- 'title' => 'UpgradeMultiZoneCluster',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeMultiZoneAvailableRegions' => [
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Create a global resource',
+ 'summary' => 'Creates a global resource in a cluster by calling CreateGlobalResource.',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-14T10:59:09.000Z', 'description' => 'Request parameters changed, Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hbase:CreateGlobalResource',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AB9ABDF-7E1E-44AD-8610-70A005115DD1\\"\\n}","type":"json"}]',
+ ],
+ 'CreateHBaseSlbServer' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'AcceptLanguage',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh-CN',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-t4naqsay5gn****', 'title' => ''],
+ ],
+ [
+ 'name' => 'SlbServer',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The load balancing service to create. Valid values:'."\n"
+ ."\n"
+ .'- **thrift**: the Thrift cross-language and cross-platform remote procedure call (RPC) protocol service.'."\n"
+ .'- **rest**: the HTTP protocol service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'thrift', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The client token.', 'type' => 'string', 'required' => false, 'example' => 'xxxxx-xxxxx-xxxxx', 'title' => ''],
],
],
'responses' => [
@@ -1142,115 +967,82 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F03BB273-45EE-4B6C-A329-A6E6A8D15856',
- ],
- 'Regions' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Region' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'RegionEndpoint' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase.aliyuncs.com',
- ],
- 'LocalName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-shenzhen',
- ],
- 'AvailableCombines' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'AvailableCombine' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-shenzhen-****-aliyun',
- ],
- 'Zones' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Zone' => [
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-shenzhen-a,cn-shenzhen-b,cn-shenzhen-c',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '61FC5B21-87B0-41BC-9686-9DA395EB40B6', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F03BB273-45EE-4B6C-A329-A6E6A8D15856\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionEndpoint\\": \\"hbase.aliyuncs.com\\",\\n \\"LocalName\\": \\"华南1(深圳)\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"AvailableCombines\\": {\\n \\"AvailableCombine\\": [\\n {\\n \\"Id\\": \\"cn-shenzhen-****-aliyun\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n \\"cn-shenzhen-a,cn-shenzhen-b,cn-shenzhen-c\\"\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>F03BB273-45EE-4B6C-A329-A6E6A8D15856</RequestId>\\n<Regions>\\n <Region>\\n <RegionId>cn-shenzhen</RegionId>\\n <RegionEndpoint>hbase.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南1(深圳)</LocalName>\\n <AvailableCombines>\\n <AvailableCombine>\\n <Id>cn-shenzhen-****-aliyun</Id>\\n <Zones>\\n <Zone>cn-shenzhen-a,cn-shenzhen-b,cn-shenzhen-c</Zone>\\n </Zones>\\n </AvailableCombine>\\n </AvailableCombines>\\n </Region>\\n</Regions>","errorExample":""}]',
- 'title' => 'DescribeMultiZoneAvailableRegions',
+ 'title' => 'Create hBase load balancing server',
+ 'summary' => 'Creates a load balancing service by calling CreateHBaseSlbServer.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeMultiZoneCluster' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-06T09:46:55.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:CreateHBaseSlbServer',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"61FC5B21-87B0-41BC-9686-9DA395EB40B6\\"\\n}","type":"json"}]',
+ ],
+ 'CreateHbaseHaSlb' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'BdsId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-t4nn71xa0yn****',
- ],
+ 'schema' => ['description' => 'The ID of the BDS cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'bds-t4n3496whj23****', 'title' => ''],
+ ],
+ [
+ 'name' => 'HaId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The high-availability ID in the BDS active-active management.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ha-v21tmnxjwh2yu****', 'title' => ''],
+ ],
+ [
+ 'name' => 'HaTypes',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The high-availability type. Valid values:'."\n"
+ ."\n"
+ .'- thrift'."\n"
+ .'- phoenix.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'thrift', 'title' => ''],
+ ],
+ [
+ 'name' => 'HbaseType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether the high-availability type is on the primary or secondary instance. Valid values:'."\n"
+ ."\n"
+ .'- Active: The high-availability type is on the primary instance.'."\n"
+ .'- Standby: The high-availability type is on the secondary instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Active', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the value is unique among different requests. The value cannot exceed 64 printable ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
],
'responses' => [
@@ -1258,692 +1050,224 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'VpcId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vpc-t4nx81tmlixcq5****',
- ],
- 'EncryptionType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CloudDisk',
- ],
- 'ModuleId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'PayType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Prepaid',
- ],
- 'ArbiterVSwitchIds' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vsw-t4nax9mp3wk0czn****',
- ],
- 'MasterNodeCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'A02C0E6D-3A47-4FA0-BA7E-60793CE256DA',
- ],
- 'InstanceName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'mz_test',
- ],
- 'CoreInstanceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase.sn1.large',
- ],
- 'EncryptionKey' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2a****',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ld-t4nn71xa0yn****',
- ],
- 'LogNodeCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'ExpireTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-16T08:00:00',
- ],
- 'MultiZoneCombination' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ap-southeast-1-abc-aliyun',
- ],
- 'InstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ld-t4nn71xa0yn****',
- ],
- 'IsDeletionProtection' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'MasterDiskSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
- ],
- 'AutoRenewal' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ClusterName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'mz_test',
- ],
- 'Duration' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ModuleStackVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2.0',
- ],
- 'MajorVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2.0',
- ],
- 'CoreDiskCount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ACTIVATION',
- ],
- 'LogInstanceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase.sn1.large',
- ],
- 'LogDiskSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'CoreDiskType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cloud_efficiency',
- ],
- 'StandbyZoneId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ap-southeast-1b',
- ],
- 'NetworkType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'VPC',
- ],
- 'PrimaryVSwitchIds' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vsw-t4n3s1zd2gtidg****',
- ],
- 'CreatedTimeUTC' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-10-15T10:04:52Z',
- ],
- 'ParentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ld-fls1gf31y5s35****',
- ],
- 'ExpireTimeUTC' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-16T00:00:00Z',
- ],
- 'LogDiskType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cloud_efficiency',
- ],
- 'MasterInstanceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase.sn1.large',
- ],
- 'CreatedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-10-15T18:04:52',
- ],
- 'CoreDiskSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'LogDiskCount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4',
- ],
- 'StandbyVSwitchIds' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vsw-t4nvvk7xur3rdi****',
- ],
- 'MaintainStartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '02:00:00',
- ],
- 'PrimaryZoneId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ap-southeast-1a',
- ],
- 'MaintainEndTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '06:00:00',
- ],
- 'ArbiterZoneId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ap-southeast-1c',
- ],
- 'MasterDiskType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cloud_efficiency',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ap-southeast-1',
- ],
- 'ResourceGroupId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rg-lk51f5fer315e****',
- ],
- 'Engine' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbaseue',
- ],
- 'TaskProgress' => [
- 'type' => 'string',
- ],
- 'TaskStatus' => [
- 'type' => 'string',
- ],
- 'CoreNodeCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '6',
- ],
- 'ColdStorageSize' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'MultiZoneInstanceModels' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'MultiZoneInstanceModel' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ACTIVATION',
- ],
- 'IsLatestVersion' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Role' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'primary',
- ],
- 'InsName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ld-t4nn71xa0yn****-az-a',
- ],
- 'MinorVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2.1.24',
- ],
- 'LatestMinorVersion' => [
- 'type' => 'string',
- ],
- 'HdfsMinorVersion' => [
- 'type' => 'string',
- ],
- 'LatestHdfsMinorVersion' => [
- 'type' => 'string',
- ],
- 'IsHdfsLatestVersion' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Tags' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Tag' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test_key',
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test_value',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C9D568D9-A59C-4AF2-8FBB-F086A841D58E', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"VpcId\\": \\"vpc-t4nx81tmlixcq5****\\",\\n \\"EncryptionType\\": \\"CloudDisk\\",\\n \\"ModuleId\\": 0,\\n \\"PayType\\": \\"Prepaid\\",\\n \\"ArbiterVSwitchIds\\": \\"vsw-t4nax9mp3wk0czn****\\",\\n \\"MasterNodeCount\\": 2,\\n \\"RequestId\\": \\"A02C0E6D-3A47-4FA0-BA7E-60793CE256DA\\",\\n \\"InstanceName\\": \\"mz_test\\",\\n \\"CoreInstanceType\\": \\"hbase.sn1.large\\",\\n \\"EncryptionKey\\": \\"2a****\\",\\n \\"ClusterId\\": \\"ld-t4nn71xa0yn****\\",\\n \\"LogNodeCount\\": 4,\\n \\"ExpireTime\\": \\"2020-11-16T08:00:00\\",\\n \\"MultiZoneCombination\\": \\"ap-southeast-1-abc-aliyun\\",\\n \\"InstanceId\\": \\"ld-t4nn71xa0yn****\\",\\n \\"IsDeletionProtection\\": false,\\n \\"MasterDiskSize\\": 50,\\n \\"AutoRenewal\\": false,\\n \\"ClusterName\\": \\"mz_test\\",\\n \\"Duration\\": 1,\\n \\"ModuleStackVersion\\": \\"2.0\\",\\n \\"MajorVersion\\": \\"2.0\\",\\n \\"CoreDiskCount\\": \\"4\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"LogInstanceType\\": \\"hbase.sn1.large\\",\\n \\"LogDiskSize\\": 100,\\n \\"CoreDiskType\\": \\"cloud_efficiency\\",\\n \\"StandbyZoneId\\": \\"ap-southeast-1b\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"PrimaryVSwitchIds\\": \\"vsw-t4n3s1zd2gtidg****\\",\\n \\"CreatedTimeUTC\\": \\"2020-10-15T10:04:52Z\\",\\n \\"ParentId\\": \\"ld-fls1gf31y5s35****\\",\\n \\"ExpireTimeUTC\\": \\"2020-11-16T00:00:00Z\\",\\n \\"LogDiskType\\": \\"cloud_efficiency\\",\\n \\"MasterInstanceType\\": \\"hbase.sn1.large\\",\\n \\"CreatedTime\\": \\"2020-10-15T18:04:52\\",\\n \\"CoreDiskSize\\": 100,\\n \\"LogDiskCount\\": \\"4\\",\\n \\"StandbyVSwitchIds\\": \\"vsw-t4nvvk7xur3rdi****\\",\\n \\"MaintainStartTime\\": \\"02:00:00\\",\\n \\"PrimaryZoneId\\": \\"ap-southeast-1a\\",\\n \\"MaintainEndTime\\": \\"06:00:00\\",\\n \\"ArbiterZoneId\\": \\"ap-southeast-1c\\",\\n \\"MasterDiskType\\": \\"cloud_efficiency\\",\\n \\"RegionId\\": \\"ap-southeast-1\\",\\n \\"ResourceGroupId\\": \\"rg-lk51f5fer315e****\\",\\n \\"Engine\\": \\"hbaseue\\",\\n \\"TaskProgress\\": \\"42\\",\\n \\"TaskStatus\\": \\"running\\",\\n \\"CoreNodeCount\\": 6,\\n \\"ColdStorageSize\\": 800,\\n \\"MultiZoneInstanceModels\\": {\\n \\"MultiZoneInstanceModel\\": [\\n {\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"IsLatestVersion\\": true,\\n \\"Role\\": \\"primary\\",\\n \\"InsName\\": \\"ld-t4nn71xa0yn****-az-a\\",\\n \\"MinorVersion\\": \\"2.1.24\\",\\n \\"LatestMinorVersion\\": \\"2.6.3\\",\\n \\"HdfsMinorVersion\\": \\"4.1.0\\",\\n \\"LatestHdfsMinorVersion\\": \\"4.1.1\\",\\n \\"IsHdfsLatestVersion\\": \\"true\\"\\n }\\n ]\\n },\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"test_key\\",\\n \\"Value\\": \\"test_value\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<StandbyZoneId>ap-southeast-1b</StandbyZoneId>\\n<ModuleStackVersion>2.0</ModuleStackVersion>\\n<CreatedTime>2020-10-15T18:04:52</CreatedTime>\\n<ResourceGroupId>rg-lk51f5fer315e****</ResourceGroupId>\\n<PrimaryVSwitchIds>vsw-t4n3s1zd2gtidg****</PrimaryVSwitchIds>\\n<MasterInstanceType>hbase.sn1.large</MasterInstanceType>\\n<LogDiskCount>4</LogDiskCount>\\n<IsDeletionProtection>false</IsDeletionProtection>\\n<LogDiskSize>100</LogDiskSize>\\n<ModuleId>0</ModuleId>\\n<ArbiterVSwitchIds>vsw-t4nax9mp3wk0czn****</ArbiterVSwitchIds>\\n<MaintainEndTime>06:00:00</MaintainEndTime>\\n<StandbyVSwitchIds>vsw-t4nvvk7xur3rdi****</StandbyVSwitchIds>\\n<NetworkType>VPC</NetworkType>\\n<CoreInstanceType>hbase.sn1.large</CoreInstanceType>\\n<ClusterName>mz_test</ClusterName>\\n<MasterDiskType>cloud_efficiency</MasterDiskType>\\n<MaintainStartTime>02:00:00</MaintainStartTime>\\n<Engine>hbaseue</Engine>\\n<Tags>\\n <Tag>\\n <Value>test_value</Value>\\n <Key>test_key</Key>\\n </Tag>\\n</Tags>\\n<ArbiterZoneId>ap-southeast-1c</ArbiterZoneId>\\n<Status>ACTIVATION</Status>\\n<ParentId>ld-fls1gf31y5s35****</ParentId>\\n<CoreDiskCount>4</CoreDiskCount>\\n<MajorVersion>2.0</MajorVersion>\\n<MultiZoneInstanceModels>\\n <MultiZoneInstanceModel>\\n <Role>primary</Role>\\n <Status>ACTIVATION</Status>\\n <IsLatestVersion>true</IsLatestVersion>\\n <MinorVersion>2.1.24</MinorVersion>\\n <InsName>ld-t4nn71xa0yn****-az-a</InsName>\\n </MultiZoneInstanceModel>\\n</MultiZoneInstanceModels>\\n<PrimaryZoneId>ap-southeast-1a</PrimaryZoneId>\\n<MasterDiskSize>50</MasterDiskSize>\\n<ExpireTimeUTC>2020-11-16T00:00:00Z</ExpireTimeUTC>\\n<MultiZoneCombination>ap-southeast-1-abc-aliyun</MultiZoneCombination>\\n<RequestId>A02C0E6D-3A47-4FA0-BA7E-60793CE256DA</RequestId>\\n<CoreNodeCount>6</CoreNodeCount>\\n<InstanceId>ld-t4nn71xa0yn****</InstanceId>\\n<ClusterId>ld-t4nn71xa0yn****</ClusterId>\\n<CreatedTimeUTC>2020-10-15T10:04:52Z</CreatedTimeUTC>\\n<LogInstanceType>hbase.sn1.large</LogInstanceType>\\n<Duration>1</Duration>\\n<EncryptionKey>2a****</EncryptionKey>\\n<EncryptionType>CloudDisk</EncryptionType>\\n<PayType>Prepaid</PayType>\\n<MasterNodeCount>2</MasterNodeCount>\\n<InstanceName>mz_test</InstanceName>\\n<VpcId>vpc-t4nx81tmlixcq5****</VpcId>\\n<AutoRenewal>false</AutoRenewal>\\n<LogNodeCount>4</LogNodeCount>\\n<CoreDiskType>cloud_efficiency</CoreDiskType>\\n<LogDiskType>cloud_efficiency</LogDiskType>\\n<RegionId>ap-southeast-1</RegionId>\\n<ExpireTime>2020-11-16T08:00:00</ExpireTime>\\n<CoreDiskSize>100</CoreDiskSize>","errorExample":""}]',
- 'title' => 'DescribeMultiZoneCluster',
+ 'errorCodes' => [],
+ 'title' => 'CreateHbaseHaSlb',
+ 'summary' => 'Creates a high-availability Thrift or Phoenix service for a BDS cluster that already has a high-availability HBase setup.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'EvaluateMultiZoneResource' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hbase:CreateHbaseHaSlb',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C9D568D9-A59C-4AF2-8FBB-F086A841D58E\\"\\n}","type":"json"}]',
+ ],
+ 'CreateMultiZoneCluster' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'Engine',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hbaseue',
- ],
+ 'schema' => ['description' => 'The service type. Currently, only ApsaraDB for HBase Performance-enhanced Edition is supported. Set the value to **hbaseue**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hbaseue', 'title' => ''],
],
[
'name' => 'EngineVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2.0',
- ],
+ 'schema' => ['description' => 'The version number of the engine type. Set the value to **2.0**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2.0', 'title' => ''],
],
[
'name' => 'ArchVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2.0',
- ],
+ 'schema' => ['description' => 'The version of the deployment architecture. Currently, only the hbaseue engine type is supported. Set the value to **2.0**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2.0', 'title' => ''],
],
[
'name' => 'ClusterName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'hbaseue_test',
- ],
+ 'schema' => ['description' => 'The name of the instance. The following rules apply:'."\n"
+ ."\n"
+ .'- The name must be 2 to 128 characters in length.'."\n"
+ .'- The name must start with an uppercase letter, a lowercase letter, or a Chinese character.'."\n"
+ .'- The name can contain digits or special characters, including periods (.), hyphens (-), and underscores (_).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'hbaseue_test', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the region in which the instance resides. You can call the [DescribeRegions](~~144489~~) operation to query the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'VpcId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'vpc-bp120k6ixs4eog*****',
- ],
+ 'schema' => ['description' => 'The ID of the virtual private cloud (VPC). The VPC must be in the region specified by RegionId.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-bp120k6ixs4eog****', 'title' => ''],
],
[
'name' => 'MultiZoneCombination',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou-bef-aliyun-com',
- ],
+ 'schema' => ['description' => '<props="china">The zone combination. You can go to the buy page or call the [DescribeMultiZoneAvailableRegions](~~203039~~) operation to view the supported zone combinations.</props>'."\n"
+ .'<props="intl">The zone combination. You can go to the buy page to view the supported zone combinations.</props>.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-bef-aliyun-com', 'title' => ''],
],
[
'name' => 'PrimaryZoneId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou-e',
- ],
+ 'schema' => ['description' => 'The zone ID of the primary zone instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-e', 'title' => ''],
],
[
'name' => 'PrimaryVSwitchId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'vsw-hangxzhouxe*****',
- ],
+ 'schema' => ['description' => 'The vSwitch ID of the primary zone instance. The vSwitch must be in the zone specified by PrimaryZoneId.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vsw-hangxzhouxe****', 'title' => ''],
],
[
'name' => 'StandbyZoneId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou-f',
- ],
+ 'schema' => ['description' => 'The zone ID of the secondary zone instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-f', 'title' => ''],
],
[
'name' => 'StandbyVSwitchId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'vsw-hangxzhouxf****',
- ],
+ 'schema' => ['description' => 'The vSwitch ID of the secondary zone instance. The vSwitch must be in the zone specified by StandbyZoneId.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vsw-hangxzhouxf****', 'title' => ''],
],
[
'name' => 'ArbiterZoneId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou-b',
- ],
+ 'schema' => ['description' => 'The zone ID of the arbiter zone.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-b', 'title' => ''],
],
[
'name' => 'ArbiterVSwitchId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'vsw-hangxzhouxb****',
- ],
+ 'schema' => ['description' => 'The vSwitch ID of the arbiter zone. The vSwitch must be in the zone specified by ArbiterZoneId.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vsw-hangxzhouxb*****', 'title' => ''],
],
[
'name' => 'MasterInstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hbase.sn1.medium',
- ],
+ 'schema' => ['description' => 'The node specifications of the master node. You can invoke the [DescribeInstanceType](~~145796~~) operation to query the node specifications.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hbase.sn1.medium', 'title' => ''],
],
[
'name' => 'CoreInstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hbase.sn1.medium',
- ],
+ 'schema' => ['description' => 'The node specifications of the core node. You can invoke the [DescribeInstanceType](~~145796~~) operation to query the node specifications.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hbase.sn1.medium', 'title' => ''],
],
[
'name' => 'CoreDiskType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cloud_ssd',
- ],
+ 'schema' => ['description' => 'The disk type of the core node. Valid values:'."\n"
+ .'- **cloud_efficiency**: ultra cloud disk.'."\n"
+ .'- **cloud_ssd**: standard SSD.'."\n"
+ .'- **local_hdd_pro**: throughput-intensive local disk.'."\n"
+ .'- **local_ssd_pro**: I/O-intensive local disk.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cloud_ssd', 'title' => ''],
],
[
'name' => 'CoreDiskSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '64000',
- 'minimum' => '400',
- 'example' => '400',
- ],
+ 'schema' => ['description' => 'The disk size of the node. Valid values: 400 to 64000. Unit: GB. The value must be a multiple of 40.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '400', 'title' => ''],
],
[
'name' => 'CoreNodeCount',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2000',
- 'minimum' => '4',
- 'example' => '4',
- ],
+ 'schema' => ['description' => 'The number of core nodes. Valid values: 2 to 20. The value must be an even number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '4', 'title' => ''],
],
[
'name' => 'LogInstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'hbase.sn1.medium',
- ],
+ 'schema' => ['description' => 'The node specifications of the log node. You can invoke the [DescribeInstanceType](~~145796~~) operation to query the node specifications.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hbase.sn1.medium', 'title' => ''],
],
[
'name' => 'LogDiskType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'cloud_ssd',
- ],
+ 'schema' => ['description' => 'The disk type of the log node. Valid values:'."\n"
+ .'- **cloud_efficiency**: ultra cloud disk.'."\n"
+ .'- **cloud_ssd**: standard SSD.'."\n"
+ .'- **local_hdd_pro**: throughput-intensive local disk.'."\n"
+ .'- **local_ssd_pro**: I/O-intensive local disk.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cloud_ssd', 'title' => ''],
],
[
'name' => 'LogDiskSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'maximum' => '64000',
- 'minimum' => '400',
- 'example' => '400',
- ],
+ 'schema' => ['description' => 'The disk size of the log node. Valid values: 400 to 64000. Unit: GB. The value must be a multiple of 40.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '400', 'title' => ''],
],
[
'name' => 'LogNodeCount',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'maximum' => '200',
- 'minimum' => '4',
- 'example' => '4',
- ],
+ 'schema' => ['description' => 'The number of log nodes. Valid values: 4 to 400. The value must be a multiple of 4.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '4', 'title' => ''],
],
[
'name' => 'SecurityIPList',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '127.0.0.1',
- ],
+ 'schema' => ['description' => 'The IP addresses in the whitelist of the instance. Separate multiple IP addresses with commas (,).'."\n"
+ ."\n"
+ .'> If the IP address is set to 127.0.0.1, no IP addresses are allowed to access the instance. For example, 192.168.0.0/24 indicates that all IP addresses in the 192.168.0.XX range are allowed to access the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '127.0.0.1', 'title' => ''],
],
[
'name' => 'PayType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Postpaid',
- ],
+ 'schema' => ['description' => 'The billing method of the instance. Valid values:'."\n"
+ .'- **Prepaid**: subscription.'."\n"
+ .'- **Postpaid**: pay-as-you-go.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Postpaid', 'title' => ''],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'month',
- ],
+ 'schema' => ['description' => 'The unit of the subscription period for the subscription instance. Valid values:'."\n"
+ .'- **year**: year.'."\n"
+ .'- **month**: month.'."\n"
+ ."\n"
+ .'> This parameter is required only when PayType is set to Prepaid.', 'type' => 'string', 'required' => false, 'example' => 'month', 'title' => ''],
],
[
'name' => 'Period',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '60',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The subscription period of the subscription instance. Valid values:'."\n"
+ ."\n"
+ .'- If PeriodUnit is set to year, valid values are 1 to 3.'."\n"
+ .'- If PeriodUnit is set to month, valid values are 1 to 9.'."\n"
+ ."\n"
+ .'> This parameter is required only when PayType is set to Prepaid.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'AutoRenewPeriod',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '60',
- 'minimum' => '1',
- 'example' => '0',
- ],
+ 'schema' => ['description' => 'The Unified Auto Renewal Cycle. Unit: months.'."\n"
+ ."\n"
+ .'><ul><li>Default value: 0, which indicates that auto-renewal is disabled.</li>'."\n"
+ .'<li>If AutoRenewPeriod is set to 2, the instance is automatically renewed for two epochs upon expiration.</li></ul>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'f4g8t5rd2gr94****',
- ],
+ 'schema' => ['description' => 'The token that is used to ensure the idempotence of the request.', 'type' => 'string', 'required' => false, 'example' => 'dfh3sf5gslfksfk****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the resource group. You can query the resource group ID in the resource group console. If you do not specify this parameter, the instance is added to the default resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-gg3f4f5d5g5w****', 'title' => ''],
],
],
'responses' => [
@@ -1951,222 +1275,95 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FB703B69-D4D4-4879-B9FE-6A37F67C46FD',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7F68E8F5-0377-4CF8-8B1D-FFFD6F5804D5', 'title' => ''],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '23232453****', 'title' => ''],
+ 'ClusterId' => ['description' => 'The instance ID of the ApsaraDB for HBase multi-zone database instance that is active.', 'type' => 'string', 'example' => 'ld-t4nn71xa0yn56****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"FB703B69-D4D4-4879-B9FE-6A37F67C46FD\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>FB703B69-D4D4-4879-B9FE-6A37F67C46FD</RequestId>\\n<Success>true</Success>","errorExample":""}]',
- 'title' => 'EvaluateMultiZoneResource',
+ 'errorCodes' => [],
+ 'title' => 'Create a multi-zone cluster',
+ 'summary' => 'Creates a multi-zone cluster by calling CreateMultiZoneCluster.',
+ 'description' => 'Currently, only version 2.0 of the HBaseue engine is supported.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeDeletedInstances' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hbase:CreateMultiZoneCluster',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F68E8F5-0377-4CF8-8B1D-FFFD6F5804D5\\",\\n \\"OrderId\\": \\"23232453****\\",\\n \\"ClusterId\\": \\"ld-t4nn71xa0yn56****\\"\\n}","type":"json"}]',
+ ],
+ 'CreateRestorePlan' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the ApsaraDB for HBase Performance-enhanced Edition cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp150tns0sjxs****', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'TargetClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The ID of the ApsaraDB for HBase Performance-enhanced Edition cluster to which data is restored. You can also restore data to the cluster that is currently backed up.'."\n"
+ ."\n"
+ .'> The specified ApsaraDB for HBase Performance-enhanced Edition cluster and the backed-up ApsaraDB for HBase Performance-enhanced Edition cluster must meet the following requirements:<ul>'."\n"
+ .'<li>They are of the same version.</li>'."\n"
+ .'<li>They are in the same region.</li>'."\n"
+ .'<li>They are associated with the BDS cluster.</li></ul>.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp169l540vc6c****', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'RestoreAllTable',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'Specifies whether to restore all tables. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Restores all tables in the ApsaraDB for HBase Performance-enhanced Edition cluster.'."\n"
+ .'- **false**: Does not restore all tables in the ApsaraDB for HBase Performance-enhanced Edition cluster.'."\n"
+ ."\n"
+ .'> If this parameter is set to **true**, the **Tables** parameter is invalid. If this parameter is set to **false**, the **Tables** parameter is required.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0CAC5702-C862-44C0-AD54-C9CE70F4B246',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Instances' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Instance' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DELETED',
- ],
- 'InstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hb-bp10q7n2zdw12xxxx',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'ParentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'ClusterType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cluster',
- ],
- 'InstanceName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'e2e-test',
- ],
- 'ZoneId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-f',
- ],
- 'DeleteTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-02T07:27:24Z',
- ],
- 'ModuleStackVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'MajorVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2.0',
- ],
- 'Engine' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase',
- ],
- 'CreatedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-02T07:16:07Z',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ [
+ 'name' => 'RestoreByCopy',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to restore data by using the copy method. Set the value to **true**.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''],
],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"0CAC5702-C862-44C0-AD54-C9CE70F4B246\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Instances\\": {\\n \\"Instance\\": [\\n {\\n \\"Status\\": \\"DELETED\\",\\n \\"InstanceId\\": \\"hb-bp10q7n2zdw12xxxx\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ParentId\\": \\"null\\",\\n \\"ClusterType\\": \\"cluster\\",\\n \\"InstanceName\\": \\"e2e-test\\",\\n \\"ZoneId\\": \\"cn-hangzhou-f\\",\\n \\"DeleteTime\\": \\"2020-11-02T07:27:24Z\\",\\n \\"ModuleStackVersion\\": \\"null\\",\\n \\"MajorVersion\\": \\"2.0\\",\\n \\"Engine\\": \\"hbase\\",\\n \\"CreatedTime\\": \\"2020-11-02T07:16:07Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<Instances>\\n <Instance>\\n <ParentId>null</ParentId>\\n <ModuleStackVersion>null</ModuleStackVersion>\\n <MajorVersion>2.0</MajorVersion>\\n <Status>DELETED</Status>\\n <CreatedTime>2020-11-02T07:16:07Z</CreatedTime>\\n <ZoneId>cn-hangzhou-f</ZoneId>\\n <InstanceId>hb-bp10q7n2zdw12xxxx</InstanceId>\\n <DeleteTime>2020-11-02T07:27:24Z</DeleteTime>\\n <ClusterType>cluster</ClusterType>\\n <InstanceName>e2e-test</InstanceName>\\n <RegionId>cn-hangzhou</RegionId>\\n <Engine>hbase</Engine>\\n </Instance>\\n</Instances>\\n<TotalCount>1</TotalCount>\\n<PageSize>10</PageSize>\\n<RequestId>0CAC5702-C862-44C0-AD54-C9CE70F4B246</RequestId>\\n<PageNumber>1</PageNumber>","errorExample":""}]',
- 'title' => 'DescribeDeletedInstances',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeIpWhitelist' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'RestoreToDate',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The point in time to which you want to restore data. The point in time must be within the recoverable time range. You can call the [DescribeRecoverableTimeRange](~~188365~~) operation to query the recoverable time range.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-11-05T05:49:42Z', 'title' => ''],
],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'Tables',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp150tns0sjxs****',
- ],
+ 'schema' => ['description' => 'The table names. Specify one table name per line. Wildcards (*) are not supported.'."\n"
+ ."\n"
+ .'- To restore to the current table, use the format: `namespace:table`. Example: `default:testTable`.'."\n"
+ .'- To restore to a different table, use the format: `namespace:table/namespace:table2`. Example: `default:testTable/default:testTable2`.', 'type' => 'string', 'required' => false, 'example' => 'test_ns:test_table/test_ns:test_table2', 'title' => ''],
],
],
'responses' => [
@@ -2174,69 +1371,41 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AFAA617B-3268-5883-982B-DB8EC8CC1F1B',
- ],
- 'Groups' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Group' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'IpVersion' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'GroupName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default',
- ],
- 'IpList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Ip' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '116.62.XX.XX/24',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A0598673-EB6E-4F6D-9961-E0F2012090C0', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AFAA617B-3268-5883-982B-DB8EC8CC1F1B\\",\\n \\"Groups\\": {\\n \\"Group\\": [\\n {\\n \\"IpVersion\\": 4,\\n \\"GroupName\\": \\"default\\",\\n \\"IpList\\": {\\n \\"Ip\\": [\\n \\"116.62.XX.XX/24\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeIpWhitelistResponse>\\n <RequestId>AFAA617B-3268-5883-982B-DB8EC8CC1F1B</RequestId>\\n <Groups>\\n <Group>\\n <IpVersion>4</IpVersion>\\n <GroupName>default</GroupName>\\n <IpList>116.62.XX.XX/24</IpList>\\n <IpList>120.21.XX.XX/24</IpList>\\n </Group>\\n </Groups>\\n</DescribeIpWhitelistResponse>","errorExample":""}]',
- 'title' => 'DescribeIpWhitelist',
- ],
- 'CreateCluster' => [
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Create a restore plan',
+ 'summary' => 'Restores backed-up data from a cluster with the backup and restore feature enabled to another ApsaraDB for HBase Performance-enhanced Edition cluster in the same region.',
+ 'description' => 'Before calling this operation, make sure that the backup and restore feature is enabled for the ApsaraDB for HBase Performance-enhanced Edition cluster and that the target ApsaraDB for HBase Performance-enhanced Edition cluster is associated with the corresponding BDS.',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T12:02:00.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hbase:CreateRestorePlan',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0598673-EB6E-4F6D-9961-E0F2012090C0\\"\\n}","type":"json"}]',
+ ],
+ 'CreateServerlessCluster' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2244,238 +1413,121 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the instance. You can call the [DescribeRegions](~~144489~~) operation to query the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou-f',
- ],
+ 'schema' => ['description' => 'The zone ID. You can call the [DescribeRegions](~~144489~~) operation to query the zone ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-f', 'title' => ''],
],
[
'name' => 'ClusterName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'hbase_test',
- ],
+ 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'serverless-name', 'title' => ''],
],
[
'name' => 'VpcId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'vpc-bp120k6ixs4eog****',
- ],
+ 'schema' => ['description' => 'The ID of the virtual private cloud (VPC).'."\n"
+ ."\n"
+ .'> If both this parameter and the VswitchId parameter are left empty, the network type of the instance is classic network.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vpc-bp120k6ixs4eog****', 'title' => ''],
],
[
'name' => 'VSwitchId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'vsw-bp191otqj1ssyl****',
- ],
+ 'schema' => ['description' => 'The vSwitch ID within the VPC.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vsw-bp191ipotqj1ssyl*****', 'title' => ''],
],
[
- 'name' => 'MasterInstanceType',
+ 'name' => 'PayType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'hbase.sn1.medium',
- ],
+ 'schema' => ['description' => 'The billing method of the instance. Valid values:'."\n"
+ ."\n"
+ .'- **Prepaid**: subscription.'."\n"
+ .'- **Postpaid**: pay-as-you-go.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Prepaid', 'title' => ''],
],
[
- 'name' => 'CoreInstanceType',
+ 'name' => 'PeriodUnit',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hbase.sn1.medium',
- ],
+ 'schema' => ['description' => 'The unit of the subscription duration for the subscription instance. Valid values:'."\n"
+ ."\n"
+ .'- **year**: year.'."\n"
+ .'- **month**: month.'."\n"
+ ."\n"
+ .'> This parameter is required only when the billing method of the instance is **Prepaid**.', 'type' => 'string', 'required' => false, 'example' => 'month', 'title' => ''],
],
[
- 'name' => 'DiskType',
+ 'name' => 'Period',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'cloud_ssd',
- ],
+ 'schema' => ['description' => 'The subscription duration of the subscription instance. Valid values:'."\n"
+ ."\n"
+ .'- If PeriodUnit is set to year, valid values are **1** to **3**.'."\n"
+ .'- If PeriodUnit is set to month, valid values are **1** to **9**.'."\n"
+ ."\n"
+ .'> This parameter is required only when the billing method of the instance is **Prepaid**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '60', 'minimum' => '0', 'default' => '0', 'example' => '6', 'title' => ''],
],
[
- 'name' => 'DiskSize',
+ 'name' => 'AutoRenewPeriod',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '400',
- ],
+ 'schema' => ['description' => 'The auto-renewal period of the instance. Unit: months.'."\n"
+ ."\n"
+ .'> <ul><li>The default value of the auto-renewal period is 0, which indicates that the instance is not automatically renewed after the instance expires.</li>'."\n"
+ .'<li>For example, if the auto-renewal period is set to 2, the instance is automatically renewed for two months after the instance expires.</li></ul>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '36', 'minimum' => '0', 'default' => '0', 'example' => '2', 'title' => ''],
],
[
- 'name' => 'NodeCount',
+ 'name' => 'ServerlessSpec',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'The specification type. Valid values: leave empty or **serverless.small**.', 'type' => 'string', 'required' => false, 'default' => 'serverless.small', 'example' => 'serverless.small', 'title' => ''],
],
[
- 'name' => 'PayType',
+ 'name' => 'ServerlessCapability',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Prepaid',
- ],
+ 'schema' => ['description' => 'The processing capability per unit. Unit: CU.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '20000', 'minimum' => '50', 'default' => '50', 'example' => '1000', 'title' => ''],
],
[
- 'name' => 'Engine',
+ 'name' => 'ServerlessStorage',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hbase',
- ],
+ 'schema' => ['description' => 'The storage size. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '20000', 'minimum' => '10', 'default' => '10', 'example' => '100', 'title' => ''],
],
[
- 'name' => 'SecurityIPList',
+ 'name' => 'Engine',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '116.62.XX.XX/24',
- ],
+ 'schema' => ['description' => 'The engine type of the HBase Serverless instance. Set the value to **serverlesshbase**.', 'type' => 'string', 'required' => false, 'default' => 'serverlesshbase', 'example' => 'serverlesshbase', 'title' => ''],
],
[
'name' => 'EngineVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2.0',
- ],
+ 'schema' => ['description' => 'The DPI engine version.', 'type' => 'string', 'required' => false, 'default' => '2.0', 'example' => '2.0', 'title' => ''],
],
[
- 'name' => 'ColdStorageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1024',
- ],
- ],
- [
- 'name' => 'PeriodUnit',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'month',
- ],
- ],
- [
- 'name' => 'Period',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '6',
- ],
- ],
- [
- 'name' => 'AutoRenewPeriod',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the value is unique among different requests. The token can be up to 64 ASCII characters in length and cannot contain non-ASCII characters.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'ClientType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ETnLKlblzczshOTUbOCz****',
- ],
+ 'schema' => ['description' => 'The parameter that identifies the source of the creation request. For public cloud, leave this parameter empty.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-j4d53glb3****',
- ],
+ 'schema' => ['description' => 'The resource group ID. For more information about resource groups, see [View basic information of a resource group](~~151181~~).', 'type' => 'string', 'required' => false, 'example' => 'rg-j4d53glb3****', 'title' => ''],
],
[
- 'name' => 'EncryptionKey',
+ 'name' => 'DiskType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0d2470df-da7b-4786-b981-9a164dae****',
- ],
+ 'schema' => ['description' => 'The disk type of the instance. Valid values:'."\n"
+ ."\n"
+ .'- **cloud_efficiency**: ultra cloud disk.'."\n"
+ .'- **cloud_ssd**: standard SSD.'."\n"
+ .'- **local_hdd_pro**: local HDD.'."\n"
+ .'- **local_ssd_pro**: local SSD.'."\n"
+ .'- **cloud_essd_pl1**: ESSD.', 'type' => 'string', 'required' => false, 'example' => 'cloud_ssd', 'title' => ''],
],
],
'responses' => [
@@ -2483,40 +1535,46 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3E19E345-101D-4014-946C-A205',
- ],
- 'OrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '23232069786****',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hb-bp1hy2sjf8gd****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3E19E345-101D-4014-946C-************', 'title' => ''],
+ 'PassWord' => ['description' => 'The password used to access the cluster.', 'type' => 'string', 'example' => '*********', 'title' => ''],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '23232453233*****', 'title' => ''],
+ 'ClusterId' => ['description' => 'The instance ID of the HBase Serverless instance.', 'type' => 'string', 'example' => 'sh-bp1a969y7681****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3E19E345-101D-4014-946C-A205\\",\\n \\"OrderId\\": \\"23232069786****\\",\\n \\"ClusterId\\": \\"hb-bp1hy2sjf8gd****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateClusterResponse>\\n <RequestId>3E19E345-101D-4014-946C-A205</RequestId>\\n <OrderId>23232069786****</OrderId>\\n <ClusterId>hb-bp1hy2sjf8gd****</ClusterId>\\n</CreateClusterResponse>","errorExample":""}]',
- 'title' => 'CreateCluster',
+ 'errorCodes' => [],
+ 'title' => 'CreateServerlessCluster',
+ 'summary' => 'Creates an HBase Serverless cluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'AddUserHdfsInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hbase:CreateServerlessCluster',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E19E345-101D-4014-946C-************\\",\\n \\"PassWord\\": \\"*********\\",\\n \\"OrderId\\": \\"23232453233*****\\",\\n \\"ClusterId\\": \\"sh-bp1a969y7681****\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteAccount' => [
+ 'summary' => 'Delete Wide Table Database Account',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2524,41 +1582,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-bp16o0pd5****582s',
- ],
- ],
- [
- 'name' => 'ExtInfo',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"dfs.nameservices":"hdfs_test","dfs.ha.namenodes":"nn1,nn2","dfs.namenode.http-address.hdfs_test.nn1":"TEST-xxx1.com:50070","dfs.namenode.http-address.hdfs_test.nn2":"TEST-xxx2.com:50070","dfs.namenode.rpc-address.hdfs_test.nn1":"TEST-xxx1.com:8020","dfs.namenode.rpc-address.hdfs_test.nn2":"TEST-xxx2.com:8020"}',
- ],
+ 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp150tns0sjxs****', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'AccountName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ETnLKlblzczshOTUbOCz****',
- ],
+ 'schema' => ['description' => 'The name of the existing account to be deleted.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test01****', 'title' => ''],
],
],
'responses' => [
@@ -2566,31 +1600,38 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FB0B7918-198C-46A8-AB9B-FE15403B1F0A',
- ],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '729CB2A7-3065-53A9-B27C-7033CA4*****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FB0B7918-198C-46A8-AB9B-FE15403B1F0A\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>FB0B7918-198C-46A8-AB9B-FE15403B1F0A</RequestId>","errorExample":""}]',
- 'title' => 'AddUserHdfsInfo',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DeleteInstance' => [
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Delete Database Account',
+ 'description' => 'Only supported for HBase Enhanced Edition (HBaseue).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:DeleteAccount',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"729CB2A7-3065-53A9-B27C-7033CA4*****\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteGlobalResource' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2598,35 +1639,27 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-bp16o0pd52e3y****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-t4naqsay5gn******', 'title' => ''],
],
[
- 'name' => 'ImmediateDeleteFlag',
+ 'name' => 'ResourceName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => '',
- 'enum' => [
- 'false',
- 'true',
- ],
- ],
+ 'schema' => ['description' => 'The resource name. PubPhoenixSLBQueryServerVip releases the public endpoint of the HBase SQL service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PubPhoenixSLBQueryServerVip', 'title' => ''],
+ ],
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The resource type.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GLOBAL_VIP', 'title' => ''],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
@@ -2634,31 +1667,43 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BD0B0B9A-79E8-4FDD-9C51-93443490B784', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteInstanceResponse>\\r\\n<RequestId>50373857-C47B-4B64-9332-D0B5280B59EA</RequestId>\\r\\n</DeleteInstanceResponse>","errorExample":""}]',
- 'title' => 'DeleteInstance',
+ 'title' => 'Delete a global resource',
+ 'summary' => 'Deletes a global resource from a cluster by calling DeleteGlobalResource.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DeleteHBaseHaDB' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-14T10:59:09.000Z', 'description' => 'Request parameters changed, Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hbase:DeleteGlobalResource',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BD0B0B9A-79E8-4FDD-9C51-93443490B784\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteHBaseHaDB' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2666,31 +1711,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'BdsId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'bds-bp14112fd7g52s1****',
- ],
+ 'schema' => ['description' => 'The ID of the BDS cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'bds-bp14112fd7g52s1****', 'title' => ''],
],
[
'name' => 'HaId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ha-sw2o0l01s4r76****',
- ],
+ 'schema' => ['description' => 'The ID of the HA instance. You can call the QueryHBaseHaDB operation to obtain the ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ha-sw2o0l01s4r76****', 'title' => ''],
],
],
'responses' => [
@@ -2698,30 +1729,43 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'B409CF51-E01F-4551-BE40-123678FA9026',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B409CF51-E01F-4551-BE40-123678FA9026', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B409CF51-E01F-4551-BE40-123678FA9026\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>B409CF51-E01F-4551-BE40-123678FA9026</RequestId>","errorExample":""}]',
- 'title' => 'DeleteHBaseHaDB',
+ 'title' => 'Delete an HA instance',
+ 'summary' => 'Deletes a created HA instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DeleteUserHdfsInfo' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-06T09:46:55.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:DeleteHBaseHaDB',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B409CF51-E01F-4551-BE40-123678FA9026\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteHBaseSlbServer' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2729,31 +1773,19 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-bp16o0pd52e3y****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-t4naqsay5gn****', 'title' => ''],
],
[
- 'name' => 'NameService',
+ 'name' => 'SlbServer',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hdfs_test',
- ],
+ 'schema' => ['description' => 'The load balancing service. Valid values:'."\n"
+ .'thrift'."\n"
+ .'rest.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'thrift', 'title' => ''],
],
],
'responses' => [
@@ -2761,31 +1793,43 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7242130A-82CF-49BF-AB32-30DCB819EBA6', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>50373857-C47B-4B64-9332-D0B5280B59EA</RequestId>","errorExample":""}]',
- 'title' => 'DeleteUserHdfsInfo',
+ 'title' => 'Delete an activated load balancing service',
+ 'summary' => 'Calls DeleteHBaseSlbServer to delete an activated load balancing service.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifyInstanceMaintainTime' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-06T09:46:55.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:DeleteHBaseSlbServer',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7242130A-82CF-49BF-AB32-30DCB819EBA6\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteHbaseHaSlb' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2793,42 +1837,24 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'BdsId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp1b**6jco89****',
- ],
+ 'schema' => ['description' => 'The ID of the BDS cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'bds-t4n3496whj23ia4k', 'title' => ''],
],
[
- 'name' => 'MaintainStartTime',
+ 'name' => 'HaId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '02:00Z',
- ],
+ 'schema' => ['description' => 'The high availability ID in BDS high availability management.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ha-v21tmnxjwh2yuy1il', 'title' => ''],
],
[
- 'name' => 'MaintainEndTime',
+ 'name' => 'HaTypes',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '06:00Z',
- ],
+ 'schema' => ['description' => 'The high availability type. Valid values:'."\n"
+ .'1. thrift'."\n"
+ .'2. phoenix.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'thrift', 'title' => ''],
],
],
'responses' => [
@@ -2836,31 +1862,42 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C9085433-A56A-4089-B49A-DF5A4E2B7B06',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C9D568D9-A59C-4AF2-8FBB-F086A841D58E', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C9085433-A56A-4089-B49A-DF5A4E2B7B06\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>C9085433-A56A-4089-B49A-DF5A4E2B7B06</RequestId>","errorExample":""}]',
- 'title' => 'ModifyInstanceMaintainTime',
+ 'title' => 'DeleteHbaseHaSlb',
+ 'summary' => 'Deletes the corresponding high-availability Thrift or high-availability Phoenix configuration. This operation is the counterpart of the CreateHbaseHaSlb operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifyInstanceType' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hbase:DeleteHbaseHaSlb',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C9D568D9-A59C-4AF2-8FBB-F086A841D58E\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteInstance' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2868,39 +1905,26 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-bp1x940uh********',
- ],
- ],
- [
- 'name' => 'MasterInstanceType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'hbase.sn1.large',
- ],
+ 'schema' => ['description' => 'The instance ID of the instance to be released.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-bp16o0pd52e3y****', 'title' => ''],
],
[
- 'name' => 'CoreInstanceType',
+ 'name' => 'ImmediateDeleteFlag',
'in' => 'query',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'Specifies whether to immediately release the instance. Valid values:'."\n"
+ .'- **true**: The instance is immediately released.'."\n"
+ .'- **false**: The instance is not immediately released and is stored in the recycle bin. This is the default value.',
+ 'type' => 'boolean',
'required' => false,
- 'example' => 'hbase.sn1.8xlarge',
+ 'default' => '',
+ 'enum' => ['false', 'true'],
+ 'example' => 'false',
+ 'title' => '',
],
],
],
@@ -2909,35 +1933,49 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'OrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123412341234123',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3E19E345-101D-4014-946C-****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"123412341234123\\",\\n \\"RequestId\\": \\"3E19E345-101D-4014-946C-****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyInstanceTypeResponse>\\n <OrderId>123412341234123</OrderId>\\n <RequestId>3E19E345-101D-4014-946C-****</RequestId>\\n</ModifyInstanceTypeResponse>","errorExample":""}]',
- 'title' => 'ModifyInstanceType',
+ 'errorCodes' => [],
+ 'title' => 'Delete an instance',
+ 'summary' => 'Calls DeleteInstance to release an HBase instance.',
+ 'description' => 'When you call this operation, the instance must meet the following conditions:'."\n"
+ ."\n"
+ .'- The instance status is **Running**.'."\n"
+ .'- The billing method of the instance is **pay-as-you-go**.'."\n"
+ ."\n"
+ .'> Subscription instances cannot be deleted by calling this operation. They are automatically released upon expiration. To release a subscription instance in advance, submit a ticket.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'EnableHBaseueModule' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hbase:DeleteInstance',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteMultiZoneCluster' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2945,205 +1983,25 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'ModuleClusterName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'cluster-name',
- ],
- ],
- [
- 'name' => 'VpcId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'vpc-bp120k6ixs4eog*****',
- ],
- ],
- [
- 'name' => 'VswitchId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'vsw-bp191ipotqj1ssyl*****',
- ],
- ],
- [
- 'name' => 'MasterInstanceType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'hbase.sn1.large',
- ],
- ],
- [
- 'name' => 'CoreInstanceType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hbase.sn1.large',
- ],
- ],
- [
- 'name' => 'DiskType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'cloud_ssd',
- ],
- ],
- [
- 'name' => 'DiskSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '400',
- ],
- ],
- [
- 'name' => 'NodeCount',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2',
- ],
- ],
- [
- 'name' => 'PayType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Prepaid',
- ],
- ],
- [
- 'name' => 'PeriodUnit',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'month',
- ],
- ],
- [
- 'name' => 'Period',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '6',
- ],
- ],
- [
- 'name' => 'AutoRenewPeriod',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- ],
- [
- 'name' => 'ClientToken',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ETnLKlblzczshOTUbOCz****',
- ],
+ 'schema' => ['description' => 'The ID of the multi-zone cluster to delete.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd-t4nn71xa0yn56****', 'title' => ''],
],
[
- 'name' => 'HbaseueClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp150tns0sjxs****',
- ],
- ],
- [
- 'name' => 'BdsId',
+ 'name' => 'ImmediateDeleteFlag',
'in' => 'query',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'Specifies whether to immediately delete the instance. By default, the instance is moved to the recycle bin and permanently deleted after 7 days. Valid values:'."\n"
+ .'- true: Immediately deletes the instance without moving it to the recycle bin. Use this option with caution.'."\n"
+ .'- false: Moves the instance to the recycle bin. This is the default value.',
+ 'type' => 'boolean',
'required' => false,
- 'example' => 'bds-bp174pm3tsk3****',
- ],
- ],
- [
- 'name' => 'ModuleTypeName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'solr',
- ],
- ],
- [
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-shenzhen',
- ],
- ],
- [
- 'name' => 'ZoneId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-shenzhen-e',
+ 'enum' => ['false', 'true'],
+ 'example' => 'false',
+ 'title' => '',
],
],
],
@@ -3152,102 +2010,65 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '407075EA-47F5-5A2D-888F-C1F90B8F3FCA',
- ],
- 'OrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '21474915573****',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ld-bp150tns0sjxs****-m1-ps',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '169A3910-A39E-4BC2-AA9F-E7AD8D473527', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"407075EA-47F5-5A2D-888F-C1F90B8F3FCA\\",\\n \\"OrderId\\": \\"21474915573****\\",\\n \\"ClusterId\\": \\"ld-bp150tns0sjxs****-m1-ps\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableHBaseueModuleResponse>\\n <RequestId>407075EA-47F5-5A2D-888F-C1F90B8F3FCA</RequestId>\\n <OrderId>21474915573****</OrderId>\\n <ClusterId>ld-bp150tns0sjxs****-m1-ps</ClusterId>\\n</EnableHBaseueModuleResponse>","errorExample":""}]',
- 'title' => 'EnableHBaseueModule',
+ 'errorCodes' => [],
+ 'title' => 'Delete a multi-zone instance',
+ 'summary' => 'Deletes a multi-zone instance by calling the DeleteMultiZoneCluster operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifyInstanceName' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hbase:DeleteMultiZoneCluster',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"169A3910-A39E-4BC2-AA9F-E7AD8D473527\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteServerlessCluster' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'ClientToken',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ETnLKlblzczshOTUbOCz****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sh-bp1pj13wh9****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou-f',
- ],
- ],
- [
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp150tns0sjxs****',
- ],
- ],
- [
- 'name' => 'ClusterName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'testhbaseone',
- ],
+ 'schema' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen-e', 'title' => ''],
],
],
'responses' => [
@@ -3255,31 +2076,43 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '959DA199-54E5-569D-AD46-92BED8515E62',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '46950E74-59C4-4E3E-9B38-A33B*********', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"959DA199-54E5-569D-AD46-92BED8515E62\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyInstanceNameResponse>\\r\\n<RequestId>65BDA532-28AF-4122-AA39-B382721EEE64</RequestId>\\r\\n</ModifyInstanceNameResponse>","errorExample":""}]',
- 'title' => 'ModifyInstanceName',
+ 'title' => 'Delete an hBase serverless cluster',
+ 'summary' => 'Deletes an HBase Serverless cluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifyDiskWarningLine' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-06T09:46:55.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hbase:DeleteServerlessCluster',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46950E74-59C4-4E3E-9B38-A33B*********\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteUserHdfsInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3287,34 +2120,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-m5eznlga4k5bcxxxx',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-bp16o0pd52e3y****', 'title' => ''],
],
[
- 'name' => 'WarningLine',
+ 'name' => 'NameService',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '100',
- 'minimum' => '0',
- 'example' => '80',
- ],
+ 'schema' => ['description' => 'The value of dfs.nameservices in addUserHdfsInfo. This value is returned when you call the [QueryXpackRelateDB](~~144509~~) operation with relateDB set to hdfs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hdfs_test', 'title' => ''],
],
],
'responses' => [
@@ -3322,31 +2138,43 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FC4A930D-3AEE-4C9D-BC70-C0F2EEEAA174',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FC4A930D-3AEE-4C9D-BC70-C0F2EEEAA174\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>FC4A930D-3AEE-4C9D-BC70-C0F2EEEAA174</RequestId>","errorExample":""}]',
- 'title' => 'ModifyDiskWarningLine',
+ 'title' => 'Delete user-created HDFS information in xpack',
+ 'summary' => 'Calls DeleteUserHdfsInfo to delete user-created HDFS information in Xpack.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifyUIAccountPassword' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hbase:DeleteUserHdfsInfo',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeAccounts' => [
+ 'summary' => 'Queries the list of database accounts.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3354,42 +2182,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp150tns0sjxs****',
- ],
- ],
- [
- 'name' => 'AccountName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test01',
- ],
- ],
- [
- 'name' => 'AccountPassword',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '**********',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp1uoihlf82e8****', 'title' => ''],
],
],
'responses' => [
@@ -3397,51 +2195,70 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F744E939-D08D-5623-82C8-9D1F9F7*****', 'title' => ''],
+ 'Accounts' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'account' => [
+ 'description' => 'The list of account information.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The account name.', 'type' => 'string', 'example' => '["test"]', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'BED4ADEB-4EA9-507E-892C-84112D6AC7C1',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BED4ADEB-4EA9-507E-892C-84112D6AC7C1\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyUIAccountPasswordResponse>\\r\\n<RequestId>BED4ADEB-4EA9-507E-892C-84112D6AC7C1</RequestId>\\r\\n</ModifyUIAccountPasswordResponse>","errorExample":""}]',
- 'title' => 'ModifyUIAccountPassword',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeInstance' => [
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Query database accounts',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeAccounts',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F744E939-D08D-5623-82C8-9D1F9F7*****\\",\\n \\"Accounts\\": {\\n \\"account\\": [\\n \\"[\\\\\\"test\\\\\\"]\\"\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeActiveOperationTaskType' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'operationType' => 'read',
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'IsHistory',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp150tns0sjxs****',
- ],
+ 'schema' => ['description' => 'Specifies whether to return historical O&M tasks. Valid values:'."\n"
+ ."\n"
+ .'- **0**: Returns only the current pending O&M tasks.'."\n"
+ .'- **1**: Returns historical O&M tasks.'."\n"
+ ."\n"
+ .'Default value: **0**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
],
],
'responses' => [
@@ -3449,745 +2266,144 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'VpcId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vpc-bp15s22y1a7sff5gj****',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ACTIVATION',
- ],
- 'EncryptionType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NoEncryption',
- ],
- 'ModuleId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'VswitchId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vsw-bp1foll427ze3d4ps****',
- ],
- 'BackupStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'open',
- ],
- 'PayType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Prepaid',
- ],
- 'CoreDiskType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cloud_ssd',
- ],
- 'MasterNodeCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'NetworkType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'VPC',
- ],
- 'CreatedTimeUTC' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-07-19T03:23:22Z',
- ],
- 'ColdStorageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '800',
- ],
- 'ParentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ld-uf699153o1m2l****',
- ],
- 'IsLatestVersion' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ExpireTimeUTC' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2022-02-23T16:00:00Z',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66',
- ],
- 'InstanceName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'testhbase',
- ],
- 'MasterInstanceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase.sn2.large',
- ],
- 'CoreInstanceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase.sn2.2xlarge',
- ],
- 'EncryptionKey' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0d2470df-da7b-4786-b981-9a164dae****',
- ],
- 'CreatedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-07-19T11:23:22',
- ],
- 'CoreDiskSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ld-bp150tns0sjxs****',
- ],
- 'ExpireTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2022-02-24T00:00:00',
- ],
- 'MaintainStartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '18:00Z',
- ],
- 'ConfirmMaintainTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'IsHa' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'MaintainEndTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '22:00Z',
- ],
- 'InstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ld-bp150tns0sjxs****',
- ],
- 'ColdStorageStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'open',
- ],
- 'IsDeletionProtection' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'MinorVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2.2.9.1',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'MasterDiskSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'MasterDiskType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cloud_efficiency',
- ],
- 'NeedUpgrade' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'IsMultiModel' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'AutoRenewal' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ClusterType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cluster',
- ],
- 'ResourceGroupId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rg-acfmyiu4ekp****',
- ],
- 'ClusterName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'testhbase',
- ],
- 'ZoneId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-f',
- ],
- 'Duration' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
- 'ModuleStackVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'phoenxi:4.0',
- ],
- 'Engine' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbaseue',
- ],
- 'MajorVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2.0',
- ],
- 'CoreDiskCount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4',
- ],
- 'TaskProgress' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '25.00',
- ],
- 'TaskStatus' => [
- 'type' => 'string',
- ],
- 'CoreNodeCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'EnableHbaseProxy' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'false',
- 'default' => 'false',
- ],
- 'LproxyMinorVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2.3.2',
- ],
- 'NeedUpgradeComps' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Comps' => [
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '[lindorm, hdfs]',
- ],
- ],
- ],
- ],
- 'Tags' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Tag' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test_key',
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test_value',
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EC7E27FC-58F8-4722-89CF-D1B6B0971956', 'title' => ''],
+ 'TypeList' => [
+ 'description' => 'The task list.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskType' => ['description' => 'The task type. The return value **rds_apsaradb_upgrade** indicates a minor engine version update.', 'type' => 'string', 'example' => 'rds_apsaradb_upgrade', 'title' => ''],
+ 'TaskTypeInfoEn' => ['description' => 'The task type in English.', 'type' => 'string', 'example' => 'rds_apsaradb_upgrade', 'title' => ''],
+ 'TaskTypeInfoZh' => ['description' => 'The task type in Chinese.', 'type' => 'string', 'example' => '小版本升级', 'title' => ''],
+ 'Count' => ['description' => 'The number of pending tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"VpcId\\": \\"vpc-bp15s22y1a7sff5gj****\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"EncryptionType\\": \\"NoEncryption\\",\\n \\"ModuleId\\": 0,\\n \\"VswitchId\\": \\"vsw-bp1foll427ze3d4ps****\\",\\n \\"BackupStatus\\": \\"open\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"CoreDiskType\\": \\"cloud_ssd\\",\\n \\"MasterNodeCount\\": 2,\\n \\"NetworkType\\": \\"VPC\\",\\n \\"CreatedTimeUTC\\": \\"2021-07-19T03:23:22Z\\",\\n \\"ColdStorageSize\\": 800,\\n \\"ParentId\\": \\"ld-uf699153o1m2l****\\",\\n \\"IsLatestVersion\\": true,\\n \\"ExpireTimeUTC\\": \\"2022-02-23T16:00:00Z\\",\\n \\"RequestId\\": \\"3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66\\",\\n \\"InstanceName\\": \\"testhbase\\",\\n \\"MasterInstanceType\\": \\"hbase.sn2.large\\",\\n \\"CoreInstanceType\\": \\"hbase.sn2.2xlarge\\",\\n \\"EncryptionKey\\": \\"0d2470df-da7b-4786-b981-9a164dae****\\",\\n \\"CreatedTime\\": \\"2021-07-19T11:23:22\\",\\n \\"CoreDiskSize\\": 100,\\n \\"ClusterId\\": \\"ld-bp150tns0sjxs****\\",\\n \\"ExpireTime\\": \\"2022-02-24T00:00:00\\",\\n \\"MaintainStartTime\\": \\"18:00Z\\",\\n \\"ConfirmMaintainTime\\": \\"true\\",\\n \\"IsHa\\": true,\\n \\"MaintainEndTime\\": \\"22:00Z\\",\\n \\"InstanceId\\": \\"ld-bp150tns0sjxs****\\",\\n \\"ColdStorageStatus\\": \\"open\\",\\n \\"IsDeletionProtection\\": false,\\n \\"MinorVersion\\": \\"2.2.9.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"MasterDiskSize\\": 0,\\n \\"MasterDiskType\\": \\"cloud_efficiency\\",\\n \\"NeedUpgrade\\": false,\\n \\"IsMultiModel\\": true,\\n \\"AutoRenewal\\": false,\\n \\"ClusterType\\": \\"cluster\\",\\n \\"ResourceGroupId\\": \\"rg-acfmyiu4ekp****\\",\\n \\"ClusterName\\": \\"testhbase\\",\\n \\"ZoneId\\": \\"cn-hangzhou-f\\",\\n \\"Duration\\": 12,\\n \\"ModuleStackVersion\\": \\"phoenxi:4.0\\",\\n \\"Engine\\": \\"hbaseue\\",\\n \\"MajorVersion\\": \\"2.0\\",\\n \\"CoreDiskCount\\": \\"4\\",\\n \\"TaskProgress\\": \\"25.00\\",\\n \\"TaskStatus\\": \\"running\\",\\n \\"CoreNodeCount\\": 2,\\n \\"EnableHbaseProxy\\": false,\\n \\"LproxyMinorVersion\\": \\"2.3.2\\",\\n \\"NeedUpgradeComps\\": {\\n \\"Comps\\": [\\n \\"[lindorm, hdfs]\\"\\n ]\\n },\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"test_key\\",\\n \\"Value\\": \\"test_value\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstanceResponse>\\n<CreatedTime>2021-07-19T11:23:22</CreatedTime>\\n<ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>\\n<NeedUpgrade>false</NeedUpgrade>\\n<ModuleId>0</ModuleId>\\n<Engine>hbaseue</Engine>\\n<NeedUpgradeComps>\\n</NeedUpgradeComps>\\n<Tags>\\n</Tags>\\n<Status>ACTIVATION</Status>\\n<ColdStorageSize>800</ColdStorageSize>\\n<EncryptionType>NoEncryption</EncryptionType>\\n<MasterDiskSize>0</MasterDiskSize>\\n<ExpireTimeUTC>2022-02-23T16:00:00Z</ExpireTimeUTC>\\n<RequestId>3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66</RequestId>\\n<InstanceId>ld-bp150tns0sjxs****</InstanceId>\\n<PayType>Prepaid</PayType>\\n<VswitchId>vsw-bp1foll427ze3d4ps****</VswitchId>\\n<InstanceName>testhbase</InstanceName>\\n<MasterNodeCount>2</MasterNodeCount>\\n<VpcId>vpc-bp15s22y1a7sff5gj****</VpcId>\\n<AutoRenewal>false</AutoRenewal>\\n<CoreDiskType>cloud_ssd</CoreDiskType>\\n<ExpireTime>2022-02-24T00:00:00</ExpireTime>\\n<BackupStatus>open</BackupStatus>\\n<IsHa>true</IsHa>\\n<TaskProgress>25.00</TaskProgress>\\n<MasterInstanceType>hbase.sn1.2xlarge</MasterInstanceType>\\n<IsDeletionProtection>false</IsDeletionProtection>\\n<IsLatestVersion>true</IsLatestVersion>\\n<MaintainEndTime>22:00Z</MaintainEndTime>\\n<NetworkType>VPC</NetworkType>\\n<CoreInstanceType>hbase.sn2.2xlarge</CoreInstanceType>\\n<ClusterName>testhbase</ClusterName>\\n<MasterDiskType/>\\n<MaintainStartTime>18:00Z</MaintainStartTime>\\n<MajorVersion>2.0</MajorVersion>\\n<CoreDiskCount>4</CoreDiskCount>\\n<ZoneId>cn-hangzhou-f</ZoneId>\\n<CoreNodeCount>2</CoreNodeCount>\\n<ClusterId>ld-bp150tns0sjxs****</ClusterId>\\n<ColdStorageStatus>open</ColdStorageStatus>\\n<MinorVersion>2.2.9.1</MinorVersion>\\n<CreatedTimeUTC>2021-07-19T03:23:22Z</CreatedTimeUTC>\\n<IsMultiModel>true</IsMultiModel>\\n<ClusterType>cluster</ClusterType>\\n<RegionId>cn-hangzhou</RegionId>\\n<CoreDiskSize>100</CoreDiskSize>\\n<ConfirmMaintainTime>true</ConfirmMaintainTime>\\n</DescribeInstanceResponse>","errorExample":""}]',
- 'title' => 'DescribeInstance',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeInstances' => [
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'DescribeActiveOperationTaskType',
+ 'summary' => 'Calls the DescribeActiveOperationTaskType operation to query the O&M task types, the number of tasks of each type, and the details of an HBase instance.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActiveOperationTaskType'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeActiveOperationTaskType',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EC7E27FC-58F8-4722-89CF-D1B6B0971956\\",\\n \\"TypeList\\": [\\n {\\n \\"TaskType\\": \\"rds_apsaradb_upgrade\\",\\n \\"TaskTypeInfoEn\\": \\"rds_apsaradb_upgrade\\",\\n \\"TaskTypeInfoZh\\": \\"小版本升级\\",\\n \\"Count\\": 1\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribeActiveOperationTasks' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'Region',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID of the event to be processed. You can call [DescribeRegions](~~144489~~) to obtain the region ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'TaskType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The task type. Set the value to **rds_apsaradb_upgrade**, which indicates a minor version upgrade.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'rds_apsaradb_upgrade', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The maximum number of records that can be displayed per page. The value must be greater than **10**. Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'default' => '30', 'example' => '30', 'title' => ''],
],
[
- 'name' => 'DbType',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'hbase',
- ],
+ 'schema' => ['description' => 'The page number. The value must be greater than **0** and cannot exceed the maximum value of the Integer data type. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'ClusterName',
+ 'name' => 'ProductId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The product name. Default value: **hbase**.', 'type' => 'string', 'required' => false, 'example' => 'hbase', 'title' => ''],
],
[
- 'name' => 'ClusterId',
+ 'name' => 'DbType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'hb-bp1u0639js2h7****',
- ],
+ 'schema' => ['description' => 'The database type. Valid values:'."\n"
+ ."\n"
+ .'- **hbaseue**: ApsaraDB for HBase Enhanced Edition.'."\n"
+ .'- **hbase**: ApsaraDB for HBase Standard Edition.'."\n"
+ .'- **bds**: BDS data synchronization service.', 'type' => 'string', 'required' => false, 'example' => 'hbaseue', 'title' => ''],
],
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'Status',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-4f51d54g5****',
- ],
+ 'schema' => ['description' => 'The task running status. Valid values:'."\n"
+ ."\n"
+ .'- **2**: Waiting for the user to specify a time.'."\n"
+ .'- **3**: Waiting for processing.'."\n"
+ .'- **4**: Processing.'."\n"
+ .'- **5**: Succeeded.'."\n"
+ .'- **6**: Failed.'."\n"
+ .'- **7**: Canceled.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''],
],
[
- 'name' => 'Tag',
+ 'name' => 'InsName',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'key',
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'value',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 21,
- ],
+ 'schema' => ['description' => 'The HBase instance ID.', 'type' => 'string', 'required' => false, 'example' => 'ld-bp150tns0sjxs****', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EBECBF12-2E34-41BE-8DE9-FC3700D4****',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '18',
- ],
- 'Instances' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Instance' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'VpcId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vpc-bp120k6ixs4eoghz*****',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ACTIVATION',
- ],
- 'ModuleId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'VswitchId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vsw-bp191ipotq****dbqf',
- ],
- 'BackupStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'open',
- ],
- 'PayType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Prepaid',
- ],
- 'CoreDiskType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cloud_efficiency',
- ],
- 'MasterNodeCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'NetworkType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'VPC',
- ],
- 'CreatedTimeUTC' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-09-12T14:40:46Z',
- ],
- 'ParentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2980****2123',
- ],
- 'ExpireTimeUTC' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-10-12T14:40:46Z',
- ],
- 'InstanceName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'MasterInstanceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase.sn1.large',
- ],
- 'CoreInstanceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase.sn1.large',
- ],
- 'CreatedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-09-12T14:40:46',
- ],
- 'CoreDiskSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hb-bp1u0639js2h7****',
- ],
- 'ExpireTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-10-12T14:40:46',
- ],
- 'IsHa' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'InstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hb-bp1u0639js2h7****',
- ],
- 'ColdStorageStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'open',
- ],
- 'IsDeletionProtection' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'MasterDiskSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'MasterDiskType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cloud_efficiency',
- ],
- 'AutoRenewal' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ClusterType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cluster',
- ],
- 'ResourceGroupId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rg-4f51d54g5****',
- ],
- 'ClusterName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'ZoneId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-f',
- ],
- 'Duration' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
- 'ModuleStackVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1.0',
- ],
- 'Engine' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase',
- ],
- 'MajorVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2.0',
- ],
- 'CoreDiskCount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
- 'CoreNodeCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Tags' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Tag' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-key',
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-value',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ [
+ 'name' => 'AllowChange',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether the time can be modified. Valid values:'."\n"
+ ."\n"
+ .'- **0**: The time cannot be modified.'."\n"
+ .'- **1**: The time can be modified.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"EBECBF12-2E34-41BE-8DE9-FC3700D4****\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 18,\\n \\"Instances\\": {\\n \\"Instance\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp120k6ixs4eoghz*****\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"ModuleId\\": 0,\\n \\"VswitchId\\": \\"vsw-bp191ipotq****dbqf\\",\\n \\"BackupStatus\\": \\"open\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"CoreDiskType\\": \\"cloud_efficiency\\",\\n \\"MasterNodeCount\\": 2,\\n \\"NetworkType\\": \\"VPC\\",\\n \\"CreatedTimeUTC\\": \\"2019-09-12T14:40:46Z\\",\\n \\"ParentId\\": \\"2980****2123\\",\\n \\"ExpireTimeUTC\\": \\"2019-10-12T14:40:46Z\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"MasterInstanceType\\": \\"hbase.sn1.large\\",\\n \\"CoreInstanceType\\": \\"hbase.sn1.large\\",\\n \\"CreatedTime\\": \\"2019-09-12T14:40:46\\",\\n \\"CoreDiskSize\\": 100,\\n \\"ClusterId\\": \\"hb-bp1u0639js2h7****\\",\\n \\"ExpireTime\\": \\"2019-10-12T14:40:46\\",\\n \\"IsHa\\": true,\\n \\"InstanceId\\": \\"hb-bp1u0639js2h7****\\",\\n \\"ColdStorageStatus\\": \\"open\\",\\n \\"IsDeletionProtection\\": true,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"MasterDiskSize\\": 100,\\n \\"MasterDiskType\\": \\"cloud_efficiency\\",\\n \\"AutoRenewal\\": false,\\n \\"ClusterType\\": \\"cluster\\",\\n \\"ResourceGroupId\\": \\"rg-4f51d54g5****\\",\\n \\"ClusterName\\": \\"test\\",\\n \\"ZoneId\\": \\"cn-hangzhou-f\\",\\n \\"Duration\\": 12,\\n \\"ModuleStackVersion\\": \\"1.0\\",\\n \\"Engine\\": \\"hbase\\",\\n \\"MajorVersion\\": \\"2.0\\",\\n \\"CoreDiskCount\\": \\"2\\",\\n \\"CoreNodeCount\\": 2,\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"test-key\\",\\n \\"Value\\": \\"test-value\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstancesResponse>\\n<Instances>\\n <Instance>\\n <ModuleStackVersion>1.0</ModuleStackVersion>\\n <IsHa>true</IsHa>\\n <CreatedTime>2019-09-12T14:40:46</CreatedTime>\\n <ResourceGroupId>rg-4f51d54g5****</ResourceGroupId>\\n <MasterInstanceType>hbase.sn1.large</MasterInstanceType>\\n <IsDeletionProtection>true</IsDeletionProtection>\\n <ModuleId>0</ModuleId>\\n <NetworkType>VPC</NetworkType>\\n <CoreInstanceType>hbase.sn1.large</CoreInstanceType>\\n <ClusterName>test</ClusterName>\\n <MasterDiskType>cloud_efficiency</MasterDiskType>\\n <Engine>hbase</Engine>\\n <CoreDiskCount>2</CoreDiskCount>\\n <ParentId>2980****2123</ParentId>\\n <MajorVersion>2.0</MajorVersion>\\n <Status>ACTIVATION</Status>\\n <ExpireTimeUTC>2019-10-12T14:40:46Z</ExpireTimeUTC>\\n <MasterDiskSize>100</MasterDiskSize>\\n <ZoneId>cn-hangzhou-f</ZoneId>\\n <ClusterId>hb-bp1u0639js2h7****</ClusterId>\\n <CoreNodeCount>2</CoreNodeCount>\\n <InstanceId>hb-bp1u0639js2h7****</InstanceId>\\n <ColdStorageStatus>open</ColdStorageStatus>\\n <CreatedTimeUTC>2019-09-12T14:40:46Z</CreatedTimeUTC>\\n <Duration>12</Duration>\\n <ClusterType>cluster</ClusterType>\\n <PayType>Prepaid</PayType>\\n <VswitchId>vsw-bp191ipotq****dbqf</VswitchId>\\n <MasterNodeCount>2</MasterNodeCount>\\n <InstanceName>test</InstanceName>\\n <AutoRenewal>false</AutoRenewal>\\n <VpcId>vpc-bp120k6ixs4eoghz****</VpcId>\\n <CoreDiskType>cloud_efficiency</CoreDiskType>\\n <RegionId>cn-hangzhou</RegionId>\\n <ExpireTime>2019-10-12T14:40:46</ExpireTime>\\n <BackupStatus>open</BackupStatus>\\n <CoreDiskSize>100</CoreDiskSize>\\n </Instance>\\n <Instance>\\n <Tags>\\n <Tag>\\n <Value>test-value</Value>\\n <Key>test-key</Key>\\n </Tag>\\n </Tags>\\n </Instance>\\n</Instances>\\n<TotalCount>18</TotalCount>\\n<PageSize>10</PageSize>\\n<RequestId>EBECBF12-2E34-41BE-8DE9-FC3700D4****</RequestId>\\n<PageNumber>1</PageNumber>\\n</DescribeInstancesResponse>","errorExample":""}]',
- 'title' => 'DescribeInstances',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeInstanceType' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'AllowCancel',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether the task can be canceled. Valid values:'."\n"
+ ."\n"
+ .'- **0**: The task cannot be canceled.'."\n"
+ .'- **1**: The task can be canceled.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
[
- 'name' => 'InstanceType',
+ 'name' => 'ChangeLevel',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'hbase.n2.4xlarge',
- ],
+ 'schema' => ['description' => 'The change level. Valid values:'."\n"
+ ."\n"
+ .'- **S0**: Exception fix.'."\n"
+ .'- **S1**: System O&M.', 'type' => 'string', 'required' => false, 'example' => 'S1', 'title' => ''],
],
],
'responses' => [
@@ -4195,302 +2411,108 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DD23BBB4-64C2-42A4-B2E2-7E56C7AA815A',
- ],
- 'InstanceTypeSpecList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'InstanceTypeSpec' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'InstanceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase.n2.4xlarge',
- ],
- 'CpuSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '8',
- ],
- 'MemSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '16',
- ],
- ],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C634E813-42FA-53D2-A7EB-B881C4B264CC', 'title' => ''],
+ 'PageSize' => ['description' => 'The maximum number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
+ 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Items' => [
+ 'description' => 'The list of O&M tasks.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The task running status. Valid values:'."\n"
+ ."\n"
+ .'- **2**: Waiting for the user to specify a time.'."\n"
+ .'- **3**: Waiting for processing.'."\n"
+ .'- **4**: Processing.'."\n"
+ .'- **5**: Succeeded.'."\n"
+ .'- **6**: Failed.'."\n"
+ .'- **7**: Canceled.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'ChangeLevelEn' => ['description' => 'The change level name in English.', 'type' => 'string', 'example' => 'Risk repairment', 'title' => ''],
+ 'TaskType' => ['description' => 'The task type. The value **rds_apsaradb_upgrade** indicates a minor version upgrade.', 'type' => 'string', 'example' => 'rds_apsaradb_upgrade', 'title' => ''],
+ 'InsName' => ['description' => 'The HBase instance ID.', 'type' => 'string', 'example' => 'ld-bp150tns0sjxs****', 'title' => ''],
+ 'Region' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hanghzou', 'title' => ''],
+ 'ImpactZh' => ['description' => 'The business impact in Chinese.', 'type' => 'string', 'example' => '中断', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The time when the O&M task was created.', 'type' => 'string', 'example' => '2022-02-15 23:59:59', 'title' => ''],
+ 'SwitchTime' => ['description' => 'The time when the system initiates the switchover.', 'type' => 'string', 'example' => '2022-02-19 14:00:00', 'title' => ''],
+ 'ChangeLevelZh' => ['description' => 'The change level name in Chinese.', 'type' => 'string', 'example' => '风险修复', 'title' => ''],
+ 'Deadline' => ['description' => 'The latest time to which the O&M task execution time can be adjusted.', 'type' => 'string', 'example' => '2022-02-19 23:59:59', 'title' => ''],
+ 'PrepareInterval' => ['description' => 'The preparation time required between the start time of the O&M task and the switchover time.', 'type' => 'string', 'example' => '14:00:00', 'title' => ''],
+ 'TaskTypeZh' => ['description' => 'The task type in Chinese.', 'type' => 'string', 'example' => '小版本升级', 'title' => ''],
+ 'CurrentAVZ' => ['description' => 'The current availability zone.', 'type' => 'string', 'example' => 'cn-shanghai-et-a', 'title' => ''],
+ 'AllowChange' => ['description' => 'Indicates whether the time can be modified. Valid values:'."\n"
+ ."\n"
+ .'- **0**: The time cannot be modified.'."\n"
+ .'- **1**: The time can be modified.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'DbVersion' => ['description' => 'The database version.', 'type' => 'string', 'example' => '2.0', 'title' => ''],
+ 'ImpactEn' => ['description' => 'The business impact in English.', 'type' => 'string', 'example' => 'Transient instance disconnection', 'title' => ''],
+ 'InsComment' => ['description' => 'The instance description.', 'type' => 'string', 'example' => '--', 'title' => ''],
+ 'StartTime' => ['description' => 'The time when the O&M task starts to be executed.', 'type' => 'string', 'example' => '2022-02-19 10:00:00', 'title' => ''],
+ 'ModifiedTime' => ['description' => 'The time when the O&M task was modified.', 'type' => 'string', 'example' => '2022-02-19 14:00:00', 'title' => ''],
+ 'AllowCancel' => ['description' => 'Indicates whether the task can be canceled. Valid values:'."\n"
+ ."\n"
+ .'- **0**: The task cannot be canceled.'."\n"
+ .'- **1**: The task can be canceled.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'DbType' => ['description' => 'The database type. Valid values:'."\n"
+ .'- **hbaseue**: ApsaraDB for HBase Enhanced Edition.'."\n"
+ .'- **hbase**: ApsaraDB for HBase Standard Edition.'."\n"
+ .'- **bds**: BDS data synchronization service.', 'type' => 'string', 'example' => 'hbaseue', 'title' => ''],
+ 'ChangeLevel' => ['description' => 'The change level.', 'type' => 'string', 'example' => 'all', 'title' => ''],
+ 'TaskTypeEn' => ['description' => 'The task type in English.', 'type' => 'string', 'example' => 'rds_apsaradb_upgrade', 'title' => ''],
+ 'ResultInfo' => ['description' => 'The description of the execution result.', 'type' => 'string', 'example' => '--', 'title' => ''],
+ 'Id' => ['description' => 'The O&M task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '111111', 'title' => ''],
+ 'SubInsNames' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'The sub-instance list item.', 'type' => 'string', 'example' => 'ld-bp150tns0sjxs****', 'title' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DD23BBB4-64C2-42A4-B2E2-7E56C7AA815A\\",\\n \\"InstanceTypeSpecList\\": {\\n \\"InstanceTypeSpec\\": [\\n {\\n \\"InstanceType\\": \\"hbase.n2.4xlarge\\",\\n \\"CpuSize\\": 8,\\n \\"MemSize\\": 16\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>DD23BBB4-64C2-42A4-B2E2-7E56C7AA815A</RequestId>\\n<InstanceTypeSpecList>\\n <InstanceTypeSpec>\\n <CpuSize>16</CpuSize>\\n <MemSize>64</MemSize>\\n <InstanceType>hbase.n2.4xlarge</InstanceType>\\n </InstanceTypeSpec>\\n</InstanceTypeSpecList>","errorExample":""}]',
- 'title' => 'DescribeInstanceType',
+ 'title' => 'DescribeActiveOperationTasks',
+ 'summary' => 'Calls the DescribeActiveOperationTasks operation to query details of O&M tasks for HBase instances.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeClusterConnection' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActiveOperationTasks'],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp150tns0sjxs****',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'VpcId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vpc-bp15s22y1a7sff5gj****',
- ],
- 'VSwitchId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vsw-bp1foll427ze3d4ps****',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '70220050-A465-5DCC-8C0C-C38C6E3DB24D',
- ],
- 'IsMultimod' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'DbType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbaseue',
- ],
- 'NetType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'VPC',
- ],
- 'UiProxyConnAddrInfo' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ConnAddr' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ld-bp150tns0sjxs****-master1-001.hbaseue.rds.aliyuncs.com',
- ],
- 'ConnAddrPort' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '443',
- ],
- 'NetType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PUBLIC',
- ],
- ],
- ],
- 'ThriftConn' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ConnAddr' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hb-bp1u0639js2h7****-proxy-thrift.hbase.rds.aliyuncs.com',
- ],
- 'ConnAddrPort' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9099',
- ],
- 'NetType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
- ],
- ],
- 'ZkConnAddrs' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'ZkConnAddr' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ConnAddr' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ld-bp150tns0sjxs****-master1-001.hbaseue.rds.aliyuncs.com',
- ],
- 'ConnAddrPort' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2181',
- ],
- 'NetType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
- ],
- ],
- ],
- ],
- ],
- 'SlbConnAddrs' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'SlbConnAddr' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'SlbType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbaseue',
- ],
- 'ConnAddrInfo' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ConnAddr' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ld-bp150tns0sjxs****-proxy-hbaseue-pub.hbaseue.rds.aliyuncs.com',
- ],
- 'ConnAddrPort' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9190',
- ],
- 'NetType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'ServiceConnAddrs' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'ServiceConnAddr' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ConnType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PhoenixConnAddr',
- ],
- 'ConnAddrInfo' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ConnAddr' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hb-****-proxy-phoenix.hbase.rds.aliyuncs.com',
- ],
- 'ConnAddrPort' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '8765',
- ],
- 'NetType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeActiveOperationTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"VpcId\\": \\"vpc-bp15s22y1a7sff5gj****\\",\\n \\"VSwitchId\\": \\"vsw-bp1foll427ze3d4ps****\\",\\n \\"RequestId\\": \\"70220050-A465-5DCC-8C0C-C38C6E3DB24D\\",\\n \\"IsMultimod\\": \\"true\\",\\n \\"DbType\\": \\"hbaseue\\",\\n \\"NetType\\": \\"VPC\\",\\n \\"UiProxyConnAddrInfo\\": {\\n \\"ConnAddr\\": \\"ld-bp150tns0sjxs****-master1-001.hbaseue.rds.aliyuncs.com\\",\\n \\"ConnAddrPort\\": \\"443\\",\\n \\"NetType\\": \\"PUBLIC\\"\\n },\\n \\"ThriftConn\\": {\\n \\"ConnAddr\\": \\"hb-bp1u0639js2h7****-proxy-thrift.hbase.rds.aliyuncs.com\\",\\n \\"ConnAddrPort\\": \\"9099\\",\\n \\"NetType\\": \\"2\\"\\n },\\n \\"ZkConnAddrs\\": {\\n \\"ZkConnAddr\\": [\\n {\\n \\"ConnAddr\\": \\"ld-bp150tns0sjxs****-master1-001.hbaseue.rds.aliyuncs.com\\",\\n \\"ConnAddrPort\\": \\"2181\\",\\n \\"NetType\\": \\"2\\"\\n }\\n ]\\n },\\n \\"SlbConnAddrs\\": {\\n \\"SlbConnAddr\\": [\\n {\\n \\"SlbType\\": \\"hbaseue\\",\\n \\"ConnAddrInfo\\": {\\n \\"ConnAddr\\": \\"ld-bp150tns0sjxs****-proxy-hbaseue-pub.hbaseue.rds.aliyuncs.com\\",\\n \\"ConnAddrPort\\": \\"9190\\",\\n \\"NetType\\": \\"0\\"\\n }\\n }\\n ]\\n },\\n \\"ServiceConnAddrs\\": {\\n \\"ServiceConnAddr\\": [\\n {\\n \\"ConnType\\": \\"PhoenixConnAddr\\",\\n \\"ConnAddrInfo\\": {\\n \\"ConnAddr\\": \\"hb-****-proxy-phoenix.hbase.rds.aliyuncs.com\\",\\n \\"ConnAddrPort\\": \\"8765\\",\\n \\"NetType\\": \\"2\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeClusterConnectionResponse>\\n <VpcId>vpc-bp15s22y1a7sff5gj****</VpcId>\\n <VSwitchId>vsw-bp1foll427ze3d4ps****</VSwitchId>\\n <RequestId>70220050-A465-5DCC-8C0C-C38C6E3DB24D</RequestId>\\n <IsMultimod>true</IsMultimod>\\n <DbType>hbaseue</DbType>\\n <NetType>VPC</NetType>\\n <UiProxyConnAddrInfo>\\n <ConnAddr>ld-bp150tns0sjxs****-master1-001.hbaseue.rds.aliyuncs.com</ConnAddr>\\n <ConnAddrPort>443</ConnAddrPort>\\n <NetType>PUBLIC</NetType>\\n </UiProxyConnAddrInfo>\\n <ThriftConn/>\\n <ZkConnAddrs>\\n <ConnAddr>ld-bp150tns0sjxs****-master1-001.hbaseue.rds.aliyuncs.com</ConnAddr>\\n <ConnAddrPort>2181</ConnAddrPort>\\n <NetType>2</NetType>\\n </ZkConnAddrs>\\n <ZkConnAddrs>\\n <ConnAddrPort>2181</ConnAddrPort>\\n <ConnAddr>ld-bp150tns0sjxsj3g6-master2-001.hbaseue.rds.aliyuncs.com</ConnAddr>\\n <NetType>2</NetType>\\n </ZkConnAddrs>\\n <SlbConnAddrs>\\n <SlbType>hbaseue</SlbType>\\n <ConnAddrInfo>\\n <ConnAddr>ld-bp150tns0sjxs****-proxy-hbaseue-pub.hbaseue.rds.aliyuncs.com</ConnAddr>\\n <ConnAddrPort>9190</ConnAddrPort>\\n <NetType>0</NetType>\\n </ConnAddrInfo>\\n </SlbConnAddrs>\\n <ServiceConnAddrs>\\n </ServiceConnAddrs>\\n</DescribeClusterConnectionResponse>","errorExample":""}]',
- 'title' => 'DescribeClusterConnection',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"C634E813-42FA-53D2-A7EB-B881C4B264CC\\",\\n \\"PageSize\\": 30,\\n \\"TotalRecordCount\\": 1,\\n \\"Items\\": [\\n {\\n \\"Status\\": 5,\\n \\"ChangeLevelEn\\": \\"Risk repairment\\",\\n \\"TaskType\\": \\"rds_apsaradb_upgrade\\",\\n \\"InsName\\": \\"ld-bp150tns0sjxs****\\",\\n \\"Region\\": \\"cn-hanghzou\\",\\n \\"ImpactZh\\": \\"中断\\",\\n \\"CreatedTime\\": \\"2022-02-15 23:59:59\\",\\n \\"SwitchTime\\": \\"2022-02-19 14:00:00\\",\\n \\"ChangeLevelZh\\": \\"风险修复\\",\\n \\"Deadline\\": \\"2022-02-19 23:59:59\\",\\n \\"PrepareInterval\\": \\"14:00:00\\",\\n \\"TaskTypeZh\\": \\"小版本升级\\",\\n \\"CurrentAVZ\\": \\"cn-shanghai-et-a\\",\\n \\"AllowChange\\": \\"1\\",\\n \\"DbVersion\\": \\"2.0\\",\\n \\"ImpactEn\\": \\"Transient instance disconnection\\",\\n \\"InsComment\\": \\"--\\",\\n \\"StartTime\\": \\"2022-02-19 10:00:00\\",\\n \\"ModifiedTime\\": \\"2022-02-19 14:00:00\\",\\n \\"AllowCancel\\": \\"1\\",\\n \\"DbType\\": \\"hbaseue\\",\\n \\"ChangeLevel\\": \\"all\\",\\n \\"TaskTypeEn\\": \\"rds_apsaradb_upgrade\\",\\n \\"ResultInfo\\": \\"--\\",\\n \\"Id\\": 111111,\\n \\"SubInsNames\\": [\\n \\"ld-bp150tns0sjxs****\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeAvailableResource' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4498,81 +2520,58 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ChargeType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Prepaid',
- ],
+ 'schema' => ['description' => 'The billing method. Valid values:'."\n"
+ .'- **Prepaid**: subscription.'."\n"
+ .'- **PostPaid**: pay-as-you-go.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Prepaid', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~144489~~) operation to query the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou-h',
- ],
+ 'schema' => ['description' => 'The zone. You can call the [DescribeRegions](~~144489~~) operation to query available zones.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', 'title' => ''],
],
[
'name' => 'Engine',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'hbaseue',
- ],
+ 'schema' => ['description' => 'The service type of the instance. Valid values:'."\n"
+ .'- **hbase**: ApsaraDB for HBase Standard Edition standard instance.'."\n"
+ .'- **hbaseue**: ApsaraDB for HBase Performance-enhanced Edition standard instance.'."\n"
+ .'- **singlehbase**: ApsaraDB for HBase single-node standard instance.'."\n"
+ .'- **bds**: Data Synchronization (BDS) service.', 'type' => 'string', 'required' => false, 'example' => 'hbaseue', 'title' => ''],
],
[
'name' => 'EngineVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2.0',
- ],
+ 'schema' => ['description' => 'The version number of the service type. Valid values:'."\n"
+ .'- **1.0**: The Data Synchronization (BDS) service supports version 1.0.'."\n"
+ .'- **1.1**: ApsaraDB for HBase Standard Edition standard instances and ApsaraDB for HBase single-node standard instances support version 1.1.'."\n"
+ .'- **2.0**: ApsaraDB for HBase Standard Edition standard instances, ApsaraDB for HBase Performance-enhanced Edition standard instances, and ApsaraDB for HBase single-node standard instances support version 2.0.'."\n"
+ ."\n"
+ .'> Specify the version number based on the service type of the ApsaraDB for HBase instance.', 'type' => 'string', 'required' => false, 'example' => '2.0', 'title' => ''],
],
[
'name' => 'CoreInstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'hbase.sn1.large',
- ],
+ 'schema' => ['description' => 'The specifications of the core node. For more information about valid values, see [Instance node specifications](~~194870~~).', 'type' => 'string', 'required' => false, 'example' => 'hbase.sn1.large', 'title' => ''],
],
[
'name' => 'DiskType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cloud_ssd',
- ],
+ 'schema' => ['description' => 'The disk type of the core node. Valid values:'."\n"
+ .'- **cloud_efficiency**: ultra cloud disk'."\n"
+ .'- **cloud_ssd**: standard SSD'."\n"
+ .'- **cloud_essd_pl1**: ESSD'."\n"
+ .'- **local_hdd_pro**: local HDD'."\n"
+ .'- **local_ssd_pro**: local SSD.', 'type' => 'string', 'required' => false, 'example' => 'cloud_ssd', 'title' => ''],
],
],
'responses' => [
@@ -4580,349 +2579,261 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EA76F208-E334-592A-A0C6-41E15EC87ED0',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EA76F208-E334-592A-A0C6-41E15EC87ED0', 'title' => ''],
'AvailableZones' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AvailableZone' => [
- 'description' => '',
+ 'description' => 'The list of available zones.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'ZoneId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-shenzhen-e',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-shenzhen',
- ],
+ 'ZoneId' => ['description' => 'The zone.', 'type' => 'string', 'example' => 'cn-shenzhen-e', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shenzhen', 'title' => ''],
'SupportedEngines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SupportedEngine' => [
- 'description' => '',
+ 'description' => 'The supported service types.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Engine' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase',
- ],
+ 'Engine' => ['description' => 'The service type.', 'type' => 'string', 'example' => 'hbase', 'title' => ''],
'SupportedEngineVersions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SupportedEngineVersion' => [
- 'description' => '',
+ 'description' => 'The supported service type versions.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Version' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2.0',
- ],
+ 'Version' => ['description' => 'The version.', 'type' => 'string', 'example' => '2.0', 'title' => ''],
'SupportedCategories' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SupportedCategories' => [
- 'description' => '',
+ 'description' => 'The supported categories.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Category' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cluster',
- ],
+ 'Category' => ['description' => 'The instance category. Valid values:'."\n"
+ ."\n"
+ .'- **cluster**: Cluster Edition'."\n"
+ .'- **single**: standalone.', 'type' => 'string', 'example' => 'cluster', 'title' => ''],
'SupportedStorageTypes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SupportedStorageType' => [
- 'description' => '',
+ 'description' => 'The storage type.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'StorageType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cloud_ssd',
- ],
+ 'StorageType' => ['description' => 'The storage type.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''],
'CoreResources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CoreResource' => [
- 'description' => '',
+ 'description' => 'The core node resources.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'InstanceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase.sn1.large',
- ],
- 'MaxCoreCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '16',
- ],
+ 'InstanceType' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'hbase.sn1.large', 'title' => ''],
+ 'MaxCoreCount' => ['description' => 'The maximum number of nodes in stock.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''],
'DBInstanceStorageRange' => [
- 'description' => '',
+ 'description' => 'The storage range.',
'type' => 'object',
'properties' => [
- 'MaxSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8000',
- ],
- 'StepSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '40',
- ],
- 'MinSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
+ 'MaxSize' => ['description' => 'The maximum storage size. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '8000', 'title' => ''],
+ 'StepSize' => ['description' => 'The step size. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''],
+ 'MinSize' => ['description' => 'The minimum storage size. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'InstanceTypeDetail' => [
- 'description' => '',
+ 'description' => 'The instance type details.',
'type' => 'object',
'properties' => [
- 'Mem' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8',
- ],
- 'Cpu' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
+ 'Mem' => ['description' => 'The memory size. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''],
+ 'Cpu' => ['description' => 'The number of CPU cores.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'MasterResources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MasterResource' => [
- 'description' => '',
+ 'description' => 'The list of master node resources.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'InstanceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase.sn1.medium',
- ],
+ 'InstanceType' => ['description' => 'The node specifications of the master node.', 'type' => 'string', 'example' => 'hbase.sn1.medium', 'title' => ''],
'InstanceTypeDetail' => [
- 'description' => '',
+ 'description' => 'The instance type details.',
'type' => 'object',
'properties' => [
- 'Mem' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8',
- ],
- 'Cpu' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
+ 'Mem' => ['description' => 'The memory size. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''],
+ 'Cpu' => ['description' => 'The number of CPU cores.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EA76F208-E334-592A-A0C6-41E15EC87ED0\\",\\n \\"AvailableZones\\": {\\n \\"AvailableZone\\": [\\n {\\n \\"ZoneId\\": \\"cn-shenzhen-e\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"SupportedEngines\\": {\\n \\"SupportedEngine\\": [\\n {\\n \\"Engine\\": \\"hbase\\",\\n \\"SupportedEngineVersions\\": {\\n \\"SupportedEngineVersion\\": [\\n {\\n \\"Version\\": \\"2.0\\",\\n \\"SupportedCategories\\": {\\n \\"SupportedCategories\\": [\\n {\\n \\"Category\\": \\"cluster\\",\\n \\"SupportedStorageTypes\\": {\\n \\"SupportedStorageType\\": [\\n {\\n \\"StorageType\\": \\"cloud_ssd\\",\\n \\"CoreResources\\": {\\n \\"CoreResource\\": [\\n {\\n \\"InstanceType\\": \\"hbase.sn1.large\\",\\n \\"MaxCoreCount\\": 16,\\n \\"DBInstanceStorageRange\\": {\\n \\"MaxSize\\": 8000,\\n \\"StepSize\\": 40,\\n \\"MinSize\\": 400\\n },\\n \\"InstanceTypeDetail\\": {\\n \\"Mem\\": 8,\\n \\"Cpu\\": 4\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"MasterResources\\": {\\n \\"MasterResource\\": [\\n {\\n \\"InstanceType\\": \\"hbase.sn1.medium\\",\\n \\"InstanceTypeDetail\\": {\\n \\"Mem\\": 8,\\n \\"Cpu\\": 4\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAvailableResourceResponse>\\n <RequestId>EA76F208-E334-592A-A0C6-41E15EC87ED0</RequestId>\\n <AvailableZones>\\n <ZoneId>cn-shenzhen-e</ZoneId>\\n <RegionId>cn-shenzhen</RegionId>\\n <SupportedEngines>\\n <Engine>hbase</Engine>\\n <SupportedEngineVersions>\\n <Version>2.0</Version>\\n <SupportedCategories>\\n <Category>cluster</Category>\\n <SupportedStorageTypes>\\n <StorageType>cloud_ssd</StorageType>\\n <CoreResources>\\n <InstanceType>hbase.sn1.large</InstanceType>\\n <MaxCoreCount>16</MaxCoreCount>\\n <DBInstanceStorageRange>\\n <MaxSize>8000</MaxSize>\\n <StepSize>40</StepSize>\\n <MinSize>400</MinSize>\\n </DBInstanceStorageRange>\\n <InstanceTypeDetail>\\n <Mem>8</Mem>\\n <Cpu>4</Cpu>\\n </InstanceTypeDetail>\\n </CoreResources>\\n </SupportedStorageTypes>\\n </SupportedCategories>\\n </SupportedEngineVersions>\\n </SupportedEngines>\\n <MasterResources>\\n <InstanceType>hbase.sn1.medium</InstanceType>\\n <InstanceTypeDetail>\\n <Mem>8</Mem>\\n <Cpu>4</Cpu>\\n </InstanceTypeDetail>\\n </MasterResources>\\n </AvailableZones>\\n</DescribeAvailableResourceResponse>","errorExample":""}]',
- 'title' => 'DescribeAvailableResource',
+ 'title' => 'Query available resources',
+ 'summary' => 'Queries available resources by calling DescribeAvailableResource.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeSubDomain' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:56:05.000Z', 'description' => 'Error codes changed'],
],
- 'security' => [
- [
- 'AK' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableResource'],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'ZoneId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou-f',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'SubDomain' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-h-aliyun',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F4208C83-B9BC-4A64-A739-8F88E98DA469',
- ],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeAvailableResource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"SubDomain\\": \\"cn-hangzhou-h-aliyun\\",\\n \\"RequestId\\": \\"F4208C83-B9BC-4A64-A739-8F88E98DA469\\"\\n}","errorExample":""},{"type":"xml","example":"<SubDomain>cn-hangzhou-h-aliyun</SubDomain>\\n<RequestId>F4208C83-B9BC-4A64-A739-8F88E98DA469</RequestId>","errorExample":""}]',
- 'title' => 'DescribeSubDomain',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EA76F208-E334-592A-A0C6-41E15EC87ED0\\",\\n \\"AvailableZones\\": {\\n \\"AvailableZone\\": [\\n {\\n \\"ZoneId\\": \\"cn-shenzhen-e\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"SupportedEngines\\": {\\n \\"SupportedEngine\\": [\\n {\\n \\"Engine\\": \\"hbase\\",\\n \\"SupportedEngineVersions\\": {\\n \\"SupportedEngineVersion\\": [\\n {\\n \\"Version\\": \\"2.0\\",\\n \\"SupportedCategories\\": {\\n \\"SupportedCategories\\": [\\n {\\n \\"Category\\": \\"cluster\\",\\n \\"SupportedStorageTypes\\": {\\n \\"SupportedStorageType\\": [\\n {\\n \\"StorageType\\": \\"cloud_ssd\\",\\n \\"CoreResources\\": {\\n \\"CoreResource\\": [\\n {\\n \\"InstanceType\\": \\"hbase.sn1.large\\",\\n \\"MaxCoreCount\\": 16,\\n \\"DBInstanceStorageRange\\": {\\n \\"MaxSize\\": 8000,\\n \\"StepSize\\": 40,\\n \\"MinSize\\": 400\\n },\\n \\"InstanceTypeDetail\\": {\\n \\"Mem\\": 8,\\n \\"Cpu\\": 4\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"MasterResources\\": {\\n \\"MasterResource\\": [\\n {\\n \\"InstanceType\\": \\"hbase.sn1.medium\\",\\n \\"InstanceTypeDetail\\": {\\n \\"Mem\\": 8,\\n \\"Cpu\\": 4\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
- 'QueryXpackRelateDB' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeBackupPlanConfig' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ap-bp1qtz9rcbbt3p6ng',
- ],
- ],
- [
- 'name' => 'RelateDbType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hbase',
- ],
- ],
- [
- 'name' => 'HasSingleNode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The ID of the cluster for which the backup plan is executed.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-m5eznlga4k5bcxxxx', 'title' => ''],
],
],
'responses' => [
@@ -4930,139 +2841,63 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '288E9010-36DD-499C-B4DA-61E4362DA4CC',
- ],
- 'ClusterList' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '33A23201-6038-4A6A-B76A-61047EA04E6A', 'title' => ''],
+ 'MinHFileBackupCount' => ['description' => 'The number of full backups to retain.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'NextFullBackupDate' => ['description' => 'The date of the next full backup.', 'type' => 'string', 'example' => '2020-11-09T18:00:00Z', 'title' => ''],
+ 'FullBackupCycle' => ['description' => 'The full backup cycle.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''],
+ 'Tables' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'Cluster' => [
- 'description' => '',
+ 'Table' => [
'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ACTIVATION',
- ],
- 'DBVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2.0',
- ],
- 'IsRelated' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ClusterName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase_test',
- ],
- 'DBType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase',
- ],
- 'LockMode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '..',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hb-bp16o0pd52e3y582s',
- ],
- ],
- ],
+ 'items' => ['description' => 'The collection of backup tables.', 'type' => 'string', 'example' => '*', 'title' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"288E9010-36DD-499C-B4DA-61E4362DA4CC\\",\\n \\"ClusterList\\": {\\n \\"Cluster\\": [\\n {\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"DBVersion\\": \\"2.0\\",\\n \\"IsRelated\\": false,\\n \\"ClusterName\\": \\"hbase_test\\",\\n \\"DBType\\": \\"hbase\\",\\n \\"LockMode\\": \\"..\\",\\n \\"ClusterId\\": \\"hb-bp16o0pd52e3y582s\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>288E9010-36DD-499C-B4DA-61E4362DA4CC</RequestId>\\n<ClusterList>\\n <Cluster>\\n <Status>ACTIVATION</Status>\\n <ClusterName>baitu-new-mem</ClusterName>\\n <ClusterId>hb-bp16fd5z8srk9216p</ClusterId>\\n <IsRelated>false</IsRelated>\\n <DBType>hbase</DBType>\\n </Cluster>\\n <Cluster>\\n <Status>COMP_ADDING</Status>\\n <ClusterName>tianyin-ha2</ClusterName>\\n <ClusterId>hb-bp16f1441y6p2kv2l</ClusterId>\\n <IsRelated>false</IsRelated>\\n <DBType>hbase</DBType>\\n </Cluster>\\n <Cluster>\\n <Status>ACTIVATION</Status>\\n <ClusterName>tianyin-ha1</ClusterName>\\n <ClusterId>hb-bp1eu91b79o8h0n7i</ClusterId>\\n <IsRelated>false</IsRelated>\\n <DBType>hbase</DBType>\\n </Cluster>\\n <Cluster>\\n <Status>ACTIVATION</Status>\\n <ClusterName>wangjk-HBase</ClusterName>\\n <ClusterId>hb-bp16o0pd52e3y582s</ClusterId>\\n <IsRelated>false</IsRelated>\\n <DBType>hbase</DBType>\\n </Cluster>\\n <Cluster>\\n <Status>ACTIVATION</Status>\\n <ClusterName>test-hbase-RESERVE</ClusterName>\\n <ClusterId>hb-bp15w8hyzqi59p5yn</ClusterId>\\n <IsRelated>false</IsRelated>\\n <DBType>hbase</DBType>\\n </Cluster>\\n</ClusterList>","errorExample":""}]',
- 'title' => 'QueryXpackRelateDB',
+ 'title' => 'Query backup plan configuration',
+ 'summary' => 'Queries the configuration of a backup plan by calling the DescribeBackupPlanConfig operation.',
+ 'description' => 'This operation currently supports only HBaseue. Before calling this operation, make sure that the backup and recovery feature is enabled for the HBaseue instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeDiskWarningLine' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:56:05.000Z', 'description' => 'Error codes changed'],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-bp1bl7iqzkahmyxxxx',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'WarningLine' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '80',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '08DF8283-D290-4107-931E-7913D6D3480D',
- ],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeBackupPlanConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
],
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"WarningLine\\": \\"80\\",\\n \\"RequestId\\": \\"08DF8283-D290-4107-931E-7913D6D3480D\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>08DF8283-D290-4107-931E-7913D6D3480D</RequestId>\\n<WarningLine>80</WarningLine>","errorExample":""}]',
- 'title' => 'DescribeDiskWarningLine',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"33A23201-6038-4A6A-B76A-61047EA04E6A\\",\\n \\"MinHFileBackupCount\\": 3,\\n \\"NextFullBackupDate\\": \\"2020-11-09T18:00:00Z\\",\\n \\"FullBackupCycle\\": 7,\\n \\"Tables\\": {\\n \\"Table\\": [\\n \\"*\\"\\n ]\\n }\\n}","type":"json"}]',
],
- 'ResizeNodeCount' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeBackupPolicy' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5070,156 +2905,61 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'hb-bp16o0pd52e3y****',
- 'required' => true,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'NodeCount',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '5',
- 'format' => 'int32',
- 'required' => true,
- 'type' => 'integer',
- ],
- ],
- [
- 'name' => 'ZoneId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'cn-hangzhou-f',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'VSwitchId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'vsw-bp191otqj1ssyl****',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-t4naqsay5gn******', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'OrderId' => [
- 'description' => '',
- 'example' => '20470860005****',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'B288B41F-6681-42A6-8905-47C3C42B19B0',
- 'type' => 'string',
- ],
+ 'PreferredBackupEndTimeUTC' => ['description' => 'The UTC time when the backup ends.', 'type' => 'string', 'example' => '18:00Z', 'title' => ''],
+ 'BackupRetentionPeriod' => ['description' => 'The number of days for which backups are retained.', 'type' => 'string', 'example' => '10', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '94AC38B6-7C6D-45B2-BC03-B8750071A482', 'title' => ''],
+ 'PreferredBackupPeriod' => ['description' => 'The backup cycle. For example, Friday indicates that the backup is performed every Friday.', 'type' => 'string', 'example' => 'Friday', 'title' => ''],
+ 'PreferredBackupTime' => ['description' => 'The backup time range in the current time zone.', 'type' => 'string', 'example' => '01:00-02:00', 'title' => ''],
+ 'PreferredBackupStartTimeUTC' => ['description' => 'The UTC time when the backup starts.', 'type' => 'string', 'example' => '17:00Z', 'title' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"20470860005****\\",\\n \\"RequestId\\": \\"B288B41F-6681-42A6-8905-47C3C42B19B0\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>B288B41F-6681-42A6-8905-47C3C42B19B0</RequestId>\\n<OrderId>20470860005****</OrderId>","errorExample":""}]',
- 'extraInfo' => ' ',
+ 'title' => 'View cluster automatic backup policy',
+ 'summary' => 'Queries the backup policy of an HBase cluster by calling DescribeBackupPolicy.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- 'summary' => 'Call ResizeNodeCount to adjust the total number of nodes in the instance.',
- 'title' => 'ResizeNodeCount',
- ],
- 'ResizeColdStorageSize' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-06T09:46:54.000Z', 'description' => 'Error codes changed'],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp169l540vc6c****',
- ],
- ],
- [
- 'name' => 'ColdStorageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '100000000',
- 'minimum' => '0',
- 'example' => '900',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'OrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '21711518427****',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '5AA6F80E-535C-5611-BD13-3832D96A4D0E',
- ],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeBackupPolicy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"21711518427****\\",\\n \\"RequestId\\": \\"5AA6F80E-535C-5611-BD13-3832D96A4D0E\\"\\n}","errorExample":""},{"type":"xml","example":"<ResizeColdStorageSizeResponse>\\n <OrderId>21711518427****</OrderId>\\n <RequestId>5AA6F80E-535C-5611-BD13-3832D96A4D0E</RequestId>\\n</ResizeColdStorageSizeResponse>","errorExample":""}]',
- 'title' => 'ResizeColdStorageSize',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PreferredBackupEndTimeUTC\\": \\"18:00Z\\",\\n \\"BackupRetentionPeriod\\": \\"10\\",\\n \\"RequestId\\": \\"94AC38B6-7C6D-45B2-BC03-B8750071A482\\",\\n \\"PreferredBackupPeriod\\": \\"Friday\\",\\n \\"PreferredBackupTime\\": \\"01:00-02:00\\",\\n \\"PreferredBackupStartTimeUTC\\": \\"17:00Z\\"\\n}","type":"json"}]',
],
- 'RestartInstance' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeBackupStatus' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5227,28 +2967,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp150tns0sjxs****',
- ],
- ],
- [
- 'name' => 'Components',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'THRIFT',
- ],
+ 'schema' => ['description' => 'The ID of the HBaseue cluster for which data backup is performed.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-m5eznlga4k5bcxxxx', 'title' => ''],
],
],
'responses' => [
@@ -5256,62 +2980,71 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F744E939-D08D-5623-82C8-9D1F9F7685D1',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F7E71430-A825-470A-B40B-DF3F3AAC9BEE', 'title' => ''],
+ 'BdsClusterId' => ['description' => 'The instance ID of the BDS instance used for backup.', 'type' => 'string', 'example' => 'bds-m5e54q06ceyhxxxx', 'title' => ''],
+ 'BackupStatus' => ['description' => 'The enabling status of backup. Valid values:'."\n"
+ .'- closed: not enabled.'."\n"
+ .'- opened: enabled.'."\n"
+ .'- opening: being enabled.', 'type' => 'string', 'example' => 'opened', 'title' => ''],
+ 'ClusterId' => ['description' => 'The ID of the backup cluster.', 'type' => 'string', 'example' => 'ld-m5eznlga4k5bcxxxx', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F744E939-D08D-5623-82C8-9D1F9F7685D1\\"\\n}","errorExample":""},{"type":"xml","example":"<RestartInstanceResponse>\\r\\n<RequestId>70F2D5B8-632F-4045-8F2D-2ADF73A31C08</RequestId>\\r\\n</RestartInstanceResponse>","errorExample":""}]',
- 'title' => 'RestartInstance',
+ 'errorCodes' => [],
+ 'title' => 'Describe backup task status',
+ 'summary' => 'Describes the status of a backup task by calling the DescribeBackupStatus operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'MoveResourceGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeBackupStatus',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7E71430-A825-470A-B40B-DF3F3AAC9BEE\\",\\n \\"BdsClusterId\\": \\"bds-m5e54q06ceyhxxxx\\",\\n \\"BackupStatus\\": \\"opened\\",\\n \\"ClusterId\\": \\"ld-m5eznlga4k5bcxxxx\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeBackupSummary' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp169l540vc6c****',
- ],
+ 'schema' => ['description' => 'The ID of the instance. You can call the [DescribeInstances](~~144595~~) operation to query the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp169l540vc6c****', 'title' => ''],
],
[
- 'name' => 'NewResourceGroupId',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'rg-aekzrk6zzsy****',
- ],
+ 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum number of entries per page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
@@ -5319,191 +3052,131 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '8CD9BFBC-D575-5FCC-BA7E-956BF0D0****',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '168793CB-7B31-43E7-ADAB-FE3E8D584D6E', 'title' => ''],
+ 'Incr' => [
+ 'description' => 'The details of the incremental backup.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The status of the incremental backup.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''],
+ 'Speed' => ['description' => 'The current write speed of the incremental backup.', 'type' => 'string', 'example' => '0.00 MB/s', 'title' => ''],
+ 'Pos' => ['description' => 'The synchronization point.', 'type' => 'string', 'example' => '2020-11-05T01:20:31Z', 'title' => ''],
+ 'QueueLogNum' => ['description' => 'The number of logs in the queue.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ 'BackupLogSize' => ['description' => 'The data size.', 'type' => 'string', 'example' => '266 B', 'title' => ''],
+ 'RunningLogNum' => ['description' => 'The number of logs being backed up.', 'type' => 'string', 'example' => '2', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Full' => [
+ 'description' => 'The details of the full backup.',
+ 'type' => 'object',
+ 'properties' => [
+ 'HasMore' => ['description' => 'Indicates whether there is a next page. Valid values:'."\n"
+ ."\n"
+ .'- true: There is a next page.'."\n"
+ .'- false: There is no next page.', 'type' => 'string', 'example' => 'false', 'title' => ''],
+ 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'NextFullBackupDate' => ['description' => 'The time of the next full backup.', 'type' => 'string', 'example' => '2020-11-09T18:00:00Z', 'title' => ''],
+ 'Records' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Record' => [
+ 'description' => 'The list of historical full backups.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The backup status.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
+ 'FinishTime' => ['description' => 'The time when the full backup was completed.', 'type' => 'string', 'example' => '2020-11-02T18:02:04Z', 'title' => ''],
+ 'Process' => ['description' => 'The backup progress.', 'type' => 'string', 'example' => '1/1', 'title' => ''],
+ 'DataSize' => ['description' => 'The size of the backup data.', 'type' => 'string', 'example' => '1.2 kB', 'title' => ''],
+ 'Speed' => ['description' => 'The backup speed.', 'type' => 'string', 'example' => '0.00 MB/s', 'title' => ''],
+ 'RecordId' => ['description' => 'The backup record ID.', 'type' => 'string', 'example' => '20201103020000', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the full backup started.', 'type' => 'string', 'example' => '2020-11-02T18:00:00Z', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8CD9BFBC-D575-5FCC-BA7E-956BF0D0****\\"\\n}","errorExample":""},{"type":"xml","example":"<MoveResourceGroupResponse>\\r\\nd>8CD9BFBC-D575-5FCC-BA7E-956BF0D0****</RequestId>\\r\\n</MoveResourceGroupResponse>","errorExample":""}]',
- 'title' => 'MoveResourceGroup',
+ 'title' => 'Get backup details',
+ 'summary' => 'After HBase Enhanced Edition backup is enabled, you can call the DescribeBackupSummary operation to query backup details.',
+ 'description' => 'The backup and restore feature of the HBase Enhanced Edition instance is enabled. For more information, see [Enable backup and restore](~~145767~~).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'PurgeInstance' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-m5ek15uzs7613xxxx',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '276F899F-E952-496F-81B8-BD46D86854E3',
- ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeBackupSummary',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"276F899F-E952-496F-81B8-BD46D86854E3\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>276F899F-E952-496F-81B8-BD46D86854E3</RequestId>","errorExample":""}]',
- 'title' => 'PurgeInstance',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"168793CB-7B31-43E7-ADAB-FE3E8D584D6E\\",\\n \\"Incr\\": {\\n \\"Status\\": \\"RUNNING\\",\\n \\"Speed\\": \\"0.00 MB/s\\",\\n \\"Pos\\": \\"2020-11-05T01:20:31Z\\",\\n \\"QueueLogNum\\": \\"0\\",\\n \\"BackupLogSize\\": \\"266 B\\",\\n \\"RunningLogNum\\": \\"2\\"\\n },\\n \\"Full\\": {\\n \\"HasMore\\": \\"false\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 2,\\n \\"NextFullBackupDate\\": \\"2020-11-09T18:00:00Z\\",\\n \\"Records\\": {\\n \\"Record\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"FinishTime\\": \\"2020-11-02T18:02:04Z\\",\\n \\"Process\\": \\"1/1\\",\\n \\"DataSize\\": \\"1.2 kB\\",\\n \\"Speed\\": \\"0.00 MB/s\\",\\n \\"RecordId\\": \\"20201103020000\\",\\n \\"CreateTime\\": \\"2020-11-02T18:00:00Z\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
],
- 'RenewInstance' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeBackupTables' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'hb-bp1u0639js2h7****',
- 'required' => true,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'PricingCycle',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'month',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ID of the backup cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-m5eznlga4k5bcxxxx', 'title' => ''],
],
[
- 'name' => 'Duration',
+ 'name' => 'BackupRecordId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '5',
- 'format' => 'int32',
- 'required' => true,
- 'type' => 'integer',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'properties' => [
- 'OrderId' => [
- 'description' => '',
- 'example' => '211235614240728',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => '729CB2A7-3065-53A9-B27C-7033CA4881D9',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
+ 'schema' => ['description' => 'The backup record ID. You can call the DescribeBackupSummary operation to obtain the ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020110302xxxx', 'title' => ''],
],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": 211235614240728,\\n \\"RequestId\\": \\"729CB2A7-3065-53A9-B27C-7033CA4881D9\\"\\n}","errorExample":""},{"type":"xml","example":"<RenewInstanceResponse>\\n<OrderId>211235614240728</OrderId>\\n<RequestId>729CB2A7-3065-53A9-B27C-7033CA4881D9</RequestId>\\n</RenewInstanceResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'title' => 'RenewInstance',
- ],
- 'ResizeDiskSize' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'ClusterId',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-bp16o0pd52e3y****',
- ],
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'NodeDiskSize',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '120',
- ],
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
@@ -5511,35 +3184,94 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'OrderId' => [
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '01262E9C-B0CC-4663-82FA-D50173649F92', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'Tables' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Table' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'The collection of table names.', 'type' => 'string', 'example' => 'default:test1', 'title' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => '3C22622B-8555-42BF-AD8A-1B960743****',
+ 'title' => '',
+ 'example' => '',
],
- 'RequestId' => [
+ 'BackupRecords' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'BackupRecord' => [
+ 'description' => 'The list of backup table details.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'EndTime' => ['description' => 'The time when the backup was completed.', 'type' => 'string', 'example' => '2020-11-02T18:00:05Z', 'title' => ''],
+ 'StartTime' => ['description' => 'The time when the backup started.', 'type' => 'string', 'example' => '2020-11-02T18:00:00Z', 'title' => ''],
+ 'Process' => ['description' => 'The completion progress.', 'type' => 'string', 'example' => '14/14', 'title' => ''],
+ 'DataSize' => ['description' => 'The data volume.', 'type' => 'string', 'example' => '1.2 kB', 'title' => ''],
+ 'Speed' => ['description' => 'The recovery speed.', 'type' => 'string', 'example' => '0.00 MB/s', 'title' => ''],
+ 'State' => ['description' => 'The table recovery status.', 'type' => 'string', 'example' => 'SUCCEEDED', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when an error occurs.', 'type' => 'string', 'example' => 'null', 'title' => ''],
+ 'Table' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'default:test1', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => '493A762B-E4A6-44E9-B877-CA6D0CAF8B29',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"3C22622B-8555-42BF-AD8A-1B960743****\\",\\n \\"RequestId\\": \\"493A762B-E4A6-44E9-B877-CA6D0CAF8B29\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>493A762B-E4A6-44E9-B877-CA6D0CAF8B29</RequestId>\\n<OrderId>3C22622B-8555-42BF-AD8A-1B960743****</OrderId>","errorExample":""}]',
- 'title' => 'ResizeDiskSize',
+ 'errorCodes' => [],
+ 'title' => 'Query backup table information of a backup record',
+ 'summary' => 'Queries the backup table information of a specific backup record by calling the DescribeBackupTables operation.',
+ 'description' => 'Before calling this operation, make sure that the backup and recovery feature is enabled for the HBaseue cluster and that backup records exist. You can call the DescribeBackupSummary operation to obtain backup records.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'UpgradeMinorVersion' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeBackupTables',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"01262E9C-B0CC-4663-82FA-D50173649F92\\",\\n \\"PageSize\\": 10,\\n \\"Total\\": 1,\\n \\"Tables\\": {\\n \\"Table\\": [\\n \\"default:test1\\"\\n ]\\n },\\n \\"BackupRecords\\": {\\n \\"BackupRecord\\": [\\n {\\n \\"EndTime\\": \\"2020-11-02T18:00:05Z\\",\\n \\"StartTime\\": \\"2020-11-02T18:00:00Z\\",\\n \\"Process\\": \\"14/14\\",\\n \\"DataSize\\": \\"1.2 kB\\",\\n \\"Speed\\": \\"0.00 MB/s\\",\\n \\"State\\": \\"SUCCEEDED\\",\\n \\"Message\\": \\"null\\",\\n \\"Table\\": \\"default:test1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeBackups' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5547,107 +3279,47 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-t4naqsay5gn****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-t4naqsay5gn****', 'title' => ''],
],
[
- 'name' => 'Components',
+ 'name' => 'BackupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'HADOOP',
- ],
+ 'schema' => ['description' => 'The ID of the backup to query.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'job-xxxx', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'UpgradingComponents' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'HADOOP',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '7B8EC240-BB13-4DBC-B955-F90170E82609',
- ],
- ],
- ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
- ],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"UpgradingComponents\\": \\"HADOOP\\",\\n \\"RequestId\\": \\"7B8EC240-BB13-4DBC-B955-F90170E82609\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>7B8EC240-BB13-4DBC-B955-F90170E82609</RequestId>\\n<UpgradingComponents>HADOOP</UpgradingComponents>","errorExample":""}]',
- 'title' => 'UpgradeMinorVersion',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'XpackRelateDB' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page size.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''],
],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ap-bp1qtz9rcbbt3****',
- ],
+ 'schema' => ['description' => 'The start time of the backup query. Format: yyyy-MM-dd HH:mm.', 'type' => 'string', 'required' => false, 'example' => '2020-12-13 00:00:00', 'title' => ''],
],
[
- 'name' => 'DbClusterIds',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-bp16o0pd52e3****',
- ],
+ 'schema' => ['description' => 'The end time of the backup query. Format: yyyy-MM-dd HH:mm.', 'type' => 'string', 'required' => false, 'example' => '2020-12-23 23:59:59', 'title' => ''],
],
[
- 'name' => 'RelateDbType',
+ 'name' => 'StartTimeUTC',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hbase',
- ],
+ 'schema' => ['description' => 'The start time of the backup query in UTC. Format: yyyy-MM-ddTHH:mmZ.', 'type' => 'string', 'required' => false, 'example' => '2020-12-12T16:00:00Z', 'title' => ''],
+ ],
+ [
+ 'name' => 'EndTimeUTC',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The end time of the backup query in UTC. The end time must be later than the start time. Format: yyyy-MM-ddTHH:mmZ.', 'type' => 'string', 'required' => false, 'example' => '2020-12-23T15:59:59Z', 'title' => ''],
],
],
'responses' => [
@@ -5655,122 +3327,298 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
+ 'EnableStatus' => ['description' => 'The backup enabling status. Valid values:'."\n"
+ .'- enable: Enabled.'."\n"
+ .'- disable: Not enabled.'."\n"
+ .'- opening: Being enabled.', 'type' => 'string', 'example' => 'enable', 'title' => ''],
+ 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A93CE373-0FDE-4CCB-9DBA-6700906825ED', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Backups' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Backup' => [
+ 'description' => 'The collection of backup records.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'BackupStatus' => ['description' => 'The backup status.'."\n"
+ ."\n"
+ .'- **0**: The backup is completed.'."\n"
+ .'- **1**: The backup is in progress.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ 'BackupStartTime' => ['description' => 'The backup start time.', 'type' => 'string', 'example' => '2020-12-23 17:25:08', 'title' => ''],
+ 'BackupType' => ['description' => 'The backup type. F indicates a full backup.', 'type' => 'string', 'example' => 'F', 'title' => ''],
+ 'BackupDownloadURL' => ['description' => 'The backup download URL.', 'type' => 'string', 'example' => ' 1', 'title' => ''],
+ 'BackupStartTimeUTC' => ['description' => 'The backup start time in UTC.', 'type' => 'string', 'example' => '2020-12-23T09:25:08Z', 'title' => ''],
+ 'BackupEndTime' => ['description' => 'The backup end time.', 'type' => 'string', 'example' => '2020-12-23 17:25:24', 'title' => ''],
+ 'BackupDBNames' => ['description' => 'The name of the backed-up database.', 'type' => 'string', 'example' => ' 1', 'title' => ''],
+ 'BackupId' => ['description' => 'The backup ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '511876087', 'title' => ''],
+ 'BackupEndTimeUTC' => ['description' => 'The backup end time in UTC.', 'type' => 'string', 'example' => '2020-12-23T09:25:24Z', 'title' => ''],
+ 'BackupSize' => ['description' => 'The size of the backup data. Unit: GB.', 'type' => 'string', 'example' => '0.00', 'title' => ''],
+ 'BackupMode' => ['description' => 'The backup policy. 0 indicates a system backup.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ 'BackupMethod' => ['description' => 'The backup method. P indicates a physical backup.', 'type' => 'string', 'example' => 'P', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>50373857-C47B-4B64-9332-D0B5280B59EA\\r\\n</RequestId>","errorExample":""}]',
- 'title' => 'XpackRelateDB',
+ 'title' => 'Query the backup list of an instance',
+ 'summary' => 'Retrieves backup records of an ApsaraDB for HBase cluster by calling DescribeBackups.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ConvertInstance' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:56:05.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeBackups',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EnableStatus\\": \\"enable\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"A93CE373-0FDE-4CCB-9DBA-6700906825ED\\",\\n \\"TotalCount\\": 1,\\n \\"Backups\\": {\\n \\"Backup\\": [\\n {\\n \\"BackupStatus\\": \\"0\\",\\n \\"BackupStartTime\\": \\"2020-12-23 17:25:08\\",\\n \\"BackupType\\": \\"F\\",\\n \\"BackupDownloadURL\\": \\" 1\\",\\n \\"BackupStartTimeUTC\\": \\"2020-12-23T09:25:08Z\\",\\n \\"BackupEndTime\\": \\"2020-12-23 17:25:24\\",\\n \\"BackupDBNames\\": \\" 1\\",\\n \\"BackupId\\": 511876087,\\n \\"BackupEndTimeUTC\\": \\"2020-12-23T09:25:24Z\\",\\n \\"BackupSize\\": \\"0.00\\",\\n \\"BackupMode\\": \\"0\\",\\n \\"BackupMethod\\": \\"P\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeClusterConnection' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'hb-bp16o0pd52e3y****',
- 'required' => true,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'PricingCycle',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'month',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'Duration',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '7',
- 'format' => 'int32',
- 'required' => false,
- 'type' => 'integer',
- ],
+ 'schema' => ['description' => 'The region ID of the instance. You can call the [DescribeRegions](~~144489~~) operation to obtain the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'PayType',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'Prepaid',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ID of target instance. You can call the [DescribeInstances](~~144595~~) operation to obtain target instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp150tns0sjxs****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'OrderId' => [
+ 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp15s22y1a7sff5gj****', 'title' => ''],
+ 'VSwitchId' => ['description' => 'The vSwitch ID in the VPC.', 'type' => 'string', 'example' => 'vsw-bp1foll427ze3d4ps****', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '70220050-A465-5DCC-8C0C-C38C6E3DB24D', 'title' => ''],
+ 'IsMultimod' => ['description' => 'Indicates whether multi-model management is enabled. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Multi-model management is enabled.'."\n"
+ .'- **false**: Multi-model management is not enabled.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'DbType' => ['description' => 'The database engine type. Valid values:'."\n"
+ ."\n"
+ .'- **hbaseue**: ApsaraDB for HBase Performance-enhanced Edition.'."\n"
+ .'- **hbase**: ApsaraDB for HBase Standard Edition or ApsaraDB for HBase single-node edition.'."\n"
+ .'- **bds**: a BDS instance.', 'type' => 'string', 'example' => 'hbaseue', 'title' => ''],
+ 'NetType' => ['description' => 'The network type of the instance. Valid values:'."\n"
+ ."\n"
+ .'- **VPC**: Virtual Private Cloud (VPC).'."\n"
+ .'- **CLASSIC**: classic network.', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
+ 'UiProxyConnAddrInfo' => [
+ 'description' => 'The WebUI connection information list.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ConnAddr' => ['description' => 'The endpoint.', 'type' => 'string', 'example' => 'ld-bp150tns0sjxs****-master1-001.hbaseue.rds.aliyuncs.com', 'title' => ''],
+ 'ConnAddrPort' => ['description' => 'The connection port.', 'type' => 'string', 'example' => '443', 'title' => ''],
+ 'NetType' => ['description' => 'The access type of the endpoint, which is public network access.', 'type' => 'string', 'example' => 'PUBLIC', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ThriftConn' => [
+ 'description' => 'The Thrift endpoint information list.'."\n"
+ ."\n"
+ .'> This parameter list is returned only when the database DPI engine type is **hbase**.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ConnAddr' => ['description' => 'The endpoint.', 'type' => 'string', 'example' => 'hb-bp1u0639js2h7****-proxy-thrift.hbase.rds.aliyuncs.com', 'title' => ''],
+ 'ConnAddrPort' => ['description' => 'The connection port.', 'type' => 'string', 'example' => '9099', 'title' => ''],
+ 'NetType' => ['description' => 'The access type of the endpoint. Valid values:'."\n"
+ ."\n"
+ .'- **2**: internal network access.'."\n"
+ .'- **0**: public network access.', 'type' => 'string', 'example' => '2', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ZkConnAddrs' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'ZkConnAddr' => [
+ 'description' => 'The ZooKeeper connection information list.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ConnAddr' => ['description' => 'The endpoint.', 'type' => 'string', 'example' => 'ld-bp150tns0sjxs****-master1-001.hbaseue.rds.aliyuncs.com', 'title' => ''],
+ 'ConnAddrPort' => ['description' => 'The connection port.', 'type' => 'string', 'example' => '2181', 'title' => ''],
+ 'NetType' => ['description' => 'The access type of the endpoint. Valid values:'."\n"
+ ."\n"
+ .'- **2**: internal network access.'."\n"
+ .'- **0**: public network access.', 'type' => 'string', 'example' => '2', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'SlbConnAddrs' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SlbConnAddr' => [
+ 'description' => 'The SLB connection information list.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SlbType' => ['description' => 'The SLB type. Valid values:'."\n"
+ ."\n"
+ .'- **hbaseue**: ApsaraDB for HBase Performance-enhanced Edition.'."\n"
+ .'- **thrift**: Thrift service.'."\n"
+ .'- **Phoenix**: Phoenix service.', 'type' => 'string', 'example' => 'hbaseue', 'title' => ''],
+ 'ConnAddrInfo' => [
+ 'description' => 'The endpoint information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ConnAddr' => ['description' => 'The endpoint.', 'type' => 'string', 'example' => 'ld-bp150tns0sjxs****-proxy-hbaseue-pub.hbaseue.rds.aliyuncs.com', 'title' => ''],
+ 'ConnAddrPort' => ['description' => 'The connection port.', 'type' => 'string', 'example' => '9190', 'title' => ''],
+ 'NetType' => ['description' => 'The access type of the endpoint. Valid values:'."\n"
+ ."\n"
+ .'- **2**: internal network access.'."\n"
+ .'- **0**: public network access.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'example' => '54124548879',
- 'format' => 'int64',
- 'type' => 'integer',
+ 'title' => '',
+ 'example' => '',
],
- 'RequestId' => [
+ 'ServiceConnAddrs' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'ServiceConnAddr' => [
+ 'description' => 'The sub-service address list.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ConnType' => ['description' => 'The service type.', 'type' => 'string', 'example' => 'PhoenixConnAddr', 'title' => ''],
+ 'ConnAddrInfo' => [
+ 'description' => 'The endpoint information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ConnAddr' => ['description' => 'The Phoenix endpoint.', 'type' => 'string', 'example' => 'hb-****-proxy-phoenix.hbase.rds.aliyuncs.com', 'title' => ''],
+ 'ConnAddrPort' => ['description' => 'The connection port.', 'type' => 'string', 'example' => '8765', 'title' => ''],
+ 'NetType' => ['description' => 'The access type of the endpoint. Valid values:'."\n"
+ ."\n"
+ .'- **2**: internal network access.'."\n"
+ .'- **0**: public network access.', 'type' => 'string', 'example' => '2', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA',
- 'type' => 'string',
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": 54124548879,\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","errorExample":""},{"type":"xml","example":"<OrderId>54124542154</OrderId>\\n<RequestId>50373857-C47B-4B64-9332-D0B5280B59EA</RequestId>","errorExample":""}]',
- 'extraInfo' => ' ',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'title' => 'ConvertInstance',
- ],
- 'ModifyIpWhitelist' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Query cluster connection list',
+ 'summary' => 'Queries the connection list of a cluster by calling DescribeClusterConnection.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeClusterConnection',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"VpcId\\": \\"vpc-bp15s22y1a7sff5gj****\\",\\n \\"VSwitchId\\": \\"vsw-bp1foll427ze3d4ps****\\",\\n \\"RequestId\\": \\"70220050-A465-5DCC-8C0C-C38C6E3DB24D\\",\\n \\"IsMultimod\\": \\"true\\",\\n \\"DbType\\": \\"hbaseue\\",\\n \\"NetType\\": \\"VPC\\",\\n \\"UiProxyConnAddrInfo\\": {\\n \\"ConnAddr\\": \\"ld-bp150tns0sjxs****-master1-001.hbaseue.rds.aliyuncs.com\\",\\n \\"ConnAddrPort\\": \\"443\\",\\n \\"NetType\\": \\"PUBLIC\\"\\n },\\n \\"ThriftConn\\": {\\n \\"ConnAddr\\": \\"hb-bp1u0639js2h7****-proxy-thrift.hbase.rds.aliyuncs.com\\",\\n \\"ConnAddrPort\\": \\"9099\\",\\n \\"NetType\\": \\"2\\"\\n },\\n \\"ZkConnAddrs\\": {\\n \\"ZkConnAddr\\": [\\n {\\n \\"ConnAddr\\": \\"ld-bp150tns0sjxs****-master1-001.hbaseue.rds.aliyuncs.com\\",\\n \\"ConnAddrPort\\": \\"2181\\",\\n \\"NetType\\": \\"2\\"\\n }\\n ]\\n },\\n \\"SlbConnAddrs\\": {\\n \\"SlbConnAddr\\": [\\n {\\n \\"SlbType\\": \\"hbaseue\\",\\n \\"ConnAddrInfo\\": {\\n \\"ConnAddr\\": \\"ld-bp150tns0sjxs****-proxy-hbaseue-pub.hbaseue.rds.aliyuncs.com\\",\\n \\"ConnAddrPort\\": \\"9190\\",\\n \\"NetType\\": \\"0\\"\\n }\\n }\\n ]\\n },\\n \\"ServiceConnAddrs\\": {\\n \\"ServiceConnAddr\\": [\\n {\\n \\"ConnType\\": \\"PhoenixConnAddr\\",\\n \\"ConnAddrInfo\\": {\\n \\"ConnAddr\\": \\"hb-****-proxy-phoenix.hbase.rds.aliyuncs.com\\",\\n \\"ConnAddrPort\\": \\"8765\\",\\n \\"NetType\\": \\"2\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeColdStorage' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5778,53 +3626,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp1uoihlf82e8****',
- ],
- ],
- [
- 'name' => 'IpList',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '42.120.XX.XX',
- ],
- ],
- [
- 'name' => 'GroupName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'group_01',
- ],
- ],
- [
- 'name' => 'IpVersion',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '4',
- ],
+ 'schema' => ['description' => 'The ID of target instance. You can call [DescribeInstances](~~144595~~) to obtain target instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp1uoihlf82e8****', 'title' => ''],
],
],
'responses' => [
@@ -5832,31 +3639,61 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '101CFA8A-FB88-5014-A10C-3A0DA9AD8B0B',
- ],
+ 'OpenStatus' => ['description' => 'The enabling status of cold storage. Valid values:'."\n"
+ .'- **open**: Cold storage is enabled.'."\n"
+ .'- **close**: Cold storage is not enabled.', 'type' => 'string', 'example' => 'open', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DCB9479E-F05F-4D1C-AFB7-C639B87764B7', 'title' => ''],
+ 'PayType' => ['description' => 'The billing method of the instance. Valid values:'."\n"
+ .'- **PREPAY**: subscription.'."\n"
+ .'- **POSTPAY**: pay-as-you-go.', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''],
+ 'ColdStorageUsePercent' => ['description' => 'The usage of the cold storage space, in percentage (%).'."\n"
+ ."\n"
+ .'> This parameter is returned only when **OpenStatus** is **open**.', 'type' => 'string', 'example' => '20.00', 'title' => ''],
+ 'ColdStorageUseAmount' => ['description' => 'The amount of cold storage space used, in GB.'."\n"
+ ."\n"
+ .'> This parameter is returned only when **OpenStatus** is **open**.', 'type' => 'string', 'example' => '20.00', 'title' => ''],
+ 'ColdStorageSize' => ['description' => 'The total storage capacity of cold storage, in GB.'."\n"
+ ."\n"
+ .'> This parameter is returned only when **OpenStatus** is **open**.', 'type' => 'string', 'example' => '800', 'title' => ''],
+ 'ColdStorageType' => ['description' => 'The cold storage type. For newly created BDS instances, the cold storage type is **BdsColdStorage**. This parameter is not returned for other instances by default.', 'type' => 'string', 'example' => 'BdsColdStorage', 'title' => ''],
+ 'ClusterId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ld-bp1uoihlf82e8****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"101CFA8A-FB88-5014-A10C-3A0DA9AD8B0B\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyIpWhitelistResponse>\\r\\n<RequestId>101CFA8A-FB88-5014-A10C-3A0DA9AD8B0B</RequestId>\\r\\n</ModifyIpWhitelistResponse>","errorExample":""}]',
- 'title' => 'ModifyIpWhitelist',
+ 'title' => 'Query cold storage status of a cluster',
+ 'summary' => 'Calls DescribeColdStorage to retrieve the cold storage information of an instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifySecurityGroups' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-02T13:39:32.000Z', 'description' => 'Response parameters changed, Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeColdStorage',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OpenStatus\\": \\"open\\",\\n \\"RequestId\\": \\"DCB9479E-F05F-4D1C-AFB7-C639B87764B7\\",\\n \\"PayType\\": \\"POSTPAY\\",\\n \\"ColdStorageUsePercent\\": \\"20.00\\",\\n \\"ColdStorageUseAmount\\": \\"20.00\\",\\n \\"ColdStorageSize\\": \\"800\\",\\n \\"ColdStorageType\\": \\"BdsColdStorage\\",\\n \\"ClusterId\\": \\"ld-bp1uoihlf82e8****\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeDBInstanceUsage' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5864,31 +3701,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-bp16f1441y6p2kv**',
- ],
- ],
- [
- 'name' => 'SecurityGroupIds',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sg-t4ng4yyc916o81nu****,sg-x4gg4dyc9d6w********',
- ],
+ 'schema' => ['description' => 'The ID of target instance. You can call [DescribeInstances](~~144595~~) to obtain target instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-bp1u0639js2h7****', 'title' => ''],
],
],
'responses' => [
@@ -5896,31 +3714,47 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F4AD2E65-482B-46B6-942E-765989B1C8A3',
- ],
+ 'Result' => ['description' => 'The disk usage of the instance, which includes the following parameters:'."\n"
+ .'- disk_used: the disk usage amount.'."\n"
+ .'- disk_total: the total disk capacity.'."\n"
+ .'- usage_rate: the disk usage rate.', 'type' => 'string', 'example' => '{\\"disk_usage_record\\":{\\"disk_used\\":\\"0.9GB\\",\\"disk_total\\":\\"1156.1GB\\",\\"usage_rate\\":\\"1%\\"}}', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A2D841CE-D066-53E8-B9AC-3731DCC85397', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F4AD2E65-482B-46B6-942E-765989B1C8A3\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>F4AD2E65-482B-46B6-942E-765989B1C8A3</RequestId>","errorExample":""}]',
- 'title' => 'ModifySecurityGroups',
+ 'title' => 'Query database instance usage',
+ 'summary' => 'Calls DescribeDBInstanceUsage to retrieve the running watermark status of an HBase cluster by cluster ID.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeSecurityGroups' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeDBInstanceUsage',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": \\"{\\\\\\\\\\\\\\"disk_usage_record\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"disk_used\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.9GB\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"disk_total\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1156.1GB\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"usage_rate\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1%\\\\\\\\\\\\\\"}}\\",\\n \\"RequestId\\": \\"A2D841CE-D066-53E8-B9AC-3731DCC85397\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeDeletedInstances' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5928,20 +3762,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-bp161ax8i03c4uq**',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
@@ -5949,96 +3785,85 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA',
- ],
- 'SecurityGroupIds' => [
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0CAC5702-C862-44C0-AD54-C9CE70F4B246', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'Instances' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'SecurityGroupId' => [
+ 'Instance' => [
+ 'description' => 'The list of clusters that have been deleted but not fully released.',
'type' => 'array',
'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The current status. The value is DELETED.', 'type' => 'string', 'example' => 'DELETED', 'title' => ''],
+ 'InstanceId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'hb-bp10q7n2zdw12xxxx', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'ParentId' => ['description' => 'The ID of the parent instance. This parameter is returned only for components.', 'type' => 'string', 'example' => 'null', 'title' => ''],
+ 'ClusterType' => ['description' => 'The cluster type. Valid values:'."\n"
+ ."\n"
+ .'- single: single-node'."\n"
+ .'- cluster: Cluster Edition.', 'type' => 'string', 'example' => 'cluster', 'title' => ''],
+ 'InstanceName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'e2e-test', 'title' => ''],
+ 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-f', 'title' => ''],
+ 'DeleteTime' => ['description' => 'The deletion time.', 'type' => 'string', 'example' => '2020-11-02T07:27:24Z', 'title' => ''],
+ 'ModuleStackVersion' => ['description' => 'The software stack version of the component. This parameter is returned only for components.', 'type' => 'string', 'example' => 'null', 'title' => ''],
+ 'MajorVersion' => ['description' => 'The major version number.', 'type' => 'string', 'example' => '2.0', 'title' => ''],
+ 'Engine' => ['description' => 'The cluster engine type.', 'type' => 'string', 'example' => 'hbase', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2020-11-02T07:16:07Z', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'sg-t4ng4yyc916o81nua6**,sg-****',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\",\\n \\"SecurityGroupIds\\": {\\n \\"SecurityGroupId\\": [\\n \\"sg-t4ng4yyc916o81nua6**,sg-****\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>50373857-C47B-4B64-9332-D0B5280B59EA</RequestId>\\n<SecurityGroupIds>\\n <SecurityGroupIds>sg-t4ng4yyc916o81nua6**</SecurityGroupIds>\\n <SecurityGroupIds>sg-****</SecurityGroupIds>\\n</SecurityGroupIds>","errorExample":""}]',
- 'title' => 'DescribeSecurityGroups',
+ 'title' => 'Retrieve a list of deleted but not fully released clusters',
+ 'summary' => 'Retrieves a list of clusters that have been deleted but not fully released.',
+ 'description' => 'By default, cluster resources are fully cleaned up 7 days after deletion. If you have called the PurgeInstance operation or set ImmediateDeleteFlag to true when calling the delete operation, the resources have already been fully cleaned up.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CreateBackupPlan' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:56:05.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'security' => [
+ 'ramActions' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'systemTags' => [
- 'operationType' => 'update',
- ],
- 'parameters' => [
- [
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-wz94lbcqc****4x93',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA',
- ],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeDeletedInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>50373857-C47B-4B64-9332-D0B5280B59EA</RequestId>","errorExample":""}]',
- 'title' => 'CreateBackupPlan',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"0CAC5702-C862-44C0-AD54-C9CE70F4B246\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Instances\\": {\\n \\"Instance\\": [\\n {\\n \\"Status\\": \\"DELETED\\",\\n \\"InstanceId\\": \\"hb-bp10q7n2zdw12xxxx\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ParentId\\": \\"null\\",\\n \\"ClusterType\\": \\"cluster\\",\\n \\"InstanceName\\": \\"e2e-test\\",\\n \\"ZoneId\\": \\"cn-hangzhou-f\\",\\n \\"DeleteTime\\": \\"2020-11-02T07:27:24Z\\",\\n \\"ModuleStackVersion\\": \\"null\\",\\n \\"MajorVersion\\": \\"2.0\\",\\n \\"Engine\\": \\"hbase\\",\\n \\"CreatedTime\\": \\"2020-11-02T07:16:07Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
- 'EnableHBaseueBackup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeDiskWarningLine' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6046,53 +3871,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'HbaseueClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-m5eznlga4k5bcxxxx',
- ],
- ],
- [
- 'name' => 'NodeCount',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2',
- ],
- ],
- [
- 'name' => 'ColdStorageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '800',
- ],
- ],
- [
- 'name' => 'ClientToken',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => 'The ID of the cluster to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-bp1bl7iqzkahmyxxxx', 'title' => ''],
],
],
'responses' => [
@@ -6100,104 +3884,57 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '15272D5D-46E8-4400-9CC8-A7E7B589F575',
- ],
- 'OrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1449xxx',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'bds-m5e54q06ceyhxxxx',
- ],
+ 'WarningLine' => ['description' => 'The disk capacity alert threshold. For example, if the value is 75, an alert is triggered when disk usage exceeds 75%. If no value is returned, the user has not configured this parameter, and the system default value is 80%.', 'type' => 'string', 'example' => '80', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '08DF8283-D290-4107-931E-7913D6D3480D', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"15272D5D-46E8-4400-9CC8-A7E7B589F575\\",\\n \\"OrderId\\": \\"1449xxx\\",\\n \\"ClusterId\\": \\"bds-m5e54q06ceyhxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>15272D5D-46E8-4400-9CC8-A7E7B589F575</RequestId>\\n<ClusterId>bds-m5e54q06ceyhxxxx</ClusterId>\\n<OrderId>1449xxx</OrderId>","errorExample":""}]',
- 'title' => 'EnableHBaseueBackup',
+ 'errorCodes' => [],
+ 'title' => 'Retrieve disk capacity alert threshold',
+ 'summary' => 'Currently, only HBase and HBaseue are supported.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifyBackupPlanConfig' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeDiskWarningLine',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"WarningLine\\": \\"80\\",\\n \\"RequestId\\": \\"08DF8283-D290-4107-931E-7913D6D3480D\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeEndpoints' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-m5eznlga4k5bcxxxx',
- ],
- ],
- [
- 'name' => 'Tables',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '*',
- ],
- ],
- [
- 'name' => 'FullBackupCycle',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '7',
- ],
- ],
- [
- 'name' => 'MinHFileBackupCount',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '3',
- ],
- ],
- [
- 'name' => 'NextFullBackupDate',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2020-11-09T18:00:00Z',
- ],
+ 'schema' => ['description' => 'The ID of the instance that you want to query. You can call the [DescribeInstances](~~144595~~) operation to obtain the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp150tns0sjxs****', 'title' => ''],
],
],
'responses' => [
@@ -6205,144 +3942,104 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
+ 'VpcId' => ['description' => 'The VPC ID. This parameter is returned only when NetType is set to **VPC**.', 'type' => 'string', 'example' => 'vpc-bp15s22y1a7sff5gj****', 'title' => ''],
+ 'VSwitchId' => ['description' => 'The vSwitch ID. This parameter is returned only when NetType is set to **VPC**.', 'type' => 'string', 'example' => 'vsw-bp1foll427ze3d4ps****', 'title' => ''],
+ 'Engine' => ['description' => 'The engine type of the instance. Valid values:'."\n"
+ ."\n"
+ .'- **hbaseue**'."\n"
+ .'- **hbase**'."\n"
+ .'- **spark**'."\n"
+ .'- **geomesa**.', 'type' => 'string', 'example' => 'hbaseue', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F072593C-5234-5B56-9F63-3C7A3AD85D66', 'title' => ''],
+ 'NetType' => ['description' => 'The network type of the instance. Valid values:'."\n"
+ .'- **VPC**: virtual private cloud.'."\n"
+ .'- **CLASSIC**: classic network.', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
+ 'ConnAddrs' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'ConnAddrInfo' => [
+ 'description' => 'The database connection information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ConnAddr' => ['description' => 'The endpoint.', 'type' => 'string', 'example' => '****', 'title' => ''],
+ 'ConnAddrPort' => ['description' => 'The port number.', 'type' => 'string', 'example' => '****', 'title' => ''],
+ 'ConnType' => ['description' => 'The connection type. Valid values:'."\n"
+ .'- **uiProxyConn**: UI access connection.'."\n"
+ .'- **zkConn**: ZooKeeper connection.'."\n"
+ .'- **thriftConn**: Thrift connection.'."\n"
+ .'- **slbConn_thrift**: load balancing Thrift connection.'."\n"
+ .'- **serviceConn_LivyConnAddr**: Livy connection.', 'type' => 'string', 'example' => 'zkConn', 'title' => ''],
+ 'NetType' => ['description' => 'The network type of the connection. Valid values:'."\n"
+ .'- **PUBLIC** or **0**: public network access.'."\n"
+ .'- **PRIVATE** or **1**: internal-facing access.'."\n"
+ .'- **VPC** or **2**: VPC access.', 'type' => 'string', 'example' => '2', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => '50F4A8C2-076F-4703-9813-2FCD7FBB91C2',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50F4A8C2-076F-4703-9813-2FCD7FBB91C2\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>50F4A8C2-076F-4703-9813-2FCD7FBB91C2</RequestId>","errorExample":""}]',
- 'title' => 'ModifyBackupPlanConfig',
+ 'title' => 'Query database connection information by cluster ID',
+ 'summary' => 'Queries the database connection information of an ApsaraDB for HBase instance by calling DescribeEndpoints.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifyBackupPolicy' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:37:16.000Z', 'description' => 'Error codes changed'],
],
- 'security' => [
- [
- 'AK' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEndpoints'],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-t4naqsay5gn****',
- ],
- ],
- [
- 'name' => 'PreferredBackupTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '01:00-02:00',
- ],
- ],
- [
- 'name' => 'PreferredBackupPeriod',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Thursday',
- ],
- ],
- [
- 'name' => 'PreferredBackupStartTimeUTC',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '17:00Z',
- ],
- ],
- [
- 'name' => 'PreferredBackupEndTimeUTC',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '18:00Z',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '17E3AC63-300D-4B69-9108-45EC20E50E85',
- ],
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeEndpoints',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"17E3AC63-300D-4B69-9108-45EC20E50E85\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>17E3AC63-300D-4B69-9108-45EC20E50E85</RequestId>","errorExample":""}]',
- 'title' => 'ModifyBackupPolicy',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"VpcId\\": \\"vpc-bp15s22y1a7sff5gj****\\",\\n \\"VSwitchId\\": \\"vsw-bp1foll427ze3d4ps****\\",\\n \\"Engine\\": \\"hbaseue\\",\\n \\"RequestId\\": \\"F072593C-5234-5B56-9F63-3C7A3AD85D66\\",\\n \\"NetType\\": \\"VPC\\",\\n \\"ConnAddrs\\": {\\n \\"ConnAddrInfo\\": [\\n {\\n \\"ConnAddr\\": \\"****\\",\\n \\"ConnAddrPort\\": \\"****\\",\\n \\"ConnType\\": \\"zkConn\\",\\n \\"NetType\\": \\"2\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
- 'DescribeBackupPlanConfig' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeInstance' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-m5eznlga4k5bcxxxx',
- ],
+ 'schema' => ['description' => 'The instance ID. You can call the [DescribeInstances](~~144595~~) operation to obtain the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp150tns0sjxs****', 'title' => ''],
],
],
'responses' => [
@@ -6350,82 +4047,226 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '33A23201-6038-4A6A-B76A-61047EA04E6A',
- ],
- 'MinHFileBackupCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'NextFullBackupDate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-09T18:00:00Z',
- ],
- 'FullBackupCycle' => [
+ 'VpcId' => ['description' => 'The virtual private cloud (VPC) ID. This parameter is returned when **NetworkType** is **2**.', 'type' => 'string', 'example' => 'vpc-bp15s22y1a7sff5gj****', 'title' => ''],
+ 'Status' => ['description' => 'The instance status. Valid values:'."\n"
+ .'- **CREATING**: The instance is being created.'."\n"
+ .'- **ACTIVATION**: The instance is running.'."\n"
+ .'- **DELETING**: The instance is being deleted.'."\n"
+ .'- **RESTARTING**: The instance is being restarted.'."\n"
+ .'- **MINOR_VERSION_TRANSING**: A minor version upgrade is in progress.', 'type' => 'string', 'example' => 'ACTIVATION', 'title' => ''],
+ 'EncryptionType' => ['description' => 'The encryption type. Valid values:'."\n"
+ .'- **NoEncryption**: Encryption is disabled.'."\n"
+ .'- **CloudDisk**: Cloud disk encryption is enabled.'."\n"
+ .'- **EncryptionKey**: The encryption key specified by the parameter.'."\n"
+ ."\n"
+ .'> Cloud disk encryption cannot be disabled after it is enabled.', 'type' => 'string', 'example' => 'NoEncryption', 'title' => ''],
+ 'ModuleId' => ['description' => 'The module ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'VswitchId' => ['description' => 'The vSwitch ID. This parameter is returned when **NetworkType** is **2**.', 'type' => 'string', 'example' => 'vsw-bp1foll427ze3d4ps****', 'title' => ''],
+ 'BackupStatus' => ['description' => 'Indicates whether the backup feature is supported. Valid values:'."\n"
+ .'- **open**: The backup feature is supported.'."\n"
+ .'- **close**: The backup feature is not supported.', 'type' => 'string', 'example' => 'open', 'title' => ''],
+ 'PayType' => ['description' => 'The billing method of the instance. Valid values:'."\n"
+ ."\n"
+ .'- **Prepaid**: subscription.'."\n"
+ .'- **Postpaid**: pay-as-you-go.'."\n", 'type' => 'string', 'example' => 'Prepaid', 'title' => ''],
+ 'CoreDiskType' => ['description' => 'The disk type of core nodes. Valid values:'."\n"
+ .'- **cloud_efficiency**: ultra disk.'."\n"
+ .'- **cloud_ssd**: standard SSD.'."\n"
+ .'- **local_hdd**: local HDD.'."\n"
+ .'- **local__ssd**: local SSD.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''],
+ 'MasterNodeCount' => ['description' => 'The type of master nodes. Valid values:'."\n"
+ .'- **0**: The master node is a single node.'."\n"
+ .'- **2**: The master node is in cluster mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'NetworkType' => ['description' => 'The network type. Valid values:'."\n"
+ .'- **VPC**: Virtual Private Cloud. If the network type is VPC, the VswitchId and VpcId parameters are returned.'."\n"
+ .'- **CLASSIC**: classic network.'."\n", 'type' => 'string', 'example' => 'VPC', 'title' => ''],
+ 'CreatedTimeUTC' => ['description' => 'The time when the instance was created, in UTC.', 'type' => 'string', 'example' => '2021-07-19T03:23:22Z', 'title' => ''],
+ 'ColdStorageSize' => ['description' => 'The cold storage capacity. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '800', 'title' => ''],
+ 'ParentId' => ['description' => 'The ID of the parent instance.', 'type' => 'string', 'example' => 'ld-uf699153o1m2l****', 'title' => ''],
+ 'IsLatestVersion' => ['description' => 'Indicates whether the instance is of the latest version. Valid values:'."\n"
+ .'- **true**: The instance is of the latest version.'."\n"
+ .'- **false**: The instance is not of the latest version.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ExpireTimeUTC' => ['description' => 'The time when the instance expires, in UTC.', 'type' => 'string', 'example' => '2022-02-23T16:00:00Z', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66', 'title' => ''],
+ 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'testhbase', 'title' => ''],
+ 'MasterInstanceType' => ['description' => 'The specification of master nodes.', 'type' => 'string', 'example' => 'hbase.sn2.large', 'title' => ''],
+ 'CoreInstanceType' => ['description' => 'The specification of core nodes.', 'type' => 'string', 'example' => 'hbase.sn2.2xlarge', 'title' => ''],
+ 'EncryptionKey' => ['description' => 'The encryption key.'."\n"
+ ."\n"
+ .'> This parameter is returned when the encryption type is **CloudDisk**.', 'type' => 'string', 'example' => '0d2470df-da7b-4786-b981-9a164dae****', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2021-07-19T11:23:22', 'title' => ''],
+ 'CoreDiskSize' => ['description' => 'The disk capacity of core nodes. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'ClusterId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ld-bp150tns0sjxs****', 'title' => ''],
+ 'ExpireTime' => ['description' => 'The time when the instance expires.', 'type' => 'string', 'example' => '2022-02-24T00:00:00', 'title' => ''],
+ 'MaintainStartTime' => ['description' => 'The start time of the maintenance window for the instance.', 'type' => 'string', 'example' => '18:00Z', 'title' => ''],
+ 'ConfirmMaintainTime' => ['description' => 'Indicates whether the maintenance window of the instance has been confirmed for the first time. Valid values:'."\n"
+ .'- **true**: The maintenance window has been confirmed.'."\n"
+ .'- **false**: The maintenance window has not been confirmed.'."\n"
+ ."\n"
+ .'> The **Confirm Maintenance Window** dialog box appears only when you access the **Basic Information** page of the instance for the first time.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'IsHa' => ['description' => 'Indicates whether the instance is configured for high availability. Valid values:'."\n"
+ .'- **true**: The instance is configured for high availability.'."\n"
+ .'- **false**: The instance is not configured for high availability.'."\n"
+ ."\n"
+ .'> - The cluster edition is configured for high availability by default and uses two master nodes.'."\n"
+ .'- The single-node edition is configured with the actual available capacity.'."\n"
+ ."\n\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'MaintainEndTime' => ['description' => 'The end time of the maintenance window for the instance.', 'type' => 'string', 'example' => '22:00Z', 'title' => ''],
+ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ld-bp150tns0sjxs****', 'title' => ''],
+ 'ColdStorageStatus' => ['description' => 'Indicates whether the cold storage feature is supported. Valid values:'."\n"
+ .'- **open**: The cold storage feature is supported.'."\n"
+ .'- **close**: The cold storage feature is not supported.', 'type' => 'string', 'example' => 'open', 'title' => ''],
+ 'IsDeletionProtection' => ['description' => 'Indicates whether deletion protection is enabled. Valid values:'."\n"
+ .'- **true**: Deletion protection is enabled.'."\n"
+ .'- **false**: Deletion protection is disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'MinorVersion' => ['description' => 'The minor version number of the instance.', 'type' => 'string', 'example' => '2.2.9.1', 'title' => ''],
+ 'RegionId' => ['description' => 'The ID of the region in which the instance is deployed.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'MasterDiskSize' => ['description' => 'The disk capacity of master nodes. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'MasterDiskType' => ['description' => 'The disk type of master nodes. Valid values:'."\n"
+ .'- **cloud_efficiency**: ultra disk.'."\n"
+ .'- **cloud_ssd**: standard SSD.'."\n"
+ ."\n"
+ .'> This parameter is returned for single-node instances.', 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''],
+ 'NeedUpgrade' => ['description' => 'Indicates whether the components of the instance need to be upgraded. Valid values:'."\n"
+ .'- **true**: An upgrade is required.'."\n"
+ .'- **false**: No upgrade is required.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'IsMultiModel' => ['description' => 'Indicates whether the instance is a multi-model cluster edition. Valid values:'."\n"
+ .'- **true**: The instance is a multi-model cluster edition.'."\n"
+ .'- **false**: The instance is not a multi-model cluster edition.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'AutoRenewal' => ['description' => 'Indicates whether auto-renewal is enabled for the instance. Valid values:'."\n"
+ .'- **true**: Auto-renewal is enabled.'."\n"
+ .'- **false**: Auto-renewal is disabled.'."\n"
+ ."\n"
+ .'> This parameter is returned only when PayType is set to Prepaid (subscription).'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'ClusterType' => ['description' => 'The instance type. Valid values:'."\n"
+ .'- **cluster**: cluster edition.'."\n"
+ .'- **single**: single-node edition.', 'type' => 'string', 'example' => 'cluster', 'title' => ''],
+ 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfmyiu4ekp****', 'title' => ''],
+ 'ClusterName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'testhbase', 'title' => ''],
+ 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-f', 'title' => ''],
+ 'Duration' => ['description' => 'The auto-renewal period.'."\n"
+ ."\n"
+ .'- Monthly subscription: The auto-renewal period is one month.'."\n"
+ .'- Yearly subscription: The auto-renewal period is one year (12 months).'."\n"
+ ."\n"
+ .'> This parameter is returned only when PayType is set to Prepaid (subscription).', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''],
+ 'ModuleStackVersion' => ['description' => 'The version of the module type.', 'type' => 'string', 'example' => 'phoenxi:4.0', 'title' => ''],
+ 'Engine' => ['description' => 'The database engine type. Valid values:'."\n"
+ .'- **hbase**: HBase Standard Edition or HBase Single-Node Edition.'."\n"
+ .'- **hbaseue**: HBase Enhanced Edition.'."\n"
+ .'- **serverlesshbase**: HBase Serverless Edition.'."\n"
+ .'- **bds**: BDS instance.', 'type' => 'string', 'example' => 'hbaseue', 'title' => ''],
+ 'MajorVersion' => ['description' => 'The major version number.', 'type' => 'string', 'example' => '2.0', 'title' => ''],
+ 'CoreDiskCount' => ['description' => 'The number of disks for core nodes.', 'type' => 'string', 'example' => '4', 'title' => ''],
+ 'TaskProgress' => ['description' => 'The progress of a task that is running on the instance, in percentage (%). Tasks initiated from the ApsaraDB for HBase console include specification changes, node scaling out, node scaling in, instance restart, and minor version upgrade.', 'type' => 'string', 'example' => '25.00', 'title' => ''],
+ 'TaskStatus' => ['description' => '- running: The task is running.'."\n"
+ .'- pause: The task is paused.'."\n"
+ .'- fail: The task is interrupted.'."\n"
+ .'- finish: The task is completed.', 'type' => 'string', 'example' => 'running', 'title' => ''],
+ 'CoreNodeCount' => ['description' => 'The number of core nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'EnableHbaseProxy' => ['description' => 'Indicates whether access from the open-source HBase client is supported. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Access is supported.'."\n"
+ ."\n"
+ .'- **false**: Access is not supported.', 'type' => 'boolean', 'required' => true, 'default' => 'false', 'example' => 'false', 'title' => ''],
+ 'LproxyMinorVersion' => ['description' => 'The minimum version of the LPROXY service.', 'type' => 'string', 'required' => false, 'example' => '2.3.2', 'title' => ''],
+ 'NeedUpgradeComps' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Comps' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'The names of the components that need to be upgraded.'."\n"
+ ."\n"
+ .'> This parameter is returned when the NeedUpgrade parameter is set to true.', 'type' => 'string', 'example' => '[lindorm, hdfs]', 'title' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '7',
+ 'title' => '',
+ 'example' => '',
],
- 'Tables' => [
+ 'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'Table' => [
+ 'Tag' => [
+ 'description' => 'The resource tags.',
'type' => 'array',
'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'test_key', 'title' => ''],
+ 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'test_value', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => '*',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"33A23201-6038-4A6A-B76A-61047EA04E6A\\",\\n \\"MinHFileBackupCount\\": 3,\\n \\"NextFullBackupDate\\": \\"2020-11-09T18:00:00Z\\",\\n \\"FullBackupCycle\\": 7,\\n \\"Tables\\": {\\n \\"Table\\": [\\n \\"*\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>33A23201-6038-4A6A-B76A-61047EA04E6A</RequestId>\\n<FullBackupCycle>7</FullBackupCycle>\\n<NextFullBackupDate>2020-11-09T18:00:00Z</NextFullBackupDate>\\n<Tables>\\n <Table>*</Table>\\n</Tables>\\n<MinHFileBackupCount>3</MinHFileBackupCount>","errorExample":""}]',
- 'title' => 'DescribeBackupPlanConfig',
+ 'title' => 'Query basic cluster information by ID',
+ 'summary' => 'Queries the detailed information of an HBase instance by calling the DescribeInstance operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeBackupPolicy' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-11T13:37:44.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-06-17T02:47:13.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-02-21T12:58:46.000Z', 'description' => 'Response parameters changed, Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstance'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"VpcId\\": \\"vpc-bp15s22y1a7sff5gj****\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"EncryptionType\\": \\"NoEncryption\\",\\n \\"ModuleId\\": 0,\\n \\"VswitchId\\": \\"vsw-bp1foll427ze3d4ps****\\",\\n \\"BackupStatus\\": \\"open\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"CoreDiskType\\": \\"cloud_ssd\\",\\n \\"MasterNodeCount\\": 2,\\n \\"NetworkType\\": \\"VPC\\",\\n \\"CreatedTimeUTC\\": \\"2021-07-19T03:23:22Z\\",\\n \\"ColdStorageSize\\": 800,\\n \\"ParentId\\": \\"ld-uf699153o1m2l****\\",\\n \\"IsLatestVersion\\": true,\\n \\"ExpireTimeUTC\\": \\"2022-02-23T16:00:00Z\\",\\n \\"RequestId\\": \\"3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66\\",\\n \\"InstanceName\\": \\"testhbase\\",\\n \\"MasterInstanceType\\": \\"hbase.sn2.large\\",\\n \\"CoreInstanceType\\": \\"hbase.sn2.2xlarge\\",\\n \\"EncryptionKey\\": \\"0d2470df-da7b-4786-b981-9a164dae****\\",\\n \\"CreatedTime\\": \\"2021-07-19T11:23:22\\",\\n \\"CoreDiskSize\\": 100,\\n \\"ClusterId\\": \\"ld-bp150tns0sjxs****\\",\\n \\"ExpireTime\\": \\"2022-02-24T00:00:00\\",\\n \\"MaintainStartTime\\": \\"18:00Z\\",\\n \\"ConfirmMaintainTime\\": \\"true\\",\\n \\"IsHa\\": true,\\n \\"MaintainEndTime\\": \\"22:00Z\\",\\n \\"InstanceId\\": \\"ld-bp150tns0sjxs****\\",\\n \\"ColdStorageStatus\\": \\"open\\",\\n \\"IsDeletionProtection\\": false,\\n \\"MinorVersion\\": \\"2.2.9.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"MasterDiskSize\\": 0,\\n \\"MasterDiskType\\": \\"cloud_efficiency\\",\\n \\"NeedUpgrade\\": false,\\n \\"IsMultiModel\\": true,\\n \\"AutoRenewal\\": false,\\n \\"ClusterType\\": \\"cluster\\",\\n \\"ResourceGroupId\\": \\"rg-acfmyiu4ekp****\\",\\n \\"ClusterName\\": \\"testhbase\\",\\n \\"ZoneId\\": \\"cn-hangzhou-f\\",\\n \\"Duration\\": 12,\\n \\"ModuleStackVersion\\": \\"phoenxi:4.0\\",\\n \\"Engine\\": \\"hbaseue\\",\\n \\"MajorVersion\\": \\"2.0\\",\\n \\"CoreDiskCount\\": \\"4\\",\\n \\"TaskProgress\\": \\"25.00\\",\\n \\"TaskStatus\\": \\"running\\",\\n \\"CoreNodeCount\\": 2,\\n \\"EnableHbaseProxy\\": false,\\n \\"LproxyMinorVersion\\": \\"2.3.2\\",\\n \\"NeedUpgradeComps\\": {\\n \\"Comps\\": [\\n \\"[lindorm, hdfs]\\"\\n ]\\n },\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"test_key\\",\\n \\"Value\\": \\"test_value\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeInstanceType' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'InstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-t4naqsay5gn******',
- ],
+ 'schema' => ['description' => 'The instance specification name. For more information, see [Instance node specifications](~~194870~~).'."\n"
+ .'> If InstanceType is left empty, all instance specifications are returned.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'hbase.n2.4xlarge', 'title' => ''],
],
],
'responses' => [
@@ -6433,55 +4274,72 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'PreferredBackupEndTimeUTC' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '18:00Z',
- ],
- 'BackupRetentionPeriod' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '94AC38B6-7C6D-45B2-BC03-B8750071A482',
- ],
- 'PreferredBackupPeriod' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Friday',
- ],
- 'PreferredBackupTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '01:00-02:00',
- ],
- 'PreferredBackupStartTimeUTC' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD23BBB4-64C2-42A4-B2E2-7E56C7AA815A', 'title' => ''],
+ 'InstanceTypeSpecList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'InstanceTypeSpec' => [
+ 'description' => 'The list of instance specifications.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceType' => ['description' => 'The instance specification name.', 'type' => 'string', 'example' => 'hbase.n2.4xlarge', 'title' => ''],
+ 'CpuSize' => ['description' => 'The number of CPU cores.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''],
+ 'MemSize' => ['description' => 'The memory size. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '16', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => '17:00Z',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"PreferredBackupEndTimeUTC\\": \\"18:00Z\\",\\n \\"BackupRetentionPeriod\\": \\"10\\",\\n \\"RequestId\\": \\"94AC38B6-7C6D-45B2-BC03-B8750071A482\\",\\n \\"PreferredBackupPeriod\\": \\"Friday\\",\\n \\"PreferredBackupTime\\": \\"01:00-02:00\\",\\n \\"PreferredBackupStartTimeUTC\\": \\"17:00Z\\"\\n}","errorExample":""},{"type":"xml","example":"<PreferredBackupPeriod>Friday</PreferredBackupPeriod>\\n<PreferredBackupStartTimeUTC>17:00Z</PreferredBackupStartTimeUTC>\\n<PreferredBackupEndTimeUTC>18:00Z</PreferredBackupEndTimeUTC>\\n<RequestId>94AC38B6-7C6D-45B2-BC03-B8750071A482</RequestId>\\n<PreferredBackupTime>01:00-02:00</PreferredBackupTime>\\n<BackupRetentionPeriod>10</BackupRetentionPeriod>","errorExample":""}]',
- 'title' => 'DescribeBackupPolicy',
+ 'title' => 'Query instance specifications (CPU and memory)',
+ 'summary' => 'Queries instance specifications (CPU and memory) by calling DescribeInstanceType.',
+ 'description' => 'The complete specification mapping table is based on the list returned by this operation.'."\n"
+ ."\n"
+ .'If the response returns an "instanceType is not found" error, the specification has been deprecated. If you have a strong dependency on this specification, contact the Alibaba Cloud HBase management team.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeBackups' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:37:16.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeInstanceType',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DD23BBB4-64C2-42A4-B2E2-7E56C7AA815A\\",\\n \\"InstanceTypeSpecList\\": {\\n \\"InstanceTypeSpec\\": [\\n {\\n \\"InstanceType\\": \\"hbase.n2.4xlarge\\",\\n \\"CpuSize\\": 8,\\n \\"MemSize\\": 16\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeInstances' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6489,90 +4347,70 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-t4naqsay5gn****',
- ],
+ 'schema' => ['description' => 'The ID of the region to which the instance belongs. You can call the [DescribeRegions](~~144489~~) operation to query the region ID.'."\n"
+ ."\n"
+ .'> If you specify the **Tag.N.Key** and **Tag.N.Value** parameters, this parameter is required.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'BackupId',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'job-xxxx',
- ],
+ 'schema' => ['description' => 'The page number of the instance list. Minimum value: **1**. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The maximum number of rows to display per page. Maximum value: **100**. Default value: **10**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'DbType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The service type. Valid values:'."\n"
+ .'- **hbase**: ApsaraDB for HBase Standard Edition or ApsaraDB for HBase single-node.'."\n"
+ .'- **hbaseue**: ApsaraDB for HBase Performance-enhanced Edition.'."\n"
+ .'- **bds**: BDS data synchronization service.', 'type' => 'string', 'required' => false, 'example' => 'hbase', 'title' => ''],
],
[
- 'name' => 'StartTime',
+ 'name' => 'ClusterName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2020-12-13 00:00:00',
- ],
+ 'schema' => ['description' => 'The name of the ApsaraDB for HBase instance.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
- 'name' => 'EndTime',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2020-12-23 23:59:59',
- ],
+ 'schema' => ['description' => 'The ID of target instance. You can call the [DescribeInstances](~~144595~~) operation to query target instance ID.', 'type' => 'string', 'required' => false, 'example' => 'hb-bp1u0639js2h7****', 'title' => ''],
],
[
- 'name' => 'StartTimeUTC',
+ 'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2020-12-12T16:00:00Z',
- ],
+ 'schema' => ['description' => 'The ID of the resource group. You can query the resource group ID in the Resource Group console.', 'type' => 'string', 'required' => false, 'example' => 'rg-4f51d54g5****', 'title' => ''],
],
[
- 'name' => 'EndTimeUTC',
+ 'name' => 'Tag',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The list of tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The key of the tag. The tag key and tag value form a key-value pair in the format of {"key1":"value1","key2":"value2"}.', 'type' => 'string', 'required' => false, 'example' => 'key', 'title' => ''],
+ 'Value' => ['description' => 'The value of the tag key. The tag value and tag key form a key-value pair.', 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '2020-12-23T15:59:59Z',
+ 'maxItems' => 21,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -6581,129 +4419,190 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'EnableStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'enable',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'A93CE373-0FDE-4CCB-9DBA-6700906825ED',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Backups' => [
+ 'PageSize' => ['description' => 'The maximum number of rows displayed per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EBECBF12-2E34-41BE-8DE9-FC3700D4****', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number of the instance list.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int64', 'example' => '18', 'title' => ''],
+ 'Instances' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'Backup' => [
- 'description' => '',
+ 'Instance' => [
+ 'description' => 'The list of ApsaraDB for HBase instances.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'BackupStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'BackupStartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-12-23 17:25:08',
- ],
- 'BackupType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F',
- ],
- 'BackupDownloadURL' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => ' 1',
- ],
- 'BackupStartTimeUTC' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-12-23T09:25:08Z',
- ],
- 'BackupEndTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-12-23 17:25:24',
- ],
- 'BackupDBNames' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => ' 1',
- ],
- 'BackupId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '511876087',
- ],
- 'BackupEndTimeUTC' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-12-23T09:25:24Z',
- ],
- 'BackupSize' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0.00',
- ],
- 'BackupMode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'BackupMethod' => [
+ 'VpcId' => ['description' => 'The VPC ID. This parameter is returned when **NetworkType** is **2**.', 'type' => 'string', 'example' => 'vpc-bp120k6ixs4eoghz*****', 'title' => ''],
+ 'Status' => ['description' => 'The instance status. Valid values:'."\n"
+ ."\n"
+ .'- **CREATING**: being created.'."\n"
+ .'- **ACTIVATION**: running.'."\n"
+ .'- **DELETING**: being deleted.'."\n"
+ .'- **RESTARTING**: being restarted.'."\n"
+ .'- **MINOR_VERSION_TRANSING**: undergoing a minor engine version update.', 'type' => 'string', 'example' => 'ACTIVATION', 'title' => ''],
+ 'ModuleId' => ['description' => 'The module ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'VswitchId' => ['description' => 'The vSwitch ID. This parameter is returned when **NetworkType** is **2**.', 'type' => 'string', 'example' => 'vsw-bp191ipotq****dbqf', 'title' => ''],
+ 'BackupStatus' => ['description' => 'Indicates whether the backup feature is supported. Valid values:'."\n"
+ ."\n"
+ .'- **open**: The backup feature is supported.'."\n"
+ .'- **close**: The backup feature is not supported.', 'type' => 'string', 'example' => 'open', 'title' => ''],
+ 'PayType' => ['description' => 'The billing method of the instance. Valid values:'."\n"
+ ."\n"
+ .'- **Prepaid**: subscription.'."\n"
+ .'- **Postpaid**: pay-as-you-go.', 'type' => 'string', 'example' => 'Prepaid', 'title' => ''],
+ 'CoreDiskType' => ['description' => 'The disk type of core nodes. Valid values:'."\n"
+ ."\n"
+ .'- **cloud_efficiency**: ultra cloud disk.'."\n"
+ .'- **cloud_ssd**: standard SSD.'."\n"
+ .'- **local_hdd**: local HDD.'."\n"
+ .'- **local__ssd**: local SSD.', 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''],
+ 'MasterNodeCount' => ['description' => 'The master node type. Valid values:'."\n"
+ ."\n"
+ .'- **0**: The master node is a single node.'."\n"
+ .'- **2**: The master node is in Cluster Edition.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'NetworkType' => ['description' => 'The network type. Valid values:'."\n"
+ ."\n"
+ .'- **VPC**: VPC. If the network type is VPC, the VswitchId and VpcId parameters are returned.'."\n"
+ .'- **CLASSIC**: classic network.', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
+ 'CreatedTimeUTC' => ['description' => 'The time when the instance was created, in UTC format.', 'type' => 'string', 'example' => '2019-09-12T14:40:46Z', 'title' => ''],
+ 'ParentId' => ['description' => 'The parent instance ID.', 'type' => 'string', 'example' => '2980****2123', 'title' => ''],
+ 'ExpireTimeUTC' => ['description' => 'The time when the instance expires, in UTC format.', 'type' => 'string', 'example' => '2019-10-12T14:40:46Z', 'title' => ''],
+ 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'MasterInstanceType' => ['description' => 'The node specifications of the master node.', 'type' => 'string', 'example' => 'hbase.sn1.large', 'title' => ''],
+ 'CoreInstanceType' => ['description' => 'The node specifications of the core node.', 'type' => 'string', 'example' => 'hbase.sn1.large', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2019-09-12T14:40:46', 'title' => ''],
+ 'CoreDiskSize' => ['description' => 'The disk capacity of the core node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'ClusterId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'hb-bp1u0639js2h7****', 'title' => ''],
+ 'ExpireTime' => ['description' => 'The time when the instance expires.', 'type' => 'string', 'example' => '2019-10-12T14:40:46', 'title' => ''],
+ 'IsHa' => ['description' => 'Indicates whether the instance is configured for high availability. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The instance is configured for high availability.'."\n"
+ .'- **false**: The instance is not configured for high availability.'."\n"
+ ."\n"
+ .'> Cluster Edition instances use default configurations for high availability and use two master nodes. Single-node instances are configured with the actual active capacity.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'hb-bp1u0639js2h7****', 'title' => ''],
+ 'ColdStorageStatus' => ['description' => 'Indicates whether the cold storage feature is supported. Valid values:'."\n"
+ ."\n"
+ .'- **open**: The cold storage feature is supported.'."\n"
+ .'- **close**: The cold storage feature is not supported.', 'type' => 'string', 'example' => 'open', 'title' => ''],
+ 'IsDeletionProtection' => ['description' => 'Indicates whether deletion protection is enabled. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Deletion protection is enabled.'."\n"
+ .'- **false**: Deletion protection is not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RegionId' => ['description' => 'The ID of the region to which the instance belongs.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'MasterDiskSize' => ['description' => 'The disk capacity of the master node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'MasterDiskType' => ['description' => 'The disk type of the master node. Valid values:'."\n"
+ ."\n"
+ .'- **cloud_efficiency**: ultra cloud disk.'."\n"
+ .'- **cloud_ssd**: standard SSD.'."\n"
+ ."\n"
+ .'> This parameter is returned for single-node instances.', 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''],
+ 'AutoRenewal' => ['description' => 'Indicates whether auto-renewal is enabled for the instance. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Auto-renewal is enabled.'."\n"
+ .'- **false**: Manual renewal is required.'."\n"
+ ."\n"
+ .'> This parameter is returned only when the billing method of the instance is subscription.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'ClusterType' => ['description' => 'The instance type. Valid values:'."\n"
+ ."\n"
+ .'- **cluster**: Cluster Edition.'."\n"
+ .'- **single**: single-node.', 'type' => 'string', 'example' => 'cluster', 'title' => ''],
+ 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-4f51d54g5****', 'title' => ''],
+ 'ClusterName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-f', 'title' => ''],
+ 'Duration' => ['description' => 'The Unified Auto Renewal Cycle. Valid values:'."\n"
+ .'- **Monthly subscription**: The auto-renewal epoch is 1 month.'."\n"
+ .'- **Yearly subscription**: The auto-renewal epoch is 1 year (12 months).'."\n"
+ ."\n"
+ .'> This parameter is returned only when the billing method of the instance is subscription.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''],
+ 'ModuleStackVersion' => ['description' => 'The module type version.', 'type' => 'string', 'example' => '1.0', 'title' => ''],
+ 'Engine' => ['description' => 'The database engine type. Valid values:'."\n"
+ ."\n"
+ .'- **hbase**: ApsaraDB for HBase Standard Edition or ApsaraDB for HBase single-node.'."\n"
+ .'- **hbaseue**: ApsaraDB for HBase Performance-enhanced Edition.'."\n"
+ .'- **serverlesshbase**: ApsaraDB for HBase Serverless Edition.'."\n"
+ .'- **bds**: BDS instance.', 'type' => 'string', 'example' => 'hbase', 'title' => ''],
+ 'MajorVersion' => ['description' => 'The major version number.', 'type' => 'string', 'example' => '2.0', 'title' => ''],
+ 'CoreDiskCount' => ['description' => 'The number of core node disks.', 'type' => 'string', 'example' => '2', 'title' => ''],
+ 'CoreNodeCount' => ['description' => 'The number of core nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'Tags' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Tag' => [
+ 'description' => 'The resource tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'test-key', 'title' => ''],
+ 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'test-value', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'P',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"EnableStatus\\": \\"enable\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"A93CE373-0FDE-4CCB-9DBA-6700906825ED\\",\\n \\"TotalCount\\": 1,\\n \\"Backups\\": {\\n \\"Backup\\": [\\n {\\n \\"BackupStatus\\": \\"0\\",\\n \\"BackupStartTime\\": \\"2020-12-23 17:25:08\\",\\n \\"BackupType\\": \\"F\\",\\n \\"BackupDownloadURL\\": \\" 1\\",\\n \\"BackupStartTimeUTC\\": \\"2020-12-23T09:25:08Z\\",\\n \\"BackupEndTime\\": \\"2020-12-23 17:25:24\\",\\n \\"BackupDBNames\\": \\" 1\\",\\n \\"BackupId\\": 511876087,\\n \\"BackupEndTimeUTC\\": \\"2020-12-23T09:25:24Z\\",\\n \\"BackupSize\\": \\"0.00\\",\\n \\"BackupMode\\": \\"0\\",\\n \\"BackupMethod\\": \\"P\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<TotalCount>1</TotalCount>\\n<RequestId>A93CE373-0FDE-4CCB-9DBA-6700906825ED</RequestId>\\n<PageSize>10</PageSize>\\n<PageNumber>1</PageNumber>\\n<EnableStatus>enable</EnableStatus>\\n<Backups>\\n <Backup>\\n <BackupMethod>P</BackupMethod>\\n <BackupDownloadURL/>\\n <BackupEndTime>2020-12-23 17:25:24</BackupEndTime>\\n <BackupMode>0</BackupMode>\\n <BackupSize>0.00</BackupSize>\\n <BackupStartTime>2020-12-23 17:25:08</BackupStartTime>\\n <BackupEndTimeUTC>2020-12-23T09:25:24Z</BackupEndTimeUTC>\\n <BackupId>511876087</BackupId>\\n <BackupType>F</BackupType>\\n <BackupStartTimeUTC>2020-12-23T09:25:08Z</BackupStartTimeUTC>\\n <BackupDBNames/>\\n <BackupStatus>0</BackupStatus>\\n </Backup>\\n</Backups>","errorExample":""}]',
- 'title' => 'DescribeBackups',
+ 'title' => 'DescribeInstances',
+ 'summary' => 'Queries the list of ApsaraDB for HBase instances in a specified region by calling DescribeInstances.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeBackupStatus' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-08T02:57:34.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-12-07T09:10:53.000Z', 'description' => 'Request parameters changed, Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstances'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"EBECBF12-2E34-41BE-8DE9-FC3700D4****\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 18,\\n \\"Instances\\": {\\n \\"Instance\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp120k6ixs4eoghz*****\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"ModuleId\\": 0,\\n \\"VswitchId\\": \\"vsw-bp191ipotq****dbqf\\",\\n \\"BackupStatus\\": \\"open\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"CoreDiskType\\": \\"cloud_efficiency\\",\\n \\"MasterNodeCount\\": 2,\\n \\"NetworkType\\": \\"VPC\\",\\n \\"CreatedTimeUTC\\": \\"2019-09-12T14:40:46Z\\",\\n \\"ParentId\\": \\"2980****2123\\",\\n \\"ExpireTimeUTC\\": \\"2019-10-12T14:40:46Z\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"MasterInstanceType\\": \\"hbase.sn1.large\\",\\n \\"CoreInstanceType\\": \\"hbase.sn1.large\\",\\n \\"CreatedTime\\": \\"2019-09-12T14:40:46\\",\\n \\"CoreDiskSize\\": 100,\\n \\"ClusterId\\": \\"hb-bp1u0639js2h7****\\",\\n \\"ExpireTime\\": \\"2019-10-12T14:40:46\\",\\n \\"IsHa\\": true,\\n \\"InstanceId\\": \\"hb-bp1u0639js2h7****\\",\\n \\"ColdStorageStatus\\": \\"open\\",\\n \\"IsDeletionProtection\\": true,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"MasterDiskSize\\": 100,\\n \\"MasterDiskType\\": \\"cloud_efficiency\\",\\n \\"AutoRenewal\\": false,\\n \\"ClusterType\\": \\"cluster\\",\\n \\"ResourceGroupId\\": \\"rg-4f51d54g5****\\",\\n \\"ClusterName\\": \\"test\\",\\n \\"ZoneId\\": \\"cn-hangzhou-f\\",\\n \\"Duration\\": 12,\\n \\"ModuleStackVersion\\": \\"1.0\\",\\n \\"Engine\\": \\"hbase\\",\\n \\"MajorVersion\\": \\"2.0\\",\\n \\"CoreDiskCount\\": \\"2\\",\\n \\"CoreNodeCount\\": 2,\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"test-key\\",\\n \\"Value\\": \\"test-value\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeIpWhitelist' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6711,20 +4610,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-m5eznlga4k5bcxxxx',
- ],
+ 'schema' => ['description' => 'The ID of the instance that you want to query. You can call [DescribeInstances](~~144595~~) to obtain the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp150tns0sjxs****', 'title' => ''],
],
],
'responses' => [
@@ -6732,88 +4623,101 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F7E71430-A825-470A-B40B-DF3F3AAC9BEE',
- ],
- 'BdsClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'bds-m5e54q06ceyhxxxx',
- ],
- 'BackupStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'opened',
- ],
- 'ClusterId' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'AFAA617B-3268-5883-982B-DB8EC8CC1F1B', 'title' => ''],
+ 'Groups' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Group' => [
+ 'description' => 'The list of IP whitelist groups.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'IpVersion' => ['description' => 'The type of the IP address. Valid values:'."\n"
+ ."\n"
+ .'- **4**: IPv4.'."\n"
+ .'- **6**: IPv6.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
+ 'GroupName' => ['description' => 'The name of the whitelist group.', 'type' => 'string', 'example' => 'default', 'title' => ''],
+ 'IpList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Ip' => [
+ 'description' => 'The list of IP addresses in the whitelist group.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The whitelisted IP address of the instance.', 'type' => 'string', 'example' => '116.62.XX.XX/24', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'ld-m5eznlga4k5bcxxxx',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F7E71430-A825-470A-B40B-DF3F3AAC9BEE\\",\\n \\"BdsClusterId\\": \\"bds-m5e54q06ceyhxxxx\\",\\n \\"BackupStatus\\": \\"opened\\",\\n \\"ClusterId\\": \\"ld-m5eznlga4k5bcxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>F7E71430-A825-470A-B40B-DF3F3AAC9BEE</RequestId>\\n<BdsClusterId>bds-m5e54q06ceyhxxxx</BdsClusterId>\\n<ClusterId>ld-m5eznlga4k5bcxxxx</ClusterId>\\n<BackupStatus>opened</BackupStatus>","errorExample":""}]',
- 'title' => 'DescribeBackupStatus',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeBackupSummary' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Retrieve cluster IP whitelist by cluster ID',
+ 'summary' => 'Retrieves the IP whitelist information of a cluster by cluster ID.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIpWhitelist'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeIpWhitelist',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFAA617B-3268-5883-982B-DB8EC8CC1F1B\\",\\n \\"Groups\\": {\\n \\"Group\\": [\\n {\\n \\"IpVersion\\": 4,\\n \\"GroupName\\": \\"default\\",\\n \\"IpList\\": {\\n \\"Ip\\": [\\n \\"116.62.XX.XX/24\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeMultiZoneAvailableRegions' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'operationType' => 'read',
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp169l540vc6c****',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
+ 'name' => 'AcceptLanguage',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The supported language. Valid values:'."\n"
+ .'- zh-CN: Chinese (default)'."\n"
+ .'- en-US: English'."\n"
+ .'- ja: Japanese.', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''],
],
],
'responses' => [
@@ -6821,204 +4725,134 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '168793CB-7B31-43E7-ADAB-FE3E8D584D6E',
- ],
- 'Incr' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'RUNNING',
- ],
- 'Speed' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0.00 MB/s',
- ],
- 'Pos' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-05T01:20:31Z',
- ],
- 'QueueLogNum' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'BackupLogSize' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '266 B',
- ],
- 'RunningLogNum' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
- ],
- ],
- 'Full' => [
- 'description' => '',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F03BB273-45EE-4B6C-A329-A6E6A8D15856', 'title' => ''],
+ 'Regions' => [
'type' => 'object',
+ 'itemNode' => true,
'properties' => [
- 'HasMore' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'false',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Total' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'NextFullBackupDate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-09T18:00:00Z',
- ],
- 'Records' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Record' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
+ 'Region' => [
+ 'description' => 'The collection of available regions.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionEndpoint' => ['description' => 'The endpoint of the region.', 'type' => 'string', 'example' => 'hbase.aliyuncs.com', 'title' => ''],
+ 'LocalName' => ['description' => 'The name of the region, returned in the specified language.', 'type' => 'string', 'example' => '华南1(深圳)', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shenzhen', 'title' => ''],
+ 'AvailableCombines' => [
'type' => 'object',
+ 'itemNode' => true,
'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'FinishTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-02T18:02:04Z',
- ],
- 'Process' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1/1',
- ],
- 'DataSize' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1.2 kB',
- ],
- 'Speed' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0.00 MB/s',
- ],
- 'RecordId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20201103020000',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-02T18:00:00Z',
+ 'AvailableCombine' => [
+ 'description' => 'The available zone combinations.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'The ID of the zone combination.', 'type' => 'string', 'example' => 'cn-shenzhen-****-aliyun', 'title' => ''],
+ 'Zones' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Zone' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'The zone combination.', 'type' => 'string', 'example' => 'cn-shenzhen-a,cn-shenzhen-b,cn-shenzhen-c', 'title' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"168793CB-7B31-43E7-ADAB-FE3E8D584D6E\\",\\n \\"Incr\\": {\\n \\"Status\\": \\"RUNNING\\",\\n \\"Speed\\": \\"0.00 MB/s\\",\\n \\"Pos\\": \\"2020-11-05T01:20:31Z\\",\\n \\"QueueLogNum\\": \\"0\\",\\n \\"BackupLogSize\\": \\"266 B\\",\\n \\"RunningLogNum\\": \\"2\\"\\n },\\n \\"Full\\": {\\n \\"HasMore\\": \\"false\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 2,\\n \\"NextFullBackupDate\\": \\"2020-11-09T18:00:00Z\\",\\n \\"Records\\": {\\n \\"Record\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"FinishTime\\": \\"2020-11-02T18:02:04Z\\",\\n \\"Process\\": \\"1/1\\",\\n \\"DataSize\\": \\"1.2 kB\\",\\n \\"Speed\\": \\"0.00 MB/s\\",\\n \\"RecordId\\": \\"20201103020000\\",\\n \\"CreateTime\\": \\"2020-11-02T18:00:00Z\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>168793CB-7B31-43E7-ADAB-FE3E8D584D6E</RequestId>\\n<Incr>\\n <Status>RUNNING</Status>\\n <Speed>0.00 MB/s</Speed>\\n <Pos>2020-11-05T01:20:31Z</Pos>\\n <BackupLogSize>266 B</BackupLogSize>\\n <QueueLogNum>0</QueueLogNum>\\n <RunningLogNum>2</RunningLogNum>\\n</Incr>\\n<Full>\\n <HasMore>false</HasMore>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <NextFullBackupDate>2020-11-09T18:00:00Z</NextFullBackupDate>\\n <Total>2</Total>\\n <Records>\\n <Record>\\n <Status>SUCCESS</Status>\\n <Speed>0.00 MB/s</Speed>\\n <FinishTime>2020-11-02T18:02:04Z</FinishTime>\\n <CreateTime>2020-11-02T18:00:00Z</CreateTime>\\n <DataSize>1.2 kB</DataSize>\\n <Process>1/1</Process>\\n <RecordId>20201103020000</RecordId>\\n </Record>\\n <Record>\\n <Status>SUCCESS</Status>\\n <Speed>0.00 MB/s</Speed>\\n <FinishTime>2020-10-26T18:02:03Z</FinishTime>\\n <CreateTime>2020-10-26T18:00:00Z</CreateTime>\\n <DataSize>1.2 kB</DataSize>\\n <Process>1/1</Process>\\n <RecordId>20201027020000</RecordId>\\n </Record>\\n </Records>\\n</Full>","errorExample":""}]',
- 'title' => 'DescribeBackupSummary',
+ 'title' => 'Query available region and zone combinations for multi-zone deployment',
+ 'summary' => 'Queries the available region and zone combinations for multi-zone deployment by calling DescribeMultiZoneAvailableRegions.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeBackupTables' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:56:05.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeMultiZoneAvailableRegions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F03BB273-45EE-4B6C-A329-A6E6A8D15856\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionEndpoint\\": \\"hbase.aliyuncs.com\\",\\n \\"LocalName\\": \\"华南1(深圳)\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"AvailableCombines\\": {\\n \\"AvailableCombine\\": [\\n {\\n \\"Id\\": \\"cn-shenzhen-****-aliyun\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n \\"cn-shenzhen-a,cn-shenzhen-b,cn-shenzhen-c\\"\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeMultiZoneAvailableResource' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-m5eznlga4k5bcxxxx',
- ],
- ],
- [
- 'name' => 'BackupRecordId',
+ 'name' => 'ChargeType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2020110302xxxx',
- ],
+ 'schema' => ['description' => 'The billing method. Valid values:'."\n"
+ .'- Prepaid: subscription.'."\n"
+ .'- Postpaid: pay-as-you-go.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Prepaid', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'ZoneCombination',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The zone combination. If this parameter is not specified, all zone combinations in the region are queried.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-bef-aliyun', 'title' => ''],
],
],
'responses' => [
@@ -7026,201 +4860,258 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '01262E9C-B0CC-4663-82FA-D50173649F92',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Total' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Tables' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Table' => [
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default:test1',
- ],
- ],
- ],
- ],
- 'BackupRecords' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B2EEBBA9-C627-4415-81A0-B77BC54F1D52', 'title' => ''],
+ 'AvailableZones' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'BackupRecord' => [
- 'description' => '',
+ 'AvailableZone' => [
+ 'description' => 'The collection of resource information in available zones.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'EndTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-02T18:00:05Z',
- ],
- 'StartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-02T18:00:00Z',
- ],
- 'Process' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '14/14',
- ],
- 'DataSize' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1.2 kB',
- ],
- 'Speed' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0.00 MB/s',
- ],
- 'State' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCEEDED',
- ],
- 'Message' => [
+ 'ZoneCombination' => ['description' => 'The zone combination.', 'type' => 'string', 'example' => 'cn-hangzhou-bef-aliyun', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'MasterResources' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'MasterResource' => [
+ 'description' => 'The resource information of master nodes.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceType' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'hbase.sn2.large', 'title' => ''],
+ 'InstanceTypeDetail' => [
+ 'description' => 'The instance type details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Mem' => ['description' => 'The memory size. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''],
+ 'Cpu' => ['description' => 'The number of CPUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'null',
+ 'title' => '',
+ 'example' => '',
],
- 'Table' => [
+ 'SupportedEngines' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SupportedEngine' => [
+ 'description' => 'The list of supported engine types. Currently, only hbaseue is supported.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Engine' => ['description' => 'The supported engine type. Currently, only hbaseue is supported.', 'type' => 'string', 'example' => 'hbaseue', 'title' => ''],
+ 'SupportedEngineVersions' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SupportedEngineVersion' => [
+ 'description' => 'The list of supported engine versions.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Version' => ['description' => 'The engine version. Currently, only hbaseue 2.0 is supported.', 'type' => 'string', 'example' => '2.0', 'title' => ''],
+ 'SupportedCategories' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SupportedCategories' => [
+ 'description' => 'The list of supported categories.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Category' => ['description' => 'The category. Currently, only the cluster edition is supported.', 'type' => 'string', 'example' => 'cluster', 'title' => ''],
+ 'SupportedStorageTypes' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SupportedStorageType' => [
+ 'description' => 'The list of supported storage types.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'StorageType' => ['description' => 'The cloud disk type.', 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''],
+ 'CoreResources' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'CoreResource' => [
+ 'description' => 'The collection of core node resources.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceType' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'hbase.sn2.2xlarge', 'title' => ''],
+ 'MaxCoreCount' => ['description' => 'The maximum number of core nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
+ 'DBInstanceStorageRange' => [
+ 'description' => 'The storage size range.',
+ 'type' => 'object',
+ 'properties' => [
+ 'MaxSize' => ['description' => 'The maximum storage size. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '64000', 'title' => ''],
+ 'StepSize' => ['description' => 'The minimum step size for each increment. Unit: GB. The value for each increment must be a multiple of the step size.', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''],
+ 'MinSize' => ['description' => 'The minimum storage size. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'InstanceTypeDetail' => [
+ 'description' => 'The instance type details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Mem' => ['description' => 'The memory size. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''],
+ 'Cpu' => ['description' => 'The number of CPUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'default:test1',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"01262E9C-B0CC-4663-82FA-D50173649F92\\",\\n \\"PageSize\\": 10,\\n \\"Total\\": 1,\\n \\"Tables\\": {\\n \\"Table\\": [\\n \\"default:test1\\"\\n ]\\n },\\n \\"BackupRecords\\": {\\n \\"BackupRecord\\": [\\n {\\n \\"EndTime\\": \\"2020-11-02T18:00:05Z\\",\\n \\"StartTime\\": \\"2020-11-02T18:00:00Z\\",\\n \\"Process\\": \\"14/14\\",\\n \\"DataSize\\": \\"1.2 kB\\",\\n \\"Speed\\": \\"0.00 MB/s\\",\\n \\"State\\": \\"SUCCEEDED\\",\\n \\"Message\\": \\"null\\",\\n \\"Table\\": \\"default:test1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<PageSize>10</PageSize>\\n<RequestId>01262E9C-B0CC-4663-82FA-D50173649F92</RequestId>\\n<BackupRecords>\\n <BackupRecord>\\n <Speed>0.00 MB/s</Speed>\\n <Table>default:test1</Table>\\n <Message>null</Message>\\n <EndTime>2020-11-02T18:00:05Z</EndTime>\\n <State>SUCCEEDED</State>\\n <DataSize>1.2 kB</DataSize>\\n <StartTime>2020-11-02T18:00:00Z</StartTime>\\n <Process>14/14</Process>\\n </BackupRecord>\\n</BackupRecords>\\n<PageNumber>1</PageNumber>\\n<Total>1</Total>\\n<Tables>\\n <Table>default:test1</Table>\\n</Tables>","errorExample":""}]',
- 'title' => 'DescribeBackupTables',
+ 'title' => 'Query multi-zone available resources',
+ 'summary' => 'Queries purchasable resources in multiple zones by calling DescribeMultiZoneAvailableResource.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeRecoverableTimeRange' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMultiZoneAvailableResource'],
],
],
- 'operationType' => 'readAndWrite',
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-m5eznlga4k5bcxxxx',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'TimeBegin' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-10-26T18:02:03Z',
- ],
- 'TimeEnd' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-05T01:20:31Z',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'A1A51D18-96DC-465C-9F1B-47180CA22524',
- ],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeMultiZoneAvailableResource',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TimeBegin\\": \\"2020-10-26T18:02:03Z\\",\\n \\"TimeEnd\\": \\"2020-11-05T01:20:31Z\\",\\n \\"RequestId\\": \\"A1A51D18-96DC-465C-9F1B-47180CA22524\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>A1A51D18-96DC-465C-9F1B-47180CA22524</RequestId>\\n<TimeEnd>2020-11-05T01:20:31Z</TimeEnd>\\n<TimeBegin>2020-10-26T18:02:03Z</TimeBegin>","errorExample":""}]',
- 'title' => 'DescribeRecoverableTimeRange',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B2EEBBA9-C627-4415-81A0-B77BC54F1D52\\",\\n \\"AvailableZones\\": {\\n \\"AvailableZone\\": [\\n {\\n \\"ZoneCombination\\": \\"cn-hangzhou-bef-aliyun\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"MasterResources\\": {\\n \\"MasterResource\\": [\\n {\\n \\"InstanceType\\": \\"hbase.sn2.large\\",\\n \\"InstanceTypeDetail\\": {\\n \\"Mem\\": 16,\\n \\"Cpu\\": 4\\n }\\n }\\n ]\\n },\\n \\"SupportedEngines\\": {\\n \\"SupportedEngine\\": [\\n {\\n \\"Engine\\": \\"hbaseue\\",\\n \\"SupportedEngineVersions\\": {\\n \\"SupportedEngineVersion\\": [\\n {\\n \\"Version\\": \\"2.0\\",\\n \\"SupportedCategories\\": {\\n \\"SupportedCategories\\": [\\n {\\n \\"Category\\": \\"cluster\\",\\n \\"SupportedStorageTypes\\": {\\n \\"SupportedStorageType\\": [\\n {\\n \\"StorageType\\": \\"cloud_efficiency\\",\\n \\"CoreResources\\": {\\n \\"CoreResource\\": [\\n {\\n \\"InstanceType\\": \\"hbase.sn2.2xlarge\\",\\n \\"MaxCoreCount\\": 30,\\n \\"DBInstanceStorageRange\\": {\\n \\"MaxSize\\": 64000,\\n \\"StepSize\\": 40,\\n \\"MinSize\\": 400\\n },\\n \\"InstanceTypeDetail\\": {\\n \\"Mem\\": 8,\\n \\"Cpu\\": 32\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
- 'CloseBackup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeMultiZoneCluster' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-t4naqsay5gn****',
- ],
+ 'schema' => ['description' => 'The ID of the multi-zone instance. You can call [DescribeInstances](~~144595~~) to obtain the list. The multi-zone instances in the list have the **DbType** of hbaseue and the **ModuleStackVersion** of 2.0.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-t4nn71xa0yn****', 'title' => ''],
],
],
'responses' => [
@@ -7228,52 +5119,194 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
+ 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-t4nx81tmlixcq5****', 'title' => ''],
+ 'EncryptionType' => ['description' => 'The encryption type. Valid values:'."\n"
+ ."\n"
+ .'- NULL: Encryption is not enabled. This is the default value.'."\n"
+ ."\n"
+ .'- CloudDisk: Cloud disk encryption. You can use the **EncryptionKey** parameter to specify the encryption key.'."\n"
+ ."\n\n", 'type' => 'string', 'example' => 'CloudDisk', 'title' => ''],
+ 'ModuleId' => ['description' => 'The module ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'PayType' => ['description' => 'The billing method. Valid values:'."\n"
+ .'- Prepaid: subscription.'."\n"
+ .'- Postpaid: pay-as-you-go.', 'type' => 'string', 'example' => 'Prepaid', 'title' => ''],
+ 'ArbiterVSwitchIds' => ['description' => 'The vSwitch ID of the arbiter zone.', 'type' => 'string', 'example' => 'vsw-t4nax9mp3wk0czn****', 'title' => ''],
+ 'MasterNodeCount' => ['description' => 'The number of master nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A02C0E6D-3A47-4FA0-BA7E-60793CE256DA', 'title' => ''],
+ 'InstanceName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'mz_test', 'title' => ''],
+ 'CoreInstanceType' => ['description' => 'The instance type of core nodes.', 'type' => 'string', 'example' => 'hbase.sn1.large', 'title' => ''],
+ 'EncryptionKey' => ['description' => 'The ID of the encryption key. This parameter is empty if encryption is not enabled.'."\n"
+ ."\n"
+ .'> Cloud disk encryption cannot be disabled after it is enabled.'."\n"
+ ."\n", 'type' => 'string', 'example' => '2a****', 'title' => ''],
+ 'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'ld-t4nn71xa0yn****', 'title' => ''],
+ 'LogNodeCount' => ['description' => 'The number of log nodes. The minimum value is 4, and the value must be a multiple of 4.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
+ 'ExpireTime' => ['description' => 'The expiration time. This parameter is returned for subscription (PayType is Prepaid) instances. The time is in the local time zone.', 'type' => 'string', 'example' => '2020-11-16T08:00:00', 'title' => ''],
+ 'MultiZoneCombination' => ['description' => 'The zone combination of the current multi-zone instance.', 'type' => 'string', 'example' => 'ap-southeast-1-abc-aliyun', 'title' => ''],
+ 'InstanceId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'ld-t4nn71xa0yn****', 'title' => ''],
+ 'IsDeletionProtection' => ['description' => 'Indicates whether deletion protection is enabled. Valid values:'."\n"
+ .'- True: Deletion protection is enabled. The instance cannot be deleted.'."\n"
+ .'- False: Deletion protection is disabled. The instance can be deleted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'MasterDiskSize' => ['description' => 'The disk size of master nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''],
+ 'AutoRenewal' => ['description' => 'Indicates whether auto-renewal is enabled for subscription (Prepaid) multi-zone instances. Valid values:'."\n"
+ .'- True: Auto-renewal is enabled.'."\n"
+ .'- False: Auto-renewal is disabled.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'ClusterName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'mz_test', 'title' => ''],
+ 'Duration' => ['description' => 'The auto-renewal period. This parameter is not returned for pay-as-you-go instances. Valid values:'."\n"
+ .'- Monthly subscription: The auto-renewal period is 1 month.'."\n"
+ .'- Yearly subscription: The auto-renewal period is 1 year (12 months).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ModuleStackVersion' => ['description' => 'The software stack version of the module.', 'type' => 'string', 'example' => '2.0', 'title' => ''],
+ 'MajorVersion' => ['description' => 'The major version of the engine. Currently, only version 2.0 of hbaseue is supported.', 'type' => 'string', 'example' => '2.0', 'title' => ''],
+ 'CoreDiskCount' => ['description' => 'The number of core disk.', 'type' => 'string', 'example' => '4', 'title' => ''],
+ 'Status' => ['description' => 'The cluster status. Valid values:'."\n"
+ .'- CREATING: The cluster is being created.'."\n"
+ .'- ACTIVATION: The cluster is running.'."\n"
+ .'- DELETING: The cluster is being deleted.'."\n"
+ .'- RESTARTING: The cluster is being restarted.', 'type' => 'string', 'example' => 'ACTIVATION', 'title' => ''],
+ 'LogInstanceType' => ['description' => 'The instance type of log nodes. You can call the [DescribeInstanceType](~~145796~~) operation to query the accurate information.', 'type' => 'string', 'example' => 'hbase.sn1.large', 'title' => ''],
+ 'LogDiskSize' => ['description' => 'The size of a single disk of each log node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'CoreDiskType' => ['description' => 'The disk type of core nodes. Valid values:'."\n"
+ .'- cloud_efficiency: ultra disk.'."\n"
+ .'- cloud_ssd: standard SSD.'."\n"
+ .'- local_hdd_pro: throughput-intensive local disk.'."\n"
+ .'- local_ssd_pro: I/O-intensive local disk.', 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''],
+ 'StandbyZoneId' => ['description' => 'The zone ID of the standby zone.', 'type' => 'string', 'example' => 'ap-southeast-1b', 'title' => ''],
+ 'NetworkType' => ['description' => 'The network type. Currently, only VPC is supported.', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
+ 'PrimaryVSwitchIds' => ['description' => 'The vSwitch ID of the primary zone.', 'type' => 'string', 'example' => 'vsw-t4n3s1zd2gtidg****', 'title' => ''],
+ 'CreatedTimeUTC' => ['description' => 'The creation time in UTC.', 'type' => 'string', 'example' => '2020-10-15T10:04:52Z', 'title' => ''],
+ 'ParentId' => ['description' => 'The ID of the parent instance. This parameter is returned if the instance is a module instance.', 'type' => 'string', 'example' => 'ld-fls1gf31y5s35****', 'title' => ''],
+ 'ExpireTimeUTC' => ['description' => 'The expiration time in UTC. This parameter is returned for subscription (PayType is Prepaid) instances.', 'type' => 'string', 'example' => '2020-11-16T00:00:00Z', 'title' => ''],
+ 'LogDiskType' => ['description' => 'The disk type of log nodes. Valid values:'."\n"
+ .'- cloud_efficiency: ultra disk.'."\n"
+ .'- cloud_ssd: standard SSD.'."\n"
+ .'- local_hdd_pro: throughput-intensive local disk.'."\n"
+ .'- local_ssd_pro: I/O-intensive local disk.', 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''],
+ 'MasterInstanceType' => ['description' => 'The instance type of master nodes.', 'type' => 'string', 'example' => 'hbase.sn1.large', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The creation time in the local time zone.', 'type' => 'string', 'example' => '2020-10-15T18:04:52', 'title' => ''],
+ 'CoreDiskSize' => ['description' => 'The disk size of core nodes. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'LogDiskCount' => ['description' => 'The number of disks per log node.', 'type' => 'string', 'example' => '4', 'title' => ''],
+ 'StandbyVSwitchIds' => ['description' => 'The vSwitch ID of the standby zone.', 'type' => 'string', 'example' => 'vsw-t4nvvk7xur3rdi****', 'title' => ''],
+ 'MaintainStartTime' => ['description' => 'The start time of the maintenance window. Format: HH:MM:SS, for example, 02:00:00.', 'type' => 'string', 'example' => '02:00:00', 'title' => ''],
+ 'PrimaryZoneId' => ['description' => 'The zone ID of the primary zone.', 'type' => 'string', 'example' => 'ap-southeast-1a', 'title' => ''],
+ 'MaintainEndTime' => ['description' => 'The end time of the maintenance window. Format: HH:MM:SS, for example, 06:00:00.', 'type' => 'string', 'example' => '06:00:00', 'title' => ''],
+ 'ArbiterZoneId' => ['description' => 'The zone ID of the arbiter zone.', 'type' => 'string', 'example' => 'ap-southeast-1c', 'title' => ''],
+ 'MasterDiskType' => ['description' => 'The disk type of master nodes.', 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'ap-southeast-1', 'title' => ''],
+ 'ResourceGroupId' => ['description' => 'The ID of the resource group to which the resource belongs.', 'type' => 'string', 'example' => 'rg-lk51f5fer315e****', 'title' => ''],
+ 'Engine' => ['description' => 'The engine type. Currently, only hbaseue is supported.', 'type' => 'string', 'example' => 'hbaseue', 'title' => ''],
+ 'TaskProgress' => ['description' => 'The progress of the task running on the instance, in percentage (%). Tasks initiated from the ApsaraDB for HBase console include specification changes, node scale-out, node scale-in, instance restart, and minor version upgrade.', 'type' => 'string', 'example' => '42', 'title' => ''],
+ 'TaskStatus' => ['description' => '- running: The task is running.'."\n"
+ .'- pause: The task is paused.'."\n"
+ .'- fail: The task failed.'."\n"
+ .'- finish: The task is completed.', 'type' => 'string', 'example' => 'running', 'title' => ''],
+ 'CoreNodeCount' => ['description' => 'The number of core nodes. The minimum value is 4, and the increment must be a multiple of 2.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''],
+ 'ColdStorageSize' => ['description' => 'The cold storage size. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '800', 'title' => ''],
+ 'MultiZoneInstanceModels' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'MultiZoneInstanceModel' => [
+ 'description' => 'The information about instances in each zone of the multi-zone instance.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The status of the sub-instance.', 'type' => 'string', 'example' => 'ACTIVATION', 'title' => ''],
+ 'IsLatestVersion' => ['description' => 'Indicates whether the version is the latest.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Role' => ['description' => 'The role of the sub-instance.', 'type' => 'string', 'example' => 'primary', 'title' => ''],
+ 'InsName' => ['description' => 'The name of the sub-instance.', 'type' => 'string', 'example' => 'ld-t4nn71xa0yn****-az-a', 'title' => ''],
+ 'MinorVersion' => ['description' => 'The minor version number of the instance.', 'type' => 'string', 'example' => '2.1.24', 'title' => ''],
+ 'LatestMinorVersion' => ['description' => 'The latest minor version of the wide table engine.', 'type' => 'string', 'example' => '2.6.3', 'title' => ''],
+ 'HdfsMinorVersion' => ['description' => 'The current version number of the storage engine.', 'type' => 'string', 'example' => '4.1.0', 'title' => ''],
+ 'LatestHdfsMinorVersion' => ['description' => 'The latest version number of the storage engine.', 'type' => 'string', 'example' => '4.1.1', 'title' => ''],
+ 'IsHdfsLatestVersion' => ['description' => 'Indicates whether the storage engine is the latest version.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Tags' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Tag' => [
+ 'description' => 'The tags of the cluster.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'test_key', 'title' => ''],
+ 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'test_value', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'F1A11940-0C34-4385-864F-A01E29B55F6A',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F1A11940-0C34-4385-864F-A01E29B55F6A\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>F1A11940-0C34-4385-864F-A01E29B55F6A</RequestId>","errorExample":""}]',
- 'title' => 'CloseBackup',
+ 'title' => 'Query the details of a multi-zone instance',
+ 'summary' => 'You can call this operation to query the details of a multi-zone instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'OpenBackup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-11T13:37:44.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-04-25T12:42:03.000Z', 'description' => 'Response parameters changed, Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeMultiZoneCluster',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"VpcId\\": \\"vpc-t4nx81tmlixcq5****\\",\\n \\"EncryptionType\\": \\"CloudDisk\\",\\n \\"ModuleId\\": 0,\\n \\"PayType\\": \\"Prepaid\\",\\n \\"ArbiterVSwitchIds\\": \\"vsw-t4nax9mp3wk0czn****\\",\\n \\"MasterNodeCount\\": 2,\\n \\"RequestId\\": \\"A02C0E6D-3A47-4FA0-BA7E-60793CE256DA\\",\\n \\"InstanceName\\": \\"mz_test\\",\\n \\"CoreInstanceType\\": \\"hbase.sn1.large\\",\\n \\"EncryptionKey\\": \\"2a****\\",\\n \\"ClusterId\\": \\"ld-t4nn71xa0yn****\\",\\n \\"LogNodeCount\\": 4,\\n \\"ExpireTime\\": \\"2020-11-16T08:00:00\\",\\n \\"MultiZoneCombination\\": \\"ap-southeast-1-abc-aliyun\\",\\n \\"InstanceId\\": \\"ld-t4nn71xa0yn****\\",\\n \\"IsDeletionProtection\\": false,\\n \\"MasterDiskSize\\": 50,\\n \\"AutoRenewal\\": false,\\n \\"ClusterName\\": \\"mz_test\\",\\n \\"Duration\\": 1,\\n \\"ModuleStackVersion\\": \\"2.0\\",\\n \\"MajorVersion\\": \\"2.0\\",\\n \\"CoreDiskCount\\": \\"4\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"LogInstanceType\\": \\"hbase.sn1.large\\",\\n \\"LogDiskSize\\": 100,\\n \\"CoreDiskType\\": \\"cloud_efficiency\\",\\n \\"StandbyZoneId\\": \\"ap-southeast-1b\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"PrimaryVSwitchIds\\": \\"vsw-t4n3s1zd2gtidg****\\",\\n \\"CreatedTimeUTC\\": \\"2020-10-15T10:04:52Z\\",\\n \\"ParentId\\": \\"ld-fls1gf31y5s35****\\",\\n \\"ExpireTimeUTC\\": \\"2020-11-16T00:00:00Z\\",\\n \\"LogDiskType\\": \\"cloud_efficiency\\",\\n \\"MasterInstanceType\\": \\"hbase.sn1.large\\",\\n \\"CreatedTime\\": \\"2020-10-15T18:04:52\\",\\n \\"CoreDiskSize\\": 100,\\n \\"LogDiskCount\\": \\"4\\",\\n \\"StandbyVSwitchIds\\": \\"vsw-t4nvvk7xur3rdi****\\",\\n \\"MaintainStartTime\\": \\"02:00:00\\",\\n \\"PrimaryZoneId\\": \\"ap-southeast-1a\\",\\n \\"MaintainEndTime\\": \\"06:00:00\\",\\n \\"ArbiterZoneId\\": \\"ap-southeast-1c\\",\\n \\"MasterDiskType\\": \\"cloud_efficiency\\",\\n \\"RegionId\\": \\"ap-southeast-1\\",\\n \\"ResourceGroupId\\": \\"rg-lk51f5fer315e****\\",\\n \\"Engine\\": \\"hbaseue\\",\\n \\"TaskProgress\\": \\"42\\",\\n \\"TaskStatus\\": \\"running\\",\\n \\"CoreNodeCount\\": 6,\\n \\"ColdStorageSize\\": 800,\\n \\"MultiZoneInstanceModels\\": {\\n \\"MultiZoneInstanceModel\\": [\\n {\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"IsLatestVersion\\": true,\\n \\"Role\\": \\"primary\\",\\n \\"InsName\\": \\"ld-t4nn71xa0yn****-az-a\\",\\n \\"MinorVersion\\": \\"2.1.24\\",\\n \\"LatestMinorVersion\\": \\"2.6.3\\",\\n \\"HdfsMinorVersion\\": \\"4.1.0\\",\\n \\"LatestHdfsMinorVersion\\": \\"4.1.1\\",\\n \\"IsHdfsLatestVersion\\": \\"true\\"\\n }\\n ]\\n },\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"test_key\\",\\n \\"Value\\": \\"test_value\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeRecoverableTimeRange' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-t4naqsay5gn******',
- ],
+ 'schema' => ['description' => 'The ID of the HBaseue cluster for which you want to query the recoverable time range.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-m5eznlga4k5bcxxxx', 'title' => ''],
],
],
'responses' => [
@@ -7281,104 +5314,72 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C977DF60-7D06-4E34-A27D-8BC696C5112A',
- ],
+ 'TimeBegin' => ['description' => 'The start time of the recoverable time range.', 'type' => 'string', 'example' => '2020-10-26T18:02:03Z', 'title' => ''],
+ 'TimeEnd' => ['description' => 'The end time of the recoverable time range.', 'type' => 'string', 'example' => '2020-11-05T01:20:31Z', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A1A51D18-96DC-465C-9F1B-47180CA22524', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C977DF60-7D06-4E34-A27D-8BC696C5112A\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>C977DF60-7D06-4E34-A27D-8BC696C5112A</RequestId>","errorExample":""}]',
- 'title' => 'OpenBackup',
+ 'errorCodes' => [],
+ 'title' => 'Retrieve the recoverable time range for backup',
+ 'summary' => 'Retrieves the recoverable time range after backup is enabled for an HBaseue cluster.',
+ 'description' => 'Before calling this operation, make sure that the backup and recovery feature is enabled for the HBaseue cluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CreateRestorePlan' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeRecoverableTimeRange',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TimeBegin\\": \\"2020-10-26T18:02:03Z\\",\\n \\"TimeEnd\\": \\"2020-11-05T01:20:31Z\\",\\n \\"RequestId\\": \\"A1A51D18-96DC-465C-9F1B-47180CA22524\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeRegions' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp150tns0sjxs****',
- ],
- ],
- [
- 'name' => 'TargetClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp169l540vc6c****',
- ],
- ],
- [
- 'name' => 'RestoreAllTable',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'RestoreByCopy',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'RestoreToDate',
+ 'name' => 'AcceptLanguage',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2020-11-05T05:49:42Z',
- ],
+ 'schema' => ['description' => 'The supported language. Valid values:'."\n"
+ ."\n"
+ .'- **zh-CN**: Chinese (default)'."\n"
+ .'- **en-US**: English'."\n"
+ .'- **ja**: Japanese.', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''],
],
[
- 'name' => 'Tables',
+ 'name' => 'Engine',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test_ns:test_table/test_ns:test_table2',
- ],
+ 'schema' => ['description' => 'The data engine type. Valid values:'."\n"
+ .'- **hbase**: ApsaraDB for HBase Standard Edition or ApsaraDB for HBase single-node edition.'."\n"
+ .'- **hbaseue**: ApsaraDB for HBase Performance-enhanced Edition.'."\n"
+ .'- **serverlesshbase**: ApsaraDB for HBase Serverless edition.'."\n"
+ .'- **bds**: BDS instance.', 'type' => 'string', 'required' => false, 'example' => 'hbase', 'title' => ''],
],
],
'responses' => [
@@ -7386,27 +5387,83 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '14D3924C-4FD8-4EE9-9B34-DA949D104F42', 'title' => ''],
+ 'Regions' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Region' => [
+ 'description' => 'The list of regions.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionEndpoint' => ['description' => 'The endpoint of the region.', 'type' => 'string', 'example' => 'hbase.aliyuncs.com', 'title' => ''],
+ 'LocalName' => ['description' => 'The name of the region.', 'type' => 'string', 'example' => '华东1(杭州)', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID, such as ap-southeast-1.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'Zones' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Zone' => [
+ 'description' => 'The list of zones.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-b', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'A0598673-EB6E-4F6D-9961-E0F2012090C0',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A0598673-EB6E-4F6D-9961-E0F2012090C0\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateRestorePlanResponse>\\n <RequestId>A0598673-EB6E-4F6D-9961-E0F2012090C0</RequestId>\\n</CreateRestorePlanResponse>","errorExample":""}]',
- 'title' => 'CreateRestorePlan',
- ],
- 'DescribeRestoreFullDetails' => [
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Query available regions',
+ 'summary' => 'Queries available regions by calling DescribeRegions.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:37:16.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14D3924C-4FD8-4EE9-9B34-DA949D104F42\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionEndpoint\\": \\"hbase.aliyuncs.com\\",\\n \\"LocalName\\": \\"华东1(杭州)\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"Id\\": \\"cn-hangzhou-b\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeRestoreFullDetails' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7414,53 +5471,27 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-m5eznlga4k5bcxxxx',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-m5eznlga4k5bcxxxx', 'title' => ''],
],
[
'name' => 'RestoreRecordId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2020110514xxxx',
- ],
+ 'schema' => ['description' => 'The restoration record ID. You can call DescribeRestoreSummary to obtain the ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020110514xxxx', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
@@ -7468,131 +5499,90 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CFE525CF-C691-4140-A981-D004DAA7A840',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CFE525CF-C691-4140-A981-D004DAA7A840', 'title' => ''],
'RestoreFull' => [
- 'description' => '',
+ 'description' => 'The full restoration details.',
'type' => 'object',
'properties' => [
- 'Succeed' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'DataSize' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1.2 kB',
- ],
- 'Speed' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0.00 MB/s',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Fail' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Total' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'Succeed' => ['description' => 'The number of successful restorations.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'DataSize' => ['description' => 'The total data size.', 'type' => 'string', 'example' => '1.2 kB', 'title' => ''],
+ 'Speed' => ['description' => 'The total restoration speed.', 'type' => 'string', 'example' => '0.00 MB/s', 'title' => ''],
+ 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Fail' => ['description' => 'The number of failed restorations.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'RestoreFullDetails' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RestoreFullDetail' => [
- 'description' => '',
+ 'description' => 'The restoration details of a table.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'EndTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-05T06:45:51Z',
- ],
- 'StartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-05T06:45:45Z',
- ],
- 'Process' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '14/14',
- ],
- 'DataSize' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1.2 kB',
- ],
- 'Speed' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0.00 MB/s',
- ],
- 'State' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCEEDED',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'Table' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default:test1',
- ],
+ 'EndTime' => ['description' => 'The completion time.', 'type' => 'string', 'example' => '2020-11-05T06:45:51Z', 'title' => ''],
+ 'StartTime' => ['description' => 'The restoration start time.', 'type' => 'string', 'example' => '2020-11-05T06:45:45Z', 'title' => ''],
+ 'Process' => ['description' => 'The restoration progress.', 'type' => 'string', 'example' => '14/14', 'title' => ''],
+ 'DataSize' => ['description' => 'The data size.', 'type' => 'string', 'example' => '1.2 kB', 'title' => ''],
+ 'Speed' => ['description' => 'The restoration speed.', 'type' => 'string', 'example' => '0.00 MB/s', 'title' => ''],
+ 'State' => ['description' => 'The restoration status.', 'type' => 'string', 'example' => 'SUCCEEDED', 'title' => ''],
+ 'Message' => ['description' => 'The error message. This parameter is returned only when the restoration fails.', 'type' => 'string', 'example' => 'null', 'title' => ''],
+ 'Table' => ['description' => 'The name of the restored table.', 'type' => 'string', 'example' => 'default:test1', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CFE525CF-C691-4140-A981-D004DAA7A840\\",\\n \\"RestoreFull\\": {\\n \\"Succeed\\": 1,\\n \\"DataSize\\": \\"1.2 kB\\",\\n \\"Speed\\": \\"0.00 MB/s\\",\\n \\"PageSize\\": 10,\\n \\"Fail\\": 0,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 1,\\n \\"RestoreFullDetails\\": {\\n \\"RestoreFullDetail\\": [\\n {\\n \\"EndTime\\": \\"2020-11-05T06:45:51Z\\",\\n \\"StartTime\\": \\"2020-11-05T06:45:45Z\\",\\n \\"Process\\": \\"14/14\\",\\n \\"DataSize\\": \\"1.2 kB\\",\\n \\"Speed\\": \\"0.00 MB/s\\",\\n \\"State\\": \\"SUCCEEDED\\",\\n \\"Message\\": \\"null\\",\\n \\"Table\\": \\"default:test1\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RestoreFull>\\n <Speed>0.00 MB/s</Speed>\\n <RestoreFullDetails>\\n <RestoreFullDetail>\\n <Speed>0.00 MB/s</Speed>\\n <Table>default:test1</Table>\\n <Message>null</Message>\\n <EndTime>2020-11-05T06:45:51Z</EndTime>\\n <State>SUCCEEDED</State>\\n <DataSize>1.2 kB</DataSize>\\n <StartTime>2020-11-05T06:45:45Z</StartTime>\\n <Process>14/14</Process>\\n </RestoreFullDetail>\\n </RestoreFullDetails>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Total>1</Total>\\n <DataSize>1.2 kB</DataSize>\\n <Fail>0</Fail>\\n <Succeed>1</Succeed>\\n</RestoreFull>\\n<RequestId>CFE525CF-C691-4140-A981-D004DAA7A840</RequestId>","errorExample":""}]',
- 'title' => 'DescribeRestoreFullDetails',
+ 'title' => 'Query full restoration details',
+ 'summary' => 'Queries the details of a specific full restoration for an HBaseue cluster that has backup and recovery enabled.',
+ 'description' => 'Before calling this operation, make sure that the backup and recovery feature is enabled for the HBaseue cluster and that restoration records exist. You can call DescribeRestoreSummary to obtain restoration records.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeRestoreIncrDetail' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-06T09:46:54.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeRestoreFullDetails',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CFE525CF-C691-4140-A981-D004DAA7A840\\",\\n \\"RestoreFull\\": {\\n \\"Succeed\\": 1,\\n \\"DataSize\\": \\"1.2 kB\\",\\n \\"Speed\\": \\"0.00 MB/s\\",\\n \\"PageSize\\": 10,\\n \\"Fail\\": 0,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 1,\\n \\"RestoreFullDetails\\": {\\n \\"RestoreFullDetail\\": [\\n {\\n \\"EndTime\\": \\"2020-11-05T06:45:51Z\\",\\n \\"StartTime\\": \\"2020-11-05T06:45:45Z\\",\\n \\"Process\\": \\"14/14\\",\\n \\"DataSize\\": \\"1.2 kB\\",\\n \\"Speed\\": \\"0.00 MB/s\\",\\n \\"State\\": \\"SUCCEEDED\\",\\n \\"Message\\": \\"null\\",\\n \\"Table\\": \\"default:test1\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeRestoreIncrDetail' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7600,31 +5590,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-m5eyf188hw481xxxx',
- ],
+ 'schema' => ['description' => 'The ID of the cluster for backup and recovery.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-m5eyf188hw481xxxx', 'title' => ''],
],
[
'name' => 'RestoreRecordId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2020110514xxxx',
- ],
+ 'schema' => ['description' => 'The ID of the restoration record. You can call the DescribeRestoreSummary operation to obtain the ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020110514xxxx', 'title' => ''],
],
],
'responses' => [
@@ -7632,72 +5608,59 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D0FE2717-E194-465A-B27B-7373F96E580B',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D0FE2717-E194-465A-B27B-7373F96E580B', 'title' => ''],
'RestoreIncrDetail' => [
- 'description' => '',
+ 'description' => 'The incremental restoration details.',
'type' => 'object',
'properties' => [
- 'EndTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-05T06:45:44Z',
- ],
- 'StartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-05T06:45:44Z',
- ],
- 'Process' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0/0',
- ],
- 'RestoreStartTs' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-02T18:00:00Z',
- ],
- 'State' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCEEDED',
- ],
- 'RestoredTs' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '\'\'',
- ],
- 'RestoreDelay' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0 ms',
- ],
+ 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2020-11-05T06:45:44Z', 'title' => ''],
+ 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2020-11-05T06:45:44Z', 'title' => ''],
+ 'Process' => ['description' => 'The progress.', 'type' => 'string', 'example' => '0/0', 'title' => ''],
+ 'RestoreStartTs' => ['description' => 'The synchronization start point.', 'type' => 'string', 'example' => '2020-11-02T18:00:00Z', 'title' => ''],
+ 'State' => ['description' => 'The status.', 'type' => 'string', 'example' => 'SUCCEEDED', 'title' => ''],
+ 'RestoredTs' => ['description' => 'The synchronization point.', 'type' => 'string', 'example' => '\'\'', 'title' => ''],
+ 'RestoreDelay' => ['description' => 'The synchronization latency.', 'type' => 'string', 'example' => '0 ms', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0FE2717-E194-465A-B27B-7373F96E580B\\",\\n \\"RestoreIncrDetail\\": {\\n \\"EndTime\\": \\"2020-11-05T06:45:44Z\\",\\n \\"StartTime\\": \\"2020-11-05T06:45:44Z\\",\\n \\"Process\\": \\"0/0\\",\\n \\"RestoreStartTs\\": \\"2020-11-02T18:00:00Z\\",\\n \\"State\\": \\"SUCCEEDED\\",\\n \\"RestoredTs\\": \\"\'\'\\",\\n \\"RestoreDelay\\": \\"0 ms\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>D0FE2717-E194-465A-B27B-7373F96E580B</RequestId>\\n<RestoreIncrDetail>\\n <RestoreDelay>0 ms</RestoreDelay>\\n <EndTime>2020-11-05T06:45:44Z</EndTime>\\n <RestoreStartTs>2020-11-02T18:00:00Z</RestoreStartTs>\\n <State>SUCCEEDED</State>\\n <StartTime>2020-11-05T06:45:44Z</StartTime>\\n <Process>0/0</Process>\\n <RestoredTs>\'\'</RestoredTs>\\n</RestoreIncrDetail>","errorExample":""}]',
- 'title' => 'DescribeRestoreIncrDetail',
+ 'title' => 'Retrieve incremental restoration details',
+ 'summary' => 'Retrieves the details of an incremental restoration by calling the DescribeRestoreIncrDetail operation.',
+ 'description' => 'Before you call this operation, make sure that the backup and recovery feature is enabled for the HBaseue cluster and that restoration records exist. You can call the DescribeRestoreSummary operation to obtain restoration records.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeRestoreIncrDetail',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0FE2717-E194-465A-B27B-7373F96E580B\\",\\n \\"RestoreIncrDetail\\": {\\n \\"EndTime\\": \\"2020-11-05T06:45:44Z\\",\\n \\"StartTime\\": \\"2020-11-05T06:45:44Z\\",\\n \\"Process\\": \\"0/0\\",\\n \\"RestoreStartTs\\": \\"2020-11-02T18:00:00Z\\",\\n \\"State\\": \\"SUCCEEDED\\",\\n \\"RestoredTs\\": \\"\'\'\\",\\n \\"RestoreDelay\\": \\"0 ms\\"\\n }\\n}","type":"json"}]',
],
'DescribeRestoreSchemaDetails' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7705,53 +5668,27 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-m5eznlga4k5bcxxxx',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-m5eznlga4k5bcxxxx', 'title' => ''],
],
[
'name' => 'RestoreRecordId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2020110514xxxx',
- ],
+ 'schema' => ['description' => 'The backup record ID. You can call the DescribeBackupSummary operation to obtain the ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020110514xxxx', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
@@ -7759,148 +5696,107 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'BC682A80-7677-4294-975C-CFEA425381DE',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BC682A80-7677-4294-975C-CFEA425381DE', 'title' => ''],
'RestoreSchema' => [
- 'description' => '',
+ 'description' => 'The schema restoration details.',
'type' => 'object',
'properties' => [
- 'Succeed' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Fail' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Total' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'Succeed' => ['description' => 'The number of successful restorations.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Fail' => ['description' => 'The number of failed restorations.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'RestoreSchemaDetails' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RestoreSchemaDetail' => [
- 'description' => '',
+ 'description' => 'The table restoration details.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'EndTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-05T06:45:18Z',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'StartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-05T06:45:14Z',
- ],
- 'Table' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default:test1',
- ],
- 'State' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCEEDED',
- ],
+ 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2020-11-05T06:45:18Z', 'title' => ''],
+ 'Message' => ['description' => 'The error log returned when an error occurs.', 'type' => 'string', 'example' => 'null', 'title' => ''],
+ 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2020-11-05T06:45:14Z', 'title' => ''],
+ 'Table' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'default:test1', 'title' => ''],
+ 'State' => ['description' => 'The status.', 'type' => 'string', 'example' => 'SUCCEEDED', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC682A80-7677-4294-975C-CFEA425381DE\\",\\n \\"RestoreSchema\\": {\\n \\"Succeed\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Fail\\": 0,\\n \\"Total\\": 1,\\n \\"RestoreSchemaDetails\\": {\\n \\"RestoreSchemaDetail\\": [\\n {\\n \\"EndTime\\": \\"2020-11-05T06:45:18Z\\",\\n \\"Message\\": \\"null\\",\\n \\"StartTime\\": \\"2020-11-05T06:45:14Z\\",\\n \\"Table\\": \\"default:test1\\",\\n \\"State\\": \\"SUCCEEDED\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RestoreSchema>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Total>1</Total>\\n <Fail>0</Fail>\\n <Succeed>1</Succeed>\\n <RestoreSchemaDetails>\\n <RestoreSchemaDetail>\\n <StartTime>2020-11-05T06:45:14Z</StartTime>\\n <Table>default:test1</Table>\\n <Message>null</Message>\\n <EndTime>2020-11-05T06:45:18Z</EndTime>\\n <State>SUCCEEDED</State>\\n </RestoreSchemaDetail>\\n </RestoreSchemaDetails>\\n</RestoreSchema>\\n<RequestId>BC682A80-7677-4294-975C-CFEA425381DE</RequestId>","errorExample":""}]',
'title' => 'DescribeRestoreSchemaDetails',
+ 'summary' => 'Queries the details of schema restoration for an HBaseue cluster that has backup and recovery enabled.',
+ 'description' => 'Before calling this operation, make sure that the backup and recovery feature is enabled for the HBaseue cluster and that restoration records exist.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeRestoreSummary' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-06T09:46:54.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeRestoreSchemaDetails',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC682A80-7677-4294-975C-CFEA425381DE\\",\\n \\"RestoreSchema\\": {\\n \\"Succeed\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Fail\\": 0,\\n \\"Total\\": 1,\\n \\"RestoreSchemaDetails\\": {\\n \\"RestoreSchemaDetail\\": [\\n {\\n \\"EndTime\\": \\"2020-11-05T06:45:18Z\\",\\n \\"Message\\": \\"null\\",\\n \\"StartTime\\": \\"2020-11-05T06:45:14Z\\",\\n \\"Table\\": \\"default:test1\\",\\n \\"State\\": \\"SUCCEEDED\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeRestoreSummary' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-m5eznlga4k5bcxxxx',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-m5eznlga4k5bcxxxx', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
@@ -7908,110 +5804,79 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AE639ED7-F0F3-4A71-911E-CF8EC088816E',
- ],
- 'Total' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'HasMoreRestoreRecord' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
+ 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'AE639ED7-F0F3-4A71-911E-CF8EC088816E', 'title' => ''],
+ 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'HasMoreRestoreRecord' => ['description' => 'Indicates whether there is a next page. This parameter is currently not used.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Rescords' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Rescord' => [
- 'description' => '',
+ 'description' => 'The details of the recovery list.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCEEDED',
- ],
- 'FinishTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-05T06:45:51Z',
- ],
- 'SchemaProcess' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1/1',
- ],
- 'BulkLoadProcess' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1/1',
- ],
- 'RecordId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20201105144514',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-05T06:45:14Z',
- ],
- 'LogProcess' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0/0',
- ],
- 'HfileRestoreProcess' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1/1',
- ],
+ 'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'SUCCEEDED', 'title' => ''],
+ 'FinishTime' => ['description' => 'The completion time.', 'type' => 'string', 'example' => '2020-11-05T06:45:51Z', 'title' => ''],
+ 'SchemaProcess' => ['description' => 'The schema recovery progress.', 'type' => 'string', 'example' => '1/1', 'title' => ''],
+ 'BulkLoadProcess' => ['description' => 'The BulkLoad progress.', 'type' => 'string', 'example' => '1/1', 'title' => ''],
+ 'RecordId' => ['description' => 'The record ID.', 'type' => 'string', 'example' => '20201105144514', 'title' => ''],
+ 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2020-11-05T06:45:14Z', 'title' => ''],
+ 'LogProcess' => ['description' => 'The incremental data recovery progress.', 'type' => 'string', 'example' => '0/0', 'title' => ''],
+ 'HfileRestoreProcess' => ['description' => 'The full data recovery progress.', 'type' => 'string', 'example' => '1/1', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"AE639ED7-F0F3-4A71-911E-CF8EC088816E\\",\\n \\"Total\\": 1,\\n \\"HasMoreRestoreRecord\\": 0,\\n \\"Rescords\\": {\\n \\"Rescord\\": [\\n {\\n \\"Status\\": \\"SUCCEEDED\\",\\n \\"FinishTime\\": \\"2020-11-05T06:45:51Z\\",\\n \\"SchemaProcess\\": \\"1/1\\",\\n \\"BulkLoadProcess\\": \\"1/1\\",\\n \\"RecordId\\": \\"20201105144514\\",\\n \\"CreateTime\\": \\"2020-11-05T06:45:14Z\\",\\n \\"LogProcess\\": \\"0/0\\",\\n \\"HfileRestoreProcess\\": \\"1/1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>AE639ED7-F0F3-4A71-911E-CF8EC088816E</RequestId>\\n<PageSize>10</PageSize>\\n<PageNumber>1</PageNumber>\\n<Total>1</Total>\\n<HasMoreRestoreRecord>0</HasMoreRestoreRecord>\\n<Rescords>\\n <Rescord>\\n <Status>SUCCEEDED</Status>\\n <LogProcess>0/0</LogProcess>\\n <FinishTime>2020-11-05T06:45:51Z</FinishTime>\\n <SchemaProcess>1/1</SchemaProcess>\\n <CreateTime>2020-11-05T06:45:14Z</CreateTime>\\n <RecordId>20201105144514</RecordId>\\n <BulkLoadProcess>1/1</BulkLoadProcess>\\n <HfileRestoreProcess>1/1</HfileRestoreProcess>\\n </Rescord>\\n</Rescords>","errorExample":""}]',
- 'title' => 'DescribeRestoreSummary',
+ 'title' => 'Retrieve data recovery summary',
+ 'summary' => 'Retrieves the data recovery summary for an HBaseue cluster that has backup and recovery enabled by calling the DescribeRestoreSummary operation.',
+ 'description' => 'Before calling this operation, make sure that backup and recovery is enabled for the HBaseue cluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeRestoreSummary',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"AE639ED7-F0F3-4A71-911E-CF8EC088816E\\",\\n \\"Total\\": 1,\\n \\"HasMoreRestoreRecord\\": 0,\\n \\"Rescords\\": {\\n \\"Rescord\\": [\\n {\\n \\"Status\\": \\"SUCCEEDED\\",\\n \\"FinishTime\\": \\"2020-11-05T06:45:51Z\\",\\n \\"SchemaProcess\\": \\"1/1\\",\\n \\"BulkLoadProcess\\": \\"1/1\\",\\n \\"RecordId\\": \\"20201105144514\\",\\n \\"CreateTime\\": \\"2020-11-05T06:45:14Z\\",\\n \\"LogProcess\\": \\"0/0\\",\\n \\"HfileRestoreProcess\\": \\"1/1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeRestoreTables' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8019,31 +5884,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-m5eznlga4k5bcxxxx',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-m5eznlga4k5bcxxxx', 'title' => ''],
],
[
'name' => 'RestoreRecordId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2020110514xxxx',
- ],
+ 'schema' => ['description' => 'The restore record ID. You can call the DescribeRestoreSummary operation to obtain this value.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020110514xxxx', 'title' => ''],
],
],
'responses' => [
@@ -8051,300 +5902,176 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '18D9CC47-D913-48BF-AB6B-4FA9B28FBDB1',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '18D9CC47-D913-48BF-AB6B-4FA9B28FBDB1', 'title' => ''],
'Tables' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Table' => [
- 'description' => '',
+ 'description' => 'The collection of table names.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default:test1',
- ],
+ 'items' => ['description' => 'The collection of table names only.', 'type' => 'string', 'example' => 'default:test1', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'RestoreSummary' => [
- 'description' => '',
+ 'description' => 'The restore summary.',
'type' => 'object',
'properties' => [
- 'EndTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-05T06:45:51Z',
- ],
- 'StartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-05T06:45:14Z',
- ],
- 'State' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCEEDED',
- ],
- 'RecordId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20201105144514',
- ],
- 'RestoreToDate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-04T05:15:00Z',
- ],
- 'TargetCluster' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ld-m5e2t34kr54wgxxxx',
- ],
+ 'EndTime' => ['description' => 'The completion time.', 'type' => 'string', 'example' => '2020-11-05T06:45:51Z', 'title' => ''],
+ 'StartTime' => ['description' => 'The restore start time.', 'type' => 'string', 'example' => '2020-11-05T06:45:14Z', 'title' => ''],
+ 'State' => ['description' => 'The status.', 'type' => 'string', 'example' => 'SUCCEEDED', 'title' => ''],
+ 'RecordId' => ['description' => 'The record ID.', 'type' => 'string', 'example' => '20201105144514', 'title' => ''],
+ 'RestoreToDate' => ['description' => 'The point in time to which data is restored.', 'type' => 'string', 'example' => '2020-11-04T05:15:00Z', 'title' => ''],
+ 'TargetCluster' => ['description' => 'The target cluster for the restore.', 'type' => 'string', 'example' => 'ld-m5e2t34kr54wgxxxx', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'RestoreSchema' => [
- 'description' => '',
+ 'description' => 'The schema restore details.',
'type' => 'object',
'properties' => [
- 'Succeed' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Fail' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Total' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'Succeed' => ['description' => 'The number of successful restores.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Fail' => ['description' => 'The number of failed restores.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'RestoreSchemaDetails' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RestoreSchemaDetail' => [
- 'description' => '',
+ 'description' => 'The schema restore progress details for tables.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'EndTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-05T06:45:18Z',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'StartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-05T06:45:14Z',
- ],
- 'Table' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default:test1',
- ],
- 'State' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCEEDED',
- ],
+ 'EndTime' => ['description' => 'The end time of the schema restore.', 'type' => 'string', 'example' => '2020-11-05T06:45:18Z', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when an error occurs.', 'type' => 'string', 'example' => 'null', 'title' => ''],
+ 'StartTime' => ['description' => 'The start time of the schema restore.', 'type' => 'string', 'example' => '2020-11-05T06:45:14Z', 'title' => ''],
+ 'Table' => ['description' => 'The table name for the schema restore.', 'type' => 'string', 'example' => 'default:test1', 'title' => ''],
+ 'State' => ['description' => 'The schema restore status.', 'type' => 'string', 'example' => 'SUCCEEDED', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
'RestoreFull' => [
- 'description' => '',
+ 'description' => 'The full restore details.',
'type' => 'object',
'properties' => [
- 'Succeed' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'DataSize' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1.2 kB',
- ],
- 'Speed' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0.00 MB/s',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Fail' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Total' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'Succeed' => ['description' => 'The number of successful restores.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'DataSize' => ['description' => 'The total data size.', 'type' => 'string', 'example' => '1.2 kB', 'title' => ''],
+ 'Speed' => ['description' => 'The total speed.', 'type' => 'string', 'example' => '0.00 MB/s', 'title' => ''],
+ 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Fail' => ['description' => 'The number of failed full restores.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'RestoreFullDetails' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RestoreFullDetail' => [
- 'description' => '',
+ 'description' => 'The full restore details for tables.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'EndTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-05T06:45:51Z',
- ],
- 'StartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-05T06:45:45Z',
- ],
- 'Process' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '14/14',
- ],
- 'DataSize' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1.2 kB',
- ],
- 'Speed' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0.00 MB/s',
- ],
- 'State' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCEEDED',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '“”',
- ],
- 'Table' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'default:test1',
- ],
+ 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2020-11-05T06:45:51Z', 'title' => ''],
+ 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2020-11-05T06:45:45Z', 'title' => ''],
+ 'Process' => ['description' => 'The progress.', 'type' => 'string', 'example' => '14/14', 'title' => ''],
+ 'DataSize' => ['description' => 'The data size of the table.', 'type' => 'string', 'example' => '1.2 kB', 'title' => ''],
+ 'Speed' => ['description' => 'The restore speed.', 'type' => 'string', 'example' => '0.00 MB/s', 'title' => ''],
+ 'State' => ['description' => 'The status.', 'type' => 'string', 'example' => 'SUCCEEDED', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '“”', 'title' => ''],
+ 'Table' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'default:test1', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
'RestoreIncrDetail' => [
- 'description' => '',
+ 'description' => 'The incremental restore details.',
'type' => 'object',
'properties' => [
- 'EndTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-05T06:45:44Z',
- ],
- 'StartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-05T06:45:44Z',
- ],
- 'Process' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0/0',
- ],
- 'RestoreStartTs' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-11-02T18:00:00Z',
- ],
- 'State' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCEEDED',
- ],
- 'RestoredTs' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '“”',
- ],
- 'RestoreDelay' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0 ms',
- ],
+ 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2020-11-05T06:45:44Z', 'title' => ''],
+ 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2020-11-05T06:45:44Z', 'title' => ''],
+ 'Process' => ['description' => 'The completion progress.', 'type' => 'string', 'example' => '0/0', 'title' => ''],
+ 'RestoreStartTs' => ['description' => 'The synchronization start position.', 'type' => 'string', 'example' => '2020-11-02T18:00:00Z', 'title' => ''],
+ 'State' => ['description' => 'The status.', 'type' => 'string', 'example' => 'SUCCEEDED', 'title' => ''],
+ 'RestoredTs' => ['description' => 'The synchronization position.', 'type' => 'string', 'example' => '“”', 'title' => ''],
+ 'RestoreDelay' => ['description' => 'The synchronization latency.', 'type' => 'string', 'example' => '0 ms', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"18D9CC47-D913-48BF-AB6B-4FA9B28FBDB1\\",\\n \\"Tables\\": {\\n \\"Table\\": [\\n \\"default:test1\\"\\n ]\\n },\\n \\"RestoreSummary\\": {\\n \\"EndTime\\": \\"2020-11-05T06:45:51Z\\",\\n \\"StartTime\\": \\"2020-11-05T06:45:14Z\\",\\n \\"State\\": \\"SUCCEEDED\\",\\n \\"RecordId\\": \\"20201105144514\\",\\n \\"RestoreToDate\\": \\"2020-11-04T05:15:00Z\\",\\n \\"TargetCluster\\": \\"ld-m5e2t34kr54wgxxxx\\"\\n },\\n \\"RestoreSchema\\": {\\n \\"Succeed\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Fail\\": 0,\\n \\"Total\\": 1,\\n \\"RestoreSchemaDetails\\": {\\n \\"RestoreSchemaDetail\\": [\\n {\\n \\"EndTime\\": \\"2020-11-05T06:45:18Z\\",\\n \\"Message\\": \\"null\\",\\n \\"StartTime\\": \\"2020-11-05T06:45:14Z\\",\\n \\"Table\\": \\"default:test1\\",\\n \\"State\\": \\"SUCCEEDED\\"\\n }\\n ]\\n }\\n },\\n \\"RestoreFull\\": {\\n \\"Succeed\\": 1,\\n \\"DataSize\\": \\"1.2 kB\\",\\n \\"Speed\\": \\"0.00 MB/s\\",\\n \\"PageSize\\": 10,\\n \\"Fail\\": 0,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 1,\\n \\"RestoreFullDetails\\": {\\n \\"RestoreFullDetail\\": [\\n {\\n \\"EndTime\\": \\"2020-11-05T06:45:51Z\\",\\n \\"StartTime\\": \\"2020-11-05T06:45:45Z\\",\\n \\"Process\\": \\"14/14\\",\\n \\"DataSize\\": \\"1.2 kB\\",\\n \\"Speed\\": \\"0.00 MB/s\\",\\n \\"State\\": \\"SUCCEEDED\\",\\n \\"Message\\": \\"“”\\",\\n \\"Table\\": \\"default:test1\\"\\n }\\n ]\\n }\\n },\\n \\"RestoreIncrDetail\\": {\\n \\"EndTime\\": \\"2020-11-05T06:45:44Z\\",\\n \\"StartTime\\": \\"2020-11-05T06:45:44Z\\",\\n \\"Process\\": \\"0/0\\",\\n \\"RestoreStartTs\\": \\"2020-11-02T18:00:00Z\\",\\n \\"State\\": \\"SUCCEEDED\\",\\n \\"RestoredTs\\": \\"“”\\",\\n \\"RestoreDelay\\": \\"0 ms\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RestoreSchema>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Total>1</Total>\\n <Fail>0</Fail>\\n <Succeed>1</Succeed>\\n <RestoreSchemaDetails>\\n <RestoreSchemaDetail>\\n <StartTime>2020-11-05T06:45:14Z</StartTime>\\n <Table>default:test1</Table>\\n <Message>null</Message>\\n <EndTime>2020-11-05T06:45:18Z</EndTime>\\n <State>SUCCEEDED</State>\\n </RestoreSchemaDetail>\\n </RestoreSchemaDetails>\\n</RestoreSchema>\\n<RestoreFull>\\n <Speed>0.00 MB/s</Speed>\\n <RestoreFullDetails>\\n <RestoreFullDetail>\\n <Speed>0.00 MB/s</Speed>\\n <Table>default:test1</Table>\\n <Message>“”</Message>\\n <EndTime>2020-11-05T06:45:51Z</EndTime>\\n <State>SUCCEEDED</State>\\n <DataSize>1.2 kB</DataSize>\\n <StartTime>2020-11-05T06:45:45Z</StartTime>\\n <Process>14/14</Process>\\n </RestoreFullDetail>\\n </RestoreFullDetails>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Total>1</Total>\\n <DataSize>1.2 kB</DataSize>\\n <Fail>0</Fail>\\n <Succeed>1</Succeed>\\n</RestoreFull>\\n<RequestId>18D9CC47-D913-48BF-AB6B-4FA9B28FBDB1</RequestId>\\n<Tables>\\n <Table>default:test1</Table>\\n</Tables>\\n<RestoreSummary>\\n <TargetCluster>ld-m5e2t34kr54wgxxxx</TargetCluster>\\n <EndTime>2020-11-05T06:45:51Z</EndTime>\\n <State>SUCCEEDED</State>\\n <StartTime>2020-11-05T06:45:14Z</StartTime>\\n <RestoreToDate>2020-11-04T05:15:00Z</RestoreToDate>\\n <RecordId>20201105144514</RecordId>\\n</RestoreSummary>\\n<RestoreIncrDetail>\\n <RestoreDelay>0 ms</RestoreDelay>\\n <EndTime>2020-11-05T06:45:44Z</EndTime>\\n <RestoreStartTs>2020-11-02T18:00:00Z</RestoreStartTs>\\n <State>SUCCEEDED</State>\\n <StartTime>2020-11-05T06:45:44Z</StartTime>\\n <Process>0/0</Process>\\n <RestoredTs>“”</RestoredTs>\\n</RestoreIncrDetail>","errorExample":""}]',
'title' => 'DescribeRestoreTables',
+ 'summary' => 'Retrieves the details of a restore record for a cluster that has been restored from a backup.',
+ 'description' => 'Before calling this operation, make sure that the backup and recovery feature is enabled for the HBaseue cluster and that restore records exist. You can call DescribeRestoreSummary to obtain restore records.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'AllocatePublicNetworkAddress' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeRestoreTables',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D9CC47-D913-48BF-AB6B-4FA9B28FBDB1\\",\\n \\"Tables\\": {\\n \\"Table\\": [\\n \\"default:test1\\"\\n ]\\n },\\n \\"RestoreSummary\\": {\\n \\"EndTime\\": \\"2020-11-05T06:45:51Z\\",\\n \\"StartTime\\": \\"2020-11-05T06:45:14Z\\",\\n \\"State\\": \\"SUCCEEDED\\",\\n \\"RecordId\\": \\"20201105144514\\",\\n \\"RestoreToDate\\": \\"2020-11-04T05:15:00Z\\",\\n \\"TargetCluster\\": \\"ld-m5e2t34kr54wgxxxx\\"\\n },\\n \\"RestoreSchema\\": {\\n \\"Succeed\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Fail\\": 0,\\n \\"Total\\": 1,\\n \\"RestoreSchemaDetails\\": {\\n \\"RestoreSchemaDetail\\": [\\n {\\n \\"EndTime\\": \\"2020-11-05T06:45:18Z\\",\\n \\"Message\\": \\"null\\",\\n \\"StartTime\\": \\"2020-11-05T06:45:14Z\\",\\n \\"Table\\": \\"default:test1\\",\\n \\"State\\": \\"SUCCEEDED\\"\\n }\\n ]\\n }\\n },\\n \\"RestoreFull\\": {\\n \\"Succeed\\": 1,\\n \\"DataSize\\": \\"1.2 kB\\",\\n \\"Speed\\": \\"0.00 MB/s\\",\\n \\"PageSize\\": 10,\\n \\"Fail\\": 0,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 1,\\n \\"RestoreFullDetails\\": {\\n \\"RestoreFullDetail\\": [\\n {\\n \\"EndTime\\": \\"2020-11-05T06:45:51Z\\",\\n \\"StartTime\\": \\"2020-11-05T06:45:45Z\\",\\n \\"Process\\": \\"14/14\\",\\n \\"DataSize\\": \\"1.2 kB\\",\\n \\"Speed\\": \\"0.00 MB/s\\",\\n \\"State\\": \\"SUCCEEDED\\",\\n \\"Message\\": \\"“”\\",\\n \\"Table\\": \\"default:test1\\"\\n }\\n ]\\n }\\n },\\n \\"RestoreIncrDetail\\": {\\n \\"EndTime\\": \\"2020-11-05T06:45:44Z\\",\\n \\"StartTime\\": \\"2020-11-05T06:45:44Z\\",\\n \\"Process\\": \\"0/0\\",\\n \\"RestoreStartTs\\": \\"2020-11-02T18:00:00Z\\",\\n \\"State\\": \\"SUCCEEDED\\",\\n \\"RestoredTs\\": \\"“”\\",\\n \\"RestoreDelay\\": \\"0 ms\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeSecurityGroups' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8352,55 +6079,72 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'hb-t4naqsay5gn******',
- 'required' => true,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '83b2b5e117a5b8bce0fae88d90576a84_6452320_82718582',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-bp161ax8i03c4uq**', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA', 'title' => ''],
+ 'SecurityGroupIds' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SecurityGroupId' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'The IDs of the security groups to which the cluster belongs.', 'type' => 'string', 'example' => 'sg-t4ng4yyc916o81nua6**,sg-****', 'title' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","errorExample":""},{"type":"xml","example":"<AllocatePublicNetworkAddressResponse>\\n <RequestId>50373857-C47B-4B64-9332-D0B5280B****</RequestId>\\n</AllocatePublicNetworkAddressResponse>","errorExample":""}]',
- ],
- 'ReleasePublicNetworkAddress' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'errorCodes' => [],
+ 'title' => 'Query basic security group information',
+ 'summary' => 'Calls DescribeSecurityGroups to retrieve the security group information of a cluster by cluster ID.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeSecurityGroups',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\",\\n \\"SecurityGroupIds\\": {\\n \\"SecurityGroupId\\": [\\n \\"sg-t4ng4yyc916o81nua6**,sg-****\\"\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeServerlessCluster' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8408,20 +6152,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
+ 'name' => 'ZoneId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The zone ID of the instance. You can call the [DescribeInstances](~~144595~~) operation to query the zone ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sdh0b7f4k5f****', 'title' => ''],
+ ],
+ [
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-t4naqsay5gn******',
- ],
+ 'schema' => ['description' => 'The cluster ID, which is a unique identifier generated by the system. You can call the [DescribeInstances](~~144595~~) operation to query the cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-bp16f1441y6p2****', 'title' => ''],
],
],
'responses' => [
@@ -8429,30 +6170,86 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'B18D4390-A968-4444-B323-4360B8E5DA3E',
- ],
+ 'VpcId' => ['description' => 'The ID of the virtual private cloud (VPC) to which the instance belongs.', 'type' => 'string', 'example' => 'vpc-bp120k6ixs4eoghz****', 'title' => ''],
+ 'Status' => ['description' => 'The current status. Valid values:'."\n"
+ .'- **CREATING**: being created.'."\n"
+ .'- **ACTIVATION**: running.'."\n"
+ .'- **DELETING**: being deleted.'."\n"
+ .'- **RESTARTING**: being restarted.', 'type' => 'string', 'example' => 'ACTIVATION', 'title' => ''],
+ 'InnerEndpoint' => ['description' => 'The internal endpoint.', 'type' => 'string', 'example' => 'https://sh-wz91452kg946i****-lindorm-serverless-in.lindorm.rds.aliyuncs.com:443', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the cluster was created.', 'type' => 'string', 'example' => '2019-10-12T14:40:46', 'title' => ''],
+ 'PayType' => ['description' => 'The billing method. Valid values:'."\n"
+ .'- **Prepaid**: subscription.'."\n"
+ .'- **Postpaid**: pay-as-you-go.', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''],
+ 'MainVersion' => ['description' => 'The major version.', 'type' => 'string', 'example' => '2.0.8', 'title' => ''],
+ 'LockMode' => ['description' => 'The lock type of the cluster.'."\n"
+ .'> This parameter does not return a value.', 'type' => 'string', 'example' => '过期', 'title' => ''],
+ 'HasUser' => ['description' => 'Indicates whether the cluster has users. Valid values:'."\n"
+ .'- **true**: The cluster has users.'."\n"
+ .'- **false**: The cluster does not have users.', 'type' => 'string', 'example' => 'false', 'title' => ''],
+ 'HaType' => ['description' => 'Indicates whether high availability (HA) is enabled. Valid values:'."\n"
+ .'- **true**: HA is enabled.'."\n"
+ .'- **false**: HA is not enabled.', 'type' => 'string', 'example' => 'false', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '89F81C30-320B-4550-91DB-C37C81D2358F', 'title' => ''],
+ 'UpdateStatus' => ['description' => 'The minor version upgrade status. Valid values:'."\n"
+ .'- **YES**: An upgrade is available.'."\n"
+ .'- **NO**: No upgrade is available.'."\n"
+ .'- **PENDING**: An upgrade is in progress.', 'type' => 'string', 'example' => 'NO', 'title' => ''],
+ 'ReserverMaxQpsNum' => ['description' => 'The maximum reserved QPS.', 'type' => 'string', 'example' => '100', 'title' => ''],
+ 'InstanceName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'OuterEndpoint' => ['description' => 'The public endpoint.', 'type' => 'string', 'example' => 'https://sh-wz91452kg946i****-lindorm-serverless.lindorm.rds.aliyuncs.com:443', 'title' => ''],
+ 'CuSize' => ['description' => 'The compute unit (CU) size.', 'type' => 'string', 'example' => '150', 'title' => ''],
+ 'ExpireTime' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '2019-10-12T14:40:46', 'title' => ''],
+ 'ReserverMinQpsNum' => ['description' => 'The minimum reserved QPS.', 'type' => 'string', 'example' => '50', 'title' => ''],
+ 'AutoRenew' => ['description' => 'Indicates whether auto-renewal is enabled. Valid values:'."\n"
+ .'- **true**: Auto-renewal is enabled.'."\n"
+ .'- **false**: Auto-renewal is not enabled.', 'type' => 'string', 'example' => 'false', 'title' => ''],
+ 'DiskSize' => ['description' => 'The disk size of the node. Unit: GB.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'InstanceId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'hb-bp16f1441y6p2****', 'title' => ''],
+ 'IsDeletionProtection' => ['description' => 'Indicates whether deletion protection is enabled.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp191ipotqf****', 'title' => ''],
+ 'ClusterType' => ['description' => 'The cluster type. Valid values:'."\n"
+ .'- **Cluster**: Cluster Edition.'."\n"
+ .'- **Single**: single-node.', 'type' => 'string', 'example' => 'single', 'title' => ''],
+ 'ResourceGroupId' => ['description' => 'The ID of the resource group to which the resource belongs.', 'type' => 'string', 'example' => 'rg-fjm2d4v7sf****', 'title' => ''],
+ 'ZoneId' => ['description' => 'The zone ID of the instance.', 'type' => 'string', 'example' => 'cn-hangzhou-f', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B18D4390-A968-4444-B323-4360B8E5DA3E\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>B18D4390-A968-4444-B323-4360B8E5DA3E</RequestId>","errorExample":""}]',
- 'title' => 'ReleasePublicNetworkAddress',
+ 'title' => 'Get a serverless cluster',
+ 'summary' => 'Queries the details of a serverless cluster by calling DescribeServerlessCluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeEndpoints' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-06T09:46:53.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeServerlessCluster',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"VpcId\\": \\"vpc-bp120k6ixs4eoghz****\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"InnerEndpoint\\": \\"https://sh-wz91452kg946i****-lindorm-serverless-in.lindorm.rds.aliyuncs.com:443\\",\\n \\"CreateTime\\": \\"2019-10-12T14:40:46\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"MainVersion\\": \\"2.0.8\\",\\n \\"LockMode\\": \\"过期\\",\\n \\"HasUser\\": \\"false\\",\\n \\"HaType\\": \\"false\\",\\n \\"RequestId\\": \\"89F81C30-320B-4550-91DB-C37C81D2358F\\",\\n \\"UpdateStatus\\": \\"NO\\",\\n \\"ReserverMaxQpsNum\\": \\"100\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"OuterEndpoint\\": \\"https://sh-wz91452kg946i****-lindorm-serverless.lindorm.rds.aliyuncs.com:443\\",\\n \\"CuSize\\": \\"150\\",\\n \\"ExpireTime\\": \\"2019-10-12T14:40:46\\",\\n \\"ReserverMinQpsNum\\": \\"50\\",\\n \\"AutoRenew\\": \\"false\\",\\n \\"DiskSize\\": \\"200\\",\\n \\"InstanceId\\": \\"hb-bp16f1441y6p2****\\",\\n \\"IsDeletionProtection\\": \\"true\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VSwitchId\\": \\"vsw-bp191ipotqf****\\",\\n \\"ClusterType\\": \\"single\\",\\n \\"ResourceGroupId\\": \\"rg-fjm2d4v7sf****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-f\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeSubDomain' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8460,20 +6257,17 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp150tns0sjxs****',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'ZoneId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-f', 'title' => ''],
],
],
'responses' => [
@@ -8481,86 +6275,44 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'VpcId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vpc-bp15s22y1a7sff5gj****',
- ],
- 'VSwitchId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vsw-bp1foll427ze3d4ps****',
- ],
- 'Engine' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbaseue',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F072593C-5234-5B56-9F63-3C7A3AD85D66',
- ],
- 'NetType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'VPC',
- ],
- 'ConnAddrs' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'ConnAddrInfo' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ConnAddr' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '****',
- ],
- 'ConnAddrPort' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '****',
- ],
- 'ConnType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'zkConn',
- ],
- 'NetType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'SubDomain' => ['description' => 'The available subdomain.', 'type' => 'string', 'example' => 'cn-hangzhou-h-aliyun', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F4208C83-B9BC-4A64-A739-8F88E98DA469', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"VpcId\\": \\"vpc-bp15s22y1a7sff5gj****\\",\\n \\"VSwitchId\\": \\"vsw-bp1foll427ze3d4ps****\\",\\n \\"Engine\\": \\"hbaseue\\",\\n \\"RequestId\\": \\"F072593C-5234-5B56-9F63-3C7A3AD85D66\\",\\n \\"NetType\\": \\"VPC\\",\\n \\"ConnAddrs\\": {\\n \\"ConnAddrInfo\\": [\\n {\\n \\"ConnAddr\\": \\"****\\",\\n \\"ConnAddrPort\\": \\"****\\",\\n \\"ConnType\\": \\"zkConn\\",\\n \\"NetType\\": \\"2\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeEndpointsResponse>\\n<RequestId>F072593C-5234-5B56-9F63-3C7A3AD85D66</RequestId>\\n<VpcId>vpc-bp15s22y1a7sff5gj****</VpcId>\\n<ConnAddrs>\\n <ConnAddrInfo>\\n <ConnAddrPort>2181</ConnAddrPort>\\n <ConnAddr>ld-bp150tns0sjx****</ConnAddr>\\n <ConnType>zkConn</ConnType>\\n <NetType>2</NetType>\\n </ConnAddrInfo>\\n <ConnAddrInfo>\\n <ConnAddrPort>9042</ConnAddrPort>\\n <ConnAddr>ld-bp150tns0sjx****</ConnAddr>\\n <ConnType>slbConn_hbaseue</ConnType>\\n <NetType>0</NetType>\\n </ConnAddrInfo>\\n</ConnAddrs>\\n<VSwitchId>vsw-bp1foll427ze3d4ps****</VSwitchId>\\n<NetType>VPC</NetType>\\n<Engine>hbaseue</Engine>\\n</DescribeEndpointsResponse>","errorExample":""}]',
- 'title' => 'DescribeEndpoints',
+ 'title' => 'Query subdomain information',
+ 'summary' => 'Calls DescribeSubDomain to retrieve an available subdomain.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeAccounts' => [
- 'summary' => '查询账户列表',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:56:05.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeSubDomain',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SubDomain\\": \\"cn-hangzhou-h-aliyun\\",\\n \\"RequestId\\": \\"F4208C83-B9BC-4A64-A739-8F88E98DA469\\"\\n}","type":"json"}]',
+ ],
+ 'EnableHBaseueBackup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8568,20 +6320,27 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'HbaseueClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp1uoihlf82e8****',
- ],
+ 'schema' => ['description' => 'The ID of the HBaseue cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-m5eznlga4k5bcxxxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'NodeCount',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of backup nodes.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '2', 'title' => ''],
+ ],
+ [
+ 'name' => 'ColdStorageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The cold storage size for the backup service. The minimum value is 800 GB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '800', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''],
],
],
'responses' => [
@@ -8589,42 +6348,45 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F744E939-D08D-5623-82C8-9D1F9F7685D1',
- ],
- 'Accounts' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'account' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '["test"]',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '15272D5D-46E8-4400-9CC8-A7E7B589F575', 'title' => ''],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '1449xxx', 'title' => ''],
+ 'ClusterId' => ['description' => 'The cluster ID of the activated BDS backup service.', 'type' => 'string', 'example' => 'bds-m5e54q06ceyhxxxx', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F744E939-D08D-5623-82C8-9D1F9F7*****\\",\\n \\"Accounts\\": {\\n \\"account\\": [\\n \\"[\\\\\\"test\\\\\\"]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAccountsResponse>\\n <RequestId>F744E939-D08D-5623-82C8-9D1F9F7*****</RequestId>\\n <Accounts>[\\"test\\"]</Accounts>\\n</DescribeAccountsResponse>","errorExample":""}]',
- ],
- 'CreateAccount' => [
- 'summary' => '新建账户',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Enable hBaseue backup and recovery',
+ 'summary' => 'Enables backup and recovery for an HBaseue cluster.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:56:05.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:EnableHBaseueBackup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15272D5D-46E8-4400-9CC8-A7E7B589F575\\",\\n \\"OrderId\\": \\"1449xxx\\",\\n \\"ClusterId\\": \\"bds-m5e54q06ceyhxxxx\\"\\n}","type":"json"}]',
+ ],
+ 'EnableHBaseueModule' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8632,40 +6394,125 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'ModuleClusterName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp150tns0sjxs****',
- ],
+ 'schema' => ['description' => 'The name of the extension cluster.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cluster-name', 'title' => ''],
],
[
- 'name' => 'AccountName',
+ 'name' => 'VpcId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test01',
- ],
+ 'schema' => ['description' => 'The ID of the virtual private cloud (VPC).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-bp120k6ixs4eog*****', 'title' => ''],
],
[
- 'name' => 'AccountPassword',
+ 'name' => 'VswitchId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '**********',
- ],
+ 'schema' => ['description' => 'The ID of the vSwitch in the VPC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vsw-bp191ipotqj1ssyl*****', 'title' => ''],
+ ],
+ [
+ 'name' => 'MasterInstanceType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The node specifications of the master node. You can invoke the [DescribeAvailableResource](~~188244~~) operation to obtain the specification value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'hbase.sn1.large', 'title' => ''],
+ ],
+ [
+ 'name' => 'CoreInstanceType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The node specifications of the core node. You can invoke the [DescribeAvailableResource](~~188244~~) operation to obtain the specification value.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hbase.sn1.large', 'title' => ''],
+ ],
+ [
+ 'name' => 'DiskType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The disk type of the core node. Valid values:'."\n"
+ ."\n"
+ .'- cloud_efficiency: ultra cloud disk.'."\n"
+ .'- cloud_ssd: standard SSD.'."\n"
+ .'- local_hdd_pro: local HDD.'."\n"
+ .'- local_ssd_pro: local SSD.'."\n"
+ .'- cloud_essd_pl1: ESSD.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cloud_ssd', 'title' => ''],
+ ],
+ [
+ 'name' => 'DiskSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The disk size per node. Unit: GB.'."\n"
+ ."\n"
+ .'- If the instance is a single-node instance, the disk size of a single core node ranges from 20 to 500 GB, with a step size of 1 GB.'."\n"
+ .'- If the instance uses cloud disks, the disk size of a single core node ranges from 400 to 64,000 GB, with a step size of 40 GB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '400', 'title' => ''],
+ ],
+ [
+ 'name' => 'NodeCount',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of nodes. Valid values:'."\n"
+ ."\n"
+ .'- If the instance is a single-node instance, the number of core nodes is fixed to 1.'."\n"
+ .'- If the instance uses cloud disks, the number of core nodes ranges from 2 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '2', 'title' => ''],
+ ],
+ [
+ 'name' => 'PayType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The billing method of the instance. Valid values:'."\n"
+ ."\n"
+ .'- Prepaid: subscription.'."\n"
+ .'- Postpaid: pay-as-you-go.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Prepaid', 'title' => ''],
+ ],
+ [
+ 'name' => 'PeriodUnit',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The unit of the subscription duration for the subscription instance. Valid values:'."\n"
+ ."\n"
+ .'- **year**'."\n"
+ .'- **month**'."\n"
+ ."\n"
+ .'> This parameter is required only when the billing method is **Prepaid**.', 'type' => 'string', 'required' => false, 'example' => 'month', 'title' => ''],
+ ],
+ [
+ 'name' => 'Period',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The subscription duration of the subscription instance. Valid values:'."\n"
+ ."\n"
+ .'- If PeriodUnit is set to year, the valid values are 1 to 3.'."\n"
+ .'- If PeriodUnit is set to month, the valid values are 1 to 9.'."\n"
+ ."\n"
+ .'> This parameter is required only when the billing method is Prepaid.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6', 'title' => ''],
+ ],
+ [
+ 'name' => 'AutoRenewPeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The auto-renewal period of the instance. Unit: months.'."\n"
+ ."\n"
+ .'> <ul><li>The default value of the auto-renewal period is 0, which indicates that the instance is not automatically renewed after the instance expires.</li>'."\n"
+ .'<li>For example, if the auto-renewal period is set to 2, the instance is automatically renewed for two months after the instance expires.</li></ul>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. The value of this parameter is generated by the client. The value must be unique among different requests, is case-sensitive, and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
+ ],
+ [
+ 'name' => 'HbaseueClusterId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The instance ID of the ApsaraDB for HBase Performance-enhanced Edition database.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp150tns0sjxs****', 'title' => ''],
+ ],
+ [
+ 'name' => 'BdsId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the BDS cluster associated with the ApsaraDB for HBase Performance-enhanced Edition instance.', 'type' => 'string', 'required' => false, 'example' => 'bds-bp174pm3tsk3****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ModuleTypeName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The type of the extension module. Set the value to solr.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'solr', 'title' => ''],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the region in which the instance resides. You can call the [DescribeRegions](~~144489~~) operation to obtain the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen', 'title' => ''],
+ ],
+ [
+ 'name' => 'ZoneId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the zone. You can call the [DescribeRegions](~~144489~~) operation to obtain the zone ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen-e', 'title' => ''],
],
],
'responses' => [
@@ -8673,68 +6520,224 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '407075EA-47F5-5A2D-888F-C1F90B8F3FCA', 'title' => ''],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '21474915573****', 'title' => ''],
+ 'ClusterId' => ['description' => 'The ID of the extension cluster.', 'type' => 'string', 'example' => 'ld-bp150tns0sjxs****-m1-ps', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280*****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAccountResponse>\\n <RequestId>50373857-C47B-4B64-9332-D0B5280*****</RequestId>\\n</CreateAccountResponse>","errorExample":""}]',
- ],
- 'ModifyAccountPassword' => [
- 'summary' => '更改账户密码',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Enable an extension service',
+ 'summary' => 'Calls the EnableHBaseueModule operation to enable an extension service.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-06T09:46:53.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:EnableHBaseueModule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"407075EA-47F5-5A2D-888F-C1F90B8F3FCA\\",\\n \\"OrderId\\": \\"21474915573****\\",\\n \\"ClusterId\\": \\"ld-bp150tns0sjxs****-m1-ps\\"\\n}","type":"json"}]',
+ ],
+ 'EvaluateMultiZoneResource' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'Engine',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp150tns0sjxs****',
- ],
+ 'schema' => ['description' => 'The service type. Currently, only ApsaraDB for HBase Performance-enhanced Edition is supported. Set the value to **hbaseue**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hbaseue', 'title' => ''],
],
[
- 'name' => 'AccountName',
+ 'name' => 'EngineVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test01',
- ],
+ 'schema' => ['description' => 'The version of the engine type. Set the value to **2.0**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2.0', 'title' => ''],
],
[
- 'name' => 'NewAccountPassword',
+ 'name' => 'ArchVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '**********',
- ],
+ 'schema' => ['description' => 'The version of the deployment architecture. Currently, only the hbaseue engine type is supported. Set the value to **2.0**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2.0', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClusterName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The cluster name. The following rules apply:'."\n"
+ ."\n"
+ .'- The name must be 2 to 128 characters in length.'."\n"
+ .'- The name must start with an uppercase letter, a lowercase letter, or a Chinese character.'."\n"
+ .'- The name can contain digits or special characters, including periods (.), hyphens (-), and underscores (_).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'hbaseue_test', 'title' => ''],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the region in which the instance resides. You can call the [DescribeRegions](~~144489~~) operation to query the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'VpcId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the virtual private cloud (VPC). The VPC must be in the region specified by **RegionId**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-bp120k6ixs4eog*****', 'title' => ''],
+ ],
+ [
+ 'name' => 'MultiZoneCombination',
+ 'in' => 'query',
+ 'schema' => ['description' => '<props="china">The zone combination. The following combinations are supported. You can go to the buy page or call the [DescribeMultiZoneAvailableRegions](~~203039~~) operation to view the supported zone combinations.</props>'."\n"
+ .'<props="intl">The zone combination. The following combinations are supported. You can go to the buy page to view the supported zone combinations.</props>.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-bef-aliyun-com', 'title' => ''],
+ ],
+ [
+ 'name' => 'PrimaryZoneId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The zone ID of the primary zone instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-e', 'title' => ''],
+ ],
+ [
+ 'name' => 'PrimaryVSwitchId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The vSwitch ID of the primary zone instance. The vSwitch must be in the zone specified by **PrimaryZoneId**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vsw-hangxzhouxe*****', 'title' => ''],
+ ],
+ [
+ 'name' => 'StandbyZoneId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The zone ID of the secondary zone instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-f', 'title' => ''],
+ ],
+ [
+ 'name' => 'StandbyVSwitchId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The vSwitch ID of the secondary zone instance. The vSwitch must be in the zone specified by **StandbyZoneId**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vsw-hangxzhouxf****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ArbiterZoneId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The zone ID of the arbitration zone.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-b', 'title' => ''],
+ ],
+ [
+ 'name' => 'ArbiterVSwitchId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The vSwitch ID of the arbitration zone. The vSwitch must be in the zone specified by **ArbiterZoneId**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vsw-hangxzhouxb****', 'title' => ''],
+ ],
+ [
+ 'name' => 'MasterInstanceType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The node specifications of the master node. You can invoke the [DescribeInstanceType](~~145796~~) operation to query the node specifications.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hbase.sn1.medium', 'title' => ''],
+ ],
+ [
+ 'name' => 'CoreInstanceType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The node specifications of the core node. You can invoke the [DescribeInstanceType](~~145796~~) operation to query the node specifications.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hbase.sn1.medium', 'title' => ''],
+ ],
+ [
+ 'name' => 'CoreDiskType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The disk type of the core node. Valid values:'."\n"
+ .'- **cloud_efficiency**: ultra cloud disk.'."\n"
+ .'- **cloud_ssd**: standard SSD.'."\n"
+ .'- **local_hdd_pro**: throughput-intensive local disk.'."\n"
+ .'- **local_ssd_pro**: I/O-intensive local disk.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cloud_ssd', 'title' => ''],
+ ],
+ [
+ 'name' => 'CoreDiskSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The disk size of the node. Valid values: 400 to 64000. Unit: GB. The value must be a multiple of 40.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '64000', 'minimum' => '400', 'example' => '400', 'title' => ''],
+ ],
+ [
+ 'name' => 'CoreNodeCount',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of core nodes. Valid values: 2 to 20. The value must be an even number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2000', 'minimum' => '4', 'example' => '4', 'title' => ''],
+ ],
+ [
+ 'name' => 'LogInstanceType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The node specifications of the log node. You can invoke the [DescribeInstanceType](~~145796~~) operation to query the node specifications.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'hbase.sn1.medium', 'title' => ''],
+ ],
+ [
+ 'name' => 'LogDiskType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The disk type of the log node. Valid values:'."\n"
+ .'- **cloud_efficiency**: ultra cloud disk.'."\n"
+ .'- **cloud_ssd**: standard SSD.'."\n"
+ .'- **local_hdd_pro**: throughput-intensive local disk.'."\n"
+ .'- **local_ssd_pro**: I/O-intensive local disk.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cloud_ssd', 'title' => ''],
+ ],
+ [
+ 'name' => 'LogDiskSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The disk size of the log node. Valid values: 400 to 64000. Unit: GB. The value must be a multiple of 40.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '64000', 'minimum' => '400', 'example' => '400', 'title' => ''],
+ ],
+ [
+ 'name' => 'LogNodeCount',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of log nodes. Valid values: 4 to 400. The value must be a multiple of 4.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '200', 'minimum' => '4', 'example' => '4', 'title' => ''],
+ ],
+ [
+ 'name' => 'SecurityIPList',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The IP addresses in the whitelist of the instance. Separate multiple IP addresses with commas (,).'."\n"
+ ."\n"
+ .'> If the IP address is set to 127.0.0.1, all addresses are denied access to the instance. For example, 192.168.0.0/24 indicates that all IP addresses in the 192.168.0.XX range are allowed to access the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '127.0.0.1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PayType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The billing method of the instance. Valid values:'."\n"
+ ."\n"
+ .'- **Prepaid**: subscription.'."\n"
+ .'- **Postpaid**: pay-as-you-go.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Postpaid', 'title' => ''],
+ ],
+ [
+ 'name' => 'PeriodUnit',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The unit of the subscription duration for the subscription instance. Valid values:'."\n"
+ ."\n"
+ .'- **year**'."\n"
+ .'- **month**'."\n"
+ ."\n"
+ .'> This parameter is required only when PayType is set to Prepaid.', 'type' => 'string', 'required' => false, 'example' => 'month', 'title' => ''],
+ ],
+ [
+ 'name' => 'Period',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The subscription duration of the subscription instance. Valid values:'."\n"
+ ."\n"
+ .'- If PeriodUnit is set to year, valid values are 1 to 3.'."\n"
+ .'- If PeriodUnit is set to month, valid values are 1 to 9.'."\n"
+ ."\n"
+ .'> This parameter is required only when PayType is set to Prepaid.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '60', 'minimum' => '1', 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'AutoRenewPeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The auto-renewal period of the instance. Unit: months.'."\n"
+ ."\n"
+ .'> <ul><li>The default value is 0, which indicates that the instance is not automatically renewed after the instance expires.</li>'."\n"
+ .'<li>For example, if the auto-renewal period is set to 2, the instance is automatically renewed for two months after the instance expires.</li></ul>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '60', 'minimum' => '1', 'example' => '0', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value. Make sure that the value is unique among different requests. The value cannot exceed 64 ASCII characters in length and cannot contain non-ASCII characters.', 'type' => 'string', 'required' => false, 'example' => 'f4g8t5rd2gr94****', 'title' => ''],
],
],
'responses' => [
@@ -8742,27 +6745,47 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AFAA617B-3268-5883-982B-DB8EC8CC1F1B',
- ],
+ 'Success' => ['description' => 'Indicates whether available resources exist. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Available resources exist.'."\n"
+ .'- **false**: No available resources exist.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FB703B69-D4D4-4879-B9FE-6A37F67C46FD', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFAA617B-3268-5883-982B-DB8EC8C*****\\"\\n}","type":"json"}]',
- ],
- 'DeleteAccount' => [
- 'summary' => '删除账户',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Evaluate whether available resources exist',
+ 'summary' => 'Calls the EvaluateMultiZoneResource operation to evaluate whether available resources exist.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-06T09:46:53.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:EvaluateMultiZoneResource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"FB703B69-D4D4-4879-B9FE-6A37F67C46FD\\"\\n}","type":"json"}]',
+ ],
+ 'GetMultimodeCmsUrl' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8770,29 +6793,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp150tns0sjxs****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-t4naqsay5gn******', 'title' => ''],
],
[
- 'name' => 'AccountName',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test01',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
@@ -8800,27 +6811,47 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '729CB2A7-3065-53A9-B27C-7033CA4881D9',
- ],
+ 'MultimodCmsUrl' => ['description' => 'The CloudMonitor URL.', 'type' => 'string', 'example' => 'htpp://***********', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '44183B05-852E-4716-B902-52977140190F', 'title' => ''],
+ 'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'hb-t4naqsay5gn******', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"729CB2A7-3065-53A9-B27C-7033CA4*****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAccountResponse>\\n <RequestId>729CB2A7-3065-53A9-B27C-7033CA4*****</RequestId>\\n</DeleteAccountResponse>","errorExample":""}]',
- ],
- 'Grant' => [
- 'summary' => '授权账户权限',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Retrieve multimodal CMS URL',
+ 'summary' => 'Retrieves the monitoring URL based on the cluster ID.',
+ 'description' => 'CloudMonitor has been migrated. This operation is no longer in use. Access monitoring from the Monitoring and Alerts page in cluster management.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-06T09:46:53.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:GetMultimodeCmsUrl',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MultimodCmsUrl\\": \\"htpp://***********\\",\\n \\"RequestId\\": \\"44183B05-852E-4716-B902-52977140190F\\",\\n \\"ClusterId\\": \\"hb-t4naqsay5gn******\\"\\n}","type":"json"}]',
+ ],
+ 'Grant' => [
+ 'summary' => 'Grants permissions to an account.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8833,57 +6864,31 @@
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp150tns0sjxs****',
- ],
+ 'schema' => ['description' => 'The ID of target instance. You can call the DescribeInstances operation to obtain target instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp150tns0sjxs****', 'title' => ''],
],
[
'name' => 'AccountName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test01',
- ],
+ 'schema' => ['description' => 'The name of the account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test01', 'title' => ''],
],
[
'name' => 'Namespace',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => 'The namespace. An asterisk (*) indicates global, which means all namespaces.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default', 'title' => ''],
],
[
'name' => 'TableName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'table',
- ],
+ 'schema' => ['description' => 'The table name. An asterisk (*) indicates global, which means all tables.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'table', 'title' => ''],
],
[
'name' => 'AclActions',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'READ,WRITE',
- ],
+ 'schema' => ['description' => 'The permission list. Separate multiple permissions with commas (,). Valid values:'."\n"
+ .'- READ: read permission.'."\n"
+ .'- WRITE: write permission.'."\n"
+ .'- ADMIN: admin permission.'."\n"
+ .'- TRASH: purge permission.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'READ,WRITE', 'title' => ''],
],
],
'responses' => [
@@ -8891,27 +6896,37 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9CBF8DF0-4931-4A54-9B60-4C6E1AB5****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9CBF8DF0-4931-4A54-9B60-4C6E1AB5****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9CBF8DF0-4931-4A54-9B60-4C6E1AB5****\\"\\n}","errorExample":""},{"type":"xml","example":"<GrantResponse>\\n <RequestId>9CBF8DF0-4931-4A54-9B60-4C6E1AB5****</RequestId>\\n</GrantResponse>","errorExample":""}]',
- ],
- 'Revoke' => [
- 'summary' => '回收账户权限',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Grant account permissions',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:Grant',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9CBF8DF0-4931-4A54-9B60-4C6E1AB5****\\"\\n}","type":"json"}]',
+ ],
+ 'ListHBaseInstances' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8922,59 +6937,9 @@
'systemTags' => [],
'parameters' => [
[
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp150tns0sjxs****',
- ],
- ],
- [
- 'name' => 'AccountName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test01',
- ],
- ],
- [
- 'name' => 'Namespace',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'default',
- ],
- ],
- [
- 'name' => 'TableName',
+ 'name' => 'VpcId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'table',
- ],
- ],
- [
- 'name' => 'AclActions',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'READ,WRITE',
- ],
+ 'schema' => ['description' => 'The VPC ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-t4nx81tmlixcq5i****', 'title' => ''],
],
],
'responses' => [
@@ -8982,26 +6947,69 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '89F81C30-320B-4550-91DB-C37C81D2358F', 'title' => ''],
+ 'Instances' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Instance' => [
+ 'description' => 'The instances.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'IsDefault' => ['description' => 'The fixed return value is false.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'InstanceId' => ['description' => 'The instance ID of the ApsaraDB for HBase database instance in the same VPC.', 'type' => 'string', 'example' => 'hb-t4naqsay5gn****', 'title' => ''],
+ 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'name_test', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'C9085433-A56A-4089-B49A-DF5A4E2B7B06',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C9085433-A56A-4089-B49A-DF5A4E2*****\\"\\n}","type":"json"}]',
- ],
- 'TagResources' => [
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Query hBase instance list',
+ 'summary' => 'Calls ListHBaseInstances to retrieve ApsaraDB for HBase instances within the same VPC.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:56:05.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:ListHBaseInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"89F81C30-320B-4550-91DB-C37C81D2358F\\",\\n \\"Instances\\": {\\n \\"Instance\\": [\\n {\\n \\"IsDefault\\": false,\\n \\"InstanceId\\": \\"hb-t4naqsay5gn****\\",\\n \\"InstanceName\\": \\"name_test\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'ListInstanceServiceConfigHistories' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -9009,97 +7017,97 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-t4naqsay5gn******', 'title' => ''],
],
[
- 'name' => 'ResourceId',
+ 'name' => 'PageSize',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '',
- 'example' => 'bds-bp15e022622fk0w1',
- 'items' => [
- 'description' => '',
- 'example' => 'ld-bp17pwu1541ia****',
- 'required' => false,
- 'type' => 'string',
- ],
- 'maxItems' => 51,
- 'required' => true,
- 'type' => 'array',
- ],
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'Tag',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'Key' => [
- 'description' => '',
- 'example' => 'key1',
- 'required' => false,
- 'type' => 'string',
- ],
- 'Value' => [
- 'description' => '',
- 'example' => 'value1',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- 'type' => 'object',
- ],
- 'maxItems' => 21,
- 'required' => true,
- 'type' => 'array',
- ],
+ 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'RequestId' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '658C1549-2C02-4FD9-9490-EB3B285F9DCA', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageRecordCount' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'ConfigureHistoryList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Config' => [
+ 'description' => 'The list of configuration item modification history.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Effective' => ['description' => 'Indicates whether the configuration has taken effect. Many parameters require a restart to take effect.', 'type' => 'string', 'example' => 'false', 'title' => ''],
+ 'OldValue' => ['description' => 'The value before the modification.', 'type' => 'string', 'example' => '10485760', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the record was created, which is also the time when the configuration item was modified.', 'type' => 'string', 'example' => '1608708923000', 'title' => ''],
+ 'NewValue' => ['description' => 'The value after the modification.', 'type' => 'string', 'example' => '10485770', 'title' => ''],
+ 'ConfigureName' => ['description' => 'The name of the configuration item.', 'type' => 'string', 'example' => 'hbase#hbase-site.xml#hbase.client.keyvalue.maxsize', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'example' => '2656FA19-6059-40C8-A157-3FFBEAEC2369',
- 'type' => 'string',
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2656FA19-6059-40C8-A157-3FFBEAEC2369\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>9CBF8DF0-4931-4A54-9B60-4C6E1AB59286</RequestId>","errorExample":""}]',
- 'extraInfo' => ' ',
+ 'title' => 'Query instance service configuration history',
+ 'summary' => 'Retrieves the modification history of cluster parameters by calling ListInstanceServiceConfigHistories.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'UnTagResources' => [
- 'methods' => [
- 'post',
- 'get',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-06T09:46:52.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hbase:ListInstanceServiceConfigHistories',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"658C1549-2C02-4FD9-9490-EB3B285F9DCA\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 10,\\n \\"TotalRecordCount\\": 1,\\n \\"ConfigureHistoryList\\": {\\n \\"Config\\": [\\n {\\n \\"Effective\\": \\"false\\",\\n \\"OldValue\\": \\"10485760\\",\\n \\"CreateTime\\": \\"1608708923000\\",\\n \\"NewValue\\": \\"10485770\\",\\n \\"ConfigureName\\": \\"hbase#hbase-site.xml#hbase.client.keyvalue.maxsize\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'ListInstanceServiceConfigurations' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -9107,60 +7115,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'All',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-t4naqsay5gn****', 'title' => ''],
],
[
- 'name' => 'ResourceId',
+ 'name' => 'PageSize',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- 'required' => true,
- 'example' => 'bds-bp15e022622fk0w1',
- 'maxItems' => 51,
- ],
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'TagKey',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- 'required' => false,
- 'example' => 'key1',
- 'maxItems' => 21,
- ],
+ 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
@@ -9168,30 +7138,81 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5B381E36-BCA3-4377-8638-B65C236617D5', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageRecordCount' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '42', 'title' => ''],
+ 'ConfigureList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Config' => [
+ 'description' => 'The list of configuration items.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => ['description' => 'The description of the configuration item.', 'type' => 'string', 'example' => 'hbase client keyvalue maxsize', 'title' => ''],
+ 'RunningValue' => ['description' => 'The current running value of the cluster.', 'type' => 'string', 'example' => '10485760', 'title' => ''],
+ 'ConfigureUnit' => ['description' => 'The type of the configuration item. Valid values:'."\n"
+ .'- INT: integer.'."\n"
+ .'- STR: string.'."\n"
+ .'- FLOAT: single-precision floating point.', 'type' => 'string', 'example' => 'INT', 'title' => ''],
+ 'ConfigureName' => ['description' => 'The name of the configuration item.', 'type' => 'string', 'example' => 'hbase#hbase-site.xml#hbase.client.keyvalue.maxsize', 'title' => ''],
+ 'ValueRange' => ['description' => 'The value range.', 'type' => 'string', 'example' => 'R[10485760,52428800]', 'title' => ''],
+ 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'example' => '10485760', 'title' => ''],
+ 'NeedRestart' => ['description' => 'Indicates whether a restart is required after the configuration item is changed. Valid values:'."\n"
+ .'- true: A restart is required.'."\n"
+ .'- false: A restart is not required.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => '9CBF8DF0-4931-4A54-9B60-4C6E1AB59286',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9CBF8DF0-4931-4A54-9B60-4C6E1AB59286\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>9CBF8DF0-4931-4A54-9B60-4C6E1AB59286</RequestId>","errorExample":""}]',
- 'title' => 'UnTagResources',
+ 'title' => 'List instance service configurations',
+ 'summary' => 'Retrieves the configuration items of a cluster by calling ListInstanceServiceConfigurations.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListTagResources' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-06T09:46:52.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hbase:ListInstanceServiceConfigurations',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5B381E36-BCA3-4377-8638-B65C236617D5\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 10,\\n \\"TotalRecordCount\\": 42,\\n \\"ConfigureList\\": {\\n \\"Config\\": [\\n {\\n \\"Description\\": \\"hbase client keyvalue maxsize\\",\\n \\"RunningValue\\": \\"10485760\\",\\n \\"ConfigureUnit\\": \\"INT\\",\\n \\"ConfigureName\\": \\"hbase#hbase-site.xml#hbase.client.keyvalue.maxsize\\",\\n \\"ValueRange\\": \\"R[10485760,52428800]\\",\\n \\"DefaultValue\\": \\"10485760\\",\\n \\"NeedRestart\\": \\"true\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'ListTagResources' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -9199,47 +7220,30 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'NextToken',
- ],
+ 'schema' => ['description' => 'The token used to start the next query. If the amount of data exceeds the limit, this parameter is returned for you to query the next page.', 'type' => 'string', 'required' => false, 'example' => 'NextToken', 'title' => ''],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '',
+ 'description' => 'The ID of resource N. In this context, the resource ID is the cluster ID. You can query multiple resources at a time by specifying ResourceId.2, ResourceId.3, and so on. N is a positive integer.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bds-bp15e022622f****',
- ],
+ 'items' => ['description' => 'The ID of resource N. In this context, the resource ID is the cluster ID. You can query multiple resources at a time by specifying ResourceId.2, ResourceId.3, and so on. N is a positive integer.', 'type' => 'string', 'required' => false, 'example' => 'bds-bp15e022622f****', 'title' => ''],
'required' => false,
'example' => 'bds-bp15e022622f****',
'maxItems' => 51,
+ 'title' => '',
],
],
[
@@ -9247,28 +7251,23 @@
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '',
+ 'description' => 'The list of tags.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'key1',
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'value1',
- ],
+ 'Key' => ['description' => 'The key of the tag to query. You can specify multiple keys. N is a positive integer.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''],
+ 'Value' => ['description' => 'The value of the tag to query. You can specify multiple values. N is a positive integer.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''],
],
'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
'maxItems' => 21,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -9277,90 +7276,84 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1d2db86sca4384811e0b5e8707e68****',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '74F02441-9A8D-48F6-933F-E317AEB28DBF',
- ],
+ 'NextToken' => ['description' => 'The token used to start the next query. An empty value of NextToken indicates that no more pages exist.', 'type' => 'string', 'example' => '1d2db86sca4384811e0b5e8707e68****', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '74F02441-9A8D-48F6-933F-E317AEB28DBF', 'title' => ''],
'TagResources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagResource' => [
- 'description' => '',
+ 'description' => 'The list of resources.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'TagValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'v2',
- ],
- 'ResourceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ALIYUN::MULTIMOD::CLUSTER',
- ],
- 'ResourceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'bds-bp15e022622f****',
- ],
- 'TagKey' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'k1',
- ],
+ 'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'v2', 'title' => ''],
+ 'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'ALIYUN::MULTIMOD::CLUSTER', 'title' => ''],
+ 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'bds-bp15e022622f****', 'title' => ''],
+ 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'k1', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"1d2db86sca4384811e0b5e8707e68****\\",\\n \\"RequestId\\": \\"74F02441-9A8D-48F6-933F-E317AEB28DBF\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"TagValue\\": \\"v2\\",\\n \\"ResourceType\\": \\"ALIYUN::MULTIMOD::CLUSTER\\",\\n \\"ResourceId\\": \\"bds-bp15e022622f****\\",\\n \\"TagKey\\": \\"k1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<NextToken>1d2db86sca4384811e0b5e8707e68****</NextToken>\\n<RequestId>74F02441-9A8D-48F6-933F-E317AEB28DBF</RequestId>\\n<TagResources>\\n <TagResource>\\n <TagKey>k1</TagKey>\\n <ResourceType>ALIYUN::MULTIMOD::CLUSTER</ResourceType>\\n <TagValue>v2</TagValue>\\n <ResourceId>bds-bp15e022622f****</ResourceId>\\n </TagResource>\\n</TagResources>","errorExample":""}]',
'title' => 'ListTagResources',
+ 'summary' => 'Retrieves a list of tags by ResourceId or Tag (query by Key only, or by both Key and Value).',
+ 'description' => 'You must specify at least one of the ResourceId and Tag parameters. Otherwise, an error is returned.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListTags' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:48:58.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:ListTagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"1d2db86sca4384811e0b5e8707e68****\\",\\n \\"RequestId\\": \\"74F02441-9A8D-48F6-933F-E317AEB28DBF\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"TagValue\\": \\"v2\\",\\n \\"ResourceType\\": \\"ALIYUN::MULTIMOD::CLUSTER\\",\\n \\"ResourceId\\": \\"bds-bp15e022622f****\\",\\n \\"TagKey\\": \\"k1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'ListTags' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-shanghai',
- ],
+ 'schema' => ['description' => 'The region ID. You can call DescribeRegions to obtain the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''],
],
],
'responses' => [
@@ -9368,55 +7361,69 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '36D1BE9B-3C4A-425B-947A-69E3D77999C4',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '36D1BE9B-3C4A-425B-947A-69E3D77999C4', 'title' => ''],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
- 'description' => '',
+ 'description' => 'The list of labels.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'TagValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'v2',
- ],
- 'TagKey' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'k1',
- ],
+ 'TagValue' => ['description' => 'The label value.', 'type' => 'string', 'example' => 'v2', 'title' => ''],
+ 'TagKey' => ['description' => 'The label key.', 'type' => 'string', 'example' => 'k1', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"36D1BE9B-3C4A-425B-947A-69E3D77999C4\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"TagValue\\": \\"v2\\",\\n \\"TagKey\\": \\"k1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<Tags>\\n <Tag>\\n <TagValue/>\\n <TagKey>k1</TagKey>\\n </Tag>\\n <Tag>\\n <TagValue>v1</TagValue>\\n <TagKey>k1</TagKey>\\n </Tag>\\n <Tag>\\n <TagValue>v2</TagValue>\\n <TagKey>k1</TagKey>\\n </Tag>\\n <Tag>\\n <TagValue>v2</TagValue>\\n <TagKey>k2</TagKey>\\n </Tag>\\n <Tag>\\n <TagValue>v3</TagValue>\\n <TagKey>k3</TagKey>\\n </Tag>\\n <Tag>\\n <TagValue>single</TagValue>\\n <TagKey>type</TagKey>\\n </Tag>\\n</Tags>\\n<RequestId>36D1BE9B-3C4A-425B-947A-69E3D77999C4</RequestId>","errorExample":""}]',
- 'title' => 'ListTags',
+ 'title' => 'Retrieve all labels in a region',
+ 'summary' => 'Retrieves all labels in a specified region.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CreateServerlessCluster' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:48:58.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:ListTags',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36D1BE9B-3C4A-425B-947A-69E3D77999C4\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"TagValue\\": \\"v2\\",\\n \\"TagKey\\": \\"k1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'ModifyAccountPassword' => [
+ 'summary' => 'Changes the password of a database access account.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -9424,214 +7431,169 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of target instance. You can call the DescribeInstances operation to obtain target instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp150tns0sjxs****', 'title' => ''],
],
[
- 'name' => 'ZoneId',
+ 'name' => 'AccountName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou-f',
- ],
+ 'schema' => ['description' => 'The name of the account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test01', 'title' => ''],
],
[
- 'name' => 'ClusterName',
+ 'name' => 'NewAccountPassword',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'serverless-name',
- ],
+ 'schema' => ['description' => 'The new password of the account. The password must meet the following requirements:'."\n"
+ .'* Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n"
+ .'* Is 8 to 32 characters in length.'."\n"
+ .'* Special characters include `!@#$%^&*()_+-=`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test*****', 'title' => ''],
],
- [
- 'name' => 'VpcId',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'AFAA617B-3268-5883-982B-DB8EC8C*****', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'vpc-bp120k6ixs4eog****',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'title' => 'Change database account password',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'VSwitchId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'vsw-bp191ipotqj1ssyl*****',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyAccountPassword',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFAA617B-3268-5883-982B-DB8EC8C*****\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyActiveOperationTasks' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'PayType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Prepaid',
- ],
+ 'AK' => [],
],
+ ],
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
[
- 'name' => 'PeriodUnit',
+ 'name' => 'Ids',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'month',
- ],
+ 'schema' => ['description' => 'The O&M task IDs. Separate multiple IDs with commas (,).'."\n"
+ ."\n"
+ .'> You can call [DescribeActiveOperationTasks](~~414458~~) to obtain O&M task IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1111,2222', 'title' => ''],
],
[
- 'name' => 'Period',
+ 'name' => 'SwitchTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '60',
- 'minimum' => '0',
- 'example' => '6',
- 'default' => '0',
- ],
+ 'schema' => ['description' => 'The scheduled switchover time to set. Specify the time in the _yyyy-MM-ddTHH:mm:ssZ_ format (UTC).'."\n"
+ ."\n"
+ .'> The time cannot be later than the deadline. You can call [DescribeActiveOperationTasks](~~414458~~) and check the value of the **Deadline** response parameter to obtain the deadline.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-02-17T18:50:00Z', 'title' => ''],
],
[
- 'name' => 'AutoRenewPeriod',
+ 'name' => 'ImmediateStart',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '36',
- 'minimum' => '0',
- 'example' => '2',
- 'default' => '0',
- ],
+ 'schema' => ['description' => 'Specifies whether to immediately execute the O&M task. Valid values:'."\n"
+ ."\n"
+ .'- **1**: immediately executes the task.'."\n"
+ .'- **0**: executes the task at the specified time.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
- [
- 'name' => 'ServerlessSpec',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Ids' => ['description' => 'The O&M task IDs. Multiple IDs are separated with commas (,).', 'type' => 'string', 'example' => '1111,2222', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8C9CC46A-9532-4752-B59F-580112C5A45B', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'serverless.small',
- 'default' => 'serverless.small',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'ServerlessCapability',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '20000',
- 'minimum' => '50',
- 'example' => '1000',
- 'default' => '50',
- ],
+ ],
+ 'title' => 'ModifyActiveOperationTasks',
+ 'summary' => 'Calls the ModifyActiveOperationTasks operation to modify the scheduled switchover time of O&M tasks.',
+ 'description' => 'In addition to notifications sent by text message, phone call, email, or internal message, O&M events of ApsaraDB for HBase (such as minor engine version updates) are also displayed in the console. In addition to calling this operation to modify the scheduled switchover time, you can also modify it in the console. For more information, see [Query or manage pending events](~~405057~~).',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyActiveOperationTasks'],
],
+ ],
+ 'ramActions' => [
[
- 'name' => 'ServerlessStorage',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '20000',
- 'minimum' => '10',
- 'example' => '100',
- 'default' => '10',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyActiveOperationTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"1111,2222\\",\\n \\"RequestId\\": \\"8C9CC46A-9532-4752-B59F-580112C5A45B\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyBackupPlanConfig' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'Engine',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'serverlesshbase',
- 'default' => 'serverlesshbase',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
[
- 'name' => 'EngineVersion',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2.0',
- 'default' => '2.0',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-m5eznlga4k5bcxxxx', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'Tables',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ETnLKlblzczshOTUbOCz****',
- ],
+ 'schema' => ['description' => 'The tables to back up. Specify one table name per line. Wildcards are supported. An asterisk (*) indicates all tables.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*', 'title' => ''],
],
[
- 'name' => 'ClientType',
+ 'name' => 'FullBackupCycle',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
+ 'schema' => ['description' => 'The full backup cycle, in days. Valid values: 3 to 9.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7', 'title' => ''],
],
[
- 'name' => 'ResourceGroupId',
+ 'name' => 'MinHFileBackupCount',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-j4d53glb3****',
- ],
+ 'schema' => ['description' => 'The number of full backups to retain. Valid values: 3 to 8.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3', 'title' => ''],
],
[
- 'name' => 'DiskType',
+ 'name' => 'NextFullBackupDate',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cloud_ssd',
- ],
+ 'schema' => ['description' => 'The time of the next full backup. The specified time must be at least 6 minutes later than the current time.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-11-09T18:00:00Z', 'title' => ''],
],
],
'responses' => [
@@ -9639,46 +7601,44 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3E19E345-101D-4014-946C-************',
- ],
- 'PassWord' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '*********',
- ],
- 'OrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '23232453233*****',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sh-bp1a969y7681****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '50F4A8C2-076F-4703-9813-2FCD7FBB91C2', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3E19E345-101D-4014-946C-************\\",\\n \\"PassWord\\": \\"*********\\",\\n \\"OrderId\\": \\"23232453233*****\\",\\n \\"ClusterId\\": \\"sh-bp1a969y7681****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>3E19E345-101D-4014-946C-************</RequestId>\\n<ClusterId>sh-bp1a969y7681****</ClusterId>\\n<OrderId>23232453233*****</OrderId>\\n<PassWord>*********</PassWord>","errorExample":""}]',
- 'title' => 'CreateServerlessCluster',
+ 'title' => 'Change backup configuration',
+ 'summary' => 'Modifies the backup configuration for an HBaseue cluster that has backup and recovery enabled.',
+ 'description' => 'Before calling this operation, make sure that the backup and recovery feature is enabled for the HBaseue cluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DeleteServerlessCluster' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:48:58.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyBackupPlanConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50F4A8C2-076F-4703-9813-2FCD7FBB91C2\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyBackupPolicy' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -9686,42 +7646,39 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sh-bp1pj13wh9****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-t4naqsay5gn****', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'PreferredBackupTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-shenzhen',
- ],
+ 'schema' => ['description' => 'The backup time range in the current time zone. The interval is 1 hour.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '01:00-02:00', 'title' => ''],
],
[
- 'name' => 'ZoneId',
+ 'name' => 'PreferredBackupPeriod',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-shenzhen-e',
- ],
+ 'schema' => ['description' => 'The backup cycle. Valid values:'."\n"
+ .'- Monday: performs backup every Monday.'."\n"
+ .'- Tuesday: performs backup every Tuesday.'."\n"
+ .'- Wednesday: performs backup every Wednesday.'."\n"
+ .'- Thursday: performs backup every Thursday.'."\n"
+ .'- Friday: performs backup every Friday.'."\n"
+ .'- Saturday: performs backup every Saturday.'."\n"
+ .'- Sunday: performs backup every Sunday.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Thursday', 'title' => ''],
+ ],
+ [
+ 'name' => 'PreferredBackupStartTimeUTC',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The UTC time when the backup starts.', 'type' => 'string', 'required' => false, 'example' => '17:00Z', 'title' => ''],
+ ],
+ [
+ 'name' => 'PreferredBackupEndTimeUTC',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The UTC time when the backup ends.', 'type' => 'string', 'required' => false, 'example' => '18:00Z', 'title' => ''],
],
],
'responses' => [
@@ -9729,30 +7686,43 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '46950E74-59C4-4E3E-9B38-A33B*********',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '17E3AC63-300D-4B69-9108-45EC20E50E85', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"46950E74-59C4-4E3E-9B38-A33B*********\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>46950E74-59C4-4E3E-9B38-A33B*********</RequestId>","errorExample":""}]',
- 'title' => 'DeleteServerlessCluster',
+ 'title' => 'Modify backup policy settings',
+ 'summary' => 'Calls ModifyBackupPolicy to modify the backup plan of an HBase cluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeServerlessCluster' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-06T09:46:52.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyBackupPolicy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"17E3AC63-300D-4B69-9108-45EC20E50E85\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyClusterDeletionProtection' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -9760,31 +7730,20 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'ZoneId',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sdh0b7f4k5f****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-****************', 'title' => ''],
],
[
- 'name' => 'ClusterId',
+ 'name' => 'Protection',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-bp16f1441y6p2****',
- ],
+ 'schema' => ['description' => 'Specifies whether to enable deletion protection. Valid values:'."\n"
+ ."\n"
+ .'- true: Enables deletion protection. The cluster cannot be deleted when deletion protection is enabled.'."\n"
+ .'- false: Disables deletion protection. The cluster can be deleted.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
@@ -9792,155 +7751,43 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'VpcId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vpc-bp120k6ixs4eoghz****',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ACTIVATION',
- ],
- 'InnerEndpoint' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://sh-wz91452kg946i****-lindorm-serverless-in.lindorm.rds.aliyuncs.com:443',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-10-12T14:40:46',
- ],
- 'PayType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Postpaid',
- ],
- 'MainVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2.0.8',
- ],
- 'LockMode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'HasUser' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'false',
- ],
- 'HaType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'false',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '89F81C30-320B-4550-91DB-C37C81D2358F',
- ],
- 'UpdateStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NO',
- ],
- 'ReserverMaxQpsNum' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'InstanceName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'OuterEndpoint' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://sh-wz91452kg946i****-lindorm-serverless.lindorm.rds.aliyuncs.com:443',
- ],
- 'CuSize' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '150',
- ],
- 'ExpireTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-10-12T14:40:46',
- ],
- 'ReserverMinQpsNum' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '50',
- ],
- 'AutoRenew' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'false',
- ],
- 'DiskSize' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'InstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hb-bp16f1441y6p2****',
- ],
- 'IsDeletionProtection' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'VSwitchId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vsw-bp191ipotqf****',
- ],
- 'ClusterType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'single',
- ],
- 'ResourceGroupId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rg-fjm2d4v7sf****',
- ],
- 'ZoneId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-f',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '24C80BD8-C710-4138-893A-D2AFED4FC13D', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"VpcId\\": \\"vpc-bp120k6ixs4eoghz****\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"InnerEndpoint\\": \\"https://sh-wz91452kg946i****-lindorm-serverless-in.lindorm.rds.aliyuncs.com:443\\",\\n \\"CreateTime\\": \\"2019-10-12T14:40:46\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"MainVersion\\": \\"2.0.8\\",\\n \\"LockMode\\": \\"过期\\",\\n \\"HasUser\\": \\"false\\",\\n \\"HaType\\": \\"false\\",\\n \\"RequestId\\": \\"89F81C30-320B-4550-91DB-C37C81D2358F\\",\\n \\"UpdateStatus\\": \\"NO\\",\\n \\"ReserverMaxQpsNum\\": \\"100\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"OuterEndpoint\\": \\"https://sh-wz91452kg946i****-lindorm-serverless.lindorm.rds.aliyuncs.com:443\\",\\n \\"CuSize\\": \\"150\\",\\n \\"ExpireTime\\": \\"2019-10-12T14:40:46\\",\\n \\"ReserverMinQpsNum\\": \\"50\\",\\n \\"AutoRenew\\": \\"false\\",\\n \\"DiskSize\\": \\"200\\",\\n \\"InstanceId\\": \\"hb-bp16f1441y6p2****\\",\\n \\"IsDeletionProtection\\": \\"true\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VSwitchId\\": \\"vsw-bp191ipotqf****\\",\\n \\"ClusterType\\": \\"single\\",\\n \\"ResourceGroupId\\": \\"rg-fjm2d4v7sf****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-f\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateStatus>string</UpdateStatus>\\n<ResourceGroupId>rg-fjm2d4v7sf****</ResourceGroupId>\\n<OuterEndpoint>string</OuterEndpoint>\\n<AutoRenew>false</AutoRenew>\\n<ReserverMinQpsNum>50</ReserverMinQpsNum>\\n<IsDeletionProtection>true</IsDeletionProtection>\\n<DiskSize>200</DiskSize>\\n<ReserverMaxQpsNum>100</ReserverMaxQpsNum>\\n<CuSize>150</CuSize>\\n<InnerEndpoint>string</InnerEndpoint>\\n<Status>ACTIVATION</Status>\\n<MainVersion>2.0.8</MainVersion>\\n<ZoneId>cn-hangzhou-f</ZoneId>\\n<RequestId>89F81C30-320B-4550-91DB-C37C81D2358F</RequestId>\\n<InstanceId>hb-bp16f1441y6p2****</InstanceId>\\n<HasUser>false</HasUser>\\n<CreateTime>2019-10-12T14:40:46</CreateTime>\\n<VSwitchId>vsw-bp191ipotqf****</VSwitchId>\\n<HaType>false</HaType>\\n<PayType>Postpaid</PayType>\\n<LockMode>过期</LockMode>\\n<ClusterType>single</ClusterType>\\n<InstanceName>test</InstanceName>\\n<VpcId>vpc-bp120k6ixs4eoghz****</VpcId>\\n<RegionId>cn-hangzhou</RegionId>\\n<ExpireTime>2019-10-12T14:40:46</ExpireTime>","errorExample":""}]',
- 'title' => 'DescribeServerlessCluster',
+ 'errorCodes' => [],
+ 'title' => 'ModifyClusterDeletionProtection',
+ 'summary' => 'Sets the deletion protection attribute of an instance by calling ModifyClusterDeletionProtection.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CreateHbaseHaSlb' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyClusterDeletionProtection',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24C80BD8-C710-4138-893A-D2AFED4FC13D\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyDiskWarningLine' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -9948,63 +7795,84 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'BdsId',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'bds-t4n3496whj23****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-m5eznlga4k5bcxxxx', 'title' => ''],
],
[
- 'name' => 'HaId',
+ 'name' => 'WarningLine',
'in' => 'query',
+ 'schema' => ['description' => 'The alert threshold. Valid values: 50 to 90.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '0', 'example' => '80', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FC4A930D-3AEE-4C9D-BC70-C0F2EEEAA174', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ha-v21tmnxjwh2yu****',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [],
+ 'title' => 'ModifyDiskWarningLine',
+ 'summary' => 'Modifies the disk capacity alert threshold for HBase Cluster Edition and HBaseue clusters. The default alert threshold is 80%.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyDiskWarningLine',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FC4A930D-3AEE-4C9D-BC70-C0F2EEEAA174\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyInstanceMaintainTime' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'HaTypes',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'thrift',
- ],
+ 'schema' => ['description' => 'The ID of the instance for which you want to modify the O&M window. You can call the [DescribeInstances](~~144595~~) operation to obtain the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp1b**6jco89****', 'title' => ''],
],
[
- 'name' => 'HbaseType',
+ 'name' => 'MaintainStartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Active',
- ],
+ 'schema' => ['description' => 'The start time of the instance O&M window. Specify the time in the HH:mmZ format in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '02:00Z', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'MaintainEndTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ETnLKlblzczshOTUbOCz****',
- ],
+ 'schema' => ['description' => 'The end time of the instance O&M window. Specify the time in the HH:mmZ format in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '06:00Z', 'title' => ''],
],
],
'responses' => [
@@ -10012,74 +7880,75 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C9D568D9-A59C-4AF2-8FBB-F086A841D58E',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C9085433-A56A-4089-B49A-DF5A4E2B7B06', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C9D568D9-A59C-4AF2-8FBB-F086A841D58E\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>C9D568D9-A59C-4AF2-8FBB-F086A841D58E</RequestId>","errorExample":""}]',
- 'title' => 'CreateHbaseHaSlb',
+ 'title' => 'Modify instance O&M window start time',
+ 'summary' => 'Calls the ModifyInstanceMaintainTime operation to modify the O&M window start time of an instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DeleteHbaseHaSlb' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyInstanceMaintainTime',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C9085433-A56A-4089-B49A-DF5A4E2B7B06\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyInstanceName' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'BdsId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'bds-t4n3496whj23ia4k',
- ],
+ 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request and prevent repeated request submissions. This parameter value is generated by the client. The value must be unique among different requests, can contain a maximum of 64 ASCII characters, and cannot contain non-ASCII characters.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
- 'name' => 'HaId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ha-v21tmnxjwh2yuy1il',
- ],
+ 'schema' => ['description' => 'The region ID of the instance. You can call the [DescribeRegions](~~144489~~) operation to query the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'HaTypes',
+ 'name' => 'ZoneId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'thrift',
- ],
+ 'schema' => ['description' => 'The zone ID. You can call the [DescribeRegions](~~144489~~) operation to query the zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-f', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp150tns0sjxs****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClusterName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The new name of the instance. You can call the [DescribeInstance](~~144594~~) operation to query the current instance name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testhbaseone', 'title' => ''],
],
],
'responses' => [
@@ -10087,31 +7956,42 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C9D568D9-A59C-4AF2-8FBB-F086A841D58E',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '959DA199-54E5-569D-AD46-92BED8515E62', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C9D568D9-A59C-4AF2-8FBB-F086A841D58E\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>C9D568D9-A59C-4AF2-8FBB-F086A841D58E</RequestId>","errorExample":""}]',
- 'title' => 'DeleteHbaseHaSlb',
+ 'title' => 'Modify instance name',
+ 'summary' => 'Modifies the name of an instance by calling ModifyInstanceName.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'SwitchHbaseHaSlb' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyInstanceName',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"959DA199-54E5-569D-AD46-92BED8515E62\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyInstanceServiceConfig' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -10119,53 +7999,42 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'BdsId',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'bds-t4n3496whj23ia4k',
- ],
+ 'schema' => ['description' => 'The ID of target instance. You can call the [DescribeInstances](~~144595~~) operation to obtain target instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-t4naqsay5gn****', 'title' => ''],
],
[
- 'name' => 'HaId',
+ 'name' => 'Restart',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ha-v21tmnxjwh2yuy1il',
- ],
+ 'schema' => ['description' => 'Specifies whether to restart the instance after the configuration is modified. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Restart the instance.'."\n"
+ .'- **false**: Do not restart the instance.', 'type' => 'boolean', 'required' => false, 'docRequired' => true, 'example' => 'false', 'title' => ''],
],
[
- 'name' => 'HaTypes',
+ 'name' => 'ConfigureName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'thrift',
- ],
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => '<props="china">The name of the configuration item to modify. You can call the [ListInstanceServiceConfigurations](~~201980~~) operation to query the configuration item name.</props>'."\n"
+ .'<props="intl">The name of the configuration item to modify.</props>'."\n"
+ ."\n"
+ .'> If you want to modify multiple configuration items, specify the Parameters parameter.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hbase#hbase-site.xml#hbase.client.keyvalue.maxsize', 'title' => ''],
],
[
- 'name' => 'HbaseType',
+ 'name' => 'ConfigureValue',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Active',
- ],
+ 'schema' => ['description' => '<props="china">The value of the configuration item to modify. You can call the [ListInstanceServiceConfigurations](~~201980~~) operation to query the configuration item value.</props>'."\n"
+ .'<props="intl">The value of the configuration item to modify.</props>'."\n"
+ ."\n"
+ .'> If you want to modify multiple configuration items, specify the Parameters parameter.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10485770', 'title' => ''],
+ ],
+ [
+ 'name' => 'Parameters',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The JSON-formatted parameters for modifying multiple configuration items. The key specifies the name of the configuration item, and the value specifies the value of the configuration item.', 'type' => 'string', 'required' => false, 'example' => '{"key1=value1", "key2=value2"}', 'title' => ''],
],
],
'responses' => [
@@ -10173,31 +8042,40 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C9D568D9-A59C-4AF2-8FBB-F086A841D58E',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F008B7AB-025D-4C20-AE12-047C8F8C3D97', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C9D568D9-A59C-4AF2-8FBB-F086A841D58E\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>C9D568D9-A59C-4AF2-8FBB-F086A841D58E</RequestId>","errorExample":""}]',
- 'title' => 'SwitchHbaseHaSlb',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'CreateGlobalResource' => [
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Modify instance service configurations',
+ 'summary' => 'Calls ModifyInstanceServiceConfig to modify cluster configurations. You can call the ListInstanceServiceConfigurations operation to query the configuration items that can be modified.',
+ 'changeSet' => [
+ ['createdAt' => '2022-03-22T12:46:40.000Z', 'description' => 'Request parameters changed, Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyInstanceServiceConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F008B7AB-025D-4C20-AE12-047C8F8C3D97\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyInstanceType' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -10205,59 +8083,103 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-t4naqsay5gn****',
- ],
+ 'schema' => ['description' => 'The ID of target instance. You can call [DescribeInstances](~~144595~~) to obtain target instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-bp1x940uh********', 'title' => ''],
],
[
- 'name' => 'ResourceName',
+ 'name' => 'MasterInstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'PubPhoenixSLBQueryServerVip',
- ],
+ 'schema' => ['description' => 'The new node specifications of the master node. You can invoke [DescribeInstanceType](~~145796~~) to obtain the available node specifications.'."\n"
+ ."\n"
+ .'> You must specify either the MasterInstanceType parameter or the CoreInstanceType parameter.', 'type' => 'string', 'required' => false, 'example' => 'hbase.sn1.large', 'title' => ''],
],
[
- 'name' => 'ResourceType',
+ 'name' => 'CoreInstanceType',
'in' => 'query',
+ 'schema' => ['description' => 'The new node specifications of the core node. You can invoke [DescribeInstanceType](~~145796~~) to obtain the available node specifications.'."\n"
+ ."\n"
+ .'> You must specify either the MasterInstanceType parameter or the CoreInstanceType parameter.', 'type' => 'string', 'required' => false, 'example' => 'hbase.sn1.8xlarge', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '123412341234123', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3E19E345-101D-4014-946C-****', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'GLOBAL_VIP',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'title' => 'Change instance specifications',
+ 'summary' => 'Calls ModifyInstanceType to change the specifications of an instance.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:48:58.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyInstanceType',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"123412341234123\\",\\n \\"RequestId\\": \\"3E19E345-101D-4014-946C-****\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyIpWhitelist' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ClientToken',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxxx-xxxxx-xxxxx',
- ],
+ 'schema' => ['description' => 'The ID of target instance. You can call [DescribeInstances](~~144595~~) to obtain target instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp1uoihlf82e8****', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'IpList',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The IP addresses in the whitelist group after modification. Separate multiple IP addresses with commas (,).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '42.120.XX.XX', 'title' => ''],
+ ],
+ [
+ 'name' => 'GroupName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the whitelist group for the target instance. You can invoke [DescribeIpWhitelist](~~144606~~) to obtain the whitelist group name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'group_01', 'title' => ''],
+ ],
+ [
+ 'name' => 'IpVersion',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The version of the IP address. Valid values:'."\n"
+ ."\n"
+ .'- **4**: IPv4.'."\n"
+ .'- **6**: IPv6.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4', 'title' => ''],
],
],
'responses' => [
@@ -10265,30 +8187,43 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1AB9ABDF-7E1E-44AD-8610-70A005115DD1',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '101CFA8A-FB88-5014-A10C-3A0DA9AD8B0B', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AB9ABDF-7E1E-44AD-8610-70A005115DD1\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateGlobalResourceResponse>\\n <RequestId>1AB9ABDF-7E1E-44AD-8610-70A005115DD1</RequestId>\\n</CreateGlobalResourceResponse>","errorExample":""}]',
- 'title' => 'CreateGlobalResource',
+ 'errorCodes' => [],
+ 'title' => 'Modify IP whitelist',
+ 'summary' => 'Modifies the IP whitelist group of an instance by calling ModifyIpWhitelist.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DeleteGlobalResource' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyIpWhitelist',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"101CFA8A-FB88-5014-A10C-3A0DA9AD8B0B\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyMultiZoneClusterNodeType' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -10296,49 +8231,27 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-t4naqsay5gn******',
- ],
+ 'schema' => ['description' => 'The ID of the multi-zone instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-dj45g7d6rbrd****', 'title' => ''],
],
[
- 'name' => 'ResourceName',
+ 'name' => 'MasterInstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'PubPhoenixSLBQueryServerVip',
- ],
+ 'schema' => ['description' => 'The node specifications of the master node. For valid values, refer to DescribeInstanceType.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'hbase.sn1.8xlarge', 'title' => ''],
],
[
- 'name' => 'ResourceType',
+ 'name' => 'CoreInstanceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'GLOBAL_VIP',
- ],
+ 'schema' => ['description' => 'The node specifications of the core node. For valid values, refer to DescribeInstanceType.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'hbase.sn1.large', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'LogInstanceType',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The node specifications of the log node. For valid values, refer to DescribeInstanceType.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'hbase.sn1.2xlarge', 'title' => ''],
],
],
'responses' => [
@@ -10346,30 +8259,43 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'BD0B0B9A-79E8-4FDD-9C51-93443490B784',
- ],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '12341234123****', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06CF7A6F-A81C-431D-BACD-793F24A67C54', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BD0B0B9A-79E8-4FDD-9C51-93443490B784\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BD0B0B9A-79E8-4FDD-9C51-93443490B784</RequestId>","errorExample":""}]',
- 'title' => 'DeleteGlobalResource',
+ 'errorCodes' => [],
+ 'title' => 'Modify multi-zone cluster node type',
+ 'summary' => 'Modifies the node specifications of a multi-zone instance by calling ModifyMultiZoneClusterNodeType.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeDBInstanceUsage' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyMultiZoneClusterNodeType',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"12341234123****\\",\\n \\"RequestId\\": \\"06CF7A6F-A81C-431D-BACD-793F24A67C54\\"\\n}","type":"json"}]',
+ ],
+ 'ModifySecurityGroups' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -10377,20 +8303,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-bp1u0639js2h7****',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-bp16f1441y6p2kv**', 'title' => ''],
+ ],
+ [
+ 'name' => 'SecurityGroupIds',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The IDs of the security groups, separated by commas.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sg-t4ng4yyc916o81nu****,sg-x4gg4dyc9d6w********', 'title' => ''],
],
],
'responses' => [
@@ -10398,78 +8321,66 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Result' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"disk_usage_record\\":{\\"disk_used\\":\\"0.9GB\\",\\"disk_total\\":\\"1156.1GB\\",\\"usage_rate\\":\\"1%\\"}}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'A2D841CE-D066-53E8-B9AC-3731DCC85397',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F4AD2E65-482B-46B6-942E-765989B1C8A3', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": \\"{\\\\\\\\\\\\\\"disk_usage_record\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"disk_used\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.9GB\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"disk_total\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1156.1GB\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"usage_rate\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1%\\\\\\\\\\\\\\"}}\\",\\n \\"RequestId\\": \\"A2D841CE-D066-53E8-B9AC-3731DCC85397\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBInstanceUsageResponse>\\n <RequestId>A2D841CE-D066-53E8-B9AC-3731DCC85397</RequestId>\\n <Result>{\\"disk_usage_record\\":{\\"disk_used\\":\\"0.0GB\\",\\"disk_total\\":\\"800.0GB\\",\\"usage_rate\\":\\"0.0%\\"}}</Result>\\n</DescribeDBInstanceUsageResponse>","errorExample":""}]',
- 'title' => 'DescribeDBInstanceUsage',
+ 'title' => 'Modify security groups',
+ 'summary' => 'Calls ModifySecurityGroups to modify the security groups associated with a cluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeMultiZoneAvailableResource' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifySecurityGroups',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F4AD2E65-482B-46B6-942E-765989B1C8A3\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyUIAccountPassword' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'ChargeType',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Prepaid',
- ],
+ 'schema' => ['description' => 'The ID of the target instance. You can call the [DescribeInstances](~~144595~~) operation to obtain the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp150tns0sjxs****', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'AccountName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The username of the cluster management system to be reset. If no user has been created for the HBase instance, the default username is **root**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test01', 'title' => ''],
],
[
- 'name' => 'ZoneCombination',
+ 'name' => 'AccountPassword',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou-bef-aliyun',
- ],
+ 'schema' => ['description' => 'The new password for the target username of the cluster management system. The password must be 2 to 30 characters in length and must contain one or more of the following character types: uppercase letters, lowercase letters, special characters, and digits. Supported special characters are underscores (_) and hyphens (-).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '**********', 'title' => ''],
],
],
'responses' => [
@@ -10477,242 +8388,44 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'B2EEBBA9-C627-4415-81A0-B77BC54F1D52',
- ],
- 'AvailableZones' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'AvailableZone' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ZoneCombination' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-bef-aliyun',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'MasterResources' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'MasterResource' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'InstanceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase.sn2.large',
- ],
- 'InstanceTypeDetail' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Mem' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '16',
- ],
- 'Cpu' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'SupportedEngines' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'SupportedEngine' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Engine' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbaseue',
- ],
- 'SupportedEngineVersions' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'SupportedEngineVersion' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Version' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2.0',
- ],
- 'SupportedCategories' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'SupportedCategories' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Category' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cluster',
- ],
- 'SupportedStorageTypes' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'SupportedStorageType' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'StorageType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cloud_efficiency',
- ],
- 'CoreResources' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'CoreResource' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'InstanceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase.sn2.2xlarge',
- ],
- 'MaxCoreCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'DBInstanceStorageRange' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'MaxSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '64000',
- ],
- 'StepSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '40',
- ],
- 'MinSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- ],
- ],
- 'InstanceTypeDetail' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Mem' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8',
- ],
- 'Cpu' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '32',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BED4ADEB-4EA9-507E-892C-84112D6AC7C1', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B2EEBBA9-C627-4415-81A0-B77BC54F1D52\\",\\n \\"AvailableZones\\": {\\n \\"AvailableZone\\": [\\n {\\n \\"ZoneCombination\\": \\"cn-hangzhou-bef-aliyun\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"MasterResources\\": {\\n \\"MasterResource\\": [\\n {\\n \\"InstanceType\\": \\"hbase.sn2.large\\",\\n \\"InstanceTypeDetail\\": {\\n \\"Mem\\": 16,\\n \\"Cpu\\": 4\\n }\\n }\\n ]\\n },\\n \\"SupportedEngines\\": {\\n \\"SupportedEngine\\": [\\n {\\n \\"Engine\\": \\"hbaseue\\",\\n \\"SupportedEngineVersions\\": {\\n \\"SupportedEngineVersion\\": [\\n {\\n \\"Version\\": \\"2.0\\",\\n \\"SupportedCategories\\": {\\n \\"SupportedCategories\\": [\\n {\\n \\"Category\\": \\"cluster\\",\\n \\"SupportedStorageTypes\\": {\\n \\"SupportedStorageType\\": [\\n {\\n \\"StorageType\\": \\"cloud_efficiency\\",\\n \\"CoreResources\\": {\\n \\"CoreResource\\": [\\n {\\n \\"InstanceType\\": \\"hbase.sn2.2xlarge\\",\\n \\"MaxCoreCount\\": 30,\\n \\"DBInstanceStorageRange\\": {\\n \\"MaxSize\\": 64000,\\n \\"StepSize\\": 40,\\n \\"MinSize\\": 400\\n },\\n \\"InstanceTypeDetail\\": {\\n \\"Mem\\": 8,\\n \\"Cpu\\": 32\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>B2EEBBA9-C627-4415-81A0-B77BC54F1D52</RequestId>\\n<AvailableZones>\\n <AvailableZone>\\n <MasterResources>\\n <MasterResource>\\n <InstanceTypeDetail>\\n <Mem>16</Mem>\\n <Cpu>4</Cpu>\\n </InstanceTypeDetail>\\n <InstanceType>hbase.sn2.large</InstanceType>\\n </MasterResource>\\n <MasterResource>\\n <InstanceTypeDetail>\\n <Mem>4</Mem>\\n <Cpu>2</Cpu>\\n </InstanceTypeDetail>\\n <InstanceType>hbase.sn1.medium</InstanceType>\\n </MasterResource>\\n <MasterResource>\\n <InstanceTypeDetail>\\n <Mem>8</Mem>\\n <Cpu>4</Cpu>\\n </InstanceTypeDetail>\\n <InstanceType>hbase.sn1.large</InstanceType>\\n </MasterResource>\\n <MasterResource>\\n <InstanceTypeDetail>\\n <Mem>16</Mem>\\n <Cpu>8</Cpu>\\n </InstanceTypeDetail>\\n <InstanceType>hbase.sn1.2xlarge</InstanceType>\\n </MasterResource>\\n <MasterResource>\\n <InstanceTypeDetail>\\n <Mem>32</Mem>\\n <Cpu>8</Cpu>\\n </InstanceTypeDetail>\\n <InstanceType>hbase.sn2.2xlarge</InstanceType>\\n </MasterResource>\\n <MasterResource>\\n <InstanceTypeDetail>\\n <Mem>32</Mem>\\n <Cpu>16</Cpu>\\n </InstanceTypeDetail>\\n <InstanceType>hbase.sn1.4xlarge</InstanceType>\\n </MasterResource>\\n <MasterResource>\\n <InstanceTypeDetail>\\n <Mem>64</Mem>\\n <Cpu>16</Cpu>\\n </InstanceTypeDetail>\\n <InstanceType>hbase.sn2.4xlarge</InstanceType>\\n </MasterResource>\\n <MasterResource>\\n <InstanceTypeDetail>\\n <Mem>8</Mem>\\n <Cpu>4</Cpu>\\n </InstanceTypeDetail>\\n <InstanceType>hbase.n1.large</InstanceType>\\n </MasterResource>\\n </MasterResources>\\n <ZoneCombination>cn-hangzhou-bef-aliyun</ZoneCombination>\\n <RegionId>cn-hangzhou</RegionId>\\n <SupportedEngines>\\n <SupportedEngine>\\n <SupportedEngineVersions>\\n <SupportedEngineVersion>\\n <Version>2.0</Version>\\n <SupportedCategories>\\n <SupportedCategories>\\n <Category>cluster</Category>\\n <SupportedStorageTypes>\\n <SupportedStorageType>\\n <StorageType>cloud_ssd</StorageType>\\n <CoreResources>\\n <CoreResource>\\n <InstanceTypeDetail>\\n <Mem>32</Mem>\\n <Cpu>8</Cpu>\\n </InstanceTypeDetail>\\n <DBInstanceStorageRange>\\n <MinSize>400</MinSize>\\n <StepSize>40</StepSize>\\n <MaxSize>64000</MaxSize>\\n </DBInstanceStorageRange>\\n <InstanceType>hbase.sn2.2xlarge</InstanceType>\\n <MaxCoreCount>30</MaxCoreCount>\\n </CoreResource>\\n <CoreResource>\\n <InstanceTypeDetail>\\n <Mem>8</Mem>\\n <Cpu>4</Cpu>\\n </InstanceTypeDetail>\\n <DBInstanceStorageRange>\\n <MinSize>400</MinSize>\\n <StepSize>40</StepSize>\\n <MaxSize>64000</MaxSize>\\n </DBInstanceStorageRange>\\n <InstanceType>hbase.sn1.large</InstanceType>\\n <MaxCoreCount>30</MaxCoreCount>\\n </CoreResource>\\n <CoreResource>\\n <InstanceTypeDetail>\\n <Mem>16</Mem>\\n <Cpu>8</Cpu>\\n </InstanceTypeDetail>\\n <DBInstanceStorageRange>\\n <MinSize>400</MinSize>\\n <StepSize>40</StepSize>\\n <MaxSize>64000</MaxSize>\\n </DBInstanceStorageRange>\\n <InstanceType>hbase.sn1.2xlarge</InstanceType>\\n <MaxCoreCount>30</MaxCoreCount>\\n </CoreResource>\\n <CoreResource>\\n <InstanceTypeDetail>\\n <Mem>32</Mem>\\n <Cpu>16</Cpu>\\n </InstanceTypeDetail>\\n <DBInstanceStorageRange>\\n <MinSize>400</MinSize>\\n <StepSize>40</StepSize>\\n <MaxSize>64000</MaxSize>\\n </DBInstanceStorageRange>\\n <InstanceType>hbase.sn1.4xlarge</InstanceType>\\n <MaxCoreCount>30</MaxCoreCount>\\n </CoreResource>\\n <CoreResource>\\n <InstanceTypeDetail>\\n <Mem>64</Mem>\\n <Cpu>32</Cpu>\\n </InstanceTypeDetail>\\n <DBInstanceStorageRange>\\n <MinSize>400</MinSize>\\n <StepSize>40</StepSize>\\n <MaxSize>64000</MaxSize>\\n </DBInstanceStorageRange>\\n <InstanceType>hbase.sn1.8xlarge</InstanceType>\\n <MaxCoreCount>30</MaxCoreCount>\\n </CoreResource>\\n <CoreResource>\\n <InstanceTypeDetail>\\n <Mem>16</Mem>\\n <Cpu>4</Cpu>\\n </InstanceTypeDetail>\\n <DBInstanceStorageRange>\\n <MinSize>400</MinSize>\\n <StepSize>40</StepSize>\\n <MaxSize>64000</MaxSize>\\n </DBInstanceStorageRange>\\n <InstanceType>hbase.sn2.large</InstanceType>\\n <MaxCoreCount>30</MaxCoreCount>\\n </CoreResource>\\n <CoreResource>\\n <InstanceTypeDetail>\\n <Mem>64</Mem>\\n <Cpu>16</Cpu>\\n </InstanceTypeDetail>\\n <DBInstanceStorageRange>\\n <MinSize>400</MinSize>\\n <StepSize>40</StepSize>\\n <MaxSize>64000</MaxSize>\\n </DBInstanceStorageRange>\\n <InstanceType>hbase.sn2.4xlarge</InstanceType>\\n <MaxCoreCount>30</MaxCoreCount>\\n </CoreResource>\\n <CoreResource>\\n <InstanceTypeDetail>\\n <Mem>128</Mem>\\n <Cpu>32</Cpu>\\n </InstanceTypeDetail>\\n <DBInstanceStorageRange>\\n <MinSize>400</MinSize>\\n <StepSize>40</StepSize>\\n <MaxSize>8000</MaxSize>\\n </DBInstanceStorageRange>\\n <InstanceType>hbase.sn2.8xlarge</InstanceType>\\n <MaxCoreCount>30</MaxCoreCount>\\n </CoreResource>\\n </CoreResources>\\n </SupportedStorageType>\\n <SupportedStorageType>\\n <StorageType>cloud_efficiency</StorageType>\\n <CoreResources>\\n <CoreResource>\\n <InstanceTypeDetail>\\n <Mem>32</Mem>\\n <Cpu>8</Cpu>\\n </InstanceTypeDetail>\\n <DBInstanceStorageRange>\\n <MinSize>400</MinSize>\\n <StepSize>40</StepSize>\\n <MaxSize>64000</MaxSize>\\n </DBInstanceStorageRange>\\n <InstanceType>hbase.sn2.2xlarge</InstanceType>\\n <MaxCoreCount>30</MaxCoreCount>\\n </CoreResource>\\n <CoreResource>\\n <InstanceTypeDetail>\\n <Mem>8</Mem>\\n <Cpu>4</Cpu>\\n </InstanceTypeDetail>\\n <DBInstanceStorageRange>\\n <MinSize>400</MinSize>\\n <StepSize>40</StepSize>\\n <MaxSize>64000</MaxSize>\\n </DBInstanceStorageRange>\\n <InstanceType>hbase.sn1.large</InstanceType>\\n <MaxCoreCount>30</MaxCoreCount>\\n </CoreResource>\\n <CoreResource>\\n <InstanceTypeDetail>\\n <Mem>16</Mem>\\n <Cpu>8</Cpu>\\n </InstanceTypeDetail>\\n <DBInstanceStorageRange>\\n <MinSize>400</MinSize>\\n <StepSize>40</StepSize>\\n <MaxSize>64000</MaxSize>\\n </DBInstanceStorageRange>\\n <InstanceType>hbase.sn1.2xlarge</InstanceType>\\n <MaxCoreCount>30</MaxCoreCount>\\n </CoreResource>\\n <CoreResource>\\n <InstanceTypeDetail>\\n <Mem>32</Mem>\\n <Cpu>16</Cpu>\\n </InstanceTypeDetail>\\n <DBInstanceStorageRange>\\n <MinSize>400</MinSize>\\n <StepSize>40</StepSize>\\n <MaxSize>64000</MaxSize>\\n </DBInstanceStorageRange>\\n <InstanceType>hbase.sn1.4xlarge</InstanceType>\\n <MaxCoreCount>30</MaxCoreCount>\\n </CoreResource>\\n <CoreResource>\\n <InstanceTypeDetail>\\n <Mem>64</Mem>\\n <Cpu>32</Cpu>\\n </InstanceTypeDetail>\\n <DBInstanceStorageRange>\\n <MinSize>400</MinSize>\\n <StepSize>40</StepSize>\\n <MaxSize>64000</MaxSize>\\n </DBInstanceStorageRange>\\n <InstanceType>hbase.sn1.8xlarge</InstanceType>\\n <MaxCoreCount>30</MaxCoreCount>\\n </CoreResource>\\n <CoreResource>\\n <InstanceTypeDetail>\\n <Mem>16</Mem>\\n <Cpu>4</Cpu>\\n </InstanceTypeDetail>\\n <DBInstanceStorageRange>\\n <MinSize>400</MinSize>\\n <StepSize>40</StepSize>\\n <MaxSize>64000</MaxSize>\\n </DBInstanceStorageRange>\\n <InstanceType>hbase.sn2.large</InstanceType>\\n <MaxCoreCount>30</MaxCoreCount>\\n </CoreResource>\\n <CoreResource>\\n <InstanceTypeDetail>\\n <Mem>64</Mem>\\n <Cpu>16</Cpu>\\n </InstanceTypeDetail>\\n <DBInstanceStorageRange>\\n <MinSize>400</MinSize>\\n <StepSize>40</StepSize>\\n <MaxSize>64000</MaxSize>\\n </DBInstanceStorageRange>\\n <InstanceType>hbase.sn2.4xlarge</InstanceType>\\n <MaxCoreCount>30</MaxCoreCount>\\n </CoreResource>\\n <CoreResource>\\n <InstanceTypeDetail>\\n <Mem>128</Mem>\\n <Cpu>32</Cpu>\\n </InstanceTypeDetail>\\n <DBInstanceStorageRange>\\n <MinSize>400</MinSize>\\n <StepSize>40</StepSize>\\n <MaxSize>8000</MaxSize>\\n </DBInstanceStorageRange>\\n <InstanceType>hbase.sn2.8xlarge</InstanceType>\\n <MaxCoreCount>30</MaxCoreCount>\\n </CoreResource>\\n </CoreResources>\\n </SupportedStorageType>\\n <SupportedStorageType>\\n <StorageType>local_hdd_pro</StorageType>\\n <CoreResources>\\n <CoreResource>\\n <InstanceTypeDetail>\\n <Mem>64</Mem>\\n <Cpu>16</Cpu>\\n </InstanceTypeDetail>\\n <DBInstanceStorageRange>\\n <MinSize>44000</MinSize>\\n <StepSize>40</StepSize>\\n <MaxSize>44000</MaxSize>\\n </DBInstanceStorageRange>\\n <InstanceType>hbase.d1.4xlarge</InstanceType>\\n <MaxCoreCount>30</MaxCoreCount>\\n </CoreResource>\\n <CoreResource>\\n <InstanceTypeDetail>\\n <Mem>96</Mem>\\n <Cpu>24</Cpu>\\n </InstanceTypeDetail>\\n <DBInstanceStorageRange>\\n <MinSize>66000</MinSize>\\n <StepSize>40</StepSize>\\n <MaxSize>66000</MaxSize>\\n </DBInstanceStorageRange>\\n <InstanceType>hbase.d1.6xlarge</InstanceType>\\n <MaxCoreCount>30</MaxCoreCount>\\n </CoreResource>\\n </CoreResources>\\n </SupportedStorageType>\\n <SupportedStorageType>\\n <StorageType>local_ssd_pro</StorageType>\\n <CoreResources>\\n <CoreResource>\\n <InstanceTypeDetail>\\n <Mem>32</Mem>\\n <Cpu>4</Cpu>\\n </InstanceTypeDetail>\\n <DBInstanceStorageRange>\\n <MinSize>894</MinSize>\\n <StepSize>1</StepSize>\\n <MaxSize>894</MaxSize>\\n </DBInstanceStorageRange>\\n <InstanceType>hbase.i2.xlarge</InstanceType>\\n <MaxCoreCount>30</MaxCoreCount>\\n </CoreResource>\\n </CoreResources>\\n </SupportedStorageType>\\n </SupportedStorageTypes>\\n </SupportedCategories>\\n </SupportedCategories>\\n </SupportedEngineVersion>\\n </SupportedEngineVersions>\\n <Engine>hbaseue</Engine>\\n </SupportedEngine>\\n </SupportedEngines>\\n </AvailableZone>\\n</AvailableZones>","errorExample":""}]',
- 'title' => 'DescribeMultiZoneAvailableResource',
+ 'title' => 'Reset UI access password',
+ 'summary' => 'Resets the password for accessing the cluster management UI by calling ModifyUIProxyAccountPassword.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifyClusterDeletionProtection' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:48:58.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyUIAccountPassword',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BED4ADEB-4EA9-507E-892C-84112D6AC7C1\\"\\n}","type":"json"}]',
+ ],
+ 'MoveResourceGroup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -10720,29 +8433,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-****************',
- ],
+ 'schema' => ['description' => 'The ID of the target instance. You can call the [DescribeInstances](~~144595~~) operation to obtain the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp169l540vc6c****', 'title' => ''],
],
[
- 'name' => 'Protection',
+ 'name' => 'NewResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The ID of the target resource group. You can call the [ListResourceGroups](~~158855~~) operation to query the list of resource groups.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rg-aekzrk6zzsy****', 'title' => ''],
],
],
'responses' => [
@@ -10750,31 +8451,43 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '24C80BD8-C710-4138-893A-D2AFED4FC13D',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8CD9BFBC-D575-5FCC-BA7E-956BF0D0****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"24C80BD8-C710-4138-893A-D2AFED4FC13D\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>24C80BD8-C710-4138-893A-D2AFED4FC13D</RequestId>","errorExample":""}]',
- 'title' => 'ModifyClusterDeletionProtection',
+ 'title' => 'Move an instance to a different resource group',
+ 'summary' => 'Moves a target instance to a target resource group.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifyMultiZoneClusterNodeType' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:MoveResourceGroup',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8CD9BFBC-D575-5FCC-BA7E-956BF0D0****\\"\\n}","type":"json"}]',
+ ],
+ 'OpenBackup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -10782,53 +8495,69 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-t4naqsay5gn******', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C977DF60-7D06-4E34-A27D-8BC696C5112A', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-dj45g7d6rbrd****',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'title' => 'Enable backup',
+ 'summary' => 'Enables the backup and recovery feature for an ApsaraDB for HBase cluster by calling OpenBackup.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-06T09:46:52.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'MasterInstanceType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'hbase.sn1.8xlarge',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:OpenBackup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C977DF60-7D06-4E34-A27D-8BC696C5112A\\"\\n}","type":"json"}]',
+ ],
+ 'PurgeInstance' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'CoreInstanceType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'hbase.sn1.large',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
[
- 'name' => 'LogInstanceType',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'hbase.sn1.2xlarge',
- ],
+ 'schema' => ['description' => 'The ID of the deleted cluster to be cleaned up. You can call the DescribeDeletedInstances operation to obtain the cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-m5ek15uzs7613xxxx', 'title' => ''],
],
],
'responses' => [
@@ -10836,36 +8565,43 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'OrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '12341234123****',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '06CF7A6F-A81C-431D-BACD-793F24A67C54',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '276F899F-E952-496F-81B8-BD46D86854E3', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"12341234123****\\",\\n \\"RequestId\\": \\"06CF7A6F-A81C-431D-BACD-793F24A67C54\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>06CF7A6F-A81C-431D-BACD-793F24A67C54</RequestId>\\n<OrderId>123412341234123</OrderId>","errorExample":""}]',
- 'title' => 'ModifyMultiZoneClusterNodeType',
+ 'title' => 'Completely clean up resources',
+ 'summary' => 'Completely cleans up an instance that has been deleted (within the last 7 days) but not fully cleaned up.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'QueryHBaseHaDB' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:48:58.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:PurgeInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"276F899F-E952-496F-81B8-BD46D86854E3\\"\\n}","type":"json"}]',
+ ],
+ 'QueryHBaseHaDB' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -10873,20 +8609,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'BdsId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'bds-t4n3496whj23ia4k',
- ],
+ 'schema' => ['description' => 'The ID of the BDS cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'bds-t4n3496whj23ia4k', 'title' => ''],
],
],
'responses' => [
@@ -10894,146 +8622,133 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '963355AD-A3B1-4654-AFFC-B5186EB8F889',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '963355AD-A3B1-4654-AFFC-B5186EB8F889', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries in the list.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'ClusterList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Cluster' => [
- 'description' => '',
+ 'description' => 'The high-availability list.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'BdsName' => [
- 'description' => 'bdsId',
- 'type' => 'string',
- 'example' => 'bds-t4n3496whj23ia4k',
- ],
- 'ActiveName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hb-t4nn7dy1u1etbzmzm',
- ],
- 'HaName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ha-v21tmnxjwh2yuy1il',
- ],
- 'StandbyName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hb-t4n0ye37832tx22vz',
- ],
+ 'BdsName' => ['description' => 'bdsId', 'type' => 'string', 'example' => 'bds-t4n3496whj23ia4k', 'title' => ''],
+ 'ActiveName' => ['description' => 'The ID of the primary instance.', 'type' => 'string', 'example' => 'hb-t4nn7dy1u1etbzmzm', 'title' => ''],
+ 'HaName' => ['description' => 'The high-availability ID.', 'type' => 'string', 'example' => 'ha-v21tmnxjwh2yuy1il', 'title' => ''],
+ 'StandbyName' => ['description' => 'The ID of the standby instance.', 'type' => 'string', 'example' => 'hb-t4n0ye37832tx22vz', 'title' => ''],
'HaSlbConnList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'HaSlbConn' => [
- 'description' => '',
+ 'description' => 'The high-availability SLB connections under this high-availability instance.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'HbaseType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Standby',
- ],
- 'SlbType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'phoenix',
- ],
- 'SlbConnAddr' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ha-v21tmnxjwh2yuy1il-phoenix.bds.9b78df04-b.rds.aliyuncs.com:8765',
- ],
+ 'HbaseType' => ['description' => 'Indicates whether the currently bound instance is the primary or standby instance. Valid values:'."\n"
+ .'1. Active: primary instance.'."\n"
+ .'2. Standby: standby instance.', 'type' => 'string', 'example' => 'Standby', 'title' => ''],
+ 'SlbType' => ['description' => 'The high-availability type. Valid values:'."\n"
+ .'1. thrift'."\n"
+ .'2. phoenix.', 'type' => 'string', 'example' => 'phoenix', 'title' => ''],
+ 'SlbConnAddr' => ['description' => 'The high-availability connection address for Thrift or Phoenix.', 'type' => 'string', 'example' => 'ha-v21tmnxjwh2yuy1il-phoenix.bds.9b78df04-b.rds.aliyuncs.com:8765', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"963355AD-A3B1-4654-AFFC-B5186EB8F889\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"ClusterList\\": {\\n \\"Cluster\\": [\\n {\\n \\"BdsName\\": \\"bds-t4n3496whj23ia4k\\",\\n \\"ActiveName\\": \\"hb-t4nn7dy1u1etbzmzm\\",\\n \\"HaName\\": \\"ha-v21tmnxjwh2yuy1il\\",\\n \\"StandbyName\\": \\"hb-t4n0ye37832tx22vz\\",\\n \\"HaSlbConnList\\": {\\n \\"HaSlbConn\\": [\\n {\\n \\"HbaseType\\": \\"Standby\\",\\n \\"SlbType\\": \\"phoenix\\",\\n \\"SlbConnAddr\\": \\"ha-v21tmnxjwh2yuy1il-phoenix.bds.9b78df04-b.rds.aliyuncs.com:8765\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<TotalCount>1</TotalCount>\\n<ClusterList>\\n <Cluster>\\n <ActiveName>hb-t4nn7dy1u1etbzmzm</ActiveName>\\n <BdsName>bds-t4n3496whj23ia4k</BdsName>\\n <HaName>ha-v21tmnxjwh2yuy1il</HaName>\\n <StandbyName>hb-t4n0ye37832tx22vz</StandbyName>\\n <HaSlbConnList>\\n <HaSlbConn>\\n <HbaseType>Standby</HbaseType>\\n <SlbConnAddr>ha-v21tmnxjwh2yuy1il-phoenix.bds.9b78df04-b.rds.aliyuncs.com:8765</SlbConnAddr>\\n <SlbType>phoenix</SlbType>\\n </HaSlbConn>\\n <HaSlbConn>\\n <HbaseType>Active</HbaseType>\\n <SlbConnAddr>ha-v21tmnxjwh2yuy1il-thrift.bds.9b78df04-b.rds.aliyuncs.com:9099</SlbConnAddr>\\n <SlbType>thrift</SlbType>\\n </HaSlbConn>\\n </HaSlbConnList>\\n </Cluster>\\n</ClusterList>\\n<PageSize>10</PageSize>\\n<RequestId>963355AD-A3B1-4654-AFFC-B5186EB8F889</RequestId>\\n<PageNumber>1</PageNumber>","errorExample":""}]',
- 'title' => 'QueryHBaseHaDB',
+ 'title' => 'Query haDB list',
+ 'summary' => 'Queries the high-availability HBase list for a BDS cluster. This operation corresponds to CreateHaCluster and CreateHbaseHaSlb. It returns the corresponding high-availability list.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CheckComponentsVersion' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:QueryHBaseHaDB',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"963355AD-A3B1-4654-AFFC-B5186EB8F889\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"ClusterList\\": {\\n \\"Cluster\\": [\\n {\\n \\"BdsName\\": \\"bds-t4n3496whj23ia4k\\",\\n \\"ActiveName\\": \\"hb-t4nn7dy1u1etbzmzm\\",\\n \\"HaName\\": \\"ha-v21tmnxjwh2yuy1il\\",\\n \\"StandbyName\\": \\"hb-t4n0ye37832tx22vz\\",\\n \\"HaSlbConnList\\": {\\n \\"HaSlbConn\\": [\\n {\\n \\"HbaseType\\": \\"Standby\\",\\n \\"SlbType\\": \\"phoenix\\",\\n \\"SlbConnAddr\\": \\"ha-v21tmnxjwh2yuy1il-phoenix.bds.9b78df04-b.rds.aliyuncs.com:8765\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'QueryXpackRelateDB' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-t4naqsay5gn****',
- ],
+ 'schema' => ['description' => 'The instance ID of the current Spark instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ap-bp1qtz9rcbbt3p6ng', 'title' => ''],
],
[
- 'name' => 'Components',
+ 'name' => 'RelateDbType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'HBASE,HADOOP',
- ],
+ 'schema' => ['description' => 'The type of database to query for association.'."\n"
+ ."\n"
+ .'- spark can be associated with hdfs, hbase, mongodb, mysql, polardb_mysql, redis, and geomesa.'."\n"
+ .'- bds can be associated with hbase, spark, and hbaseue.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hbase', 'title' => ''],
+ ],
+ [
+ 'name' => 'HasSingleNode',
+ 'in' => 'query',
+ 'schema' => ['description' => 'This parameter is valid only when bds queries associated HBase instances.'."\n"
+ ."\n"
+ .'- true: Single-node HBase instances are included.'."\n"
+ ."\n"
+ .'- false: Single-node HBase instances are not included. This parameter is optional. For backward compatibility, single-node HBase instances are included when this parameter is left empty.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
@@ -11041,55 +8756,73 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E3537EB4-1100-41CA-A147-C74CCC8BB12C',
- ],
- 'Components' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '288E9010-36DD-499C-B4DA-61E4362DA4CC', 'title' => ''],
+ 'ClusterList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'Component' => [
- 'description' => '',
+ 'Cluster' => [
+ 'description' => 'The list of databases that can be associated.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'IsLatestVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Component' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'HBASE',
- ],
+ 'Status' => ['description' => 'The instance status.', 'type' => 'string', 'example' => 'ACTIVATION', 'title' => ''],
+ 'DBVersion' => ['description' => 'The instance version.', 'type' => 'string', 'example' => '2.0', 'title' => ''],
+ 'IsRelated' => ['description' => 'Indicates whether the instance is already associated.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'ClusterName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'hbase_test', 'title' => ''],
+ 'DBType' => ['description' => 'The database type of the instance.', 'type' => 'string', 'example' => 'hbase', 'title' => ''],
+ 'LockMode' => ['description' => 'The lock mode.', 'type' => 'string', 'example' => '..', 'title' => ''],
+ 'ClusterId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'hb-bp16o0pd52e3y582s', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E3537EB4-1100-41CA-A147-C74CCC8BB12C\\",\\n \\"Components\\": {\\n \\"Component\\": [\\n {\\n \\"IsLatestVersion\\": \\"true\\",\\n \\"Component\\": \\"HBASE\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<Components>\\n <Component>\\n <IsLatestVersion>true</IsLatestVersion>\\n <Component>HBASE</Component>\\n </Component>\\n <Component>\\n <IsLatestVersion>true</IsLatestVersion>\\n <Component>HADOOP</Component>\\n </Component>\\n</Components>\\n<RequestId>E3537EB4-1100-41CA-A147-C74CCC8BB12C</RequestId>","errorExample":""}]',
- 'title' => 'CheckComponentsVersion',
+ 'errorCodes' => [],
+ 'title' => 'Query databases that can be associated with the current instance',
+ 'summary' => 'Queries the list of databases that can be associated with the current instance by calling QueryXpackRelateDB.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CreateHBaseSlbServer' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:QueryXpackRelateDB',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"288E9010-36DD-499C-B4DA-61E4362DA4CC\\",\\n \\"ClusterList\\": {\\n \\"Cluster\\": [\\n {\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"DBVersion\\": \\"2.0\\",\\n \\"IsRelated\\": false,\\n \\"ClusterName\\": \\"hbase_test\\",\\n \\"DBType\\": \\"hbase\\",\\n \\"LockMode\\": \\"..\\",\\n \\"ClusterId\\": \\"hb-bp16o0pd52e3y582s\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'RelateDbForHBaseHa' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -11097,41 +8830,121 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-t4naqsay5gn****',
- ],
+ 'schema' => ['description' => 'The ID of the BDS cluster. You can call the [DescribeInstances](~~144595~~) operation to obtain the cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'bds-t4nj9v2x85******', 'title' => ''],
],
[
- 'name' => 'SlbServer',
+ 'name' => 'HaTables',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'thrift',
- ],
+ 'schema' => ['description' => 'The tables to synchronize. This parameter is required when HaMigrateType is set to TABLE. Separate multiple tables with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'test,test1', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'HaActiveHdfsUri',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxxx-xxxxx-xxxxx',
- ],
+ 'schema' => ['description' => 'The HDFS URI of the primary instance. This parameter is required when the primary instance is a non-standard instance (IsActiveStandard is set to false).', 'type' => 'string', 'required' => false, 'example' => 'hdfs://hb-t4naqsay5gn******-master1-001.hbase.rds.aliyuncs.com:8020,hb-t4naqsay5gn******-master2-001.hbase.rds.aliyuncs.com:8020', 'title' => ''],
+ ],
+ [
+ 'name' => 'HaActiveHbaseFsDir',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The HDFS directory of the primary instance. This parameter is required when the primary instance is a non-standard instance (IsActiveStandard is set to false).', 'type' => 'string', 'required' => false, 'example' => '/hbase', 'title' => ''],
+ ],
+ [
+ 'name' => 'HaActiveClusterKey',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ZooKeeper address of the primary instance. This parameter is required when the primary instance is a non-standard instance (IsActiveStandard is set to false).', 'type' => 'string', 'required' => false, 'example' => 'hb-t4naqsay5gn******-master1-001.hbase.singapore.rds.aliyuncs.com,hb-t4naqsay5gn******-master3-001.hbase.singapore.rds.aliyuncs.com,hb-t4naqsay5gn******-master2-001.hbase.singapore.rds.aliyuncs.com:2181:/hbase', 'title' => ''],
+ ],
+ [
+ 'name' => 'HaActiveVersion',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The database engine version of the primary instance. This parameter is required when the primary instance is a non-standard instance (IsActiveStandard is set to false). Valid values:'."\n"
+ .'- **HBase1x**: HBase 1.x.'."\n"
+ .'- **HBase2x**: HBase 2.x.'."\n"
+ .'- **HBaseUE**: HBaseue.', 'type' => 'string', 'required' => false, 'example' => 'HBase2x', 'title' => ''],
+ ],
+ [
+ 'name' => 'HaActiveUser',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The username of the primary instance. This parameter is required when the primary instance is **HBaseue**.', 'type' => 'string', 'required' => false, 'example' => 'root', 'title' => ''],
+ ],
+ [
+ 'name' => 'HaActivePassword',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The password that corresponds to the username of the primary instance. This parameter is required when the primary instance is **HBaseue**.', 'type' => 'string', 'required' => false, 'example' => 'root', 'title' => ''],
+ ],
+ [
+ 'name' => 'HaStandbyHdfsUri',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The HDFS URI of the secondary instance. This parameter is required when the secondary instance is a non-standard instance (IsStandbyStandard is set to false).', 'type' => 'string', 'required' => false, 'example' => 'hdfs://hb-bp1w6krp539******-master1-001.hbase.rds.aliyuncs.com:8020,hb-bp1w6krp539******-master2-001.hbase.rds.aliyuncs.com:8020', 'title' => ''],
+ ],
+ [
+ 'name' => 'HaStandbyHbaseFsDir',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The HDFS directory of the secondary instance. This parameter is required when the secondary instance is a non-standard instance (IsStandbyStandard is set to false).', 'type' => 'string', 'required' => false, 'example' => '/hbase', 'title' => ''],
+ ],
+ [
+ 'name' => 'HaStandbyClusterKey',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ZooKeeper address of the secondary instance. This parameter is required when the secondary instance is a non-standard instance (IsStandbyStandard is set to false).', 'type' => 'string', 'required' => false, 'example' => 'hb-bp1w6krp539******-master1-001.hbase.singapore.rds.aliyuncs.com,hb-bp1w6krp539******-master3-001.hbase.singapore.rds.aliyuncs.com,hb-t4naqsay5gn******-master2-001.hbase.singapore.rds.aliyuncs.com:2181:/hbase', 'title' => ''],
+ ],
+ [
+ 'name' => 'HaStandbyVersion',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The database engine version of the secondary instance. This parameter is required when the secondary instance is a non-standard instance (IsStandbyStandard is set to false). Valid values:'."\n"
+ .'- **HBase1x**: HBase 1.x.'."\n"
+ .'- **HBase2x**: HBase 2.x.'."\n"
+ .'- **HBaseUE**: HBaseue.', 'type' => 'string', 'required' => false, 'example' => 'HBase2x', 'title' => ''],
+ ],
+ [
+ 'name' => 'HaStandbyUser',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The username of the secondary instance. This parameter is required when the secondary instance is **hbaseue**.', 'type' => 'string', 'required' => false, 'example' => 'root', 'title' => ''],
+ ],
+ [
+ 'name' => 'HaStandbyPassword',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The password that corresponds to the username of the secondary instance. This parameter is required when the secondary instance is **hbaseue**.', 'type' => 'string', 'required' => false, 'example' => 'root', 'title' => ''],
+ ],
+ [
+ 'name' => 'HaActive',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The instance ID of the primary instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-bp1w6krp539******', 'title' => ''],
+ ],
+ [
+ 'name' => 'HaStandby',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the secondary instance cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-bp1bl7iqzka******', 'title' => ''],
+ ],
+ [
+ 'name' => 'HaActiveDBType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The cluster type of the primary instance. Valid values: **HBase** and **HBaseue**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hbase', 'title' => ''],
+ ],
+ [
+ 'name' => 'HaStandbyDBType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The cluster type of the secondary instance. Valid values: **HBase** and **HBaseue**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hbase', 'title' => ''],
+ ],
+ [
+ 'name' => 'IsActiveStandard',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether the primary instance is a standard instance. Set this parameter to **true** for a standard instance.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'IsStandbyStandard',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether the secondary instance is a standard instance. Set this parameter to **true** for a standard instance.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'HaMigrateType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The synchronization type. Valid values:'."\n"
+ .'- **CLUSTER**: instance-level synchronization.'."\n"
+ .'- **TABLE**: table-level synchronization.'."\n"
+ .'- **SKIP**: no synchronization required.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CLUSTER', 'title' => ''],
],
],
'responses' => [
@@ -11139,30 +8952,43 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '61FC5B21-87B0-41BC-9686-9DA395EB40B6',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DC654531-0799-4502-AFA5-80EE1C16829A', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"61FC5B21-87B0-41BC-9686-9DA395EB40B6\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>61FC5B21-87B0-41BC-9686-9DA395EB40B6</RequestId>","errorExample":""}]',
- 'title' => 'CreateHBaseSlbServer',
+ 'title' => 'Add an active-active instance pair to a BDS cluster',
+ 'summary' => 'Adds an active-active instance pair to a BDS cluster.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DeleteHBaseSlbServer' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-06T09:46:51.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:RelateDbForHBaseHa',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC654531-0799-4502-AFA5-80EE1C16829A\\"\\n}","type":"json"}]',
+ ],
+ 'ReleasePublicNetworkAddress' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -11170,31 +8996,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-t4naqsay5gn****',
- ],
- ],
- [
- 'name' => 'SlbServer',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'thrift',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-t4naqsay5gn******', 'title' => ''],
],
],
'responses' => [
@@ -11202,30 +9009,43 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '7242130A-82CF-49BF-AB32-30DCB819EBA6',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B18D4390-A968-4444-B323-4360B8E5DA3E', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7242130A-82CF-49BF-AB32-30DCB819EBA6\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>7242130A-82CF-49BF-AB32-30DCB819EBA6</RequestId>","errorExample":""}]',
- 'title' => 'DeleteHBaseSlbServer',
+ 'title' => 'Release instance public endpoint',
+ 'summary' => 'Releases the public endpoint of an instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeColdStorage' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-06T09:46:51.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hbase:ReleasePublicNetworkAddress',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B18D4390-A968-4444-B323-4360B8E5DA3E\\"\\n}","type":"json"}]',
+ ],
+ 'RenewInstance' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -11233,20 +9053,28 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ld-bp1uoihlf82e8****',
- ],
+ 'schema' => ['description' => 'The instance ID of the target instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-bp1u0639js2h7****', 'title' => ''],
+ ],
+ [
+ 'name' => 'PricingCycle',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The unit of the renewal epoch for the target instance.'."\n"
+ ."\n"
+ .'- **year**: year.'."\n"
+ .'- **month**: month.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'month', 'title' => ''],
+ ],
+ [
+ 'name' => 'Duration',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The renewal epoch for the target instance.'."\n"
+ ."\n"
+ .'- If PricingCycle is set to **year**, valid values are 1 to 3.'."\n"
+ .'- If PricingCycle is set to **month**, valid values are 1 to 9.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '5', 'title' => ''],
],
],
'responses' => [
@@ -11254,65 +9082,45 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'OpenStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'open',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DCB9479E-F05F-4D1C-AFB7-C639B87764B7',
- ],
- 'PayType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'POSTPAY',
- ],
- 'ColdStorageUsePercent' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20.00',
- ],
- 'ColdStorageUseAmount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20.00',
- ],
- 'ColdStorageSize' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '800',
- ],
- 'ColdStorageType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'BdsColdStorage',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ld-bp1uoihlf82e8****',
- ],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '211235614240728', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '729CB2A7-3065-53A9-B27C-7033CA4881D9', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"OpenStatus\\": \\"open\\",\\n \\"RequestId\\": \\"DCB9479E-F05F-4D1C-AFB7-C639B87764B7\\",\\n \\"PayType\\": \\"POSTPAY\\",\\n \\"ColdStorageType\\": \\"BdsColdStorage\\",\\n \\"ColdStorageUsePercent\\": \\"20.00\\",\\n \\"ColdStorageUseAmount\\": \\"20.00\\",\\n \\"ColdStorageSize\\": \\"800\\",\\n \\"ClusterId\\": \\"ld-bp1uoihlf82e8****\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeColdStorageResponse>\\n<ColdStorageUsePercent>20.00</ColdStorageUsePercent>\\n<ColdStorageSize>800</ColdStorageSize>\\n<RequestId>DCB9479E-F05F-4D1C-AFB7-C639B87764B7</RequestId>\\n<ClusterId>ld-bp1uoihlf82e8****</ClusterId>\\n<ColdStorageUseAmount>20.00</ColdStorageUseAmount>\\n<PayType>POSTPAY</PayType>\\n<OpenStatus>open</OpenStatus>\\n</DescribeColdStorageResponse>","errorExample":""}]',
- 'title' => 'DescribeColdStorage',
+ 'title' => 'Renew the current instance',
+ 'summary' => 'Renews a subscription for an HBase instance.',
+ 'description' => 'This operation applies only to subscription HBase instances.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'GetMultimodeCmsUrl' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:48:58.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:RenewInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": 211235614240728,\\n \\"RequestId\\": \\"729CB2A7-3065-53A9-B27C-7033CA4881D9\\"\\n}","type":"json"}]',
+ ],
+ 'ResizeColdStorageSize' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -11320,31 +9128,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-t4naqsay5gn******',
- ],
+ 'schema' => ['description' => 'The ID of the HBase instance. You can call the [DescribeInstances](~~144595~~) operation to obtain the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp169l540vc6c****', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'ColdStorageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The cold storage capacity after the change. Unit: GB. Valid values: **800** to **1000000**.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100000000', 'minimum' => '0', 'example' => '900', 'title' => ''],
],
],
'responses' => [
@@ -11352,40 +9146,42 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'MultimodCmsUrl' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'htpp://***********',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '44183B05-852E-4716-B902-52977140190F',
- ],
- 'ClusterId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hb-t4naqsay5gn******',
- ],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '21711518427****', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5AA6F80E-535C-5611-BD13-3832D96A4D0E', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"MultimodCmsUrl\\": \\"htpp://***********\\",\\n \\"RequestId\\": \\"44183B05-852E-4716-B902-52977140190F\\",\\n \\"ClusterId\\": \\"hb-t4naqsay5gn******\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>44183B05-852E-4716-B902-52977140190F</RequestId>\\n<ClusterId>hb-t4naqsay5gn******</ClusterId>\\n<MultimodCmsUrl>htpp://***********</MultimodCmsUrl>","errorExample":""}]',
- 'title' => 'GetMultimodeCmsUrl',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ListHBaseInstances' => [
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Change cold storage size',
+ 'summary' => 'Changes the cold storage size.',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-26T03:44:59.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-10T11:37:16.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ResizeColdStorageSize',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"21711518427****\\",\\n \\"RequestId\\": \\"5AA6F80E-535C-5611-BD13-3832D96A4D0E\\"\\n}","type":"json"}]',
+ ],
+ 'ResizeDiskSize' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -11396,15 +9192,14 @@
'systemTags' => [],
'parameters' => [
[
- 'name' => 'VpcId',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'vpc-t4nx81tmlixcq5i****',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-bp16o0pd52e3y****', 'title' => ''],
+ ],
+ [
+ 'name' => 'NodeDiskSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The disk size of a single node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '120', 'title' => ''],
],
],
'responses' => [
@@ -11412,60 +9207,44 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '89F81C30-320B-4550-91DB-C37C81D2358F',
- ],
- 'Instances' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Instance' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'IsDefault' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'InstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hb-t4naqsay5gn****',
- ],
- 'InstanceName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'name_test',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '3C22622B-8555-42BF-AD8A-1B960743****', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '493A762B-E4A6-44E9-B877-CA6D0CAF8B29', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"89F81C30-320B-4550-91DB-C37C81D2358F\\",\\n \\"Instances\\": {\\n \\"Instance\\": [\\n {\\n \\"IsDefault\\": false,\\n \\"InstanceId\\": \\"hb-t4naqsay5gn****\\",\\n \\"InstanceName\\": \\"name_test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListHBaseInstancesResponse>\\n <RequestId>89F81C30-320B-4550-91DB-C37C81D2358F</RequestId>\\n <Instances>\\n <IsDefault>false</IsDefault>\\n <InstanceId>hb-t4naqsay5gn****</InstanceId>\\n <InstanceName>name_test</InstanceName>\\n </Instances>\\n</ListHBaseInstancesResponse>","errorExample":""}]',
- 'title' => 'ListHBaseInstances',
+ 'title' => 'Resize a disk',
+ 'summary' => 'Calls ResizeDiskSize to resize a disk.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListInstanceServiceConfigHistories' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:37:16.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:ResizeDiskSize',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"3C22622B-8555-42BF-AD8A-1B960743****\\",\\n \\"RequestId\\": \\"493A762B-E4A6-44E9-B877-CA6D0CAF8B29\\"\\n}","type":"json"}]',
+ ],
+ 'ResizeMultiZoneClusterDiskSize' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -11473,43 +9252,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-t4naqsay5gn******',
- ],
+ 'schema' => ['description' => 'The ID of the multi-zone instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-f5d6vc2r8d6****', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'CoreDiskSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The disk size of core nodes. The value must be greater than the current disk size and must be a multiple of 40. Unit: GB. Maximum value: 64000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '64000', 'minimum' => '400', 'example' => '480', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'LogDiskSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The disk size of log nodes. The value must be greater than the current disk size of log nodes and must be a multiple of 40. Unit: GB. Maximum value: 8000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '64000', 'minimum' => '400', 'example' => '440', 'title' => ''],
],
],
'responses' => [
@@ -11517,88 +9275,43 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '658C1549-2C02-4FD9-9490-EB3B285F9DCA',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageRecordCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalRecordCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'ConfigureHistoryList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Config' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Effective' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'false',
- ],
- 'OldValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10485760',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1608708923000',
- ],
- 'NewValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10485770',
- ],
- 'ConfigureName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase#hbase-site.xml#hbase.client.keyvalue.maxsize',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '123412341****', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '568339C4-9F71-43D0-994E-E039CD826E56', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"658C1549-2C02-4FD9-9490-EB3B285F9DCA\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 10,\\n \\"TotalRecordCount\\": 1,\\n \\"ConfigureHistoryList\\": {\\n \\"Config\\": [\\n {\\n \\"Effective\\": \\"false\\",\\n \\"OldValue\\": \\"10485760\\",\\n \\"CreateTime\\": \\"1608708923000\\",\\n \\"NewValue\\": \\"10485770\\",\\n \\"ConfigureName\\": \\"hbase#hbase-site.xml#hbase.client.keyvalue.maxsize\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<TotalRecordCount>1</TotalRecordCount>\\n<PageRecordCount>10</PageRecordCount>\\n<RequestId>658C1549-2C02-4FD9-9490-EB3B285F9DCA</RequestId>\\n<PageNumber>1</PageNumber>\\n<ConfigureHistoryList>\\n <Config>\\n <OldValue>10485760</OldValue>\\n <CreateTime>1608708923000</CreateTime>\\n <ConfigureName>hbase#hbase-site.xml#hbase.client.keyvalue.maxsize</ConfigureName>\\n <NewValue>10485770</NewValue>\\n <Effective>false</Effective>\\n </Config>\\n</ConfigureHistoryList>","errorExample":""}]',
- 'title' => 'ListInstanceServiceConfigHistories',
+ 'errorCodes' => [],
+ 'title' => 'Resize multi-zone cluster disk',
+ 'summary' => 'Calls the ResizeMultiZoneClusterDiskSize operation to modify the disk size of a multi-zone instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListInstanceServiceConfigurations' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ResizeMultiZoneClusterDiskSize',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"123412341****\\",\\n \\"RequestId\\": \\"568339C4-9F71-43D0-994E-E039CD826E56\\"\\n}","type":"json"}]',
+ ],
+ 'ResizeMultiZoneClusterNodeCount' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -11606,43 +9319,47 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-t4naqsay5gn****',
- ],
+ 'schema' => ['description' => 'The ID of the multi-zone cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-f5d8d6s4s2a1****', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'PrimaryVSwitchId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The vSwitch ID of the instance in the primary zone.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vsw-hangxzhouxe*****', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'StandbyVSwitchId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The vSwitch ID of the instance in the secondary zone.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vsw-hangxzhouxf****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ArbiterVSwitchId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The vSwitch ID of the arbitration node.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vsw-hangxzhouxb*****', 'title' => ''],
+ ],
+ [
+ 'name' => 'CoreNodeCount',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of core nodes. The minimum value is 4, and the increment must be a multiple of 2.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '2', 'example' => '6', 'title' => ''],
+ ],
+ [
+ 'name' => 'PrimaryCoreNodeCount',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of core nodes in the primary zone instance. The minimum value is 4, and the increment must be a multiple of 2.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '750', 'minimum' => '1', 'example' => '6', 'title' => ''],
+ ],
+ [
+ 'name' => 'StandbyCoreNodeCount',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of core nodes in the secondary zone instance. The minimum value is 4, and the increment must be a multiple of 2.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '750', 'minimum' => '1', 'example' => '6', 'title' => ''],
+ ],
+ [
+ 'name' => 'LogNodeCount',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of log nodes. The minimum value is 4, and the value must be a multiple of 4.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '500', 'minimum' => '4', 'example' => '8', 'title' => ''],
],
],
'responses' => [
@@ -11650,98 +9367,43 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '5B381E36-BCA3-4377-8638-B65C236617D5',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageRecordCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalRecordCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '42',
- ],
- 'ConfigureList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Config' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase client keyvalue maxsize',
- ],
- 'RunningValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10485760',
- ],
- 'ConfigureUnit' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'INT',
- ],
- 'ConfigureName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbase#hbase-site.xml#hbase.client.keyvalue.maxsize',
- ],
- 'ValueRange' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'R[10485760,52428800]',
- ],
- 'DefaultValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10485760',
- ],
- 'NeedRestart' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '1234123412****', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E2B7E9DA-1575-4B9D-A0E4-9468BAC', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5B381E36-BCA3-4377-8638-B65C236617D5\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 10,\\n \\"TotalRecordCount\\": 42,\\n \\"ConfigureList\\": {\\n \\"Config\\": [\\n {\\n \\"Description\\": \\"hbase client keyvalue maxsize\\",\\n \\"RunningValue\\": \\"10485760\\",\\n \\"ConfigureUnit\\": \\"INT\\",\\n \\"ConfigureName\\": \\"hbase#hbase-site.xml#hbase.client.keyvalue.maxsize\\",\\n \\"ValueRange\\": \\"R[10485760,52428800]\\",\\n \\"DefaultValue\\": \\"10485760\\",\\n \\"NeedRestart\\": \\"true\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<TotalRecordCount>42</TotalRecordCount>\\n<PageRecordCount>10</PageRecordCount>\\n<RequestId>1DD84F22-4615-451E-8F05-58405EDB7236</RequestId>\\n<PageNumber>1</PageNumber>\\n<ConfigureList>\\n <Config>\\n <ValueRange>R[10485760,52428800]</ValueRange>\\n <DefaultValue>10485760</DefaultValue>\\n <Description>hbase client keyvalue maxsize</Description>\\n <ConfigureUnit>INT</ConfigureUnit>\\n <ConfigureName>hbase#hbase-site.xml#hbase.client.keyvalue.maxsize</ConfigureName>\\n <NeedRestart>true</NeedRestart>\\n <RunningValue>10485760</RunningValue>\\n </Config>\\n <Config>\\n <ValueRange>G[true|false]</ValueRange>\\n <DefaultValue>false</DefaultValue>\\n <Description>Enable dynamic class loader</Description>\\n <ConfigureUnit>STR</ConfigureUnit>\\n <ConfigureName>hbase#hbase-site.xml#hbase.dynamic.jars.enabled</ConfigureName>\\n <NeedRestart>true</NeedRestart>\\n <RunningValue>false</RunningValue>\\n </Config>\\n <Config>\\n <ValueRange>G[.+]</ValueRange>\\n <DefaultValue>true</DefaultValue>\\n <ConfigureUnit>STR</ConfigureUnit>\\n <ConfigureName>hbase#hbase-site.xml#hbase.exporter.enabled</ConfigureName>\\n <NeedRestart>true</NeedRestart>\\n <RunningValue>true</RunningValue>\\n </Config>\\n <Config>\\n <ValueRange>R[0,604800000]</ValueRange>\\n <DefaultValue>604800000</DefaultValue>\\n <Description>The time (in miliseconds) between major compactions of all HStoreFiles in a region</Description>\\n <ConfigureUnit>INT</ConfigureUnit>\\n <ConfigureName>hbase#hbase-site.xml#hbase.hregion.majorcompaction</ConfigureName>\\n <NeedRestart>true</NeedRestart>\\n <RunningValue>604800000</RunningValue>\\n </Config>\\n <Config>\\n <ValueRange>R[0.0,0.7]</ValueRange>\\n <DefaultValue>0.0</DefaultValue>\\n <Description>Split the call queues into read and write queues. The specified interval (which should be between 0.0 and 1.0) will be multiplied by the number of call queues. A value of 0 indicate to not split the call queues, meaning that both read and write requests will be pushed to the same set of queues.</Description>\\n <ConfigureUnit>FLOAT</ConfigureUnit>\\n <ConfigureName>hbase#hbase-site.xml#hbase.ipc.server.callqueue.read.ratio</ConfigureName>\\n <NeedRestart>true</NeedRestart>\\n <RunningValue>0.0</RunningValue>\\n </Config>\\n <Config>\\n <ValueRange>R[0.0,0.7]</ValueRange>\\n <DefaultValue>0.0</DefaultValue>\\n <Description>Given the number of read call queues, calculated from the total number of call queues multiplied by the callqueue.read.ratio, the scan.ratio property will split the read call queues into small-read and long-read queues.</Description>\\n <ConfigureUnit>FLOAT</ConfigureUnit>\\n <ConfigureName>hbase#hbase-site.xml#hbase.ipc.server.callqueue.scan.ratio</ConfigureName>\\n <NeedRestart>true</NeedRestart>\\n <RunningValue>0.0</RunningValue>\\n </Config>\\n <Config>\\n <ValueRange>R[0.24,0.475]|E[0.8*${hbase#hbase-site.xml#hbase.regionserver.global.memstore.size}&lt;=${hbase#hbase-site.xml#hbase.regionserver.global.memstore.lowerLimit}]|E[0.95*${hbase#hbase-site.xml#hbase.regionserver.global.memstore.size}&gt;=${hbase#hbase-site.xml#hbase.regionserver.global.memstore.lowerLimit}]</ValueRange>\\n <DefaultValue>0.3</DefaultValue>\\n <Description>Maximum size of all memstores in a region server before flushes are forced. Defaults to 95% of hbase.regionserver.global.memstore.size (0.95).</Description>\\n <ConfigureUnit>FLOAT</ConfigureUnit>\\n <ConfigureName>hbase#hbase-site.xml#hbase.regionserver.global.memstore.lowerLimit</ConfigureName>\\n <NeedRestart>true</NeedRestart>\\n <RunningValue>0.3</RunningValue>\\n </Config>\\n <Config>\\n <ValueRange>R[0.3,0.5]|E[${hbase#hbase-site.xml#hfile.block.cache.size}+${hbase#hbase-site.xml#hbase.regionserver.global.memstore.size}&lt;=0.8]</ValueRange>\\n <DefaultValue>0.35</DefaultValue>\\n <Description>Maximum size of all memstores in a region server before new updates are blocked and flushes are forced</Description>\\n <ConfigureUnit>FLOAT</ConfigureUnit>\\n <ConfigureName>hbase#hbase-site.xml#hbase.regionserver.global.memstore.size</ConfigureName>\\n <NeedRestart>true</NeedRestart>\\n <RunningValue>0.35</RunningValue>\\n </Config>\\n <Config>\\n <ValueRange>R[16,256]</ValueRange>\\n <DefaultValue>32</DefaultValue>\\n <Description>If more than this many logs, force flush of oldest region to oldest edit goes to disk.</Description>\\n <ConfigureUnit>INT</ConfigureUnit>\\n <ConfigureName>hbase#hbase-site.xml#hbase.regionserver.maxlogs</ConfigureName>\\n <NeedRestart>true</NeedRestart>\\n <RunningValue>32</RunningValue>\\n </Config>\\n <Config>\\n <ValueRange>R[1,10]</ValueRange>\\n <DefaultValue>1</DefaultValue>\\n <Description>Large compaction threads</Description>\\n <ConfigureUnit>INT</ConfigureUnit>\\n <ConfigureName>hbase#hbase-site.xml#hbase.regionserver.thread.compaction.large</ConfigureName>\\n <NeedRestart>false</NeedRestart>\\n <RunningValue>1</RunningValue>\\n </Config>\\n</ConfigureList>","errorExample":""}]',
- 'title' => 'ListInstanceServiceConfigurations',
+ 'errorCodes' => [],
+ 'title' => 'Change multi-zone cluster node count',
+ 'summary' => 'Scales out nodes for a multi-zone instance by calling the ResizeMultiZoneClusterNodeCount operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ModifyInstanceServiceConfig' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ResizeMultiZoneClusterNodeCount',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"1234123412****\\",\\n \\"RequestId\\": \\"E2B7E9DA-1575-4B9D-A0E4-9468BAC\\"\\n}","type":"json"}]',
+ ],
+ 'ResizeNodeCount' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -11749,64 +9411,29 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-t4naqsay5gn****',
- ],
- ],
- [
- 'name' => 'Restart',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-bp16o0pd52e3y****', 'title' => ''],
],
[
- 'name' => 'ConfigureName',
+ 'name' => 'NodeCount',
'in' => 'query',
- 'allowEmptyValue' => false,
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hbase#hbase-site.xml#hbase.client.keyvalue.maxsize',
- ],
+ 'schema' => ['description' => 'The number of core nodes in the cluster.'."\n"
+ ."\n"
+ .'You can add up to 50 nodes at a time, and the total number of nodes can be scaled up to 250. If you have additional requirements, submit a ticket.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '5', 'title' => ''],
],
[
- 'name' => 'ConfigureValue',
+ 'name' => 'ZoneId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '10485770',
- ],
+ 'schema' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-f', 'title' => ''],
],
[
- 'name' => 'Parameters',
+ 'name' => 'VSwitchId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"key1=value1", "key2=value2"}',
- ],
+ 'schema' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp191otqj1ssyl****', 'title' => ''],
],
],
'responses' => [
@@ -11814,27 +9441,45 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F008B7AB-025D-4C20-AE12-047C8F8C3D97',
- ],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '20470860005****', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B288B41F-6681-42A6-8905-47C3C42B19B0', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F008B7AB-025D-4C20-AE12-047C8F8C3D97\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyInstanceServiceConfigResponse>\\n <RequestId>F008B7AB-025D-4C20-AE12-047C8F8C3D97</RequestId>\\n</ModifyInstanceServiceConfigResponse>","errorExample":""}]',
- 'title' => 'ModifyInstanceServiceConfig',
- ],
- 'RelateDbForHBaseHa' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'errorCodes' => [],
+ 'title' => 'ResizeNodeCount',
+ 'summary' => 'Calls ResizeNodeCount to adjust the number of nodes for an instance.',
+ 'description' => 'Scales up the number of core nodes in a cluster. You can add up to 50 nodes at a time, and the total number of nodes can be scaled up to 250. If you have additional requirements, submit a ticket.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:ResizeNodeCount',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"20470860005****\\",\\n \\"RequestId\\": \\"B288B41F-6681-42A6-8905-47C3C42B19B0\\"\\n}","type":"json"}]',
+ ],
+ 'RestartInstance' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -11842,227 +9487,175 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'bds-t4nj9v2x85******',
- ],
- ],
- [
- 'name' => 'HaTables',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test,test1',
- ],
+ 'schema' => ['description' => 'The ID of target instance. You can call [DescribeInstances](~~144595~~) to obtain target instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp150tns0sjxs****', 'title' => ''],
],
[
- 'name' => 'HaActiveHdfsUri',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'hdfs://hb-t4naqsay5gn******-master1-001.hbase.rds.aliyuncs.com:8020,hb-t4naqsay5gn******-master2-001.hbase.rds.aliyuncs.com:8020',
- ],
- ],
- [
- 'name' => 'HaActiveHbaseFsDir',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/hbase',
- ],
- ],
- [
- 'name' => 'HaActiveClusterKey',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'hb-t4naqsay5gn******-master1-001.hbase.singapore.rds.aliyuncs.com,hb-t4naqsay5gn******-master3-001.hbase.singapore.rds.aliyuncs.com,hb-t4naqsay5gn******-master2-001.hbase.singapore.rds.aliyuncs.com:2181:/hbase',
- ],
- ],
- [
- 'name' => 'HaActiveVersion',
+ 'name' => 'Components',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'HBase2x',
- ],
+ 'schema' => ['description' => 'The name of the component in the target instance. Valid values:'."\n"
+ ."\n"
+ .'- **HBASE**'."\n"
+ .'- **HADOOP**'."\n"
+ .'- **PHOENIX**'."\n"
+ .'- **SOLR**'."\n"
+ .'- **THRIFT**', 'type' => 'string', 'required' => false, 'example' => 'THRIFT', 'title' => ''],
],
- [
- 'name' => 'HaActiveUser',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F744E939-D08D-5623-82C8-9D1F9F7685D1', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'root',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'title' => 'Restart an instance',
+ 'summary' => 'Restarts an HBase cluster by calling RestartInstance.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:37:16.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'HaActivePassword',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'root',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:RestartInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F744E939-D08D-5623-82C8-9D1F9F7685D1\\"\\n}","type":"json"}]',
+ ],
+ 'Revoke' => [
+ 'summary' => 'Revokes permissions from a wide table account.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'HaStandbyHdfsUri',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'hdfs://hb-bp1w6krp539******-master1-001.hbase.rds.aliyuncs.com:8020,hb-bp1w6krp539******-master2-001.hbase.rds.aliyuncs.com:8020',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
[
- 'name' => 'HaStandbyHbaseFsDir',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/hbase',
- ],
+ 'schema' => ['description' => 'The target instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-bp150tns0sjxs****', 'title' => ''],
],
[
- 'name' => 'HaStandbyClusterKey',
+ 'name' => 'AccountName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'hb-bp1w6krp539******-master1-001.hbase.singapore.rds.aliyuncs.com,hb-bp1w6krp539******-master3-001.hbase.singapore.rds.aliyuncs.com,hb-t4naqsay5gn******-master2-001.hbase.singapore.rds.aliyuncs.com:2181:/hbase',
- ],
+ 'schema' => ['description' => 'The database account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test01', 'title' => ''],
],
[
- 'name' => 'HaStandbyVersion',
+ 'name' => 'Namespace',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'HBase2x',
- ],
+ 'schema' => ['description' => 'The namespace. An asterisk (*) indicates global, which means all namespaces.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default', 'title' => ''],
],
[
- 'name' => 'HaStandbyUser',
+ 'name' => 'TableName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'root',
- ],
+ 'schema' => ['description' => 'The table name. An asterisk (*) indicates global, which means all tables.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'table', 'title' => ''],
],
[
- 'name' => 'HaStandbyPassword',
+ 'name' => 'AclActions',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'root',
- ],
+ 'schema' => ['description' => 'The list of permissions. Separate multiple permissions with commas (,). Valid values:'."\n"
+ .'- READ: read permission.'."\n"
+ .'- WRITE: write permission.'."\n"
+ .'- ADMIN: administrative permission.'."\n"
+ .'- TRASH: purge permission.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'READ,WRITE', 'title' => ''],
],
- [
- 'name' => 'HaActive',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C9085433-A56A-4089-B49A-DF5A4E2*****', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-bp1w6krp539******',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'title' => 'Revoke account permissions',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'HaStandby',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hb-bp1bl7iqzka******',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:Revoke',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C9085433-A56A-4089-B49A-DF5A4E2*****\\"\\n}","type":"json"}]',
+ ],
+ 'SwitchHbaseHaSlb' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'HaActiveDBType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hbase',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
[
- 'name' => 'HaStandbyDBType',
+ 'name' => 'BdsId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hbase',
- ],
+ 'schema' => ['description' => 'The ID of the BDS cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'bds-t4n3496whj23ia4k', 'title' => ''],
],
[
- 'name' => 'IsActiveStandard',
+ 'name' => 'HaId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The high-availability ID in BDS high-availability management.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ha-v21tmnxjwh2yuy1il', 'title' => ''],
],
[
- 'name' => 'IsStandbyStandard',
+ 'name' => 'HaTypes',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The high-availability type. Valid values:'."\n"
+ .'1. thrift'."\n"
+ .'2. phoenix.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'thrift', 'title' => ''],
],
[
- 'name' => 'HaMigrateType',
+ 'name' => 'HbaseType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'CLUSTER',
- ],
+ 'schema' => ['description' => 'Specifies whether to switch to the primary or secondary instance. Valid values:'."\n"
+ .'1. Active: Switch to the primary instance.'."\n"
+ .'2. Standby: Switch to the secondary instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Active', 'title' => ''],
],
],
'responses' => [
@@ -12070,104 +9663,167 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DC654531-0799-4502-AFA5-80EE1C16829A',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C9D568D9-A59C-4AF2-8FBB-F086A841D58E', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DC654531-0799-4502-AFA5-80EE1C16829A\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>DC654531-0799-4502-AFA5-80EE1C16829A</RequestId>","errorExample":""}]',
- 'title' => 'RelateDbForHBaseHa',
+ 'errorCodes' => [],
+ 'title' => 'SwitchHbaseHaSlb',
+ 'summary' => 'Performs a primary/secondary switchover for high-availability Thrift or high-availability Phoenix. This operation corresponds to the CreateHbaseHaSlb operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CancelActiveOperationTasks' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:SwitchHbaseHaSlb',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C9D568D9-A59C-4AF2-8FBB-F086A841D58E\\"\\n}","type":"json"}]',
+ ],
+ 'SwitchService' => [
+ 'summary' => 'Enable or disable an extension service ',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'Ids',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '11111,22222',
- ],
+ 'schema' => ['description' => 'Instance ID. ', 'docRequired' => true, 'example' => 'ld-uf6r2hn2zrxxxxxx', 'required' => true, 'type' => 'string', 'title' => ''],
+ ],
+ [
+ 'name' => 'ServiceName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Service name. ', 'docRequired' => true, 'example' => 'HBaseProxy', 'required' => true, 'type' => 'string', 'title' => ''],
+ ],
+ [
+ 'name' => 'Operate',
+ 'in' => 'query',
+ 'schema' => ['description' => '- open: Enable '."\n"
+ .'- close: Shutdown ', 'docRequired' => true, 'example' => 'open', 'required' => true, 'type' => 'string', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'type' => 'object',
'properties' => [
- 'Ids' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '11111,22222',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AE4F6C34-065F-45AA-F5BN-4B8D816F6305',
- ],
+ 'RequestId' => ['description' => 'Request ID ', 'example' => 'F1005DE4-D981-559F-9E37-5172DXXXXXX', 'type' => 'string', 'title' => ''],
],
+ 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AE4F6C34-065F-45AA-F5BN-4B8D816F6305\\",\\n \\"Ids\\": \\"11111,22222\\"\\n}","errorExample":""},{"type":"xml","example":"<CancelActiveOperationTasksResponse>\\n <RequestId>AE4F6C34-065F-45AA-F5BN-4B8D816F6305</RequestId>\\n <Ids>11111,22222</Ids>\\n</CancelActiveOperationTasksResponse>","errorExample":""}]',
- 'title' => 'CancelActiveOperationTasks',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeActiveOperationTaskType' => [
- 'methods' => [
- 'post',
- 'get',
+ 'description' => 'Extension service '."\n"
+ .'For example: the Lindorm service compatible with the HBaseProxy protocol. ',
+ 'changeSet' => [
+ ['createdAt' => '2022-06-17T02:47:14.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:SwitchService',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F1005DE4-D981-559F-9E37-5172DXXXXXX\\"\\n}","type":"json"}]',
+ 'title' => '',
+ ],
+ 'TagResources' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'IsHistory',
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID of the instance. You can call the [DescribeRegions](~~144489~~) operation to query the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'ResourceId',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
+ 'description' => 'The list of instance IDs. You can call the [DescribeInstances](~~144595~~) operation to query instance IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'ld-bp17pwu1541ia****', 'title' => ''],
+ 'required' => true,
+ 'example' => 'bds-bp15e022622fk0w1',
+ 'maxItems' => 51,
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'Tag',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The list of tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The key of the tag.'."\n"
+ ."\n"
+ .'> N specifies the sequence number of the tag key. For example:<ul>'."\n"
+ .'<li>Tag.1.Key specifies the key of the first tag.</li>'."\n"
+ .'<li>Tag.2.Key specifies the key of the second tag.</li></ul>.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''],
+ 'Value' => ['description' => 'The value of the tag.'."\n"
+ ."\n"
+ .'> N specifies the sequence number of the tag value. For example:<ul>'."\n"
+ .'<li>Tag.1.Value specifies the value of the first tag.</li>'."\n"
+ .'<li>Tag.2.Value specifies the value of the second tag.</li></ul>.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'maxItems' => 21,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -12176,105 +9832,88 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EC7E27FC-58F8-4722-89CF-D1B6B0971956',
- ],
- 'TypeList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'TaskType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rds_apsaradb_upgrade',
- ],
- 'TaskTypeInfoEn' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rds_apsaradb_upgrade',
- ],
- 'TaskTypeInfoZh' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Count' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2656FA19-6059-40C8-A157-3FFBEAEC2369', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'RequiredParam.NotFound',
- 'errorMessage' => 'Required input param is not found.',
+ 'title' => 'Add tags to instances',
+ 'summary' => 'Adds tags to instances.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:37:15.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:TagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC7E27FC-58F8-4722-89CF-D1B6B0971956\\",\\n \\"TypeList\\": [\\n {\\n \\"TaskType\\": \\"rds_apsaradb_upgrade\\",\\n \\"TaskTypeInfoEn\\": \\"rds_apsaradb_upgrade\\",\\n \\"TaskTypeInfoZh\\": \\"小版本升级\\",\\n \\"Count\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeActiveOperationTaskTypeResponse>\\r\\n <RequestId>EC7E27FC-58F8-4722-89CF-D1B6B0971956</RequestId>\\r\\n <TypeList>\\r\\n <TaskTypeInfoZh>小版本升级</TaskTypeInfoZh>\\r\\n <TaskType>rds_apsaradb_upgrade</TaskType>\\r\\n <Count>1</Count>\\r\\n <TaskTypeInfoEn>rds_apsaradb_upgrade</TaskTypeInfoEn>\\r\\n </TypeList>\\r\\n</DescribeActiveOperationTaskTypeResponse>","errorExample":""}]',
- 'title' => 'DescribeActiveOperationTaskType',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2656FA19-6059-40C8-A157-3FFBEAEC2369\\"\\n}","type":"json"}]',
],
- 'ModifyActiveOperationTasks' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UnTagResources' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'Ids',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1111,2222',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'SwitchTime',
+ 'name' => 'All',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to delete all tags. If TagKey is specified, tags are deleted only by TagKey. Valid values: true and false. If this parameter is set to true and TagKey is not specified, all tags are deleted.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'ResourceId',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The ID of resource N to untag. The resource ID is the cluster ID. You can specify multiple resource IDs, such as ResourceId.2 and ResourceId.3. N is a positive integer.',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'required' => true,
- 'docRequired' => true,
- 'example' => '2022-02-17T18:50:00Z',
+ 'example' => 'bds-bp15e022622fk0w1',
+ 'maxItems' => 51,
+ 'title' => '',
],
],
[
- 'name' => 'ImmediateStart',
+ 'name' => 'TagKey',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => 'The key of tag N to delete. You can specify multiple tag keys, such as TagKey.2 and TagKey.3. N is a positive integer.',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
- 'example' => '1',
+ 'example' => 'key1',
+ 'maxItems' => 21,
+ 'title' => '',
],
],
],
@@ -12283,166 +9922,155 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Ids' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1111,2222',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '8C9CC46A-9532-4752-B59F-580112C5A45B',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9CBF8DF0-4931-4A54-9B60-4C6E1AB59286', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8C9CC46A-9532-4752-B59F-580112C5A45B\\",\\n \\"Ids\\": \\"1111,2222\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyActiveOperationTasksResponse>\\n <RequestId>8C9CC46A-9532-4752-B59F-580112C5A45B</RequestId>\\n <Ids>1111,2222</Ids>\\n</ModifyActiveOperationTasksResponse>","errorExample":""}]',
- 'title' => 'ModifyActiveOperationTasks',
+ 'title' => 'Delete resource tags',
+ 'summary' => 'Untags resources. This operation is the counterpart of TagResources.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeActiveOperationTasks' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:37:16.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:UnTagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9CBF8DF0-4931-4A54-9B60-4C6E1AB59286\\"\\n}","type":"json"}]',
+ ],
+ 'UpgradeMinorVersion' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'Region',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-t4naqsay5gn****', 'title' => ''],
],
[
- 'name' => 'TaskType',
+ 'name' => 'Components',
'in' => 'query',
+ 'schema' => ['description' => 'The names of the components to upgrade. Separate multiple component names with commas (,).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'HADOOP', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'UpgradingComponents' => ['description' => 'The components that were successfully upgraded.', 'type' => 'string', 'example' => 'HADOOP', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7B8EC240-BB13-4DBC-B955-F90170E82609', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'rds_apsaradb_upgrade',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '10',
- 'example' => '30',
- 'default' => '30',
+ ],
+ 'errorCodes' => [],
+ 'title' => 'Modify the minor version upgrade method of an instance',
+ 'summary' => 'Upgrades the minor version of a cluster by calling UpgradeMinorVersion.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:UpgradeMinorVersion',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UpgradingComponents\\": \\"HADOOP\\",\\n \\"RequestId\\": \\"7B8EC240-BB13-4DBC-B955-F90170E82609\\"\\n}","type":"json"}]',
+ ],
+ 'UpgradeMultiZoneCluster' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
[
- 'name' => 'ProductId',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'hbase',
- ],
+ 'schema' => ['description' => 'The ID of the multi-zone instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ld-***************', 'title' => ''],
],
[
- 'name' => 'DbType',
+ 'name' => 'RunMode',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The execution mode. If UpgradeInsName is not empty, the mode is forcibly set to single. If UpgradeInsName is empty and RunMode is not specified, the default value is serial. Valid values:'."\n"
+ ."\n"
+ .'- serial: all sub-instances are upgraded.'."\n"
+ .'- single: only the specified sub-instance is upgraded.',
'type' => 'string',
'required' => false,
- 'example' => 'hbaseue',
+ 'default' => '',
+ 'example' => 'serial',
+ 'enum' => ['false', 'true'],
+ 'title' => '',
],
],
[
- 'name' => 'Status',
+ 'name' => 'UpgradeInsName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '5',
- ],
+ 'schema' => ['description' => 'The name of the sub-instance to upgrade. You can obtain this value from the MultiZoneInstanceModels field in the response of the [DescribeMultiZoneCluster](~~DescribeMultiZoneCluster~~) operation. This parameter is optional. If you do not specify this parameter, all sub-instances are upgraded.', 'type' => 'string', 'required' => false, 'example' => 'ld-t4n40m3171t4******-az-b', 'title' => ''],
],
[
- 'name' => 'InsName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ld-bp150tns0sjxs****',
- ],
- ],
- [
- 'name' => 'AllowChange',
+ 'name' => 'Components',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The component names. You can specify multiple component names separated by commas (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'LINDORM', 'title' => ''],
],
[
- 'name' => 'AllowCancel',
+ 'name' => 'Versions',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The RPM version to upgrade to. If you do not specify this parameter, the components are upgraded to the latest version. If you specify multiple values for Components, you must also specify the same number of values for Versions, separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => 't-apsara-lindorm-2.1.20-20200518175539.alios7.x86_64', 'title' => ''],
],
[
- 'name' => 'ChangeLevel',
+ 'name' => 'RestartComponents',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'S1',
- ],
+ 'schema' => ['description' => 'The names of the components that need to be restarted after the upgrade. You can specify multiple component names separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => 'LPROXY', 'title' => ''],
],
],
'responses' => [
@@ -12450,193 +10078,44 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C634E813-42FA-53D2-A7EB-B881C4B264CC',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'TotalRecordCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Items' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'ChangeLevelEn' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Risk repairment',
- ],
- 'TaskType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rds_apsaradb_upgrade',
- ],
- 'InsName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ld-bp150tns0sjxs****',
- ],
- 'Region' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hanghzou',
- ],
- 'ImpactZh' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'CreatedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2022-02-15 23:59:59',
- ],
- 'SwitchTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2022-02-19 14:00:00',
- ],
- 'ChangeLevelZh' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Deadline' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2022-02-19 23:59:59',
- ],
- 'PrepareInterval' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '14:00:00',
- ],
- 'TaskTypeZh' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'CurrentAVZ' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-shanghai-et-a',
- ],
- 'AllowChange' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'DbVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2.0',
- ],
- 'ImpactEn' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Transient instance disconnection',
- ],
- 'InsComment' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '--',
- ],
- 'StartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2022-02-19 10:00:00',
- ],
- 'ModifiedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2022-02-19 14:00:00',
- ],
- 'AllowCancel' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'DbType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hbaseue',
- ],
- 'ChangeLevel' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'all',
- ],
- 'TaskTypeEn' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rds_apsaradb_upgrade',
- ],
- 'ResultInfo' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '--',
- ],
- 'Id' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '111111',
- ],
- 'SubInsNames' => [
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ld-bp150tns0sjxs****',
- ],
- ],
- ],
- ],
- ],
+ 'UpgradingComponents' => ['description' => 'The components that triggered the upgrade among the multiple components to be upgraded.', 'type' => 'string', 'example' => 'LINDORM', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C532A4D4-9451-4460-BB3E-300FEC852D3F', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"C634E813-42FA-53D2-A7EB-B881C4B264CC\\",\\n \\"PageSize\\": 30,\\n \\"TotalRecordCount\\": 1,\\n \\"Items\\": [\\n {\\n \\"Status\\": 5,\\n \\"ChangeLevelEn\\": \\"Risk repairment\\",\\n \\"TaskType\\": \\"rds_apsaradb_upgrade\\",\\n \\"InsName\\": \\"ld-bp150tns0sjxs****\\",\\n \\"Region\\": \\"cn-hanghzou\\",\\n \\"ImpactZh\\": \\"中断\\",\\n \\"CreatedTime\\": \\"2022-02-15 23:59:59\\",\\n \\"SwitchTime\\": \\"2022-02-19 14:00:00\\",\\n \\"ChangeLevelZh\\": \\"风险修复\\",\\n \\"Deadline\\": \\"2022-02-19 23:59:59\\",\\n \\"PrepareInterval\\": \\"14:00:00\\",\\n \\"TaskTypeZh\\": \\"小版本升级\\",\\n \\"CurrentAVZ\\": \\"cn-shanghai-et-a\\",\\n \\"AllowChange\\": \\"1\\",\\n \\"DbVersion\\": \\"2.0\\",\\n \\"ImpactEn\\": \\"Transient instance disconnection\\",\\n \\"InsComment\\": \\"--\\",\\n \\"StartTime\\": \\"2022-02-19 10:00:00\\",\\n \\"ModifiedTime\\": \\"2022-02-19 14:00:00\\",\\n \\"AllowCancel\\": \\"1\\",\\n \\"DbType\\": \\"hbaseue\\",\\n \\"ChangeLevel\\": \\"all\\",\\n \\"TaskTypeEn\\": \\"rds_apsaradb_upgrade\\",\\n \\"ResultInfo\\": \\"--\\",\\n \\"Id\\": 111111,\\n \\"SubInsNames\\": [\\n \\"ld-bp150tns0sjxs****\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeActiveOperationTasksResponse>\\n<TotalRecordCount>1</TotalRecordCount>\\n<PageSize>30</PageSize>\\n<RequestId>C634E813-42FA-53D2-A7EB-B881C4B264CC</RequestId>\\n<PageNumber>1</PageNumber>\\n<Items>\\n <Status>5</Status>\\n <CreatedTime>2022-02-15 23:59:59</CreatedTime>\\n <CurrentAVZ>cn-shanghai-et-a</CurrentAVZ>\\n <Deadline>2022-02-19 23:59:59</Deadline>\\n <StartTime>2022-02-19 10:00:00</StartTime>\\n <InsName>ld-bp150tns0sjxs****</InsName>\\n <ChangeLevel>all</ChangeLevel>\\n <DbType>hbaseue</DbType>\\n <ImpactEn>Transient instance disconnection</ImpactEn>\\n <InsComment>--</InsComment>\\n <ChangeLevelZh>风险修复</ChangeLevelZh>\\n <AllowCancel>1</AllowCancel>\\n <TaskTypeZh>小版本升级</TaskTypeZh>\\n <ChangeLevelEn>Risk repairment</ChangeLevelEn>\\n <ModifiedTime>2022-02-19 14:00:00</ModifiedTime>\\n <DbVersion>2.0</DbVersion>\\n <TaskTypeEn>rds_apsaradb_upgrade</TaskTypeEn>\\n <ImpactZh>中断</ImpactZh>\\n <AllowChange>1</AllowChange>\\n <TaskType>rds_apsaradb_upgrade</TaskType>\\n <PrepareInterval>14:00:00</PrepareInterval>\\n <Region>cn-hanghzou</Region>\\n <Id>111111</Id>\\n <SwitchTime>2022-02-19 14:00:00</SwitchTime>\\n <SubInsNames>ld-bp150tns0sjxs****</SubInsNames>\\n</Items>\\n</DescribeActiveOperationTasksResponse>","errorExample":""}]',
- 'title' => 'DescribeActiveOperationTasks',
+ 'title' => 'Upgrade a multi-zone cluster',
+ 'summary' => 'Upgrades the minor version of components for a multi-zone instance by calling the UpgradeMultiZoneCluster operation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'SwitchService' => [
- 'summary' => '开通/关闭 扩展服务',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-10T11:37:16.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:UpgradeMultiZoneCluster',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UpgradingComponents\\": \\"LINDORM\\",\\n \\"RequestId\\": \\"C532A4D4-9451-4460-BB3E-300FEC852D3F\\"\\n}","type":"json"}]',
+ ],
+ 'XpackRelateDB' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -12649,158 +10128,1656 @@
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'ld-uf6r2hn2zrxxxxxx',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The instance ID of the current Spark instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ap-bp1qtz9rcbbt3****', 'title' => ''],
],
[
- 'name' => 'ServiceName',
+ 'name' => 'DbClusterIds',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'HBaseProxy',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The instance ID of the cluster to associate.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hb-bp16o0pd52e3****', 'title' => ''],
],
[
- 'name' => 'Operate',
+ 'name' => 'RelateDbType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'open',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The type of database to associate. Valid values:'."\n"
+ .'- **hdfs**'."\n"
+ .'- **hbase**'."\n"
+ .'- **mongodb**'."\n"
+ .'- **mysql**'."\n"
+ .'- **polardb_mysql**'."\n"
+ .'- **redis**'."\n"
+ .'- **geomesa**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hbase', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'example' => 'F1005DE4-D981-559F-9E37-5172DXXXXXX',
- 'type' => 'string',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '50373857-C47B-4B64-9332-D0B5280B59EA', 'title' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F1005DE4-D981-559F-9E37-5172DXXXXXX\\"\\n}","type":"json"}]',
+ 'errorCodes' => [],
+ 'title' => 'Associate a database',
+ 'summary' => 'Associates a database by calling XpackRelateDB.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:XpackRelateDB',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbase.cn-beijing.aliyuncs.com', 'endpoint' => 'hbase.cn-beijing.aliyuncs.com', 'vpc' => 'hbase-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbase.cn-qingdao.aliyuncs.com', 'endpoint' => 'hbase.cn-qingdao.aliyuncs.com', 'vpc' => 'hbase-vpc.cn-qingdao.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbase.cn-shanghai.aliyuncs.com', 'endpoint' => 'hbase.cn-shanghai.aliyuncs.com', 'vpc' => 'hbase-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbase.cn-hongkong.aliyuncs.com', 'endpoint' => 'hbase.cn-hongkong.aliyuncs.com', 'vpc' => 'hbase-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbase.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'hbase.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'hbase-vpc.cn-zhangjiakou.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbase.cn-shenzhen.aliyuncs.com', 'endpoint' => 'hbase.cn-shenzhen.aliyuncs.com', 'vpc' => 'hbase-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbase.ap-northeast-1.aliyuncs.com', 'endpoint' => 'hbase.ap-northeast-1.aliyuncs.com', 'vpc' => 'hbase-vpc.ap-northeast-1.aliyuncs.com'],
+ ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbase.cn-chengdu.aliyuncs.com', 'endpoint' => 'hbase.cn-chengdu.aliyuncs.com', 'vpc' => 'hbase-vpc.cn-chengdu.aliyuncs.com'],
+ ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbase.cn-guangzhou.aliyuncs.com', 'endpoint' => 'hbase.cn-guangzhou.aliyuncs.com', 'vpc' => 'hbase-vpc.cn-guangzhou.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbase.ap-southeast-1.aliyuncs.com', 'endpoint' => 'hbase.ap-southeast-1.aliyuncs.com', 'vpc' => 'hbase-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbase.ap-southeast-2.aliyuncs.com', 'endpoint' => 'hbase.ap-southeast-2.aliyuncs.com', 'vpc' => 'hbase-vpc.ap-southeast-2.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbase.ap-southeast-3.aliyuncs.com', 'endpoint' => 'hbase.ap-southeast-3.aliyuncs.com', 'vpc' => 'hbase-vpc.ap-southeast-3.aliyuncs.com'],
+ ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbase.cn-huhehaote.aliyuncs.com', 'endpoint' => 'hbase.cn-huhehaote.aliyuncs.com', 'vpc' => 'hbase-vpc.cn-huhehaote.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbase.ap-southeast-5.aliyuncs.com', 'endpoint' => 'hbase.ap-southeast-5.aliyuncs.com', 'vpc' => 'hbase-vpc.ap-southeast-5.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'hbase.aliyuncs.com', 'endpoint' => 'hbase.aliyuncs.com', 'vpc' => 'hbase-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'hbase.us-east-1.aliyuncs.com', 'endpoint' => 'hbase.us-east-1.aliyuncs.com', 'vpc' => 'hbase-vpc.us-east-1.aliyuncs.com'],
+ ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'hbase.eu-west-1.aliyuncs.com', 'endpoint' => 'hbase.eu-west-1.aliyuncs.com', 'vpc' => 'hbase-vpc.eu-west-1.aliyuncs.com'],
+ ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'hbase.us-west-1.aliyuncs.com', 'endpoint' => 'hbase.us-west-1.aliyuncs.com', 'vpc' => 'hbase-vpc.us-west-1.aliyuncs.com'],
+ ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'hbase.eu-central-1.aliyuncs.com', 'endpoint' => 'hbase.eu-central-1.aliyuncs.com', 'vpc' => 'hbase-vpc.eu-central-1.aliyuncs.com'],
+ ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'hbase.me-east-1.aliyuncs.com', 'endpoint' => 'hbase.me-east-1.aliyuncs.com', 'vpc' => 'hbase-vpc.me-east-1.aliyuncs.com'],
+ ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'hbase.me-central-1.aliyuncs.com', 'endpoint' => 'hbase.me-central-1.aliyuncs.com', 'vpc' => 'hbase-vpc.me-central-1.aliyuncs.com'],
+ ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'hbase.ap-south-1.aliyuncs.com', 'endpoint' => 'hbase.ap-south-1.aliyuncs.com', 'vpc' => 'hbase-vpc.ap-south-1.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'hbase.aliyuncs.com', 'endpoint' => 'hbase.aliyuncs.com', 'vpc' => 'hbase-vpc.cn-hangzhou-finance.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'hbase.aliyuncs.com', 'endpoint' => 'hbase.aliyuncs.com', 'vpc' => 'hbase-vpc.cn-shenzhen-finance-1.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'hbase.aliyuncs.com', 'endpoint' => 'hbase.aliyuncs.com', 'vpc' => 'hbase-vpc.cn-shanghai-finance-1.aliyuncs.com'],
+ ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'hbase.cn-north-2-gov-1.aliyuncs.com', 'endpoint' => 'hbase.cn-north-2-gov-1.aliyuncs.com', 'vpc' => 'hbase-vpc.cn-north-2-gov-1.aliyuncs.com'],
+ ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'hbase.aliyuncs.com', 'endpoint' => 'hbase.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'Bds.InternalError', 'message' => 'An internal error occurred on the BDS service. Please try again later. If the error persists, submit a ticket.', 'http_code' => 400, 'description' => 'An internal error occurred on the BDS service. Please try again later. If the error persists, submit a ticket.'],
+ ['code' => 'CloseBackupFailed', 'message' => 'The instance is in backup, please wait for a moment.', 'http_code' => 400, 'description' => 'The instance is being backed up. Try again later.'],
+ ['code' => 'DeleteClusterForbidden', 'message' => 'This instance is protected and cannot be deleted.', 'http_code' => 400, 'description' => 'You cannot delete the instance because deletion protection is enabled for the instance.'],
+ ['code' => 'Forbidden', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 403, 'description' => 'You are not authorized to perform this operation.'],
+ ['code' => 'HBaseInvalidParam', 'message' => 'hbase parameter is invalid:', 'http_code' => 400, 'description' => 'The value of a kernel-related parameter is invalid.'],
+ ['code' => 'Instance.DeleteInstanceForbidden', 'message' => 'Deletion protection has been enabled on the instance. To release the instance, disable detection protection first.', 'http_code' => 400, 'description' => 'Deletion protection has been enabled on the instance. To release the instance, disable detection protection first.'],
+ ['code' => 'Instance.InvalidDbType', 'message' => 'The specified DbType parameter is invalid.', 'http_code' => 400, 'description' => 'The specified DbType parameter is invalid.'],
+ ['code' => 'Instance.InvalidRelateDbType', 'message' => 'The specified RelateDbType parameter is invalid.', 'http_code' => 400, 'description' => 'The specified RelateDbType parameter is invalid.'],
+ ['code' => 'Instance.InvalidStatus', 'message' => 'The specified instance status is invalid.', 'http_code' => 400, 'description' => 'The specified instance status is invalid.'],
+ ['code' => 'Instance.NotFound', 'message' => 'The specified instance does not exist.', 'http_code' => 404, 'description' => 'The specified instance does not exist.'],
+ ['code' => 'InternalError', 'message' => 'An internal server error occurred. Please try again later. Submit a ticket if the error still exists.', 'http_code' => 500, 'description' => 'An internal server error occurred. Please try again later. Submit a ticket if the error still exists.'],
+ ['code' => 'InternalError', 'message' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.', 'http_code' => 500, 'description' => 'An internal error occurred. Please try again later. If the error persists, submit a ticket.'],
+ ['code' => 'InvalidAccessKeyId.NotFound', 'message' => 'Specified access key is not found.', 'http_code' => 400, 'description' => 'The specified AccessKey ID is invalid.'],
+ ['code' => 'InvalidParameter', 'message' => 'The specified parameter is invalid. %s', 'http_code' => 400, 'description' => 'The specified parameter is invalid. %s'],
+ ['code' => 'JobTemplate.InvalidContent', 'message' => 'The specified job template content is invalid:', 'http_code' => 400, 'description' => 'The specified task template is invalid.'],
+ ['code' => 'JobTemplate.NotFound', 'message' => 'The specified job template does not exist.', 'http_code' => 400, 'description' => 'The task template does not exist.'],
+ ['code' => 'MissingParameter', 'message' => 'You must specify this parameter.', 'http_code' => 400, 'description' => 'You must specify this parameter.'],
+ ['code' => 'NotFound', 'message' => 'The specified object does not exist.', 'http_code' => 404, 'description' => 'The specified object does not exist.'],
+ ['code' => 'SalesInternalError', 'message' => 'An internal error occurred on the sales system. Please try again later.', 'http_code' => 500, 'description' => 'An internal error occurred on the sales system. Please try again later.'],
+ ['code' => 'Tags.DuplicateTagKey', 'message' => 'The specified tag key is duplicated.', 'http_code' => 400, 'description' => 'The specified tag key is duplicated.'],
+ ['code' => 'Tags.InvalidTagKey', 'message' => 'The tag key format is invalid. The tag key can contain letters, digits, and underscores (_).', 'http_code' => 400, 'description' => 'The tag key format is invalid. The tag key can contain letters, digits, and underscores (_).'],
+ ['code' => 'Tags.InvalidTagValue', 'message' => 'The tag value format is invalid. The tag value can contain letters, digits, and underscores (_).', 'http_code' => 400, 'description' => 'The tag value format is invalid. The tag value can contain letters, digits, and underscores (_).'],
+ ['code' => 'Tags.MissParameterTagOrResourceId', 'message' => 'You must specify the resource group ID or the tag key and value.', 'http_code' => 400, 'description' => 'You must specify the resource group ID or the tag key and value.'],
+ ['code' => 'Tags.NumberExceed', 'message' => 'The number of tags has reached 10. Delete the tags that are no longer needed and try again.', 'http_code' => 400, 'description' => 'The number of tags has reached 10. Delete the tags that are no longer needed and try again.'],
+ ['code' => 'Tags.ResourceIdsNumberExceed', 'message' => 'The number of resource group IDs has reached 50. Release the resource groups that are no longer needed and try again.', 'http_code' => 400, 'description' => 'The number of resource group IDs has reached 50. Release the resource groups that are no longer needed and try again.'],
+ ],
+ 'changeSet' => [
[
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'hbase.ap-southeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'hbase.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'hbase.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'hbase.cn-zhangjiakou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'hbase.cn-huhehaote.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'hbase.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'hbase.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'hbase.cn-shenzhen.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'],
+ ['description' => 'Response parameters changed', 'api' => 'DescribeMultiZoneCluster'],
+ ],
+ 'createdAt' => '2024-07-11T13:37:58.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-guangzhou',
- 'endpoint' => 'hbase.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CheckComponentsVersion'],
+ ['description' => 'Error codes changed', 'api' => 'CreateBackupPlan'],
+ ['description' => 'Error codes changed', 'api' => 'CreateHBaseSlbServer'],
+ ['description' => 'Error codes changed', 'api' => 'DeleteHBaseHaDB'],
+ ['description' => 'Error codes changed', 'api' => 'DeleteHBaseSlbServer'],
+ ['description' => 'Error codes changed', 'api' => 'DeleteServerlessCluster'],
+ ['description' => 'Error codes changed', 'api' => 'DescribeBackupPolicy'],
+ ],
+ 'createdAt' => '2024-05-06T09:47:10.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'hbase.cn-chengdu.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ResizeColdStorageSize'],
+ ],
+ 'createdAt' => '2024-04-26T03:45:11.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'hbase.cn-hongkong.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CreateCluster'],
+ ['description' => 'Error codes changed', 'api' => 'CreateRestorePlan'],
+ ],
+ 'createdAt' => '2023-08-10T12:02:14.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'hbase.ap-northeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'DescribeAvailableResource'],
+ ['description' => 'Error codes changed', 'api' => 'DescribeBackupPlanConfig'],
+ ['description' => 'Error codes changed', 'api' => 'DescribeBackups'],
+ ['description' => 'Error codes changed', 'api' => 'DescribeDeletedInstances'],
+ ['description' => 'Error codes changed', 'api' => 'DescribeMultiZoneAvailableRegions'],
+ ['description' => 'Error codes changed', 'api' => 'DescribeSubDomain'],
+ ['description' => 'Error codes changed', 'api' => 'EnableHBaseueBackup'],
+ ['description' => 'Error codes changed', 'api' => 'ListHBaseInstances'],
+ ],
+ 'createdAt' => '2023-08-10T11:56:10.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-southeast-2',
- 'endpoint' => 'hbase.ap-southeast-2.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'ListTagResources'],
+ ['description' => 'Error codes changed', 'api' => 'ListTags'],
+ ['description' => 'Error codes changed', 'api' => 'ModifyBackupPlanConfig'],
+ ['description' => 'Error codes changed', 'api' => 'ModifyInstanceType'],
+ ['description' => 'Error codes changed', 'api' => 'ModifyUIAccountPassword'],
+ ['description' => 'Error codes changed', 'api' => 'PurgeInstance'],
+ ['description' => 'Error codes changed', 'api' => 'RenewInstance'],
+ ],
+ 'createdAt' => '2023-08-10T11:49:09.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'hbase.ap-southeast-3.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'DescribeEndpoints'],
+ ['description' => 'Error codes changed', 'api' => 'DescribeInstanceType'],
+ ['description' => 'Error codes changed', 'api' => 'DescribeRegions'],
+ ['description' => 'Error codes changed', 'api' => 'ResizeColdStorageSize'],
+ ['description' => 'Error codes changed', 'api' => 'ResizeDiskSize'],
+ ['description' => 'Error codes changed', 'api' => 'RestartInstance'],
+ ['description' => 'Error codes changed', 'api' => 'TagResources'],
+ ['description' => 'Error codes changed', 'api' => 'UnTagResources'],
+ ['description' => 'Error codes changed', 'api' => 'UpgradeMultiZoneCluster'],
+ ],
+ 'createdAt' => '2023-08-10T11:37:28.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'hbase.ap-southeast-5.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed, Error codes changed', 'api' => 'DescribeMultiZoneCluster'],
+ ],
+ 'createdAt' => '2023-04-25T12:42:11.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'us-east-1',
- 'endpoint' => 'hbase.us-east-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed, Error codes changed', 'api' => 'CreateGlobalResource'],
+ ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DeleteGlobalResource'],
+ ],
+ 'createdAt' => '2023-04-14T10:59:19.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'us-west-1',
- 'endpoint' => 'hbase.us-west-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'AllocatePublicNetworkAddress'],
+ ],
+ 'createdAt' => '2023-04-07T16:51:30.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'eu-west-1',
- 'endpoint' => 'hbase.eu-west-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'DescribeInstances'],
+ ],
+ 'createdAt' => '2022-12-08T02:59:29.000Z',
+ 'description' => 'RegionId 非必填',
],
[
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'hbase.eu-central-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'],
+ ['description' => 'OpenAPI offline', 'api' => 'SwitchService'],
+ ],
+ 'createdAt' => '2022-06-17T02:47:57.000Z',
+ 'description' => '开通开源hbase客户端访问地址',
],
[
- 'regionId' => 'ap-south-1',
- 'endpoint' => 'hbase.ap-south-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed, Error codes changed', 'api' => 'ModifyInstanceServiceConfig'],
+ ],
+ 'createdAt' => '2022-03-22T12:48:41.000Z',
+ 'description' => '事件接口 对外公开',
],
[
- 'regionId' => 'me-east-1',
- 'endpoint' => 'hbase.me-east-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed, Error codes changed', 'api' => 'DescribeInstance'],
+ ],
+ 'createdAt' => '2022-02-22T11:34:48.000Z',
+ 'description' => '1、事件相关请求2、查询实例详情包括任务进度',
],
[
- 'regionId' => 'cn-hangzhou-finance',
- 'endpoint' => 'hbase.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DescribeInstances'],
+ ],
+ 'createdAt' => '2021-12-07T15:37:14.000Z',
+ 'description' => 'DescribeInstanes 增加cluster_id',
],
[
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'hbase.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed, Error codes changed', 'api' => 'DescribeColdStorage'],
+ ],
+ 'createdAt' => '2021-11-03T13:41:15.000Z',
+ 'description' => 'DescribeColdStorage 增加bds冷存类型, bds冷存储使用量',
],
- [
- 'regionId' => 'cn-shenzhen-finance-1',
- 'endpoint' => 'hbase.aliyuncs.com',
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMultiZoneAvailableResource'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstance'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstances'],
+ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActiveOperationTaskType'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIpWhitelist'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEndpoints'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableResource'],
+ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyActiveOperationTasks'],
+ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActiveOperationTasks'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'],
+ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelActiveOperationTasks'],
],
- [
- 'regionId' => 'cn-beijing-finance-1',
- 'endpoint' => 'hbase.aliyuncs.com',
+ ],
+ 'ram' => [
+ 'productCode' => 'HBase',
+ 'productName' => 'ApsaraDB for Hbase',
+ 'ramCodes' => ['hbase'],
+ 'ramLevel' => 'RESOURCE',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'DescribeMultiZoneCluster',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeMultiZoneCluster',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'Revoke',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:Revoke',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResizeDiskSize',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:ResizeDiskSize',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeSubDomain',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeSubDomain',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EnableHBaseueBackup',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:EnableHBaseueBackup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteServerlessCluster',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hbase:DeleteServerlessCluster',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeBackupTables',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeBackupTables',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyBackupPlanConfig',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyBackupPlanConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpgradeMultiZoneCluster',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:UpgradeMultiZoneCluster',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RelateDbForHBaseHa',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:RelateDbForHBaseHa',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifySecurityGroups',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifySecurityGroups',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeActiveOperationTaskType',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeActiveOperationTaskType',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EnableHBaseueModule',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:EnableHBaseueModule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteUserHdfsInfo',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hbase:DeleteUserHdfsInfo',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpgradeMinorVersion',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:UpgradeMinorVersion',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteGlobalResource',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hbase:DeleteGlobalResource',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ConvertInstance',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:ConvertInstance',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeSecurityGroups',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeSecurityGroups',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeRestoreFullDetails',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeRestoreFullDetails',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'OpenBackup',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:OpenBackup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListInstanceServiceConfigHistories',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hbase:ListInstanceServiceConfigHistories',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateHBaseSlbServer',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:CreateHBaseSlbServer',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyAccountPassword',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyAccountPassword',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeClusterConnection',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeClusterConnection',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteMultiZoneCluster',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hbase:DeleteMultiZoneCluster',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyBackupPolicy',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyBackupPolicy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTags',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:ListTags',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDBInstanceUsage',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeDBInstanceUsage',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeInstanceType',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeInstanceType',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateRestorePlan',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hbase:CreateRestorePlan',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeRestoreSchemaDetails',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeRestoreSchemaDetails',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ReleasePublicNetworkAddress',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hbase:ReleasePublicNetworkAddress',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteHBaseSlbServer',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:DeleteHBaseSlbServer',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyInstanceType',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyInstanceType',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'XpackRelateDB',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:XpackRelateDB',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateCluster',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hbase:CreateCluster',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'MoveResourceGroup',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:MoveResourceGroup',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CancelActiveOperationTasks',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:CancelActiveOperationTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeColdStorage',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeColdStorage',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SwitchHbaseHaSlb',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:SwitchHbaseHaSlb',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyInstanceName',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyInstanceName',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryXpackRelateDB',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:QueryXpackRelateDB',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyClusterDeletionProtection',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyClusterDeletionProtection',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteAccount',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:DeleteAccount',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListHBaseInstances',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:ListHBaseInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetMultimodeCmsUrl',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:GetMultimodeCmsUrl',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeBackups',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeBackups',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeAccounts',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeAccounts',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RenewInstance',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:RenewInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SwitchService',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:SwitchService',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTagResources',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:ListTagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeMultiZoneAvailableResource',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeMultiZoneAvailableResource',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResizeColdStorageSize',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ResizeColdStorageSize',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateServerlessCluster',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hbase:CreateServerlessCluster',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyInstanceServiceConfig',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyInstanceServiceConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CheckComponentsVersion',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:CheckComponentsVersion',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeBackupSummary',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeBackupSummary',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyDiskWarningLine',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyDiskWarningLine',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListInstanceServiceConfigurations',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hbase:ListInstanceServiceConfigurations',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteHbaseHaSlb',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hbase:DeleteHbaseHaSlb',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryHBaseHaDB',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:QueryHBaseHaDB',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RestartInstance',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:RestartInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AllocatePublicNetworkAddress',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hbase:AllocatePublicNetworkAddress',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CloseBackup',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:CloseBackup',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDiskWarningLine',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeDiskWarningLine',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeMultiZoneAvailableRegions',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeMultiZoneAvailableRegions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyMultiZoneClusterNodeType',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyMultiZoneClusterNodeType',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeRestoreTables',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeRestoreTables',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'TagResources',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:TagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeEndpoints',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeEndpoints',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeInstance',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeServerlessCluster',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeServerlessCluster',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeBackupPlanConfig',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeBackupPlanConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UnTagResources',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:UnTagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDeletedInstances',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeDeletedInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateHbaseHaSlb',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hbase:CreateHbaseHaSlb',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyUIAccountPassword',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyUIAccountPassword',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateGlobalResource',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hbase:CreateGlobalResource',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyActiveOperationTasks',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyActiveOperationTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteHBaseHaDB',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:DeleteHBaseHaDB',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeActiveOperationTasks',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeActiveOperationTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddUserHdfsInfo',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hbase:AddUserHdfsInfo',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateAccount',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:CreateAccount',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResizeMultiZoneClusterDiskSize',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ResizeMultiZoneClusterDiskSize',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyIpWhitelist',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyIpWhitelist',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyInstanceMaintainTime',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ModifyInstanceMaintainTime',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeRestoreSummary',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeRestoreSummary',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteInstance',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'hbase:DeleteInstance',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResizeMultiZoneClusterNodeCount',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:ResizeMultiZoneClusterNodeCount',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'Grant',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:Grant',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateMultiZoneCluster',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'hbase:CreateMultiZoneCluster',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeIpWhitelist',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeIpWhitelist',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResizeNodeCount',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:ResizeNodeCount',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'PurgeInstance',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'hbase:PurgeInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateBackupPlan',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'hbase:CreateBackupPlan',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeBackupStatus',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeBackupStatus',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EvaluateMultiZoneResource',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:EvaluateMultiZoneResource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeBackupPolicy',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeBackupPolicy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeRestoreIncrDetail',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeRestoreIncrDetail',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeInstances',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeRecoverableTimeRange',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeRecoverableTimeRange',
+ 'authLevel' => '',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeAvailableResource',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'hbase:DescribeAvailableResource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HBase', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- [
- 'regionId' => 'me-central-1',
- 'endpoint' => 'hbase.me-central-1.aliyuncs.com',
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'Cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#ClusterId}'],
+ ['validationType' => 'always', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/{#clusterId}'],
+ ['validationType' => 'always', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
+ ['validationType' => 'always', 'resourceType' => 'Backup', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:Backup/*'],
+ ['validationType' => 'always', 'resourceType' => 'cluster', 'arn' => 'acs:hbase::{#accountId}:cluster/*'],
+ ['validationType' => 'always', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase::{#accountId}:dbinstance/*'],
+ ['validationType' => 'always', 'resourceType' => 'cluster', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:cluster/*'],
+ ['validationType' => 'always', 'resourceType' => 'dbinstance', 'arn' => 'acs:hbase:{#regionId}:{#accountId}:dbinstance/*'],
],
],
];