'1.0',
'info' => [
'style' => 'RPC',
'product' => 'HBase',
'version' => '2019-01-01',
],
'directories' => [
[
'id' => 77177,
'title' => '服务地域',
'type' => 'directory',
'children' => [
'DescribeRegions',
],
],
[
'id' => 77179,
'title' => '多可用区集群',
'type' => 'directory',
'children' => [
'CreateMultiZoneCluster',
'DeleteMultiZoneCluster',
'ResizeMultiZoneClusterDiskSize',
'ResizeMultiZoneClusterNodeCount',
'UpgradeMultiZoneCluster',
'DescribeMultiZoneAvailableRegions',
'DescribeMultiZoneCluster',
'EvaluateMultiZoneResource',
],
],
[
'id' => 77188,
'title' => '集群',
'type' => 'directory',
'children' => [
'DescribeDeletedInstances',
'DescribeIpWhitelist',
],
],
[
'id' => 77191,
'title' => '实例',
'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',
'ConvertInstance',
],
],
[
'id' => 77221,
'title' => '安全',
'type' => 'directory',
'children' => [
'ModifyIpWhitelist',
'ModifySecurityGroups',
'DescribeSecurityGroups',
],
],
[
'id' => 77225,
'title' => '备份',
'type' => 'directory',
'children' => [
'CreateBackupPlan',
'EnableHBaseueBackup',
'ModifyBackupPlanConfig',
'ModifyBackupPolicy',
'DescribeBackupPlanConfig',
'DescribeBackupPolicy',
'DescribeBackups',
'DescribeBackupStatus',
'DescribeBackupSummary',
'DescribeBackupTables',
'DescribeRecoverableTimeRange',
'CloseBackup',
'OpenBackup',
],
],
[
'id' => 77239,
'title' => '恢复',
'type' => 'directory',
'children' => [
'CreateRestorePlan',
'DescribeRestoreFullDetails',
'DescribeRestoreIncrDetail',
'DescribeRestoreSchemaDetails',
'DescribeRestoreSummary',
'DescribeRestoreTables',
],
],
[
'id' => 77246,
'title' => '网络',
'type' => 'directory',
'children' => [
'AllocatePublicNetworkAddress',
'ReleasePublicNetworkAddress',
'DescribeEndpoints',
],
],
[
'id' => 191553,
'title' => '用户',
'type' => 'directory',
'children' => [
'DescribeAccounts',
'CreateAccount',
'ModifyAccountPassword',
'DeleteAccount',
'Grant',
'Revoke',
],
],
[
'id' => 77250,
'title' => '标签',
'type' => 'directory',
'children' => [
'TagResources',
'UnTagResources',
'ListTagResources',
'ListTags',
],
],
[
'id' => 77255,
'title' => 'Serverless集群',
'type' => 'directory',
'children' => [
'CreateServerlessCluster',
'DeleteServerlessCluster',
'DescribeServerlessCluster',
],
],
[
'id' => 77259,
'title' => 'Ha负载均衡',
'type' => 'directory',
'children' => [
'CreateHbaseHaSlb',
'DeleteHbaseHaSlb',
'SwitchHbaseHaSlb',
],
],
[
'id' => 77263,
'title' => '全局资源',
'type' => 'directory',
'children' => [
'CreateGlobalResource',
'DeleteGlobalResource',
],
],
[
'id' => 175972,
'title' => '其他',
'type' => 'directory',
'children' => [
'DescribeDBInstanceUsage',
'DescribeMultiZoneAvailableResource',
'ModifyClusterDeletionProtection',
'ModifyMultiZoneClusterNodeType',
'QueryHBaseHaDB',
'CheckComponentsVersion',
'CreateHBaseSlbServer',
'DeleteHBaseSlbServer',
'DescribeColdStorage',
'GetMultimodeCmsUrl',
'ListHBaseInstances',
'ListInstanceServiceConfigHistories',
'ListInstanceServiceConfigurations',
'ModifyInstanceServiceConfig',
'RelateDbForHBaseHa',
'CancelActiveOperationTasks',
'DescribeActiveOperationTaskType',
'ModifyActiveOperationTasks',
'DescribeActiveOperationTasks',
'SwitchService',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'DescribeRegions' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '支持的语言。包括以下取值:'."\n"
."\n"
.'- **中文**:zh-CN(默认值)'."\n"
.'- **英文**:en-US'."\n"
.'- **日文**:ja',
'type' => 'string',
'required' => false,
'example' => 'zh-CN',
],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => [
'description' => '数据引擎类型。'."\n"
.'- **hbase**:HBase标准版或HBase单机版。'."\n"
.'- **hbaseue**:HBase增强版。'."\n"
.'- **serverlesshbase**:HBaseServerless版。'."\n"
.'- **bds**:表示BDS实例。',
'type' => 'string',
'required' => false,
'example' => 'hbase',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '14D3924C-4FD8-4EE9-9B34-DA949D104F42',
],
'Regions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Region' => [
'description' => '返回Region列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RegionEndpoint' => [
'description' => 'Region服务的Endpoint地址。',
'type' => 'string',
'example' => 'hbase.aliyuncs.com',
],
'LocalName' => [
'description' => '地域名称。',
'type' => 'string',
'example' => '华东1(杭州)',
],
'RegionId' => [
'description' => '地域ID,如cn-hangzhou。',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'Zones' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Zone' => [
'description' => '可用区列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => [
'description' => '可用区ID。',
'type' => 'string',
'example' => 'cn-hangzhou-b',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'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":"8D354E7A-E7F4-4A1D-A5D9-159DAC29FEA6\\n\\n \\n cn-hangzhou\\n hbase.aliyuncs.com\\n 华东1(杭州)\\n \\n \\n cn-hangzhou-h\\n \\n \\n cn-hangzhou-i\\n \\n \\n cn-hangzhou-b\\n \\n \\n cn-hangzhou-e\\n \\n \\n cn-hangzhou-f\\n \\n \\n cn-hangzhou-g\\n \\n \\n \\n \\n cn-shanghai\\n hbase.aliyuncs.com\\n 华东2(上海)\\n \\n \\n cn-shanghai-g\\n \\n \\n cn-shanghai-e\\n \\n \\n cn-shanghai-f\\n \\n \\n cn-shanghai-a\\n \\n \\n cn-shanghai-b\\n \\n \\n cn-shanghai-c\\n \\n \\n cn-shanghai-d\\n \\n \\n \\n \\n cn-qingdao\\n hbase.aliyuncs.com\\n 华北1(青岛)\\n \\n \\n cn-qingdao-b\\n \\n \\n cn-qingdao-c\\n \\n \\n \\n \\n cn-beijing\\n hbase.aliyuncs.com\\n 华北2(北京)\\n \\n \\n cn-beijing-h\\n \\n \\n cn-beijing-g\\n \\n \\n cn-beijing-f\\n \\n \\n cn-beijing-a\\n \\n \\n cn-beijing-b\\n \\n \\n cn-beijing-c\\n \\n \\n cn-beijing-d\\n \\n \\n cn-beijing-e\\n \\n \\n \\n \\n cn-shenzhen\\n hbase.aliyuncs.com\\n 华南1(深圳)\\n \\n \\n cn-shenzhen-d\\n \\n \\n cn-shenzhen-e\\n \\n \\n cn-shenzhen-a\\n \\n \\n cn-shenzhen-b\\n \\n \\n cn-shenzhen-c\\n \\n \\n \\n \\n ap-southeast-1\\n hbase.aliyuncs.com\\n 新加坡\\n \\n \\n ap-southeast-1c\\n \\n \\n ap-southeast-1a\\n \\n \\n ap-southeast-1b\\n \\n \\n \\n","errorExample":""}]',
'title' => '查询可用地域',
'summary' => '调用DescribeRegions查询可用地域。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateMultiZoneCluster' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'Engine',
'in' => 'query',
'schema' => [
'description' => '服务类型,目前仅支持HBase增强版,取值为**hbaseue**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hbaseue',
],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => [
'description' => '引擎类型的版本号,取值为**2.0**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2.0',
],
],
[
'name' => 'ArchVersion',
'in' => 'query',
'schema' => [
'description' => '部署架构的版本,目前仅支持hbaseue引擎类型,取值为**2.0**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2.0',
],
],
[
'name' => 'ClusterName',
'in' => 'query',
'schema' => [
'description' => '实例名称,设置规则如下:'."\n"
."\n"
.'- 长度为2~128个字符。'."\n"
.'- 以大小写字母或中文开头。'."\n"
.'- 可包含数字或者特殊字符,特殊字符包括半角句号(.)、短横线(-)和下划线(_)。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'hbaseue_test',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例所属的地域ID,可调用[DescribeRegions](~~144489~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => [
'description' => '专有网络ID,必须在RegionId所在的地域下。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'vpc-bp120k6ixs4eog****',
],
],
[
'name' => 'MultiZoneCombination',
'in' => 'query',
'schema' => [
'description' => '可用区组合。可用区组合支持情况可前往售卖页或者通过[DescribeMultiZoneAvailableRegions](~~203039~~)接口查看。'."\n"
.'可用区组合。可用区组合支持情况可前往售卖页查看。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou-bef-aliyun-com',
],
],
[
'name' => 'PrimaryZoneId',
'in' => 'query',
'schema' => [
'description' => '主可用区实例的可用区ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou-e',
],
],
[
'name' => 'PrimaryVSwitchId',
'in' => 'query',
'schema' => [
'description' => '主可用区实例的虚拟交换机ID,必须在PrimaryZoneId对应的可用区下。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'vsw-hangxzhouxe****',
],
],
[
'name' => 'StandbyZoneId',
'in' => 'query',
'schema' => [
'description' => '备可用区实例的可用区ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou-f',
],
],
[
'name' => 'StandbyVSwitchId',
'in' => 'query',
'schema' => [
'description' => '备可用区实例的虚拟交换机ID,必须在StandbyZoneId对应的可用区下。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'vsw-hangxzhouxf****',
],
],
[
'name' => 'ArbiterZoneId',
'in' => 'query',
'schema' => [
'description' => '仲裁可用区ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou-b',
],
],
[
'name' => 'ArbiterVSwitchId',
'in' => 'query',
'schema' => [
'description' => '仲裁虚拟交换机ID,交换机需位于ArbiterZoneId对应的可用区下。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'vsw-hangxzhouxb*****',
],
],
[
'name' => 'MasterInstanceType',
'in' => 'query',
'schema' => [
'description' => 'master节点规格,可调用[DescribeInstanceType](~~145796~~)接口查询。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hbase.sn1.medium',
],
],
[
'name' => 'CoreInstanceType',
'in' => 'query',
'schema' => [
'description' => 'core节点规格,可调用[DescribeInstanceType](~~145796~~)接口查询。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hbase.sn1.medium',
],
],
[
'name' => 'CoreDiskType',
'in' => 'query',
'schema' => [
'description' => 'core磁盘类型,取值:'."\n"
.'- **cloud_efficiency**:高效云盘。'."\n"
.'- **cloud_ssd**:SSD云盘。'."\n"
.'- **local_hdd_pro**:吞吐密集型本地盘 。'."\n"
.'- **local_ssd_pro**:I/O密集型本地盘 。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cloud_ssd',
],
],
[
'name' => 'CoreDiskSize',
'in' => 'query',
'schema' => [
'description' => '节点磁盘大小,范围为400~64000 GB,步长为40 GB。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '400',
],
],
[
'name' => 'CoreNodeCount',
'in' => 'query',
'schema' => [
'description' => 'Core节点个数,Core节点个数取值范围为2~20,且增量为2的倍数。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '4',
],
],
[
'name' => 'LogInstanceType',
'in' => 'query',
'schema' => [
'description' => 'log节点规格,可调用[DescribeInstanceType](~~145796~~)接口查询。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hbase.sn1.medium',
],
],
[
'name' => 'LogDiskType',
'in' => 'query',
'schema' => [
'description' => 'log节点磁盘类型,取值:'."\n"
.'- **cloud_efficiency**:高效云盘。'."\n"
.'- **cloud_ssd**:SSD云盘。'."\n"
.'- **local_hdd_pro**:吞吐密集型本地盘 。'."\n"
.'- **local_ssd_pro**:I/O密集型本地盘 。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cloud_ssd',
],
],
[
'name' => 'LogDiskSize',
'in' => 'query',
'schema' => [
'description' => 'log节点磁盘大小,范围为400~64000 GB,步长为40 GB。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '400',
],
],
[
'name' => 'LogNodeCount',
'in' => 'query',
'schema' => [
'description' => 'log节点数量,log节点个数取值范围为4~400,且为4的倍数。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '4',
],
],
[
'name' => 'SecurityIPList',
'in' => 'query',
'schema' => [
'description' => '添加实例的白名单IP地址,多个白名单IP地址之间使用半角逗号(,)分隔。'."\n"
."\n"
.'> 如果IP地址设置为127.0.0.1,表示禁止所有地址访问该实例。例如IP地址为192.168.0.0/24表示允许所有192.168.0.XX的IP地址访问该实例。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '127.0.0.1',
],
],
[
'name' => 'PayType',
'in' => 'query',
'schema' => [
'description' => '实例的付费类型,取值:'."\n"
.'- **Prepaid**:预付费。'."\n"
.'- **Postpaid**:后付费。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Postpaid',
],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
'description' => '包年包月实例的购买单位,取值:'."\n"
.'- **year**:年。'."\n"
.'- **month**:月。'."\n"
."\n"
.'> 仅当实例的付费类型为Prepaid时,需要填写此参数。',
'type' => 'string',
'required' => false,
'example' => 'month',
],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => [
'description' => '包年包月实例的购买时长,取值:'."\n"
."\n"
.'- 当PeriodUnit为year时,取值范围为1~3。'."\n"
.'- 当PeriodUnit为month时,取值范围为1~9。'."\n"
."\n"
.'> 仅当实例的付费类型为Prepaid时,需要填写此参数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'AutoRenewPeriod',
'in' => 'query',
'schema' => [
'description' => '自动续费周期,单位:月。'."\n"
."\n"
.'>
- 默认为0,表示不自动续费。
'."\n"
.'- AutoRenewPeriod=2,表示到期后自动续费2个月。
',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证接口幂等性的token。',
'type' => 'string',
'required' => false,
'example' => 'dfh3sf5gslfksfk****',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '资源组ID,可通过资源组控制台查询,不填时放入默认资源组中。',
'type' => 'string',
'required' => false,
'example' => 'rg-gg3f4f5d5g5w****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7F68E8F5-0377-4CF8-8B1D-FFFD6F5804D5',
],
'OrderId' => [
'description' => '订单ID。',
'type' => 'string',
'example' => '23232453****',
],
'ClusterId' => [
'description' => '云数据库HBase多可用区实例ID。',
'type' => 'string',
'example' => 'ld-t4nn71xa0yn56****',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7F68E8F5-0377-4CF8-8B1D-FFFD6F5804D5\\",\\n \\"OrderId\\": \\"23232453****\\",\\n \\"ClusterId\\": \\"ld-t4nn71xa0yn56****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 7F68E8F5-0377-4CF8-8B1D-FFFD6F5804D5\\n 23232453****\\n ld-t4nn71xa0yn56****\\n","errorExample":""}]',
'title' => '可以创建多可用区集群',
'summary' => '调用CreateMultiZoneCluster可以创建多可用区集群。',
'description' => '目前仅支持HBaseue引擎的2.0版本。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteMultiZoneCluster' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '要删除的多可用区集群Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd-t4nn71xa0yn56****',
],
],
[
'name' => 'ImmediateDeleteFlag',
'in' => 'query',
'schema' => [
'description' => '是否立即删除实例(默认是走回收站,7日后完全清理)'."\n"
.'- true:立即删除, 不走回收站,慎重提交。'."\n"
.'- false:不立即删除,走回收站, 默认。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'enum' => [
'false',
'true',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求Id。',
'type' => 'string',
'example' => '169A3910-A39E-4BC2-AA9F-E7AD8D473527',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"169A3910-A39E-4BC2-AA9F-E7AD8D473527\\"\\n}","errorExample":""},{"type":"xml","example":"169A3910-A39E-4BC2-AA9F-E7AD8D473527","errorExample":""}]',
'title' => '删除多可用区实例',
'summary' => '通过DeleteMultiZoneCluster接口删除多可用区实例。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ResizeMultiZoneClusterDiskSize' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '多可用区实例Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-f5d6vc2r8d6****',
],
],
[
'name' => 'CoreDiskSize',
'in' => 'query',
'schema' => [
'description' => 'core节点磁盘大小,必须大于当前磁盘大小,步长为40的整数倍,单位:GB,最大值64000。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'maximum' => '64000',
'minimum' => '400',
'example' => '480',
],
],
[
'name' => 'LogDiskSize',
'in' => 'query',
'schema' => [
'description' => 'log节点磁盘大小,必须大于当前log节点磁盘大小,步长为40的整数倍,单位:GB,最大值8000。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '64000',
'minimum' => '400',
'example' => '440',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OrderId' => [
'description' => '订单Id。',
'type' => 'string',
'example' => '123412341****',
],
'RequestId' => [
'description' => '请求Id。',
'type' => 'string',
'example' => '568339C4-9F71-43D0-994E-E039CD826E56',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"123412341****\\",\\n \\"RequestId\\": \\"568339C4-9F71-43D0-994E-E039CD826E56\\"\\n}","errorExample":""},{"type":"xml","example":"568339C4-9F71-43D0-994E-E039CD826E56\\n123412341****","errorExample":""}]',
'title' => '改变多可用区集群磁盘大小',
'summary' => '调用ResizeMultiZoneClusterDiskSize接口修改多可用区实例的磁盘大小。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ResizeMultiZoneClusterNodeCount' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '多可用区集群Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-f5d8d6s4s2a1****',
],
],
[
'name' => 'PrimaryVSwitchId',
'in' => 'query',
'schema' => [
'description' => '主可用区实例的虚拟交换机Id。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'vsw-hangxzhouxe*****',
],
],
[
'name' => 'StandbyVSwitchId',
'in' => 'query',
'schema' => [
'description' => '备可用区实例的虚拟交换机Id。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'vsw-hangxzhouxf****',
],
],
[
'name' => 'ArbiterVSwitchId',
'in' => 'query',
'schema' => [
'description' => '仲裁虚拟交换机Id。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'vsw-hangxzhouxb*****',
],
],
[
'name' => 'CoreNodeCount',
'in' => 'query',
'schema' => [
'description' => 'core节点个数,4节点起,且增量为2的倍数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'maximum' => '1000',
'minimum' => '2',
'example' => '6',
],
],
[
'name' => 'PrimaryCoreNodeCount',
'in' => 'query',
'schema' => [
'description' => '主可用区实例的core节点个数,4节点起,且增量为2的倍数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'maximum' => '750',
'minimum' => '1',
'example' => '6',
],
],
[
'name' => 'StandbyCoreNodeCount',
'in' => 'query',
'schema' => [
'description' => '备可用区实例的core节点个数,4节点起,且增量为2的倍数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'maximum' => '750',
'minimum' => '1',
'example' => '6',
],
],
[
'name' => 'LogNodeCount',
'in' => 'query',
'schema' => [
'description' => 'log节点数量,4节点起,且为4的倍数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'maximum' => '500',
'minimum' => '4',
'example' => '8',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OrderId' => [
'description' => '订单Id。',
'type' => 'string',
'example' => '1234123412****',
],
'RequestId' => [
'description' => '请求Id。',
'type' => 'string',
'example' => 'E2B7E9DA-1575-4B9D-A0E4-9468BAC',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"1234123412****\\",\\n \\"RequestId\\": \\"E2B7E9DA-1575-4B9D-A0E4-9468BAC\\"\\n}","errorExample":""},{"type":"xml","example":"E2B7E9DA-1575-4B9D-A0E4-9468BAC\\n1234123412****","errorExample":""}]',
'title' => '改变多可用区集群节点数量',
'summary' => '调用ResizeMultiZoneClusterNodeCount接口对多可用区实例进行扩节点。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpgradeMultiZoneCluster' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '多可用区实例Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-***************',
],
],
[
'name' => 'RunMode',
'in' => 'query',
'schema' => [
'description' => '可选参数,执行模式,如果UpgradeInsName不为空,则强制设置为single模式,如果UpgradeInsName为空且未设置RunMode,默认为serial。可选值'."\n"
.'serial 子实例都会升级'."\n"
.'single 指定的单个子实例升级',
'type' => 'string',
'required' => false,
'example' => 'serial',
'default' => '',
'enum' => [
'false',
'true',
],
],
],
[
'name' => 'UpgradeInsName',
'in' => 'query',
'schema' => [
'description' => '要升级的子实例的实例名称,可通过DescribeMultiZoneCluster接口里的MultiZoneInstanceModels字段下属性获得,可选参数,不填时子实例全部升级。',
'type' => 'string',
'required' => false,
'example' => 'ld-t4n40m3171t4******-az-b',
],
],
[
'name' => 'Components',
'in' => 'query',
'schema' => [
'description' => '组件名称,可传多个,逗号隔开。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LINDORM',
],
],
[
'name' => 'Versions',
'in' => 'query',
'schema' => [
'description' => '可选参数,升级到指定rpm的版本,不指定的话升级到最新版,如果Components为多个,要传Versions时也要传多个,英文逗号隔开。',
'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',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'UpgradingComponents' => [
'description' => '返回要升级的多个组件中触发升级的组件。',
'type' => 'string',
'example' => 'LINDORM',
],
'RequestId' => [
'description' => '请求Id。',
'type' => 'string',
'example' => 'C532A4D4-9451-4460-BB3E-300FEC852D3F',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"UpgradingComponents\\": \\"LINDORM\\",\\n \\"RequestId\\": \\"C532A4D4-9451-4460-BB3E-300FEC852D3F\\"\\n}","errorExample":""},{"type":"xml","example":"C532A4D4-9451-4460-BB3E-300FEC852D3F\\nLINDORM","errorExample":""}]',
'title' => '升级多可用区集群',
'summary' => '通过UpgradeMultiZoneCluster接口可以对多可用区实例进行组件的小版本升级。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeMultiZoneAvailableRegions' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '支持的语言。包括以下取值:'."\n"
.'- 中文:zh-CN(默认值)'."\n"
.'- 英文:en-US'."\n"
.'- 日文:ja',
'type' => 'string',
'required' => false,
'example' => 'zh-CN',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求Id。',
'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' => '华南1(深圳)',
],
'RegionId' => [
'description' => '地域Id。',
'type' => 'string',
'example' => 'cn-shenzhen',
],
'AvailableCombines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AvailableCombine' => [
'description' => '可用的可用区组合。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => [
'description' => '可用区组合Id。',
'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',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'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":"F03BB273-45EE-4B6C-A329-A6E6A8D15856\\n\\n \\n cn-shenzhen\\n hbase.aliyuncs.com\\n 华南1(深圳)\\n \\n \\n cn-shenzhen-****-aliyun\\n \\n cn-shenzhen-a,cn-shenzhen-b,cn-shenzhen-c\\n \\n \\n \\n \\n","errorExample":""}]',
'title' => '多可用区的可用地域组合',
'summary' => '调用DescribeMultiZoneAvailableRegions多可用区的可用地域组合。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeMultiZoneCluster' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '多可用区实例的Id,可通过[DescribeInstances](~~144595~~)获取列表,列表中**DbType**为hbaseue且**ModuleStackVersion**为2.0的多可用区实例。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-t4nn71xa0yn****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'VpcId' => [
'description' => '专有网络ID。',
'type' => 'string',
'example' => 'vpc-t4nx81tmlixcq5****',
],
'EncryptionType' => [
'description' => '加密类型,可选项为:'."\n"
."\n"
.'- NULL:不启用加密(默认值)。'."\n"
."\n"
.'- CloudDisk:云盘加密并通过**EncryptionKey**参数指定密钥。'."\n"
."\n\n",
'type' => 'string',
'example' => 'CloudDisk',
],
'ModuleId' => [
'description' => '组件ID。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'PayType' => [
'description' => '付费类型。'."\n"
.'- Prepaid:预付费。'."\n"
.'- Postpaid:后付费。',
'type' => 'string',
'example' => 'Prepaid',
],
'ArbiterVSwitchIds' => [
'description' => '仲裁虚拟交换机ID。',
'type' => 'string',
'example' => 'vsw-t4nax9mp3wk0czn****',
],
'MasterNodeCount' => [
'description' => 'master节点数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'A02C0E6D-3A47-4FA0-BA7E-60793CE256DA',
],
'InstanceName' => [
'description' => '集群名称。',
'type' => 'string',
'example' => 'mz_test',
],
'CoreInstanceType' => [
'description' => 'core节点规格。',
'type' => 'string',
'example' => 'hbase.sn1.large',
],
'EncryptionKey' => [
'description' => '加密的密钥ID,如果未启用加密则为空。'."\n"
."\n"
.'> 当前云盘加密开启后无法关闭。'."\n"
."\n",
'type' => 'string',
'example' => '2a****',
],
'ClusterId' => [
'description' => '集群ID。',
'type' => 'string',
'example' => 'ld-t4nn71xa0yn****',
],
'LogNodeCount' => [
'description' => 'log节点数量,4节点起,且为4的倍数。',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
'ExpireTime' => [
'description' => '过期时间,预付费(PayType为Prepaid)时有此字段(当前时区)。',
'type' => 'string',
'example' => '2020-11-16T08:00:00',
],
'MultiZoneCombination' => [
'description' => '当前多可用区实例的可用区组合。',
'type' => 'string',
'example' => 'ap-southeast-1-abc-aliyun',
],
'InstanceId' => [
'description' => '集群ID。',
'type' => 'string',
'example' => 'ld-t4nn71xa0yn****',
],
'IsDeletionProtection' => [
'description' => '是否启动删除保护:'."\n"
.'- True:启动,不能删除,删除时会提示禁止删除。'."\n"
.'- False:不启动,可以删除。',
'type' => 'boolean',
'example' => 'false',
],
'MasterDiskSize' => [
'description' => 'master节点磁盘大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '50',
],
'AutoRenewal' => [
'description' => '对于PayType为预付费(Prepaid)的多可用区实例,有此是否自动续费字段。'."\n"
.'- True:自动续费。'."\n"
.'- False:不自动续费。'."\n",
'type' => 'boolean',
'example' => 'false',
],
'ClusterName' => [
'description' => '集群名称。',
'type' => 'string',
'example' => 'mz_test',
],
'Duration' => [
'description' => '自动续费周期,后付费实例无此返回值。'."\n"
.'- 按月购买:则自动续费周期为1 个月。'."\n"
.'- 按年购买:则自动续费周期为1 年(12个月)。'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'ModuleStackVersion' => [
'description' => '组件软件栈版本。',
'type' => 'string',
'example' => '2.0',
],
'MajorVersion' => [
'description' => '根据引擎类型的版本号,目前仅支持hbaseue的2.0版本。',
'type' => 'string',
'example' => '2.0',
],
'CoreDiskCount' => [
'description' => 'core节点数量。',
'type' => 'string',
'example' => '4',
],
'Status' => [
'description' => '集群状态。'."\n"
.'- CREATING:创建中。'."\n"
.'- ACTIVATION:运行中。'."\n"
.'- DELETING:删除中。'."\n"
.'- RESTARTING:重启中。',
'type' => 'string',
'example' => 'ACTIVATION',
],
'LogInstanceType' => [
'description' => 'log节点规格, 可以从[DescribeInstanceType](~~145796~~)接口查询到准确的信息。',
'type' => 'string',
'example' => 'hbase.sn1.large',
],
'LogDiskSize' => [
'description' => 'log节点单个磁盘大小,单位:GB。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'CoreDiskType' => [
'description' => 'core磁盘类型:'."\n"
.'- cloud_efficiency:高效云盘。'."\n"
.'- cloud_ssd:SSD盘。'."\n"
.'- local_hdd_pro:吞吐密集型本地盘。'."\n"
.'- local_ssd_pro:I/O密集型本地盘。',
'type' => 'string',
'example' => 'cloud_efficiency',
],
'StandbyZoneId' => [
'description' => '备可用区实例的可用区ID。',
'type' => 'string',
'example' => 'ap-southeast-1b',
],
'NetworkType' => [
'description' => '网络类型,目前仅支持VPC。',
'type' => 'string',
'example' => 'VPC',
],
'PrimaryVSwitchIds' => [
'description' => '主可用区实例的虚拟交换机ID。',
'type' => 'string',
'example' => 'vsw-t4n3s1zd2gtidg****',
],
'CreatedTimeUTC' => [
'description' => '创建时间,UTC时间。',
'type' => 'string',
'example' => '2020-10-15T10:04:52Z',
],
'ParentId' => [
'description' => '如果为组件实例,会有此字段显示其主实例ID。',
'type' => 'string',
'example' => 'ld-fls1gf31y5s35****',
],
'ExpireTimeUTC' => [
'description' => '过期时间,预付费(PayType为Prepaid)时有此字段(UTC时间)。',
'type' => 'string',
'example' => '2020-11-16T00:00:00Z',
],
'LogDiskType' => [
'description' => 'log节点磁盘类型。'."\n"
.'- cloud_efficiency:高效云盘。'."\n"
.'- cloud_ssd:SSD盘。'."\n"
.'- local_hdd_pro:吞吐密集型本地盘。'."\n"
.'- local_ssd_pro:I/O密集型本地盘。',
'type' => 'string',
'example' => 'cloud_efficiency',
],
'MasterInstanceType' => [
'description' => 'master节点规格。',
'type' => 'string',
'example' => 'hbase.sn1.large',
],
'CreatedTime' => [
'description' => '创建时间,当前时区的时间。',
'type' => 'string',
'example' => '2020-10-15T18:04:52',
],
'CoreDiskSize' => [
'description' => 'core节点磁盘大小,单位GB。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'LogDiskCount' => [
'description' => 'log单节点的磁盘数量。',
'type' => 'string',
'example' => '4',
],
'StandbyVSwitchIds' => [
'description' => '备可用区实例的虚拟交换机ID。',
'type' => 'string',
'example' => 'vsw-t4nvvk7xur3rdi****',
],
'MaintainStartTime' => [
'description' => '可运维时间开始时间。HH:MMZ样式,如20:00Z。',
'type' => 'string',
'example' => '02:00:00',
],
'PrimaryZoneId' => [
'description' => '主可用区实例的可用区ID。',
'type' => 'string',
'example' => 'ap-southeast-1a',
],
'MaintainEndTime' => [
'description' => '可运维时间结束时间。HH:MMZ样式,如20:00Z。',
'type' => 'string',
'example' => '06:00:00',
],
'ArbiterZoneId' => [
'description' => '仲裁可用区ID。',
'type' => 'string',
'example' => 'ap-southeast-1c',
],
'MasterDiskType' => [
'description' => 'master节点磁盘类型。',
'type' => 'string',
'example' => 'cloud_efficiency',
],
'RegionId' => [
'description' => '地域ID。',
'type' => 'string',
'example' => 'ap-southeast-1',
],
'ResourceGroupId' => [
'description' => '资源所在的资源组ID。',
'type' => 'string',
'example' => 'rg-lk51f5fer315e****',
],
'Engine' => [
'description' => '服务类型:目前仅支持hbaseue。',
'type' => 'string',
'example' => 'hbaseue',
],
'TaskProgress' => [
'description' => '实例的任务运行进度,单位为百分比(%)。通过云数据库HBase控制台发起的任务,包括变更规格、扩容节点、缩容节点、重启实例,小版本升级等。',
'type' => 'string',
'example' => '42',
],
'TaskStatus' => [
'description' => '- running 运行中'."\n"
.'- pause 任务暂停'."\n"
.'- fail 任务中断'."\n"
.'- finish 已完成',
'type' => 'string',
'example' => 'running',
],
'CoreNodeCount' => [
'description' => 'core节点个数,4节点起,且增量为2的倍数。',
'type' => 'integer',
'format' => 'int32',
'example' => '6',
],
'ColdStorageSize' => [
'description' => '冷存储大小。单位:GB。',
'type' => 'integer',
'format' => 'int32',
'example' => '800',
],
'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' => [
'description' => '宽表引擎当前的最新版本。',
'type' => 'string',
'example' => '2.6.3',
],
'HdfsMinorVersion' => [
'description' => '存储引擎当前版本号。',
'type' => 'string',
'example' => '4.1.0',
],
'LatestHdfsMinorVersion' => [
'description' => '存储引擎当前最新版本号。',
'type' => 'string',
'example' => '4.1.1',
],
'IsHdfsLatestVersion' => [
'description' => '存储引擎是否是最新版本。',
'type' => 'string',
'example' => 'true',
],
],
],
],
],
],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '集群标签。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签的Key。',
'type' => 'string',
'example' => 'test_key',
],
'Value' => [
'description' => '标签的Value。',
'type' => 'string',
'example' => 'test_value',
],
],
],
],
],
],
],
],
],
],
'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":"ap-southeast-1b\\n2.0\\n2020-10-15T18:04:52\\nrg-lk51f5fer315e****\\nvsw-t4n3s1zd2gtidg****\\nhbase.sn1.large\\n4\\nfalse\\n100\\n0\\nvsw-t4nax9mp3wk0czn****\\n06:00:00\\nvsw-t4nvvk7xur3rdi****\\nVPC\\nhbase.sn1.large\\nmz_test\\ncloud_efficiency\\n02:00:00\\nhbaseue\\n\\n \\n test_value\\n test_key\\n \\n\\nap-southeast-1c\\nACTIVATION\\nld-fls1gf31y5s35****\\n4\\n2.0\\n\\n \\n primary\\n ACTIVATION\\n true\\n 2.1.24\\n ld-t4nn71xa0yn****-az-a\\n \\n\\nap-southeast-1a\\n50\\n2020-11-16T00:00:00Z\\nap-southeast-1-abc-aliyun\\nA02C0E6D-3A47-4FA0-BA7E-60793CE256DA\\n6\\nld-t4nn71xa0yn****\\nld-t4nn71xa0yn****\\n2020-10-15T10:04:52Z\\nhbase.sn1.large\\n1\\n2a****\\nCloudDisk\\nPrepaid\\n2\\nmz_test\\nvpc-t4nx81tmlixcq5****\\nfalse\\n4\\ncloud_efficiency\\ncloud_efficiency\\nap-southeast-1\\n2020-11-16T08:00:00\\n100","errorExample":""}]',
'title' => '获取多可用区实例的详情',
'summary' => '调用DescribeMultiZoneCluster可以获取多可用区实例的详情信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'EvaluateMultiZoneResource' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Engine',
'in' => 'query',
'schema' => [
'description' => '服务类型,目前仅支持HBase增强版,取值为**hbaseue**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hbaseue',
],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => [
'description' => '引擎类型的版本号,取值为**2.0**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2.0',
],
],
[
'name' => 'ArchVersion',
'in' => 'query',
'schema' => [
'description' => '部署架构的版本,目前仅支持hbaseue引擎类型,取值为**2.0**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2.0',
],
],
[
'name' => 'ClusterName',
'in' => 'query',
'schema' => [
'description' => '集群名称,设置规则如下:'."\n"
."\n"
.'- 长度为2~128个字符。'."\n"
.'- 以大小写字母或中文开头。'."\n"
.'- 可包含数字或者特殊字符,特殊字符包括半角句号(.)、短横线(-)和下划线(_)。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'hbaseue_test',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例所属的地域ID,可调用[DescribeRegions](~~144489~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => [
'description' => '专有网络ID,必须在**RegionId**所在的地域下。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'vpc-bp120k6ixs4eog*****',
],
],
[
'name' => 'MultiZoneCombination',
'in' => 'query',
'schema' => [
'description' => '可用区组合。目前支持如下,可用区组合支持情况可前往售卖页或者通过[DescribeMultiZoneAvailableRegions](~~203039~~)接口查看。'."\n"
.'可用区组合。目前支持如下,可用区组合支持情况可前往售卖页查看。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou-bef-aliyun-com',
],
],
[
'name' => 'PrimaryZoneId',
'in' => 'query',
'schema' => [
'description' => '主可用区实例的可用区ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou-e',
],
],
[
'name' => 'PrimaryVSwitchId',
'in' => 'query',
'schema' => [
'description' => '主可用区实例的虚拟交换机ID,必须在**PrimaryZoneId**对应的可用区下。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'vsw-hangxzhouxe*****',
],
],
[
'name' => 'StandbyZoneId',
'in' => 'query',
'schema' => [
'description' => '备可用区实例的可用区ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou-f',
],
],
[
'name' => 'StandbyVSwitchId',
'in' => 'query',
'schema' => [
'description' => '备可用区实例的虚拟交换机ID,必须在**StandbyZoneId**对应的可用区下。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'vsw-hangxzhouxf****',
],
],
[
'name' => 'ArbiterZoneId',
'in' => 'query',
'schema' => [
'description' => '仲裁可用区ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou-b',
],
],
[
'name' => 'ArbiterVSwitchId',
'in' => 'query',
'schema' => [
'description' => '仲裁虚拟交换机ID,交换机需位于**ArbiterZoneId**对应的可用区下。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'vsw-hangxzhouxb****',
],
],
[
'name' => 'MasterInstanceType',
'in' => 'query',
'schema' => [
'description' => 'master节点规格, 可调用[DescribeInstanceType](~~145796~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hbase.sn1.medium',
],
],
[
'name' => 'CoreInstanceType',
'in' => 'query',
'schema' => [
'description' => 'core节点规格,可调用[DescribeInstanceType](~~145796~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hbase.sn1.medium',
],
],
[
'name' => 'CoreDiskType',
'in' => 'query',
'schema' => [
'description' => 'core磁盘类型,取值:'."\n"
.'- **cloud_efficiency**:高效云盘。'."\n"
.'- **cloud_ssd**:SSD云盘。'."\n"
.'- **local_hdd_pro**:吞吐密集型本地盘。'."\n"
.'- **local_ssd_pro**:I/O密集型本地盘。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cloud_ssd',
],
],
[
'name' => 'CoreDiskSize',
'in' => 'query',
'schema' => [
'description' => '节点磁盘大小,范围为400~64000 GB,步长为40 GB。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '64000',
'minimum' => '400',
'example' => '400',
],
],
[
'name' => 'CoreNodeCount',
'in' => 'query',
'schema' => [
'description' => 'Core节点个数,Core节点个数取值范围为2~20,且增量为2的倍数。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '2000',
'minimum' => '4',
'example' => '4',
],
],
[
'name' => 'LogInstanceType',
'in' => 'query',
'schema' => [
'description' => 'log节点规格, 可调用[DescribeInstanceType](~~145796~~)接口获取。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'hbase.sn1.medium',
],
],
[
'name' => 'LogDiskType',
'in' => 'query',
'schema' => [
'description' => 'log节点磁盘类型, 取值:'."\n"
.'- **cloud_efficiency**:高效云盘。'."\n"
.'- **cloud_ssd**:SSD云盘。'."\n"
.'- **local_hdd_pro**:吞吐密集型本地盘。'."\n"
.'- **local_ssd_pro**:I/O密集型本地盘。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'cloud_ssd',
],
],
[
'name' => 'LogDiskSize',
'in' => 'query',
'schema' => [
'description' => 'log节点磁盘大小,范围为400~64000 GB,步长为40 GB。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'maximum' => '64000',
'minimum' => '400',
'example' => '400',
],
],
[
'name' => 'LogNodeCount',
'in' => 'query',
'schema' => [
'description' => 'log节点数量,log节点个数取值范围为4~400,且为4的倍数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'maximum' => '200',
'minimum' => '4',
'example' => '4',
],
],
[
'name' => 'SecurityIPList',
'in' => 'query',
'schema' => [
'description' => '添加实例的白名单IP地址,多个白名单IP地址之间使用半角逗号(,)分隔。'."\n"
."\n"
.'> 如果IP地址设置为127.0.0.1,表示禁止所有地址访问该实例。例如IP地址为192.168.0.0/24表示允许所有192.168.0.XX的IP地址访问该实例。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '127.0.0.1',
],
],
[
'name' => 'PayType',
'in' => 'query',
'schema' => [
'description' => '实例的付费类型,取值:'."\n"
."\n"
.'- **Prepaid**:包年包月(预付费)。'."\n"
.'- **Postpaid**:按量付费(后付费)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Postpaid',
],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
'description' => '包年包月实例的购买单位,取值:'."\n"
."\n"
.'- **year**:年。'."\n"
.'- **month**:月。'."\n"
."\n"
.'> 仅当实例的付费类型为Prepaid时,需要填写此参数。',
'type' => 'string',
'required' => false,
'example' => 'month',
],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => [
'description' => '包年包月实例的购买时长,取值:'."\n"
."\n"
.'- 当PeriodUnit为year时,取值范围为1~3。'."\n"
.'- 当PeriodUnit为month时,取值范围为1~9。'."\n"
."\n"
.'> 仅当实例的付费类型为Prepaid时,需要填写此参数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '60',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'AutoRenewPeriod',
'in' => 'query',
'schema' => [
'description' => '设置实例自动续费周期,单位为月。'."\n"
."\n"
.'> - 自动续费周期默认值为0,表示实例到期后不自动续费。
'."\n"
.'- 例如自动续费周期设置为2,表示实例到期后自动续费2个月。
',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '60',
'minimum' => '1',
'example' => '0',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。',
'type' => 'string',
'required' => false,
'example' => 'f4g8t5rd2gr94****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否有可用资源,返回值:'."\n"
."\n"
.'- **true**:有可用的资源。'."\n"
.'- **false**:没有可用的资源。',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'FB703B69-D4D4-4879-B9FE-6A37F67C46FD',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"FB703B69-D4D4-4879-B9FE-6A37F67C46FD\\"\\n}","errorExample":""},{"type":"xml","example":"FB703B69-D4D4-4879-B9FE-6A37F67C46FD\\ntrue","errorExample":""}]',
'title' => '评估是否存在可用资源',
'summary' => '调用EvaluateMultiZoneResource接口评估是否存在可用资源。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDeletedInstances' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '请求的地域region。',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '页码大小。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '页码大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'RequestId' => [
'description' => '请求Id。',
'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' => '当前状态,此处只有DELETED。',
'type' => 'string',
'example' => 'DELETED',
],
'InstanceId' => [
'description' => '集群Id。',
'type' => 'string',
'example' => 'hb-bp10q7n2zdw12xxxx',
],
'RegionId' => [
'description' => '地域Id。',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'ParentId' => [
'description' => '父级实例Id(如果是组件时存在)。',
'type' => 'string',
'example' => 'null',
],
'ClusterType' => [
'description' => '集群类型,单节点single或集群版cluster。',
'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',
],
],
],
],
],
],
],
],
],
],
'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":"\\n \\n null\\n null\\n 2.0\\n DELETED\\n 2020-11-02T07:16:07Z\\n cn-hangzhou-f\\n hb-bp10q7n2zdw12xxxx\\n 2020-11-02T07:27:24Z\\n cluster\\n e2e-test\\n cn-hangzhou\\n hbase\\n \\n\\n1\\n10\\n0CAC5702-C862-44C0-AD54-C9CE70F4B246\\n1","errorExample":""}]',
'title' => '获取已删除但未完全释放的集群列表',
'summary' => '获取已删除但未完全释放的集群列表。',
'description' => '集群删除默认7日后会完全清理资源。如果已经调用了清理接口PurgeInstance或自己调用接口删除时设置了ImmediateDeleteFlag为true时,则已经完全清理掉。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeIpWhitelist' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '需要查询的实例ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp150tns0sjxs****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'AFAA617B-3268-5883-982B-DB8EC8CC1F1B',
],
'Groups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Group' => [
'description' => 'IP白名单分组列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'IpVersion' => [
'description' => 'IP地址的类型,返回值:'."\n"
."\n"
.'- **4**:表示IPV4。'."\n"
.'- **6**:表示IPV6。',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
'GroupName' => [
'description' => '白名单分组名称。',
'type' => 'string',
'example' => 'default',
],
'IpList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Ip' => [
'description' => '分组中包含的IP白名单列表。',
'type' => 'array',
'items' => [
'description' => '实例的白名单IP地址。',
'type' => 'string',
'example' => '116.62.XX.XX/24',
],
],
],
],
],
],
],
],
],
],
],
],
],
'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":"\\n AFAA617B-3268-5883-982B-DB8EC8CC1F1B\\n \\n \\n 4\\n default\\n 116.62.XX.XX/24\\n 120.21.XX.XX/24\\n \\n \\n","errorExample":""}]',
'title' => '根据集群 ID 获取集群白名单信息列表',
'summary' => '根据集群id获取集群白名单信息列表。',
],
'CreateCluster' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例所属的地域ID,可调用[DescribeRegions](~~144489~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'description' => '可用区ID,可调用[DescribeRegions](~~144489~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou-f',
],
],
[
'name' => 'ClusterName',
'in' => 'query',
'schema' => [
'description' => '实例名称。命名规则为:'."\n"
."\n"
.'- 长度为2~128个字符。'."\n"
.'- 以大小写字母或中文开头。'."\n"
.'- 可包含数字或者特殊字符,特殊字符包括半角句号(.)、短横线(-)和下划线(_)。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'hbase_test',
],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => [
'description' => '专有网络ID。'."\n"
."\n"
.'> 本参数与VswitchId参数同时为空时表示实例的网络类型为经典网络。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'vpc-bp120k6ixs4eog****',
],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => [
'description' => '专有网络下的虚拟交换机ID。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'vsw-bp191otqj1ssyl****',
],
],
[
'name' => 'MasterInstanceType',
'in' => 'query',
'schema' => [
'description' => 'Master节点规格,可调用[DescribeAvailableResource](~~188244~~)接口获取规格值。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'hbase.sn1.medium',
],
],
[
'name' => 'CoreInstanceType',
'in' => 'query',
'schema' => [
'description' => 'Core节点规格,可调用[DescribeAvailableResource](~~188244~~)接口获取规格值。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hbase.sn1.medium',
],
],
[
'name' => 'DiskType',
'in' => 'query',
'schema' => [
'description' => '实例的Core磁盘类型,取值:'."\n"
.''."\n"
.' - **cloud_efficiency**:高效云盘。
'."\n"
.'- **cloud_ssd**:SSD云盘。
'."\n"
.'- **local_hdd_pro**:本地HDD盘。
'."\n"
.'- **local_ssd_pro**:本地SSD盘。
'."\n"
.'- **cloud_essd_pl1**:ESSD云盘。
'."\n"
.'
',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'cloud_ssd',
],
],
[
'name' => 'DiskSize',
'in' => 'query',
'schema' => [
'description' => 'Core单节点磁盘大小,单位:GB。'."\n"
.''."\n"
.' - 如果实例为单节点,Core单节点磁盘容量的范围为20~500 GB,步长为1 GB。
'."\n"
.' - 如果实例为云盘版,Core单节点磁盘容量的范围为400~64000 GB,步长为40 GB。
'."\n"
.' - 如果实例为本地盘,Core单节点磁盘容量与Core节点规格有关,具体如下:'."\n"
.'
'."\n"
.' - Core节点规格为hbase.d1.4xlarge时,磁盘容量为44000。
'."\n"
.' - Core节点规格为hbase.d1.6xlarge时,磁盘容量为66000。
'."\n"
.' - Core节点规格为hbase.d1.8xlarge时,磁盘容量为88000。
'."\n"
.' - Core节点规格为hbase.i2.xlarge时,磁盘容量为894。
'."\n"
.' - Core节点规格为hbase.i2.2xlarge时,磁盘容量为1788。
'."\n"
.' - Core节点规格为hbase.i2.4xlarge时,磁盘容量为3576。
'."\n"
.' - Core节点规格为hbase.i2.8xlarge时,磁盘容量为7152。
'."\n"
.' - Core节点规格为hbase.d2s.5xlarge时,磁盘容量为58400。
'."\n"
.' - Core节点规格为hbase.d2s.10xlarge时,磁盘容量为109500。
'."\n"
.'
'."\n"
.' '."\n"
.'
'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'example' => '400',
],
],
[
'name' => 'NodeCount',
'in' => 'query',
'schema' => [
'description' => 'Core节点个数,取值如下:'."\n"
.''."\n"
.' - 如果实例为单节点,Core节点个数固定为**1**个。
'."\n"
.' - 如果实例为云盘版,Core节点个数取值范围为**2**~**100**。
'."\n"
.' - 如果实例为本地盘,Core节点个数取值范围为**4**~**100**。
'."\n"
.'
',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '2',
],
],
[
'name' => 'PayType',
'in' => 'query',
'schema' => [
'description' => '实例的付费类型,取值:'."\n"
.'- **Prepaid**:包年包月(预付费)。'."\n"
.'- **Postpaid**:按量付费(后付费)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Prepaid',
],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => [
'description' => '数据库引擎类型:'."\n"
.'- **hbase**:HBase标准版或HBase单机版。'."\n"
.'- **hbaseue**:HBase增强版。'."\n"
.'- **bds**:表示BDS实例。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hbase',
],
],
[
'name' => 'SecurityIPList',
'in' => 'query',
'schema' => [
'description' => '添加实例的白名单IP地址,多个白名单IP地址之间使用半角逗号(,)分隔。'."\n"
."\n"
.'> 如果IP地址设置为127.0.0.1,表示禁止所有地址访问该实例。例如IP地址为192.168.0.0/24表示允许所有192.168.0.XX的IP地址访问该实例。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '116.62.XX.XX/24',
],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => [
'description' => '实例的引擎版本,与引擎类型有关,取值:'."\n"
.'- 如果实例的引擎类型为**hbase**,引擎版本为**1.1**或者**2.0**。'."\n"
.'- 如果实例的引擎类型为**hbaseue**,引擎版本为**2.0**。'."\n"
.'- 如果实例的引擎类型为**bds**,引擎版本为**1.0**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2.0',
],
],
[
'name' => 'ColdStorageSize',
'in' => 'query',
'schema' => [
'description' => '实例的冷存储容量大小,单位为GB。取值如下:'."\n"
.'- 取值为**0**:表示不开启冷存储。'."\n"
.'- 取值范围为**800**~**1000000**:表示开启冷存储。'."\n"
."\n"
.'> 仅当实例的引擎类型为**hbaseue**时,开启冷存储功能才有效。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1024',
],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
'description' => '包年包月实例的购买单位,取值:'."\n"
.'- **year**:年。'."\n"
.'- **month**:月。'."\n"
."\n"
.'> 仅当实例的付费类型为**Prepaid**时,需要填写此参数。',
'type' => 'string',
'required' => false,
'example' => 'month',
],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => [
'description' => '包年包月实例的购买时长,取值:'."\n"
.'- 当PeriodUnit为**year**时,取值范围为**1**~**3**。'."\n"
.'- 当PeriodUnit为**month**时,取值范围为**1**~**9**。'."\n"
."\n"
.'> 仅当实例的付费类型为**Prepaid**时,需要填写此参数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '6',
],
],
[
'name' => 'AutoRenewPeriod',
'in' => 'query',
'schema' => [
'description' => '设置实例自动续费周期,单位为月。'."\n"
."\n"
.'> - 自动续费周期默认值为**0**,表示实例到期后不自动续费。'."\n"
.'- 例如自动续费周期设置为**2**,表示实例到期后自动续费2个月。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。',
'type' => 'string',
'required' => false,
'example' => 'ETnLKlblzczshOTUbOCz****',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '资源组ID。资源组详情请参见[查看资源组基本信息](~~151181~~)。',
'type' => 'string',
'required' => false,
'example' => 'rg-j4d53glb3****',
],
],
[
'name' => 'EncryptionKey',
'in' => 'query',
'schema' => [
'description' => '加密的密钥ID,如果未启用加密则为空。'."\n"
."\n"
.'> 当前云盘版加密开启后无法关闭。'."\n"
."\n",
'type' => 'string',
'required' => false,
'example' => '0d2470df-da7b-4786-b981-9a164dae****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '3E19E345-101D-4014-946C-A205',
],
'OrderId' => [
'description' => '订单ID。',
'type' => 'string',
'example' => '23232069786****',
],
'ClusterId' => [
'description' => '实例ID。',
'type' => 'string',
'example' => 'hb-bp1hy2sjf8gd****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3E19E345-101D-4014-946C-A205\\",\\n \\"OrderId\\": \\"23232069786****\\",\\n \\"ClusterId\\": \\"hb-bp1hy2sjf8gd****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 3E19E345-101D-4014-946C-A205\\n 23232069786****\\n hb-bp1hy2sjf8gd****\\n","errorExample":""}]',
'title' => '创建HBase集群',
'summary' => '调用CreateCluster创建HBase集群。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddUserHdfsInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-bp16o0pd5****582s',
],
],
[
'name' => 'ExtInfo',
'in' => 'query',
'schema' => [
'description' => 'dfs.nameservices为dfs的nameservices名称,dfs.ha.namenodes为dfs节点,如nn1,nn2。'."\n"
.'dfs.namenode.http-address.{dfs.nameservices}.nn1 为hdfs nn1的50070链接。'."\n"
.'dfs.namenode.http-address.{dfs.nameservices}.nn2 为hdfs nn2的50070链接。'."\n"
.'dfs.namenode.rpc-address.{dfs.nameservices}.nn1 为hdfs nn1的8020链接。'."\n"
.'dfs.namenode.rpc-address.{dfs.nameservices}.nn2 为hdfs nn2的8020链接。'."\n"
.'50070端口链接和8020端口链接在hdfs各个节点都存在,hdfs有几个节点,就有几对50070和8020端口的链接。',
'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"}',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用于保证请求的幂等性。',
'type' => 'string',
'required' => false,
'example' => 'ETnLKlblzczshOTUbOCz****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'FB0B7918-198C-46A8-AB9B-FE15403B1F0A',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FB0B7918-198C-46A8-AB9B-FE15403B1F0A\\"\\n}","errorExample":""},{"type":"xml","example":"FB0B7918-198C-46A8-AB9B-FE15403B1F0A","errorExample":""}]',
'title' => '增加用户自建hdfs地址',
'summary' => '在Xpack里增加用户自建的hdfs地址。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteInstance' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '待释放的实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-bp16o0pd52e3y****',
],
],
[
'name' => 'ImmediateDeleteFlag',
'in' => 'query',
'schema' => [
'description' => '是否立即释放实例。'."\n"
.'- **true**:立即释放。'."\n"
.'- **false**:不立即释放,存储在回收站, 默认值。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => '',
'enum' => [
'false',
'true',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '50373857-C47B-4B64-9332-D0B5280B59EA',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n50373857-C47B-4B64-9332-D0B5280B59EA\\r\\n","errorExample":""}]',
'title' => '删除实例',
'summary' => '调用DeleteInstance释放HBase实例。',
'description' => '调用本接口时,实例必须满足以下条件:'."\n"
."\n"
.'- 实例状态为**运行中**。'."\n"
.'- 实例的付费方式为**按量付费**。'."\n"
."\n"
.'> 包年包月实例无法调用此接口主动删除,到期后将自动释放。 如需提前释放,请提交工单申请。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteHBaseHaDB' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'BdsId',
'in' => 'query',
'schema' => [
'description' => 'bds集群Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'bds-bp14112fd7g52s1****',
],
],
[
'name' => 'HaId',
'in' => 'query',
'schema' => [
'description' => 'Ha实例Id,可通过QueryHBaseHaDB接口获取到。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ha-sw2o0l01s4r76****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => 'B409CF51-E01F-4551-BE40-123678FA9026',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B409CF51-E01F-4551-BE40-123678FA9026\\"\\n}","errorExample":""},{"type":"xml","example":"B409CF51-E01F-4551-BE40-123678FA9026","errorExample":""}]',
'title' => '删除 Ha 实例',
'summary' => '删除已创建的Ha实例。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteUserHdfsInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-bp16o0pd52e3y****',
],
],
[
'name' => 'NameService',
'in' => 'query',
'schema' => [
'description' => 'addUserHdfsInfo里的dfs.nameservices的值,会通过[QueryXpackRelateDB](~~144509~~)接口(relateDB为hdfs)时返回。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hdfs_test',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '50373857-C47B-4B64-9332-D0B5280B59EA',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","errorExample":""},{"type":"xml","example":"50373857-C47B-4B64-9332-D0B5280B59EA","errorExample":""}]',
'title' => '删除Xpack里用户自建的hdfs信息',
'summary' => '调用DeleteUserHdfsInfo删除Xpack里用户自建的hdfs信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyInstanceMaintainTime' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '待修改运维时间的实例ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp1b**6jco89****',
],
],
[
'name' => 'MaintainStartTime',
'in' => 'query',
'schema' => [
'description' => '实例运维开始时间,格式为HH:mmZ,UTC时间。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '02:00Z',
],
],
[
'name' => 'MaintainEndTime',
'in' => 'query',
'schema' => [
'description' => '实例运维结束时间,格式为HH:mmZ,UTC时间。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '06:00Z',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C9085433-A56A-4089-B49A-DF5A4E2B7B06',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C9085433-A56A-4089-B49A-DF5A4E2B7B06\\"\\n}","errorExample":""},{"type":"xml","example":"C9085433-A56A-4089-B49A-DF5A4E2B7B06","errorExample":""}]',
'title' => '修改实例运维起始时间',
'summary' => '调用ModifyInstanceMaintainTime接口修改实例运维起始时间。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyInstanceType' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '目标实例ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-bp1x940uh********',
],
],
[
'name' => 'MasterInstanceType',
'in' => 'query',
'schema' => [
'description' => '修改后的Master节点规格。可调用[DescribeInstanceType](~~145796~~)接口获取。'."\n"
."\n"
.'> MasterInstanceType参数和CoreInstanceType参数需要填写其中一个。',
'type' => 'string',
'required' => false,
'example' => 'hbase.sn1.large',
],
],
[
'name' => 'CoreInstanceType',
'in' => 'query',
'schema' => [
'description' => '修改后的Core节点规格。可调用[DescribeInstanceType](~~145796~~)接口获取。'."\n"
."\n"
.'> MasterInstanceType参数和CoreInstanceType参数需要填写其中一个。',
'type' => 'string',
'required' => false,
'example' => 'hbase.sn1.8xlarge',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OrderId' => [
'description' => '订单ID。',
'type' => 'string',
'example' => '123412341234123',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '3E19E345-101D-4014-946C-****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"123412341234123\\",\\n \\"RequestId\\": \\"3E19E345-101D-4014-946C-****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 123412341234123\\n 3E19E345-101D-4014-946C-****\\n","errorExample":""}]',
'title' => '更改实例的规格',
'summary' => '调用ModifyInstanceType更改实例的规格。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'EnableHBaseueModule' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ModuleClusterName',
'in' => 'query',
'schema' => [
'description' => '扩展集群名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'cluster-name',
],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => [
'description' => '专有网络ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'vpc-bp120k6ixs4eog*****',
],
],
[
'name' => 'VswitchId',
'in' => 'query',
'schema' => [
'description' => '专有网络下的虚拟交换机ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'vsw-bp191ipotqj1ssyl*****',
],
],
[
'name' => 'MasterInstanceType',
'in' => 'query',
'schema' => [
'description' => 'Master节点规格,可调用[DescribeAvailableResource](~~188244~~)接口获取规格值。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'hbase.sn1.large',
],
],
[
'name' => 'CoreInstanceType',
'in' => 'query',
'schema' => [
'description' => 'Core节点规格,可调用[DescribeAvailableResource](~~188244~~)接口获取规格值。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hbase.sn1.large',
],
],
[
'name' => 'DiskType',
'in' => 'query',
'schema' => [
'description' => 'Core磁盘类型,取值:'."\n"
."\n"
.'- cloud_efficiency:高效云盘。'."\n"
.'- cloud_ssd:SSD云盘。'."\n"
.'- local_hdd_pro:本地HDD盘。'."\n"
.'- local_ssd_pro:本地SSD盘。'."\n"
.'- cloud_essd_pl1:ESSD云盘。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'cloud_ssd',
],
],
[
'name' => 'DiskSize',
'in' => 'query',
'schema' => [
'description' => '每个节点磁盘大小,单位:GB。'."\n"
."\n"
.'- 如果实例为单节点,Core单节点磁盘容量的范围为20~500 GB,步长为1 GB。'."\n"
.'- 如果实例为云盘版,Core单节点磁盘容量的范围为400~64000 GB,步长为40 GB。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'example' => '400',
],
],
[
'name' => 'NodeCount',
'in' => 'query',
'schema' => [
'description' => '节点个数,取值如下:'."\n"
."\n"
.'- 如果实例为单节点,Core节点个数固定为1个。'."\n"
.'- 如果实例为云盘版,Core节点个数取值范围为2~100。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '2',
],
],
[
'name' => 'PayType',
'in' => 'query',
'schema' => [
'description' => '实例的付费类型,取值:'."\n"
."\n"
.'- Prepaid:包年包月(预付费)。'."\n"
.'- Postpaid:按量付费(后付费)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Prepaid',
],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
'description' => '包年包月实例的购买单位,取值:'."\n"
."\n"
.'- **year**:年。'."\n"
.'- **month**:月。'."\n"
."\n"
.'> 仅当实例的付费类型为**Prepaid**时,需要填写此参数。',
'type' => 'string',
'required' => false,
'example' => 'month',
],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => [
'description' => '包年包月实例的购买时长,取值:'."\n"
."\n"
.'- 当PeriodUnit为year时,取值范围为1~3。'."\n"
.'- 当PeriodUnit为month时,取值范围为1~9。'."\n"
."\n"
.'> 仅当实例的付费类型为Prepaid时,需要填写此参数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '6',
],
],
[
'name' => 'AutoRenewPeriod',
'in' => 'query',
'schema' => [
'description' => '设置实例自动续费周期,单位为月。'."\n"
."\n"
.'> - 自动续费周期默认值为0,表示实例到期后不自动续费。
'."\n"
.'- 例如自动续费周期设置为2,表示实例到期后自动续费2个月。
',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,大小写敏感、不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => 'ETnLKlblzczshOTUbOCz****',
],
],
[
'name' => 'HbaseueClusterId',
'in' => 'query',
'schema' => [
'description' => '云数据库HBase增强版实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp150tns0sjxs****',
],
],
[
'name' => 'BdsId',
'in' => 'query',
'schema' => [
'description' => 'HBase增强版实例中关联的BDS集群ID。',
'type' => 'string',
'required' => false,
'example' => 'bds-bp174pm3tsk3****',
],
],
[
'name' => 'ModuleTypeName',
'in' => 'query',
'schema' => [
'description' => '扩展模块类型,固定取值为solr。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'solr',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例所属的地域ID,可调用[DescribeRegions](~~144489~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-shenzhen',
],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'description' => '可用区ID,可调用[DescribeRegions](~~144489~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-shenzhen-e',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '407075EA-47F5-5A2D-888F-C1F90B8F3FCA',
],
'OrderId' => [
'description' => '订单ID。',
'type' => 'string',
'example' => '21474915573****',
],
'ClusterId' => [
'description' => '扩展集群ID。',
'type' => 'string',
'example' => 'ld-bp150tns0sjxs****-m1-ps',
],
],
],
],
],
'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":"\\n 407075EA-47F5-5A2D-888F-C1F90B8F3FCA\\n 21474915573****\\n ld-bp150tns0sjxs****-m1-ps\\n","errorExample":""}]',
'title' => '开通扩展服务',
'summary' => '调用EnableHBaseueModule开通扩展服务。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyInstanceName' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。',
'type' => 'string',
'required' => false,
'example' => 'ETnLKlblzczshOTUbOCz****',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例所属的地域ID,可调用[DescribeRegions](~~144489~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'description' => '可用区ID,可调用[DescribeRegions](~~144489~~)接口获取。',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou-f',
],
],
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp150tns0sjxs****',
],
],
[
'name' => 'ClusterName',
'in' => 'query',
'schema' => [
'description' => '修改后的实例名称,可调用[DescribeInstance](~~144594~~)接口获取修改前的实例名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testhbaseone',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '959DA199-54E5-569D-AD46-92BED8515E62',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"959DA199-54E5-569D-AD46-92BED8515E62\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n65BDA532-28AF-4122-AA39-B382721EEE64\\r\\n","errorExample":""}]',
'title' => '修改实例名称',
'summary' => '调用ModifyInstanceName修改实例名称。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyDiskWarningLine' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-m5eznlga4k5bcxxxx',
],
],
[
'name' => 'WarningLine',
'in' => 'query',
'schema' => [
'description' => '告警线,取值范围[50, 90]。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '100',
'minimum' => '0',
'example' => '80',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'FC4A930D-3AEE-4C9D-BC70-C0F2EEEAA174',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FC4A930D-3AEE-4C9D-BC70-C0F2EEEAA174\\"\\n}","errorExample":""},{"type":"xml","example":"FC4A930D-3AEE-4C9D-BC70-C0F2EEEAA174","errorExample":""}]',
'title' => 'ModifyDiskWarningLine',
'summary' => '对于HBase集群版和HBaseue集群可通过ModifyDiskWarningLine接口更改磁盘容量告警线,默认告警线为80%。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyUIAccountPassword' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '目标实例ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp150tns0sjxs****',
],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => [
'description' => '待重置的集群管理系统用户名,如果HBase实例没有新建用户,默认用户名为**root**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test01',
],
],
[
'name' => 'AccountPassword',
'in' => 'query',
'schema' => [
'description' => '集群管理系统目标用户名的新密码。长度为2~30位,需包含大写字母、小写字母、特殊字符和数字中的一种或者多种,允许的特殊字符包括_-。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '**********',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'BED4ADEB-4EA9-507E-892C-84112D6AC7C1',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BED4ADEB-4EA9-507E-892C-84112D6AC7C1\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nBED4ADEB-4EA9-507E-892C-84112D6AC7C1\\r\\n","errorExample":""}]',
'title' => '重置UI访问密码',
'summary' => '调用ModifyUIProxyAccountPassword重置集群管理UI访问密码。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeInstance' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '实例ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp150tns0sjxs****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'VpcId' => [
'description' => '专有网络ID,当**NetworkType**为**2**时会返回此参数。',
'type' => 'string',
'example' => 'vpc-bp15s22y1a7sff5gj****',
],
'Status' => [
'description' => '实例状态,返回值:'."\n"
.'- **CREATING**:创建中。'."\n"
.'- **ACTIVATION**:运行中。'."\n"
.'- **DELETING**:删除中。'."\n"
.'- **RESTARTING**:重启中。'."\n"
.'- **MINOR_VERSION_TRANSING**:小版本升级中。',
'type' => 'string',
'example' => 'ACTIVATION',
],
'EncryptionType' => [
'description' => '加密类型,返回值:'."\n"
.'- **NoEncryption**:不启用加密。'."\n"
.'- **CloudDisk**:云盘加密并返回。'."\n"
.'- **EncryptionKey**:参数指定加密的密钥。'."\n"
."\n"
.'> 云盘加密开启后无法关闭。',
'type' => 'string',
'example' => 'NoEncryption',
],
'ModuleId' => [
'description' => '模块ID。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'VswitchId' => [
'description' => '虚拟交换机ID,当**NetworkType**为**2**时会返回此参数。',
'type' => 'string',
'example' => 'vsw-bp1foll427ze3d4ps****',
],
'BackupStatus' => [
'description' => '表示是否支持备份功能,返回值:'."\n"
.'- **open**:支持备份功能。'."\n"
.'- **close**:不支持备份功能。',
'type' => 'string',
'example' => 'open',
],
'PayType' => [
'description' => '实例的计费类型,返回值:'."\n"
."\n"
.'- **Prepaid**:包年包月。'."\n"
.'- **Postpaid**:按量付费。'."\n",
'type' => 'string',
'example' => 'Prepaid',
],
'CoreDiskType' => [
'description' => 'Core节点磁盘类型,返回值:'."\n"
.'- **cloud_efficiency**:高效云盘。'."\n"
.'- **cloud_ssd**:SSD云盘。'."\n"
.'- **local_hdd**:本地HDD盘。'."\n"
.'- **local__ssd**:本地SSD盘。',
'type' => 'string',
'example' => 'cloud_ssd',
],
'MasterNodeCount' => [
'description' => '表示Master节点类型,返回值:'."\n"
.'- **0**表示Master节点为单节点。'."\n"
.'- **2**表示Master节点为集群版。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'NetworkType' => [
'description' => '网络类型,返回值:'."\n"
.'- **VPC**:专有网络类型,如果为专有网络,则返回VswitchId和VpcId参数。'."\n"
.'- **CLASSIC**:经典网络类型。'."\n",
'type' => 'string',
'example' => 'VPC',
],
'CreatedTimeUTC' => [
'description' => '实例创建时间,UTC格式。',
'type' => 'string',
'example' => '2021-07-19T03:23:22Z',
],
'ColdStorageSize' => [
'description' => '冷存储空间大小,单位为GB。',
'type' => 'integer',
'format' => 'int32',
'example' => '800',
],
'ParentId' => [
'description' => '父实例ID。',
'type' => 'string',
'example' => 'ld-uf699153o1m2l****',
],
'IsLatestVersion' => [
'description' => '实例是否为最新版本,返回值:'."\n"
.'- **true**:最新版本。'."\n"
.'- **false**:不是最新版本。',
'type' => 'boolean',
'example' => 'true',
],
'ExpireTimeUTC' => [
'description' => '实例到期时间,UTC格式。',
'type' => 'string',
'example' => '2022-02-23T16:00:00Z',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66',
],
'InstanceName' => [
'description' => '实例名称。',
'type' => 'string',
'example' => 'testhbase',
],
'MasterInstanceType' => [
'description' => 'Master节点规格。',
'type' => 'string',
'example' => 'hbase.sn2.large',
],
'CoreInstanceType' => [
'description' => 'Core节点规格。',
'type' => 'string',
'example' => 'hbase.sn2.2xlarge',
],
'EncryptionKey' => [
'description' => '加密的密钥。'."\n"
."\n"
.'> 加密类型为**CloudDisk**时返回此参数。',
'type' => 'string',
'example' => '0d2470df-da7b-4786-b981-9a164dae****',
],
'CreatedTime' => [
'description' => '实例创建时间。',
'type' => 'string',
'example' => '2021-07-19T11:23:22',
],
'CoreDiskSize' => [
'description' => 'Core节点磁盘容量,单位为GB。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'ClusterId' => [
'description' => '实例ID。',
'type' => 'string',
'example' => 'ld-bp150tns0sjxs****',
],
'ExpireTime' => [
'description' => '实例到期时间。',
'type' => 'string',
'example' => '2022-02-24T00:00:00',
],
'MaintainStartTime' => [
'description' => '实例运维开始时间。',
'type' => 'string',
'example' => '18:00Z',
],
'ConfirmMaintainTime' => [
'description' => '是否首次确认实例的运维时间,返回值:'."\n"
.'- **true**:已确认。'."\n"
.'- **false**:未确认。'."\n"
."\n"
.'> 仅首次进入实例的**基本信息**页面会弹出**首次确认实例的运维时间**对话框。',
'type' => 'string',
'example' => 'true',
],
'IsHa' => [
'description' => '实例是否配置为高可用,返回值:'."\n"
.'- **true**:配置为高可用。'."\n"
.'- **false**:未配置为高可用。'."\n"
."\n"
.'> - 集群版默认配置为高可用,使用2个Master节点。'."\n"
.'- 单节点配置为实际可用容量。'."\n"
."\n\n",
'type' => 'boolean',
'example' => 'true',
],
'MaintainEndTime' => [
'description' => '实例运维结束时间。',
'type' => 'string',
'example' => '22:00Z',
],
'InstanceId' => [
'description' => '实例ID。',
'type' => 'string',
'example' => 'ld-bp150tns0sjxs****',
],
'ColdStorageStatus' => [
'description' => '是否支持冷存储功能,返回值:'."\n"
.'- **open**:支持冷存储功能。'."\n"
.'- **close**:不支持冷存储功能。',
'type' => 'string',
'example' => 'open',
],
'IsDeletionProtection' => [
'description' => '是否开启删除保护,返回值:'."\n"
.'- **true**:开启。'."\n"
.'- **false**:未开启。',
'type' => 'boolean',
'example' => 'false',
],
'MinorVersion' => [
'description' => '实例的小版本号。',
'type' => 'string',
'example' => '2.2.9.1',
],
'RegionId' => [
'description' => '实例所属地域的ID。',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'MasterDiskSize' => [
'description' => 'Master节点的磁盘容量,单位为GB。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'MasterDiskType' => [
'description' => 'Master节点的磁盘类型,返回值:'."\n"
.'- **cloud_efficiency**:高效云盘。'."\n"
.'- **cloud_ssd**:SSD云盘。'."\n"
."\n"
.'> 单节点实例会返回此参数。',
'type' => 'string',
'example' => 'cloud_efficiency',
],
'NeedUpgrade' => [
'description' => '表示是否需要升级实例的组件,返回值:'."\n"
.'- **true**:升级。'."\n"
.'- **false**:不升级。',
'type' => 'boolean',
'example' => 'false',
],
'IsMultiModel' => [
'description' => '实例是否为多模集群版,返回值:'."\n"
.'- **true**:是多模集群版。'."\n"
.'- **false**:不是多模集群版。',
'type' => 'boolean',
'example' => 'true',
],
'AutoRenewal' => [
'description' => '实例是否自动续费,返回值:'."\n"
.'- **true**:自动续费。'."\n"
.'- **false**:不自动续费。'."\n"
."\n"
.'> 仅当PayType取值为Prepaid(包年包月)时,此参数有返回值。'."\n",
'type' => 'boolean',
'example' => 'false',
],
'ClusterType' => [
'description' => '实例类型,返回值:'."\n"
.'- **cluster**:集群版。'."\n"
.'- **single**:单节点。',
'type' => 'string',
'example' => 'cluster',
],
'ResourceGroupId' => [
'description' => '资源组ID。',
'type' => 'string',
'example' => 'rg-acfmyiu4ekp****',
],
'ClusterName' => [
'description' => '实例名称。',
'type' => 'string',
'example' => 'testhbase',
],
'ZoneId' => [
'description' => '可用区ID。',
'type' => 'string',
'example' => 'cn-hangzhou-f',
],
'Duration' => [
'description' => '自动续费周期。'."\n"
."\n"
.'- 按月购买:自动续费周期为1个月。'."\n"
.'- 按年购买:自动续费周期为1年(12个月)。'."\n"
."\n"
.'> 仅当PayType取值为Prepaid(包年包月)时,此参数有返回值。',
'type' => 'integer',
'format' => 'int32',
'example' => '12',
],
'ModuleStackVersion' => [
'description' => '模块类型版本。',
'type' => 'string',
'example' => 'phoenxi:4.0',
],
'Engine' => [
'description' => '数据引擎类型。'."\n"
.'- **hbase**:HBase标准版或HBase单机版。'."\n"
.'- **hbaseue**:HBase增强版。'."\n"
.'- **serverlesshbase**:HBaseServerless版。'."\n"
.'- **bds**:BDS实例。',
'type' => 'string',
'example' => 'hbaseue',
],
'MajorVersion' => [
'description' => '主版本号。',
'type' => 'string',
'example' => '2.0',
],
'CoreDiskCount' => [
'description' => 'Core磁盘数量。',
'type' => 'string',
'example' => '4',
],
'TaskProgress' => [
'description' => '实例的任务运行进度,单位为百分比(%)。通过云数据库HBase控制台发起的任务,包括变更规格、扩容节点、缩容节点、重启实例,小版本升级等。',
'type' => 'string',
'example' => '25.00',
],
'TaskStatus' => [
'description' => '- running 运行中'."\n"
.'- pause 任务暂停'."\n"
.'- fail 任务中断'."\n"
.'- finish 已完成',
'type' => 'string',
'example' => 'running',
],
'CoreNodeCount' => [
'description' => 'Core节点个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'EnableHbaseProxy' => [
'description' => '是否支持HBase开源客户端访问,返回值:'."\n"
."\n"
.'- **true**:支持访问。'."\n"
."\n"
.'- **false**:不支持访问。',
'type' => 'boolean',
'required' => true,
'example' => 'false',
'default' => 'false',
],
'LproxyMinorVersion' => [
'description' => ' LPROXY服务的最小版本。',
'type' => 'string',
'required' => false,
'example' => '2.3.2',
],
'NeedUpgradeComps' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Comps' => [
'type' => 'array',
'items' => [
'description' => '需要升级的组件名称。'."\n"
."\n"
.'> 当NeedUpgrade参数返回true时,则返回此参数。',
'type' => 'string',
'example' => '[lindorm, hdfs]',
],
],
],
],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '资源标签。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签Key值。',
'type' => 'string',
'example' => 'test_key',
],
'Value' => [
'description' => '标签Value值。',
'type' => 'string',
'example' => 'test_value',
],
],
],
],
],
],
],
],
],
],
'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":"\\n2021-07-19T11:23:22\\nrg-acfmyiu4ekp****\\nfalse\\n0\\nhbaseue\\n\\n\\n\\n\\nACTIVATION\\n800\\nNoEncryption\\n0\\n2022-02-23T16:00:00Z\\n3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66\\nld-bp150tns0sjxs****\\nPrepaid\\nvsw-bp1foll427ze3d4ps****\\ntesthbase\\n2\\nvpc-bp15s22y1a7sff5gj****\\nfalse\\ncloud_ssd\\n2022-02-24T00:00:00\\nopen\\ntrue\\n25.00\\nhbase.sn1.2xlarge\\nfalse\\ntrue\\n22:00Z\\nVPC\\nhbase.sn2.2xlarge\\ntesthbase\\n\\n18:00Z\\n2.0\\n4\\ncn-hangzhou-f\\n2\\nld-bp150tns0sjxs****\\nopen\\n2.2.9.1\\n2021-07-19T03:23:22Z\\ntrue\\ncluster\\ncn-hangzhou\\n100\\ntrue\\n","errorExample":""}]',
'title' => '根据id查询集群基本信息',
'summary' => '调用DescribeInstance查询HBase实例的详细信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeInstances' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例所属的地域ID,可调用[DescribeRegions](~~144489~~)接口获取。'."\n"
."\n"
.'> 调用本接口时,如果传入了**Tag.N.Key**和**Tag.N.Value**参数,则本参数必须传入。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '实例列表的页码,起始值为**1**,默认值为**1**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页最多可显示的行数,最大值为**100**,默认值为**10**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
[
'name' => 'DbType',
'in' => 'query',
'schema' => [
'description' => '服务类型,取值:'."\n"
.'- **hbase**:HBase标准版或HBase单机版。'."\n"
.'- **hbaseue**:HBase增强版。'."\n"
.'- **bds**:表示BDS数据同步服务。',
'type' => 'string',
'required' => false,
'example' => 'hbase',
],
],
[
'name' => 'ClusterName',
'in' => 'query',
'schema' => [
'description' => 'HBase实例名称。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '目标实例ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => false,
'example' => 'hb-bp1u0639js2h7****',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '资源组ID,可通过资源组控制台查询。',
'type' => 'string',
'required' => false,
'example' => 'rg-4f51d54g5****',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签的键,与Tag Value组成标签的键值对,格式为{"key1":"value1","key2":"value2"}。',
'type' => 'string',
'required' => false,
'example' => 'key',
],
'Value' => [
'description' => '标签键的值,与Tag Key组成标签的键值对。',
'type' => 'string',
'required' => false,
'example' => 'value',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '每页最多可显示的行数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'RequestId' => [
'description' => '请求ID。',
'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' => 'HBase实例列表信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'VpcId' => [
'description' => '专有网络ID,当**NetworkType**为**2**时会返回此参数。',
'type' => 'string',
'example' => 'vpc-bp120k6ixs4eoghz*****',
],
'Status' => [
'description' => '实例状态,返回值:'."\n"
."\n"
.'- **CREATING**:创建中。'."\n"
.'- **ACTIVATION**:运行中。'."\n"
.'- **DELETING**:删除中。'."\n"
.'- **RESTARTING**:重启中。'."\n"
.'- **MINOR_VERSION_TRANSING**:小版本升级中。',
'type' => 'string',
'example' => 'ACTIVATION',
],
'ModuleId' => [
'description' => '模块ID。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'VswitchId' => [
'description' => '虚拟交换机ID,当**NetworkType**为**2**时会返回此参数。',
'type' => 'string',
'example' => 'vsw-bp191ipotq****dbqf',
],
'BackupStatus' => [
'description' => '表示是否支持备份功能,返回值:'."\n"
."\n"
.'- **open**:支持备份功能。'."\n"
.'- **close**:不支持备份功能。',
'type' => 'string',
'example' => 'open',
],
'PayType' => [
'description' => '实例的计费类型,返回值:'."\n"
."\n"
.'- **Prepaid**:包年包月。'."\n"
.'- **Postpaid**:按量付费。',
'type' => 'string',
'example' => 'Prepaid',
],
'CoreDiskType' => [
'description' => 'Core节点磁盘类型,返回值:'."\n"
."\n"
.'- **cloud_efficiency**:高效云盘。'."\n"
.'- **cloud_ssd**:SSD云盘。'."\n"
.'- **local_hdd**:本地HDD盘。'."\n"
.'- **local__ssd**:本地SSD盘。',
'type' => 'string',
'example' => 'cloud_efficiency',
],
'MasterNodeCount' => [
'description' => '表示Master节点类型,返回值:'."\n"
."\n"
.'- **0**表示Master节点为单节点。'."\n"
.'- **2**表示Master节点为集群版。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'NetworkType' => [
'description' => '网络类型,返回值:'."\n"
."\n"
.'- **VPC**:专有网络类型,如果为专有网络,就会返回VswitchId和VpcId参数。'."\n"
.'- **CLASSIC**:经典网络类型。',
'type' => 'string',
'example' => 'VPC',
],
'CreatedTimeUTC' => [
'description' => '实例创建时间,UTC格式。',
'type' => 'string',
'example' => '2019-09-12T14:40:46Z',
],
'ParentId' => [
'description' => '父实例ID。',
'type' => 'string',
'example' => '2980****2123',
],
'ExpireTimeUTC' => [
'description' => '实例到期时间,UTC格式。',
'type' => 'string',
'example' => '2019-10-12T14:40:46Z',
],
'InstanceName' => [
'description' => '实例名称。',
'type' => 'string',
'example' => 'test',
],
'MasterInstanceType' => [
'description' => 'Master节点规格。',
'type' => 'string',
'example' => 'hbase.sn1.large',
],
'CoreInstanceType' => [
'description' => 'Core节点规格。',
'type' => 'string',
'example' => 'hbase.sn1.large',
],
'CreatedTime' => [
'description' => '实例创建时间。',
'type' => 'string',
'example' => '2019-09-12T14:40:46',
],
'CoreDiskSize' => [
'description' => 'Core节点磁盘容量,默认单位G。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'ClusterId' => [
'description' => '实例ID。',
'type' => 'string',
'example' => 'hb-bp1u0639js2h7****',
],
'ExpireTime' => [
'description' => '实例到期时间。',
'type' => 'string',
'example' => '2019-10-12T14:40:46',
],
'IsHa' => [
'description' => '实例是否配置为高可用,返回值:'."\n"
."\n"
.'- **true**:配置为高可用。'."\n"
.'- **false**:未配置为高可用。'."\n"
."\n"
.'> 集群版默认配置为高可用,使用2个Master节点。单节点配置为实际可用容量。'."\n",
'type' => 'boolean',
'example' => 'true',
],
'InstanceId' => [
'description' => '实例ID。',
'type' => 'string',
'example' => 'hb-bp1u0639js2h7****',
],
'ColdStorageStatus' => [
'description' => '是否支持冷存储功能,返回值:'."\n"
."\n"
.'- **open**:支持冷存储功能。'."\n"
.'- **close**:不支持冷存储功能。',
'type' => 'string',
'example' => 'open',
],
'IsDeletionProtection' => [
'description' => '是否开启删除保护,返回值:'."\n"
."\n"
.'- **true**:已开启。'."\n"
.'- **false**:未开启。'."\n",
'type' => 'boolean',
'example' => 'true',
],
'RegionId' => [
'description' => '实例所属地域ID。',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'MasterDiskSize' => [
'description' => 'Master节点的磁盘容量,默认单位G。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'MasterDiskType' => [
'description' => 'Master节点的磁盘类型,返回值:'."\n"
."\n"
.'- **cloud_efficiency**:高效云盘。'."\n"
.'- **cloud_ssd**:SSD云盘。'."\n"
."\n"
.'> 单节点实例会返回此参数。',
'type' => 'string',
'example' => 'cloud_efficiency',
],
'AutoRenewal' => [
'description' => '实例是否自动续费,返回值:'."\n"
."\n"
.'- **true**:自动续费。'."\n"
.'- **false**:手动续费。'."\n"
."\n"
.'> 仅当实例的付费类型为包年包月才会返回本参数。',
'type' => 'boolean',
'example' => 'false',
],
'ClusterType' => [
'description' => '实例类型,返回值:'."\n"
."\n"
.'- **cluster**:集群版。'."\n"
.'- **single**:单节点。',
'type' => 'string',
'example' => 'cluster',
],
'ResourceGroupId' => [
'description' => '资源组ID。',
'type' => 'string',
'example' => 'rg-4f51d54g5****',
],
'ClusterName' => [
'description' => '实例名称。',
'type' => 'string',
'example' => 'test',
],
'ZoneId' => [
'description' => '可用区ID。',
'type' => 'string',
'example' => 'cn-hangzhou-f',
],
'Duration' => [
'description' => '自动续费周期,返回值:'."\n"
.'- **按月购买**:则自动续费周期为1个月。'."\n"
.'- **按年购买**:则自动续费周期为1年(12个月)。'."\n"
."\n"
.'>仅当实例的付费类型为包年包月才会返回本参数。',
'type' => 'integer',
'format' => 'int32',
'example' => '12',
],
'ModuleStackVersion' => [
'description' => '模块类型版本。',
'type' => 'string',
'example' => '1.0',
],
'Engine' => [
'description' => '数据引擎类型,返回值:'."\n"
."\n"
.'- **hbase**:HBase标准版或HBase单机版。'."\n"
.'- **hbaseue**:HBase增强版。'."\n"
.'- **serverlesshbase**:HBaseServerless版。'."\n"
.'- **bds**:表示BDS实例。',
'type' => 'string',
'example' => 'hbase',
],
'MajorVersion' => [
'description' => '主版本号。',
'type' => 'string',
'example' => '2.0',
],
'CoreDiskCount' => [
'description' => 'Core磁盘数量。',
'type' => 'string',
'example' => '2',
],
'CoreNodeCount' => [
'description' => 'Core节点个数。',
'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',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'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":"\\n\\n \\n 1.0\\n true\\n 2019-09-12T14:40:46\\n rg-4f51d54g5****\\n hbase.sn1.large\\n true\\n 0\\n VPC\\n hbase.sn1.large\\n test\\n cloud_efficiency\\n hbase\\n 2\\n 2980****2123\\n 2.0\\n ACTIVATION\\n 2019-10-12T14:40:46Z\\n 100\\n cn-hangzhou-f\\n hb-bp1u0639js2h7****\\n 2\\n hb-bp1u0639js2h7****\\n open\\n 2019-09-12T14:40:46Z\\n 12\\n cluster\\n Prepaid\\n vsw-bp191ipotq****dbqf\\n 2\\n test\\n false\\n vpc-bp120k6ixs4eoghz****\\n cloud_efficiency\\n cn-hangzhou\\n 2019-10-12T14:40:46\\n open\\n 100\\n \\n \\n \\n \\n test-value\\n test-key\\n \\n \\n \\n\\n18\\n10\\nEBECBF12-2E34-41BE-8DE9-FC3700D4****\\n1\\n","errorExample":""}]',
'title' => 'DescribeInstances',
'summary' => '调用DescribeInstances查询指定地域的HBase实例列表信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeInstanceType' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceType',
'in' => 'query',
'schema' => [
'description' => '实例规格名称,请参见[实例节点规格](~~194870~~)。'."\n"
.'> InstanceType为空时,返回全部的实例规格列表。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'hbase.n2.4xlarge',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => 'CPU核数。',
'type' => 'integer',
'format' => 'int64',
'example' => '8',
],
'MemSize' => [
'description' => '内存大小。单位:GB。',
'type' => 'integer',
'format' => 'int64',
'example' => '16',
],
],
],
],
],
],
],
],
],
],
'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":"DD23BBB4-64C2-42A4-B2E2-7E56C7AA815A\\n\\n \\n 16\\n 64\\n hbase.n2.4xlarge\\n \\n","errorExample":""}]',
'title' => '查询实例规格(cpu、mem)',
'summary' => '调用DescribeInstanceType查询实例规格(cpu、mem)。',
'description' => '完整的规格映射表以此接口的返回列表为标准。'."\n"
."\n"
.'返回异常报“instanceType is not found”错误, 则说明是弃用的规格,如强依赖此规格,可联系阿里云HBase管控团队。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeClusterConnection' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例所属的地域ID,可调用[DescribeRegions](~~144489~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '目标实例ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp150tns0sjxs****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'VpcId' => [
'description' => '专有网络ID。',
'type' => 'string',
'example' => 'vpc-bp15s22y1a7sff5gj****',
],
'VSwitchId' => [
'description' => '专有网络下的虚拟交换机ID。',
'type' => 'string',
'example' => 'vsw-bp1foll427ze3d4ps****',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '70220050-A465-5DCC-8C0C-C38C6E3DB24D',
],
'IsMultimod' => [
'description' => '是否为多模管控,返回值:'."\n"
."\n"
.'- **true**:是多模管控。'."\n"
.'- **false**:不是多模管控。',
'type' => 'string',
'example' => 'true',
],
'DbType' => [
'description' => '数据库引擎类型,返回值:'."\n"
."\n"
.'- **hbaseue**:HBase增强版。'."\n"
.'- **hbase**:HBase标准版或HBase单机版。'."\n"
.'- **bds**:表示BDS实例。',
'type' => 'string',
'example' => 'hbaseue',
],
'NetType' => [
'description' => '实例的网络类型,返回值:'."\n"
."\n"
.'- **VPC**:专有网络类型。'."\n"
.'- **CLASSIC**:经典网络类型。',
'type' => 'string',
'example' => 'VPC',
],
'UiProxyConnAddrInfo' => [
'description' => 'WebUI连接信息列表。',
'type' => 'object',
'properties' => [
'ConnAddr' => [
'description' => '连接地址。',
'type' => 'string',
'example' => 'ld-bp150tns0sjxs****-master1-001.hbaseue.rds.aliyuncs.com',
],
'ConnAddrPort' => [
'description' => '连接端口。',
'type' => 'string',
'example' => '443',
],
'NetType' => [
'description' => '连接地址为公网访问类型。'."\n",
'type' => 'string',
'example' => 'PUBLIC',
],
],
],
'ThriftConn' => [
'description' => 'Thrift连接地址信息列表。'."\n"
."\n"
.'> 数据库引擎类型为**hbase**会返回此参数列表。',
'type' => 'object',
'properties' => [
'ConnAddr' => [
'description' => '连接地址。',
'type' => 'string',
'example' => 'hb-bp1u0639js2h7****-proxy-thrift.hbase.rds.aliyuncs.com',
],
'ConnAddrPort' => [
'description' => '连接端口。',
'type' => 'string',
'example' => '9099',
],
'NetType' => [
'description' => '连接地址的访问类型,返回值:'."\n"
."\n"
.'- **2**:内网访问。'."\n"
.'- **0**:公网访问。',
'type' => 'string',
'example' => '2',
],
],
],
'ZkConnAddrs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ZkConnAddr' => [
'description' => 'Zookeeper连接信息列表。',
'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' => '连接地址的访问类型,返回值:'."\n"
."\n"
.'- **2**:内网访问。'."\n"
.'- **0**:公网访问。',
'type' => 'string',
'example' => '2',
],
],
],
],
],
],
'SlbConnAddrs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SlbConnAddr' => [
'description' => 'Slb连接信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SlbType' => [
'description' => 'Slb类型,返回值:'."\n"
."\n"
.'- **hbaseue**:HBase增强版类型。'."\n"
.'- **thrift**:Thrift服务类型。'."\n"
.'- **Phoenix**:Phoenix服务类型。',
'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' => '连接地址的访问类型,返回值:'."\n"
."\n"
.'- **2**:内网访问。'."\n"
.'- **0**:公网访问。',
'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' => 'Phoenix连接地址。',
'type' => 'string',
'example' => 'hb-****-proxy-phoenix.hbase.rds.aliyuncs.com',
],
'ConnAddrPort' => [
'description' => '连接端口。',
'type' => 'string',
'example' => '8765',
],
'NetType' => [
'description' => '连接地址的访问类型,返回值:'."\n"
."\n"
.'- **2**:内网访问。'."\n"
.'- **0**:公网访问。',
'type' => 'string',
'example' => '2',
],
],
],
],
],
],
],
],
],
],
],
],
'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":"\\n vpc-bp15s22y1a7sff5gj****\\n vsw-bp1foll427ze3d4ps****\\n 70220050-A465-5DCC-8C0C-C38C6E3DB24D\\n true\\n hbaseue\\n VPC\\n \\n ld-bp150tns0sjxs****-master1-001.hbaseue.rds.aliyuncs.com\\n 443\\n PUBLIC\\n \\n \\n \\n ld-bp150tns0sjxs****-master1-001.hbaseue.rds.aliyuncs.com\\n 2181\\n 2\\n \\n \\n 2181\\n ld-bp150tns0sjxsj3g6-master2-001.hbaseue.rds.aliyuncs.com\\n 2\\n \\n \\n hbaseue\\n \\n ld-bp150tns0sjxs****-proxy-hbaseue-pub.hbaseue.rds.aliyuncs.com\\n 9190\\n 0\\n \\n \\n \\n \\n","errorExample":""}]',
'title' => '查询集群连接列表',
'summary' => '调用DescribeClusterConnection查询集群连接列表。',
],
'DescribeAvailableResource' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => [
'description' => '付费方式,取值:'."\n"
.'- **Prepaid**:包年包月(预付费)。'."\n"
.'- **PostPaid**:按量付费(后付费)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Prepaid',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID,可调用[DescribeRegions](~~144489~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'description' => '可用区,可调用[DescribeRegions](~~144489~~)接口获取。',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou-h',
],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => [
'description' => '实例的服务类型。取值:'."\n"
.'- **hbase**:表示云数据库HBase标准版实例。'."\n"
.'- **hbaseue**:表示云数据库HBase增强版实例。'."\n"
.'- **singlehbase**:表示云数据库HBase单节点实例。'."\n"
.'- **bds**:表示数据同步(BDS)服务。',
'type' => 'string',
'required' => false,
'example' => 'hbaseue',
],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => [
'description' => '实例的服务类型版本号。取值:'."\n"
.'- **1.0**:数据同步(BDS)服务支持1.0版本。'."\n"
.'- **1.1**:云数据库HBase标准版实例和云数据库HBase单节点实例支持1.1版本。'."\n"
.'- **2.0**:云数据库HBase标准版实例、云数据库HBase增强版实例和云数据库HBase单节点实例支持2.0版本。'."\n"
."\n"
.'> 请根据云数据库HBase实例的服务类型填写对应的版本号。',
'type' => 'string',
'required' => false,
'example' => '2.0',
],
],
[
'name' => 'CoreInstanceType',
'in' => 'query',
'schema' => [
'description' => '实例的Core节点规格,更多取值请参见[实例节点规格](~~194870~~)。',
'type' => 'string',
'required' => false,
'example' => 'hbase.sn1.large',
],
],
[
'name' => 'DiskType',
'in' => 'query',
'schema' => [
'description' => '实例的Core磁盘类型,取值:'."\n"
.'- **cloud_efficiency**:高效云盘'."\n"
.'- **cloud_ssd**:SSD云盘'."\n"
.'- **cloud_essd_pl1**:ESSD云盘'."\n"
.'- **local_hdd_pro**:本地HDD盘'."\n"
.'- **local_ssd_pro**:本地SSD盘',
'type' => 'string',
'required' => false,
'example' => 'cloud_ssd',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'EA76F208-E334-592A-A0C6-41E15EC87ED0',
],
'AvailableZones' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AvailableZone' => [
'description' => '可用区列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ZoneId' => [
'description' => '可用区。',
'type' => 'string',
'example' => 'cn-shenzhen-e',
],
'RegionId' => [
'description' => '地域ID。',
'type' => 'string',
'example' => 'cn-shenzhen',
],
'SupportedEngines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SupportedEngine' => [
'description' => '支持的服务类型。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Engine' => [
'description' => '服务类型。',
'type' => 'string',
'example' => 'hbase',
],
'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' => '实例类别,返回值:'."\n"
."\n"
.'- **cluster**:集群版'."\n"
.'- **single**:单机版',
'type' => 'string',
'example' => 'cluster',
],
'SupportedStorageTypes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SupportedStorageType' => [
'description' => '存储类型。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StorageType' => [
'description' => '存储类型。',
'type' => 'string',
'example' => 'cloud_ssd',
],
'CoreResources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CoreResource' => [
'description' => '工作节点资源。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceType' => [
'description' => '规格。',
'type' => 'string',
'example' => 'hbase.sn1.large',
],
'MaxCoreCount' => [
'description' => '库存最大节点个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '16',
],
'DBInstanceStorageRange' => [
'description' => '存储范围。',
'type' => 'object',
'properties' => [
'MaxSize' => [
'description' => '最大存储大小,单位:GB。',
'type' => 'integer',
'format' => 'int32',
'example' => '8000',
],
'StepSize' => [
'description' => '步长,单位:GB。',
'type' => 'integer',
'format' => 'int32',
'example' => '40',
],
'MinSize' => [
'description' => '最小存储大小,单位:GB。',
'type' => 'integer',
'format' => 'int32',
'example' => '400',
],
],
],
'InstanceTypeDetail' => [
'description' => '规格详情。',
'type' => 'object',
'properties' => [
'Mem' => [
'description' => '内存大小,单位:GB。',
'type' => 'integer',
'format' => 'int32',
'example' => '8',
],
'Cpu' => [
'description' => 'cpu 核数。',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'MasterResources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MasterResource' => [
'description' => 'Master节点列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceType' => [
'description' => 'Master节点规格。',
'type' => 'string',
'example' => 'hbase.sn1.medium',
],
'InstanceTypeDetail' => [
'description' => '规格描述。',
'type' => 'object',
'properties' => [
'Mem' => [
'description' => '内存大小,单位:GB。',
'type' => 'integer',
'format' => 'int32',
'example' => '8',
],
'Cpu' => [
'description' => 'CPU核数。',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'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":"\\n EA76F208-E334-592A-A0C6-41E15EC87ED0\\n \\n cn-shenzhen-e\\n cn-shenzhen\\n \\n hbase\\n \\n 2.0\\n \\n cluster\\n \\n cloud_ssd\\n \\n hbase.sn1.large\\n 16\\n \\n 8000\\n 40\\n 400\\n \\n \\n 8\\n 4\\n \\n \\n \\n \\n \\n \\n \\n hbase.sn1.medium\\n \\n 8\\n 4\\n \\n \\n \\n","errorExample":""}]',
'title' => '查询可用资源',
'summary' => '调用DescribeAvailableResource查询可用资源。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeSubDomain' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'description' => '可用区ID。',
'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' => '请求ID。',
'type' => 'string',
'example' => 'F4208C83-B9BC-4A64-A739-8F88E98DA469',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"SubDomain\\": \\"cn-hangzhou-h-aliyun\\",\\n \\"RequestId\\": \\"F4208C83-B9BC-4A64-A739-8F88E98DA469\\"\\n}","errorExample":""},{"type":"xml","example":"cn-hangzhou-h-aliyun\\nF4208C83-B9BC-4A64-A739-8F88E98DA469","errorExample":""}]',
'title' => '查询子域名信息',
'summary' => '调用DescribeSubDomain获取一个可用子域。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryXpackRelateDB' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '当前Spark实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ap-bp1qtz9rcbbt3p6ng',
],
],
[
'name' => 'RelateDbType',
'in' => 'query',
'schema' => [
'description' => '要查询可关联数据库类型。'."\n"
."\n"
.'- spark可以关联hdfs,hbase,mongodb,mysql,polardb_mysql,redis,geomesa'."\n"
.'- bds可以关联hbase,spark,hbaseue',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hbase',
],
],
[
'name' => 'HasSingleNode',
'in' => 'query',
'schema' => [
'description' => '仅对bds查询关联hbase有效。'."\n"
."\n"
.'- true:会包含单节点HBase。'."\n"
."\n"
.'- false:不包含单节点HBase。非必填,为兼容之前逻辑为空时会包含单节点HBase。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '288E9010-36DD-499C-B4DA-61E4362DA4CC',
],
'ClusterList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Cluster' => [
'description' => '可关联的数据库列表。',
'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' => '实例ID。',
'type' => 'string',
'example' => 'hb-bp16o0pd52e3y582s',
],
],
],
],
],
],
],
],
],
],
'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":"288E9010-36DD-499C-B4DA-61E4362DA4CC\\n\\n \\n ACTIVATION\\n baitu-new-mem\\n hb-bp16fd5z8srk9216p\\n false\\n hbase\\n \\n \\n COMP_ADDING\\n tianyin-ha2\\n hb-bp16f1441y6p2kv2l\\n false\\n hbase\\n \\n \\n ACTIVATION\\n tianyin-ha1\\n hb-bp1eu91b79o8h0n7i\\n false\\n hbase\\n \\n \\n ACTIVATION\\n wangjk-HBase\\n hb-bp16o0pd52e3y582s\\n false\\n hbase\\n \\n \\n ACTIVATION\\n test-hbase-RESERVE\\n hb-bp15w8hyzqi59p5yn\\n false\\n hbase\\n \\n","errorExample":""}]',
'title' => '查询当前实例可关联的数据库列表',
'summary' => '调用QueryXpackRelateDB查询当前实例可关联的数据库列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDiskWarningLine' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '要查询的集群Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-bp1bl7iqzkahmyxxxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'WarningLine' => [
'description' => '磁盘容量告警线,如配置75,则表示磁盘使用率超过75%时会报警。未返回时说明用户还没有配置,系统默认为80%。',
'type' => 'string',
'example' => '80',
],
'RequestId' => [
'description' => '请求id。',
'type' => 'string',
'example' => '08DF8283-D290-4107-931E-7913D6D3480D',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"WarningLine\\": \\"80\\",\\n \\"RequestId\\": \\"08DF8283-D290-4107-931E-7913D6D3480D\\"\\n}","errorExample":""},{"type":"xml","example":"08DF8283-D290-4107-931E-7913D6D3480D\\n80","errorExample":""}]',
'title' => '获取磁盘容量报警线',
'summary' => '目前仅支持HBase和HBaseue。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ResizeNodeCount' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '实例id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-bp16o0pd52e3y****',
],
],
[
'name' => 'NodeCount',
'in' => 'query',
'schema' => [
'description' => '集群Core节点数量。'."\n"
."\n"
.'单次最多添加50个,整体最高可调整至250个。如有更多需求,请提交工单。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '5',
],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'description' => '可用区ID。',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou-f',
],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => [
'description' => '虚拟交换机Id。',
'type' => 'string',
'required' => false,
'example' => 'vsw-bp191otqj1ssyl****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OrderId' => [
'description' => '订单id',
'type' => 'string',
'example' => '20470860005****',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => 'B288B41F-6681-42A6-8905-47C3C42B19B0',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"20470860005****\\",\\n \\"RequestId\\": \\"B288B41F-6681-42A6-8905-47C3C42B19B0\\"\\n}","errorExample":""},{"type":"xml","example":"B288B41F-6681-42A6-8905-47C3C42B19B0\\n20470860005****","errorExample":""}]',
'title' => 'ResizeNodeCount',
'summary' => '调用ResizeNodeCount调整整个实例节点数。',
'description' => '上调整个集群Core节点数量,单次最多添加50个,整体最高可调整至250个。如有更多需求,请提交工单。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ResizeColdStorageSize' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => 'HBase实例ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp169l540vc6c****',
],
],
[
'name' => 'ColdStorageSize',
'in' => 'query',
'schema' => [
'description' => '修改后的冷存储容量,单位为GB,取值范围为**800**~**1000000**。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '100000000',
'minimum' => '0',
'example' => '900',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OrderId' => [
'description' => '订单ID。',
'type' => 'string',
'example' => '21711518427****',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '5AA6F80E-535C-5611-BD13-3832D96A4D0E',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"21711518427****\\",\\n \\"RequestId\\": \\"5AA6F80E-535C-5611-BD13-3832D96A4D0E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 21711518427****\\n 5AA6F80E-535C-5611-BD13-3832D96A4D0E\\n","errorExample":""}]',
'title' => '更改冷存储大小',
'summary' => '更改冷存储大小。',
],
'RestartInstance' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '目标实例ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp150tns0sjxs****',
],
],
[
'name' => 'Components',
'in' => 'query',
'schema' => [
'description' => '目标实例的组件名称,取值:'."\n"
."\n"
.'- **HBASE**'."\n"
.'- **HADOOP**'."\n"
.'- **PHOENIX**'."\n"
.'- **SOLR**'."\n"
.'- **THRIFT**',
'type' => 'string',
'required' => false,
'example' => 'THRIFT',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F744E939-D08D-5623-82C8-9D1F9F7685D1',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F744E939-D08D-5623-82C8-9D1F9F7685D1\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n70F2D5B8-632F-4045-8F2D-2ADF73A31C08\\r\\n","errorExample":""}]',
'title' => '重启实例',
'summary' => '调用RestartInstance重启HBase集群。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'MoveResourceGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '目标实例ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp169l540vc6c****',
],
],
[
'name' => 'NewResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '目标资源组ID,可调用[ListResourceGroups](~~158855~~)接口查看资源组列表。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'rg-aekzrk6zzsy****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8CD9BFBC-D575-5FCC-BA7E-956BF0D0****',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8CD9BFBC-D575-5FCC-BA7E-956BF0D0****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nd>8CD9BFBC-D575-5FCC-BA7E-956BF0D0****\\r\\n","errorExample":""}]',
'title' => '移动资源所在的资源组',
'summary' => '调用MoveResourceGroup将目标实例移动至目标资源组。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'PurgeInstance' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '要清理的已删除的集群Id,可通过DescribeDeletedInstances接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-m5ek15uzs7613xxxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求Id。',
'type' => 'string',
'example' => '276F899F-E952-496F-81B8-BD46D86854E3',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"276F899F-E952-496F-81B8-BD46D86854E3\\"\\n}","errorExample":""},{"type":"xml","example":"276F899F-E952-496F-81B8-BD46D86854E3","errorExample":""}]',
'title' => '完全清理资源',
'summary' => '针对已删除(未超过7天)但未完全清理的实例。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RenewInstance' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '目标实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-bp1u0639js2h7****',
],
],
[
'name' => 'PricingCycle',
'in' => 'query',
'schema' => [
'description' => '目标实例续费的周期单位。'."\n"
."\n"
.'- **year**:年。'."\n"
.'- **month**:月。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'month',
],
],
[
'name' => 'Duration',
'in' => 'query',
'schema' => [
'description' => '目标实例续费的周期。'."\n"
."\n"
.'- PricingCycle为**year**时,取值1~3。'."\n"
.'- PricingCycle为**month**时,取值1~9。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '5',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OrderId' => [
'description' => '订单ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '211235614240728',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '729CB2A7-3065-53A9-B27C-7033CA4881D9',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": 211235614240728,\\n \\"RequestId\\": \\"729CB2A7-3065-53A9-B27C-7033CA4881D9\\"\\n}","errorExample":""},{"type":"xml","example":"\\n211235614240728\\n729CB2A7-3065-53A9-B27C-7033CA4881D9\\n","errorExample":""}]',
'title' => '续费当前实例',
'summary' => '调用RenewInstance为HBase实例续费。',
'description' => '本接口仅适用于包年包月付费类型的HBase实例。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ResizeDiskSize' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-bp16o0pd52e3y****',
],
],
[
'name' => 'NodeDiskSize',
'in' => 'query',
'schema' => [
'description' => '单节点磁盘大小,默认单位为GB。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '120',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OrderId' => [
'description' => '订单ID。',
'type' => 'string',
'example' => '3C22622B-8555-42BF-AD8A-1B960743****',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '493A762B-E4A6-44E9-B877-CA6D0CAF8B29',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"3C22622B-8555-42BF-AD8A-1B960743****\\",\\n \\"RequestId\\": \\"493A762B-E4A6-44E9-B877-CA6D0CAF8B29\\"\\n}","errorExample":""},{"type":"xml","example":"493A762B-E4A6-44E9-B877-CA6D0CAF8B29\\n3C22622B-8555-42BF-AD8A-1B960743****","errorExample":""}]',
'title' => '扩容或调整磁盘大小',
'summary' => '调用ResizeDiskSize调整磁盘大小。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpgradeMinorVersion' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-t4naqsay5gn****',
],
],
[
'name' => 'Components',
'in' => 'query',
'schema' => [
'description' => '要升级的组件名称,多个组件中间逗号隔开。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'HADOOP',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'UpgradingComponents' => [
'description' => '成功升级的组件。',
'type' => 'string',
'example' => 'HADOOP',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7B8EC240-BB13-4DBC-B955-F90170E82609',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"UpgradingComponents\\": \\"HADOOP\\",\\n \\"RequestId\\": \\"7B8EC240-BB13-4DBC-B955-F90170E82609\\"\\n}","errorExample":""},{"type":"xml","example":"7B8EC240-BB13-4DBC-B955-F90170E82609\\nHADOOP","errorExample":""}]',
'title' => '修改实例升级小版本的方式',
'summary' => '集群通过UpgradeMinorVersion进行小版本升级。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'XpackRelateDB' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '当前Spark实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ap-bp1qtz9rcbbt3****',
],
],
[
'name' => 'DbClusterIds',
'in' => 'query',
'schema' => [
'description' => '需要关联的集群实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-bp16o0pd52e3****',
],
],
[
'name' => 'RelateDbType',
'in' => 'query',
'schema' => [
'description' => '需要关联的数据库类型,可选值:'."\n"
.'- **hdfs**'."\n"
.'- **hbase**'."\n"
.'- **mongodb**'."\n"
.'- **mysql**'."\n"
.'- **polardb_mysql**'."\n"
.'- **redis**'."\n"
.'- **geomesa**',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hbase',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '50373857-C47B-4B64-9332-D0B5280B59EA',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","errorExample":""},{"type":"xml","example":"50373857-C47B-4B64-9332-D0B5280B59EA\\r\\n","errorExample":""}]',
'title' => '关联数据库',
'summary' => '调用XpackRelateDB关联数据库。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ConvertInstance' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-bp16o0pd52e3y****',
],
],
[
'name' => 'PricingCycle',
'in' => 'query',
'schema' => [
'description' => '订购的周期单位'."\n"
.'- year:年,'."\n"
.'- month:月。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'month',
],
],
[
'name' => 'Duration',
'in' => 'query',
'schema' => [
'description' => '订购的周期数量'."\n"
.'- PricingCycle=year时,取值1-3;'."\n"
.'- PricingCycle=month时,取值1-9。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'example' => '7',
],
],
[
'name' => 'PayType',
'in' => 'query',
'schema' => [
'description' => '实例的计费类型,返回值:'."\n"
."\n"
.'- **Prepaid**:包年包月。'."\n"
.'- **Postpaid**:按量付费。'."\n",
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Prepaid',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OrderId' => [
'description' => '订单ID',
'type' => 'integer',
'format' => 'int64',
'example' => '54124548879',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '50373857-C47B-4B64-9332-D0B5280B59EA',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": 54124548879,\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","errorExample":""},{"type":"xml","example":"54124542154\\n50373857-C47B-4B64-9332-D0B5280B59EA","errorExample":""}]',
'title' => 'ConvertInstance',
'summary' => '调用ConvertInstance将实例从按量收费转为包年包月收费。',
'description' => '注意:payType为Postpaid时才可以调用此接口',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyIpWhitelist' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '目标实例ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp1uoihlf82e8****',
],
],
[
'name' => 'IpList',
'in' => 'query',
'schema' => [
'description' => '修改后分组白名单的IP地址,如果有多个IP地址,您可以使用英文逗号(,)分隔。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '42.120.XX.XX',
],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => [
'description' => '目标实例的白名单分组名称,可调用[DescribeIpWhitelist](~~144606~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'group_01',
],
],
[
'name' => 'IpVersion',
'in' => 'query',
'schema' => [
'description' => 'IP地址的版本类型,取值:'."\n"
."\n"
.'- **4**:表示IP地址的版本类型为IPv4。'."\n"
.'- **6**:表示IP地址的版本类型为IPv6。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '4',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '101CFA8A-FB88-5014-A10C-3A0DA9AD8B0B',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"101CFA8A-FB88-5014-A10C-3A0DA9AD8B0B\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n101CFA8A-FB88-5014-A10C-3A0DA9AD8B0B\\r\\n","errorExample":""}]',
'title' => '修改网络访问白名单',
'summary' => '调用ModifyIpWhitelist修改实例的分组白名单。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifySecurityGroups' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-bp16f1441y6p2kv**',
],
],
[
'name' => 'SecurityGroupIds',
'in' => 'query',
'schema' => [
'description' => '所属安全组id,逗号隔开',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sg-t4ng4yyc916o81nu****,sg-x4gg4dyc9d6w********',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'F4AD2E65-482B-46B6-942E-765989B1C8A3',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F4AD2E65-482B-46B6-942E-765989B1C8A3\\"\\n}","errorExample":""},{"type":"xml","example":"F4AD2E65-482B-46B6-942E-765989B1C8A3","errorExample":""}]',
'title' => '修改安全组',
'summary' => '调用ModifySecurityGroups修改集群所属安全组。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeSecurityGroups' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-bp161ax8i03c4uq**',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '50373857-C47B-4B64-9332-D0B5280B59EA',
],
'SecurityGroupIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SecurityGroupId' => [
'type' => 'array',
'items' => [
'description' => '所属安全组ID集合',
'type' => 'string',
'example' => 'sg-t4ng4yyc916o81nua6**,sg-****',
],
],
],
],
],
],
],
],
'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":"50373857-C47B-4B64-9332-D0B5280B59EA\\n\\n sg-t4ng4yyc916o81nua6**\\n sg-****\\n","errorExample":""}]',
'title' => '查询安全组的基本信息',
'summary' => '调用DescribeSecurityGroups根据集群ID获取集群所属安全组信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateBackupPlan' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-wz94lbcqc****4x93',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '50373857-C47B-4B64-9332-D0B5280B59EA',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","errorExample":""},{"type":"xml","example":"50373857-C47B-4B64-9332-D0B5280B59EA","errorExample":""}]',
'title' => '创建备份计划',
'summary' => '目前仅支持HBaseue。',
'description' => '目前该接口仅支持HBaseue集群,并且EnableHBaseueBackup接口已兼容了该接口,会在创建BDS集群后自动创建备份计划。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'EnableHBaseueBackup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'HbaseueClusterId',
'in' => 'query',
'schema' => [
'description' => 'HBaseue集群Id。',
'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' => '备份服务冷存大小,800G起步。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '800',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证幂等token。',
'type' => 'string',
'required' => false,
'example' => 'xxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求Id。',
'type' => 'string',
'example' => '15272D5D-46E8-4400-9CC8-A7E7B589F575',
],
'OrderId' => [
'description' => '订单Id。',
'type' => 'string',
'example' => '1449xxx',
],
'ClusterId' => [
'description' => '开通的BDS备份服务的集群Id。',
'type' => 'string',
'example' => 'bds-m5e54q06ceyhxxxx',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"15272D5D-46E8-4400-9CC8-A7E7B589F575\\",\\n \\"OrderId\\": \\"1449xxx\\",\\n \\"ClusterId\\": \\"bds-m5e54q06ceyhxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"15272D5D-46E8-4400-9CC8-A7E7B589F575\\nbds-m5e54q06ceyhxxxx\\n1449xxx","errorExample":""}]',
'title' => '开通HBaseue备份恢复',
'summary' => '开通HBaseue备份恢复。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyBackupPlanConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群Id。',
'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' => '全量备份周期(天),取值范围3-9。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '7',
],
],
[
'name' => 'MinHFileBackupCount',
'in' => 'query',
'schema' => [
'description' => '全量备份保留个数,取值3-8。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '3',
],
],
[
'name' => 'NextFullBackupDate',
'in' => 'query',
'schema' => [
'description' => '设置下一次全量备份时间,必须比当前时间大6分钟以上。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2020-11-09T18:00:00Z',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求Id。',
'type' => 'string',
'example' => '50F4A8C2-076F-4703-9813-2FCD7FBB91C2',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50F4A8C2-076F-4703-9813-2FCD7FBB91C2\\"\\n}","errorExample":""},{"type":"xml","example":"50F4A8C2-076F-4703-9813-2FCD7FBB91C2","errorExample":""}]',
'title' => '更改备份配置',
'summary' => '对于已开通备份恢复的HBaseue集群。',
'description' => '请确保在使用该接口前,确认HBaseue集群已开通备份恢复功能。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyBackupPolicy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-t4naqsay5gn****',
],
],
[
'name' => 'PreferredBackupTime',
'in' => 'query',
'schema' => [
'description' => '当前时区的备份时间区间。间隔为1小时。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '01:00-02:00',
],
],
[
'name' => 'PreferredBackupPeriod',
'in' => 'query',
'schema' => [
'description' => '备份周期。'."\n"
.'- Monday:每周一进行备份'."\n"
.'- Tuesday:每周二进行备份。'."\n"
.'- Wednesday:每周三进行备份。'."\n"
.'- Thursday: 每周四进行备份。'."\n"
.'- Friday:每周五进行备份。'."\n"
.'- Saturday: 每周六进行备份。'."\n"
.'- Sunday:每周日进行备份。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Thursday',
],
],
[
'name' => 'PreferredBackupStartTimeUTC',
'in' => 'query',
'schema' => [
'description' => '备份开始的utc时间。',
'type' => 'string',
'required' => false,
'example' => '17:00Z',
],
],
[
'name' => 'PreferredBackupEndTimeUTC',
'in' => 'query',
'schema' => [
'description' => '备份结束的utc时间。',
'type' => 'string',
'required' => false,
'example' => '18:00Z',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '17E3AC63-300D-4B69-9108-45EC20E50E85',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"17E3AC63-300D-4B69-9108-45EC20E50E85\\"\\n}","errorExample":""},{"type":"xml","example":"17E3AC63-300D-4B69-9108-45EC20E50E85","errorExample":""}]',
'title' => '修改备份策略设置',
'summary' => '调用ModifyBackupPolicy更改HBase集群的备份计划。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeBackupPlanConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '执行备份计划的集群ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-m5eznlga4k5bcxxxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求Id。',
'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' => [
'description' => '全量备份周期。',
'type' => 'integer',
'format' => 'int32',
'example' => '7',
],
'Tables' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Table' => [
'type' => 'array',
'items' => [
'description' => '备份表集合。',
'type' => 'string',
'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":"33A23201-6038-4A6A-B76A-61047EA04E6A\\n7\\n2020-11-09T18:00:00Z\\n\\n \\n\\n3","errorExample":""}]',
'title' => '查询备份计划配置',
'summary' => '调用DescribeBackupPlanConfig接口查询备份计划配置。',
'description' => '该接口目前仅支持HBaseue,请确保在使用该接口前,该HBaseue已开通备份恢复功能。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeBackupPolicy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-t4naqsay5gn******',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PreferredBackupEndTimeUTC' => [
'description' => '备份结束的Utc时间。',
'type' => 'string',
'example' => '18:00Z',
],
'BackupRetentionPeriod' => [
'description' => '备份保留天数。',
'type' => 'string',
'example' => '10',
],
'RequestId' => [
'description' => '请求Id。',
'type' => 'string',
'example' => '94AC38B6-7C6D-45B2-BC03-B8750071A482',
],
'PreferredBackupPeriod' => [
'description' => '备份周期。Friday就是每周五进行备份。',
'type' => 'string',
'example' => 'Friday',
],
'PreferredBackupTime' => [
'description' => '当前时区的备份时间区间。',
'type' => 'string',
'example' => '01:00-02:00',
],
'PreferredBackupStartTimeUTC' => [
'description' => '备份开始的Utc时间。',
'type' => 'string',
'example' => '17:00Z',
],
],
],
],
],
'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":"Friday\\n17:00Z\\n18:00Z\\n94AC38B6-7C6D-45B2-BC03-B8750071A482\\n01:00-02:00\\n10","errorExample":""}]',
'title' => '查看集群自动备份策略',
'summary' => '通过DescribeBackupPolicy获取hbase集群的备份规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeBackups' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-t4naqsay5gn****',
],
],
[
'name' => 'BackupId',
'in' => 'query',
'schema' => [
'description' => '要查询的备份ID。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'job-xxxx',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页码。',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '页面大小。',
'type' => 'string',
'required' => false,
'example' => '10',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '查询备份的开始时间,格式为yyyy-MM-dd HH:mm。',
'type' => 'string',
'required' => false,
'example' => '2020-12-13 00:00:00',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '查询备份的结束时间,格式为yyyy-MM-dd HH:mm。',
'type' => 'string',
'required' => false,
'example' => '2020-12-23 23:59:59',
],
],
[
'name' => 'StartTimeUTC',
'in' => 'query',
'schema' => [
'description' => '查询备份的开始时间,格式为yyyy-MM-ddTHH:mmZ(UTC时间)。',
'type' => 'string',
'required' => false,
'example' => '2020-12-12T16:00:00Z',
],
],
[
'name' => 'EndTimeUTC',
'in' => 'query',
'schema' => [
'description' => '查询备份的结束时间,必须晚于查询开始时间,格式为yyyy-MM-ddTHH:mmZ(UTC时间)。',
'type' => 'string',
'required' => false,
'example' => '2020-12-23T15:59:59Z',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'EnableStatus' => [
'description' => '备份开启状态。'."\n"
.'- enable:已开启。'."\n"
.'- disable: 未开启。'."\n"
.'- opening:开启中。',
'type' => 'string',
'example' => 'enable',
],
'PageSize' => [
'description' => '页面大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'PageNumber' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'A93CE373-0FDE-4CCB-9DBA-6700906825ED',
],
'TotalCount' => [
'description' => '总记录数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Backups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Backup' => [
'description' => '备份记录集合。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BackupStatus' => [
'description' => '备份状态。'."\n"
."\n"
.'- **0**:备份已完成。'."\n"
.'- **1**:备份中。',
'type' => 'string',
'example' => '0',
],
'BackupStartTime' => [
'description' => '备份开始时间。',
'type' => 'string',
'example' => '2020-12-23 17:25:08',
],
'BackupType' => [
'description' => '备份类型。F为全量备份。',
'type' => 'string',
'example' => 'F',
],
'BackupDownloadURL' => [
'description' => '备份下载链接。',
'type' => 'string',
'example' => ' 1',
],
'BackupStartTimeUTC' => [
'description' => '备份开始的UTC时间。',
'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' => '备份ID。',
'type' => 'integer',
'format' => 'int32',
'example' => '511876087',
],
'BackupEndTimeUTC' => [
'description' => '备份完成的UTC时间。',
'type' => 'string',
'example' => '2020-12-23T09:25:24Z',
],
'BackupSize' => [
'description' => '备份数据大小。单位GB。',
'type' => 'string',
'example' => '0.00',
],
'BackupMode' => [
'description' => '备份策略。0为系统备份。',
'type' => 'string',
'example' => '0',
],
'BackupMethod' => [
'description' => '备份方法。P为物理备份。',
'type' => 'string',
'example' => 'P',
],
],
],
],
],
],
],
],
],
],
'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":"1\\nA93CE373-0FDE-4CCB-9DBA-6700906825ED\\n10\\n1\\nenable\\n\\n \\n P\\n \\n 2020-12-23 17:25:24\\n 0\\n 0.00\\n 2020-12-23 17:25:08\\n 2020-12-23T09:25:24Z\\n 511876087\\n F\\n 2020-12-23T09:25:08Z\\n \\n 0\\n \\n","errorExample":""}]',
'title' => '查询实例的备份列表',
'summary' => '通过DescribeBackups获取hbase集群备份记录信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeBackupStatus' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '执行数据备份的HBaseue集群ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-m5eznlga4k5bcxxxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F7E71430-A825-470A-B40B-DF3F3AAC9BEE',
],
'BdsClusterId' => [
'description' => '备份使用的BDS实例ID。',
'type' => 'string',
'example' => 'bds-m5e54q06ceyhxxxx',
],
'BackupStatus' => [
'description' => '备份开启状态。'."\n"
.'- closed 未开启'."\n"
.'- opened 已开启'."\n"
.'- opening 开启中',
'type' => 'string',
'example' => 'opened',
],
'ClusterId' => [
'description' => '备份集群ID',
'type' => 'string',
'example' => 'ld-m5eznlga4k5bcxxxx',
],
],
],
],
],
'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":"F7E71430-A825-470A-B40B-DF3F3AAC9BEE\\nbds-m5e54q06ceyhxxxx\\nld-m5eznlga4k5bcxxxx\\nopened","errorExample":""}]',
'title' => '描述备份任务状态',
'summary' => '调用DescribeBackupStatus接口描述备份任务状态。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeBackupSummary' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '目标实例ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp169l540vc6c****',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '实例列表的页码,起始值为1,默认值为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页最多可显示的行数,最大值为100,默认值为10。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '排队中LOG数量。',
'type' => 'string',
'example' => '0',
],
'BackupLogSize' => [
'description' => '数据量。',
'type' => 'string',
'example' => '266 B',
],
'RunningLogNum' => [
'description' => '备份中LOG数量。',
'type' => 'string',
'example' => '2',
],
],
],
'Full' => [
'description' => '全量备份详情。',
'type' => 'object',
'properties' => [
'HasMore' => [
'description' => '是否有下一页,返回值:'."\n"
."\n"
.'- true:有下一页。'."\n"
.'- false:无下一页。',
'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' => [
'type' => 'object',
'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' => '备份记录ID。',
'type' => 'string',
'example' => '20201103020000',
],
'CreateTime' => [
'description' => '全量备份开始时间。',
'type' => 'string',
'example' => '2020-11-02T18:00:00Z',
],
],
],
],
],
],
],
],
],
],
],
],
'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":"168793CB-7B31-43E7-ADAB-FE3E8D584D6E\\n\\n RUNNING\\n 0.00 MB/s\\n 2020-11-05T01:20:31Z\\n 266 B\\n 0\\n 2\\n\\n\\n false\\n 10\\n 1\\n 2020-11-09T18:00:00Z\\n 2\\n \\n \\n SUCCESS\\n 0.00 MB/s\\n 2020-11-02T18:02:04Z\\n 2020-11-02T18:00:00Z\\n 1.2 kB\\n 1/1\\n 20201103020000\\n \\n \\n SUCCESS\\n 0.00 MB/s\\n 2020-10-26T18:02:03Z\\n 2020-10-26T18:00:00Z\\n 1.2 kB\\n 1/1\\n 20201027020000\\n \\n \\n","errorExample":""}]',
'title' => '获取备份详情',
'summary' => 'HBaseue备份开启后,通过DescribeBackupSummary接口获取备份详情。',
'description' => '已开通HBase增强版实例的备份恢复功能,具体请参见[开通备份恢复](~~145767~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeBackupTables' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '该备份集群Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-m5eznlga4k5bcxxxx',
],
],
[
'name' => 'BackupRecordId',
'in' => 'query',
'schema' => [
'description' => '备份记录ID,可通过DescribeBackupSummary接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2020110302xxxx',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '页码大小。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '请求Id。',
'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' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'BackupRecord' => [
'description' => '备份表详情列表。',
'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' => [
'description' => '报错时的报错信息。',
'type' => 'string',
'example' => 'null',
],
'Table' => [
'description' => '表名。',
'type' => 'string',
'example' => 'default:test1',
],
],
],
],
],
],
],
],
],
],
'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":"10\\n01262E9C-B0CC-4663-82FA-D50173649F92\\n\\n \\n 0.00 MB/s\\n \\n null\\n 2020-11-02T18:00:05Z\\n SUCCEEDED\\n 1.2 kB\\n 2020-11-02T18:00:00Z\\n 14/14\\n \\n\\n1\\n1\\n\\n \\n","errorExample":""}]',
'title' => '通过获取某一次备份记录的备份表的信息',
'summary' => '通过调用DescribeBackupTables接口获取某一次备份记录的备份表的信息。',
'description' => '请确保在使用该接口前,确认HBaseue集群已开通备份恢复功能,并且已有备份记录产生,可通过DescribeBackupSummary获取。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeRecoverableTimeRange' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '备份恢复的HBaseue集群Id。',
'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' => '请求id。',
'type' => 'string',
'example' => 'A1A51D18-96DC-465C-9F1B-47180CA22524',
],
],
],
],
],
'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":"A1A51D18-96DC-465C-9F1B-47180CA22524\\n2020-11-05T01:20:31Z\\n2020-10-26T18:02:03Z","errorExample":""}]',
'title' => '获取备份可恢复的时间范围',
'summary' => 'HBaseue备份开启后,可通过DescribeRecoverableTimeRange接口获取可恢复的时间范围。',
'description' => '请确保在使用该接口前,确认HBaseue集群已开通备份恢复功能。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CloseBackup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-t4naqsay5gn****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'F1A11940-0C34-4385-864F-A01E29B55F6A',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F1A11940-0C34-4385-864F-A01E29B55F6A\\"\\n}","errorExample":""},{"type":"xml","example":"F1A11940-0C34-4385-864F-A01E29B55F6A","errorExample":""}]',
'title' => '关闭备份',
'summary' => '通过CloseBackup关闭hbase集群的备份恢复功能。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'OpenBackup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-t4naqsay5gn******',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求Id。',
'type' => 'string',
'example' => 'C977DF60-7D06-4E34-A27D-8BC696C5112A',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C977DF60-7D06-4E34-A27D-8BC696C5112A\\"\\n}","errorExample":""},{"type":"xml","example":"C977DF60-7D06-4E34-A27D-8BC696C5112A","errorExample":""}]',
'title' => '开通备份',
'summary' => '通过OpenBackup打开hbase集群的备份恢复功能。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateRestorePlan' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => 'HBase增强版集群ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp150tns0sjxs****',
],
],
[
'name' => 'TargetClusterId',
'in' => 'query',
'schema' => [
'description' => '恢复到指定HBase增强版集群,也可以恢复到当前备份的集群。'."\n"
."\n"
.'> 指定HBase增强版集群和备份的HBase增强版集群需要满足以下要求:'."\n"
.'- 版本相同。
'."\n"
.'- 处于同一个Region。
'."\n"
.'- 与BDS集群相关联。
',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp169l540vc6c****',
],
],
[
'name' => 'RestoreAllTable',
'in' => 'query',
'schema' => [
'description' => '是否恢复所有表,取值:'."\n"
."\n"
.'- **true**:恢复HBase增强版集群的所有表。'."\n"
.'- **false**:不恢复HBase增强版集群的所有表。'."\n"
."\n"
.'> 取值为**true**时,**Tables**参数无效。取值为**false**时,**Tables**参数必须填写。',
'type' => 'boolean',
'required' => true,
'docRequired' => true,
'example' => 'false',
],
],
[
'name' => 'RestoreByCopy',
'in' => 'query',
'schema' => [
'description' => '通过复制方法恢复数据,固定取值为**true**。',
'type' => 'boolean',
'required' => true,
'docRequired' => true,
'example' => 'true',
],
],
[
'name' => 'RestoreToDate',
'in' => 'query',
'schema' => [
'description' => '恢复到指定时间点,时间点的设置需要在恢复时间段内,恢复时间段可调用[DescribeRecoverableTimeRange](~~188365~~)接口查看。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2020-11-05T05:49:42Z',
],
],
[
'name' => 'Tables',
'in' => 'query',
'schema' => [
'description' => '表名称。需要⼀⾏写⼀个表名称,不支持通配符(*)。'."\n"
."\n"
.'- 如果恢复至当前表,填写格式为:`namespace:table`,例如:`default:testTable`。'."\n"
.'- 如果恢复至其他表,填写格式为:`namespace:table/namespace:table2`,例如:`default:testTable/default:testTable2`。',
'type' => 'string',
'required' => false,
'example' => 'test_ns:test_table/test_ns:test_table2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'A0598673-EB6E-4F6D-9961-E0F2012090C0',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A0598673-EB6E-4F6D-9961-E0F2012090C0\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A0598673-EB6E-4F6D-9961-E0F2012090C0\\n","errorExample":""}]',
'title' => '创建恢复计划',
'summary' => '对于已开通备份恢复集群,可将已备份的数据恢复到当前region的其他同款HBaseue集群里。',
'description' => '请确保在使用该接口前,HBaseue集群已开通备份恢复功能,确认恢复的HBaseue目标集群已与相应的BDS相关联。',
],
'DescribeRestoreFullDetails' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-m5eznlga4k5bcxxxx',
],
],
[
'name' => 'RestoreRecordId',
'in' => 'query',
'schema' => [
'description' => '恢复记录Id,可通过DescribeRestoreSummary接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2020110514xxxx',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '页面大小。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求Id。',
'type' => 'string',
'example' => 'CFE525CF-C691-4140-A981-D004DAA7A840',
],
'RestoreFull' => [
'description' => '全量恢复详情。',
'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',
],
'RestoreFullDetails' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RestoreFullDetail' => [
'description' => '恢复表详情。',
'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',
],
],
],
],
],
],
],
],
],
],
],
],
'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":"\\n 0.00 MB/s\\n \\n \\n 0.00 MB/s\\n \\n null\\n 2020-11-05T06:45:51Z\\n SUCCEEDED\\n 1.2 kB\\n 2020-11-05T06:45:45Z\\n 14/14\\n \\n \\n 10\\n 1\\n 1\\n 1.2 kB\\n 0\\n 1\\n\\nCFE525CF-C691-4140-A981-D004DAA7A840","errorExample":""}]',
'title' => '查询具体某个全量恢复的详情',
'summary' => '对于已开启备份恢复的HBaseue集群,通过DescribeRestoreFullDetails接口查询具体某个全量恢复的详情。',
'description' => '请确保在使用该接口前,确认HBaseue集群已开通备份恢复功能,并且已有恢复记录产生,可通过DescribeRestoreSummary获取到恢复记录。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeRestoreIncrDetail' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '备份恢复的集群Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-m5eyf188hw481xxxx',
],
],
[
'name' => 'RestoreRecordId',
'in' => 'query',
'schema' => [
'description' => '恢复记录Id,可通过DescribeRestoreSummary接口获取到。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2020110514xxxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求Id。',
'type' => 'string',
'example' => 'D0FE2717-E194-465A-B27B-7373F96E580B',
],
'RestoreIncrDetail' => [
'description' => '增量恢复详情。',
'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',
],
],
],
],
],
],
],
'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":"D0FE2717-E194-465A-B27B-7373F96E580B\\n\\n 0 ms\\n 2020-11-05T06:45:44Z\\n 2020-11-02T18:00:00Z\\n SUCCEEDED\\n 2020-11-05T06:45:44Z\\n 0/0\\n \'\'\\n","errorExample":""}]',
'title' => '获取增量恢复详情',
'summary' => '通过DescribeRestoreIncrDetail接口获取增量恢复详情。',
'description' => '请确保在使用该接口前,确认HBaseue集群已开通备份恢复功能,且已存在恢复记录,可通过DescribeRestoreSummary接口获取到恢复记录。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeRestoreSchemaDetails' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-m5eznlga4k5bcxxxx',
],
],
[
'name' => 'RestoreRecordId',
'in' => 'query',
'schema' => [
'description' => '备份记录Id,可通过DescribeBackupSummary接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2020110514xxxx',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '页面大小。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'BC682A80-7677-4294-975C-CFEA425381DE',
],
'RestoreSchema' => [
'description' => 'schema恢复详情。',
'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',
],
'RestoreSchemaDetails' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RestoreSchemaDetail' => [
'description' => '表恢复详情。',
'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',
],
],
],
],
],
],
],
],
],
],
],
],
'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":"\\n 10\\n 1\\n 1\\n 0\\n 1\\n \\n \\n 2020-11-05T06:45:14Z\\n \\n null\\n 2020-11-05T06:45:18Z\\n SUCCEEDED\\n \\n \\n\\nBC682A80-7677-4294-975C-CFEA425381DE","errorExample":""}]',
'title' => 'DescribeRestoreSchemaDetails',
'summary' => '对于已开启备份恢复的HBaseue集群,通过DescribeRestoreSchemaDetails接口查询具体恢复Schema的详情。',
'description' => '请确保在使用该接口前,确认HBaseue集群已开通备份恢复功能,且已存在恢复记录。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeRestoreSummary' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-m5eznlga4k5bcxxxx',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '页面大小。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '页面大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'PageNumber' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '请求Id。',
'type' => 'string',
'example' => 'AE639ED7-F0F3-4A71-911E-CF8EC088816E',
],
'Total' => [
'description' => '总记录数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'HasMoreRestoreRecord' => [
'description' => '是否有下一页,该参数现未使用。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Rescords' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Rescord' => [
'description' => '恢复列表详情。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '状态。',
'type' => 'string',
'example' => 'SUCCEEDED',
],
'FinishTime' => [
'description' => '完成时间。',
'type' => 'string',
'example' => '2020-11-05T06:45:51Z',
],
'SchemaProcess' => [
'description' => 'schema恢复进度。',
'type' => 'string',
'example' => '1/1',
],
'BulkLoadProcess' => [
'description' => 'BulkLoad进度。',
'type' => 'string',
'example' => '1/1',
],
'RecordId' => [
'description' => '记录Id。',
'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',
],
],
],
],
],
],
],
],
],
],
'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":"AE639ED7-F0F3-4A71-911E-CF8EC088816E\\n10\\n1\\n1\\n0\\n\\n \\n SUCCEEDED\\n 0/0\\n 2020-11-05T06:45:51Z\\n 1/1\\n 2020-11-05T06:45:14Z\\n 20201105144514\\n 1/1\\n 1/1\\n \\n","errorExample":""}]',
'title' => '获取数据恢复概要',
'summary' => '对于已开通备份恢复的HBaseue集群,通过DescribeRestoreSummary接口获取数据恢复概要。',
'description' => '请确保在使用该接口前,确认HBaseue集群已开通备份恢复功能。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeRestoreTables' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-m5eznlga4k5bcxxxx',
],
],
[
'name' => 'RestoreRecordId',
'in' => 'query',
'schema' => [
'description' => '恢复记录Id,可通过DescribeRestoreSummary接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2020110514xxxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '18D9CC47-D913-48BF-AB6B-4FA9B28FBDB1',
],
'Tables' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Table' => [
'description' => '表名的集合。',
'type' => 'array',
'items' => [
'description' => '仅有表名的集合。',
'type' => 'string',
'example' => 'default:test1',
],
],
],
],
'RestoreSummary' => [
'description' => '恢复总览情况。',
'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' => '记录Id。',
'type' => 'string',
'example' => '20201105144514',
],
'RestoreToDate' => [
'description' => '恢复到指定的时间点。',
'type' => 'string',
'example' => '2020-11-04T05:15:00Z',
],
'TargetCluster' => [
'description' => '恢复目标集群。',
'type' => 'string',
'example' => 'ld-m5e2t34kr54wgxxxx',
],
],
],
'RestoreSchema' => [
'description' => 'schema恢复详情。',
'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',
],
'RestoreSchemaDetails' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RestoreSchemaDetail' => [
'description' => '表的schema恢复详情进度。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => 'schema恢复结束时间。',
'type' => 'string',
'example' => '2020-11-05T06:45:18Z',
],
'Message' => [
'description' => '报错时的错误信息。',
'type' => 'string',
'example' => 'null',
],
'StartTime' => [
'description' => 'schema恢复开始时间。',
'type' => 'string',
'example' => '2020-11-05T06:45:14Z',
],
'Table' => [
'description' => 'schema恢复表名。',
'type' => 'string',
'example' => 'default:test1',
],
'State' => [
'description' => 'schema恢复状态。',
'type' => 'string',
'example' => 'SUCCEEDED',
],
],
],
],
],
],
],
],
'RestoreFull' => [
'description' => '全量恢复详情。',
'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',
],
'RestoreFullDetails' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RestoreFullDetail' => [
'description' => '全量恢复表详情信息。',
'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',
],
],
],
],
],
],
],
],
'RestoreIncrDetail' => [
'description' => '增量恢复详情。',
'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',
],
],
],
],
],
],
],
'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":"\\n 10\\n 1\\n 1\\n 0\\n 1\\n \\n \\n 2020-11-05T06:45:14Z\\n \\n null\\n 2020-11-05T06:45:18Z\\n SUCCEEDED\\n \\n \\n\\n\\n 0.00 MB/s\\n \\n \\n 0.00 MB/s\\n \\n “”\\n 2020-11-05T06:45:51Z\\n SUCCEEDED\\n 1.2 kB\\n 2020-11-05T06:45:45Z\\n 14/14\\n \\n \\n 10\\n 1\\n 1\\n 1.2 kB\\n 0\\n 1\\n\\n18D9CC47-D913-48BF-AB6B-4FA9B28FBDB1\\n\\n \\n\\n\\n ld-m5e2t34kr54wgxxxx\\n 2020-11-05T06:45:51Z\\n SUCCEEDED\\n 2020-11-05T06:45:14Z\\n 2020-11-04T05:15:00Z\\n 20201105144514\\n\\n\\n 0 ms\\n 2020-11-05T06:45:44Z\\n 2020-11-02T18:00:00Z\\n SUCCEEDED\\n 2020-11-05T06:45:44Z\\n 0/0\\n “”\\n","errorExample":""}]',
'title' => 'DescribeRestoreTables',
'summary' => '对于已经发起过备份后恢复的集群,可通过DescribeRestoreTables获取对应恢复记录的详情。',
'description' => '请确保在使用该接口前,确认HBaseue集群已开通备份恢复功能,并且已有恢复记录产生,可通过DescribeRestoreSummary获取到恢复记录。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AllocatePublicNetworkAddress' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-t4naqsay5gn******',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。 说明:若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
'type' => 'string',
'required' => false,
'example' => '83b2b5e117a5b8bce0fae88d90576a84_6452320_82718582',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '50373857-C47B-4B64-9332-D0B5280B59EA',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280B59EA\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 50373857-C47B-4B64-9332-D0B5280B****\\n","errorExample":""}]',
'title' => '为实例申请公网连接地址',
'summary' => '申请公网地址。',
],
'ReleasePublicNetworkAddress' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-t4naqsay5gn******',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求Id。',
'type' => 'string',
'example' => 'B18D4390-A968-4444-B323-4360B8E5DA3E',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B18D4390-A968-4444-B323-4360B8E5DA3E\\"\\n}","errorExample":""},{"type":"xml","example":"B18D4390-A968-4444-B323-4360B8E5DA3E","errorExample":""}]',
'title' => '释放实例公网地址',
'summary' => '释放公网地址。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeEndpoints' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '要查询的实例ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp150tns0sjxs****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'VpcId' => [
'description' => '专有网络ID,当NetType为**VPC**时会返回此参数。',
'type' => 'string',
'example' => 'vpc-bp15s22y1a7sff5gj****',
],
'VSwitchId' => [
'description' => '虚拟交换机ID,当NetType为**VPC**时会返回此参数。',
'type' => 'string',
'example' => 'vsw-bp1foll427ze3d4ps****',
],
'Engine' => [
'description' => '实例引擎类型,返回值:'."\n"
."\n"
.'- **hbaseue**'."\n"
.'- **hbase**'."\n"
.'- **spark**'."\n"
.'- **geomesa**',
'type' => 'string',
'example' => 'hbaseue',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F072593C-5234-5B56-9F63-3C7A3AD85D66',
],
'NetType' => [
'description' => '实例的网络类型,返回值:'."\n"
.'- **VPC**:专有网络类型。'."\n"
.'- **CLASSIC**:经典网络类型。',
'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' => '连接的类型,返回值:'."\n"
.'- **uiProxyConn**:UI访问连接。'."\n"
.'- **zkConn**:ZK连接。'."\n"
.'- **thriftConn**:thrift连接。'."\n"
.'- **slbConn_thrift**:负载均衡的thrift连接。'."\n"
.'- **serviceConn_LivyConnAddr**: livy连接。'."\n",
'type' => 'string',
'example' => 'zkConn',
],
'NetType' => [
'description' => '连接的访问网络类型,返回值:'."\n"
.'- **PUBLIC**或**0**:表示公网访问。'."\n"
.'- **PRIVATE**或**1**:表示私网访问。'."\n"
.'- **VPC**或**2**:表示VPC访问。',
'type' => 'string',
'example' => '2',
],
],
],
],
],
],
],
],
],
],
'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":"\\nF072593C-5234-5B56-9F63-3C7A3AD85D66\\nvpc-bp15s22y1a7sff5gj****\\n\\n \\n 2181\\n ld-bp150tns0sjx****\\n zkConn\\n 2\\n \\n \\n 9042\\n ld-bp150tns0sjx****\\n slbConn_hbaseue\\n 0\\n \\n\\nvsw-bp1foll427ze3d4ps****\\nVPC\\nhbaseue\\n","errorExample":""}]',
'title' => '根据集群 ID 查询集群数据库链接信息',
'summary' => '调用DescribeEndpoints查询HBase实例的数据库连接信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeAccounts' => [
'summary' => '查询数据库账号列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '要查询的实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp1uoihlf82e8****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F744E939-D08D-5623-82C8-9D1F9F7*****',
],
'Accounts' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'account' => [
'description' => '账号信息列表。',
'type' => 'array',
'items' => [
'description' => '账户名称。',
'type' => 'string',
'example' => '["test"]',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F744E939-D08D-5623-82C8-9D1F9F7*****\\",\\n \\"Accounts\\": {\\n \\"account\\": [\\n \\"[\\\\\\"test\\\\\\"]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n F744E939-D08D-5623-82C8-9D1F9F7*****\\n [\\"test\\"]\\n","errorExample":""}]',
'title' => '查询数据库账号列表',
],
'CreateAccount' => [
'summary' => '创建宽表账号',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp150tns0sjxs****',
],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => [
'description' => '账号名称,需符合如下要求:'."\n"
."\n"
.'* 以小写字母开头,以字母或数字结尾。'."\n"
.'* 由小写字母、数字或下划线组成。'."\n"
.'* 长度为2~16个字符。'."\n"
.'* 不能使用某些预留的用户名,如root、admin等。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test01',
],
],
[
'name' => 'AccountPassword',
'in' => 'query',
'schema' => [
'description' => '数据库账号的密码。需遵循以下要求:'."\n"
.'- 由大写字母、小写字母、数字、特殊字符中的任意三种组成。'."\n"
.'- 特殊字符为`!@#$%^&*()_+-=`。'."\n"
.'- 长度为8~32个字符。'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '50373857-C47B-4B64-9332-D0B5280*****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50373857-C47B-4B64-9332-D0B5280*****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 50373857-C47B-4B64-9332-D0B5280*****\\n","errorExample":""}]',
'title' => '创建数据库账号',
'description' => '仅支持HBaseue增强版',
],
'ModifyAccountPassword' => [
'summary' => '修改数据库访问账号密码。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '目标实例ID,可调用DescribeInstances接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp150tns0sjxs****',
],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => [
'description' => '账号名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test01',
],
],
[
'name' => 'NewAccountPassword',
'in' => 'query',
'schema' => [
'description' => '账号的新密码,需符合以下要求:'."\n"
.'* 至少包含大写字母、小写字母、数字或特殊字符中的任意三种。'."\n"
.'* 长度为8~32个字符。'."\n"
.'* 特殊字符为`!@#$%^&*()_+-=`。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'AFAA617B-3268-5883-982B-DB8EC8C*****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFAA617B-3268-5883-982B-DB8EC8C*****\\"\\n}","type":"json"}]',
'title' => '更改数据库账号密码',
],
'DeleteAccount' => [
'summary' => '删除宽表数据库账号',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp150tns0sjxs****',
],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => [
'description' => '删除已存在的账号名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test01****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '729CB2A7-3065-53A9-B27C-7033CA4*****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"729CB2A7-3065-53A9-B27C-7033CA4*****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 729CB2A7-3065-53A9-B27C-7033CA4*****\\n","errorExample":""}]',
'title' => '删除数据库账号',
'description' => '仅支持HBaseue增强版',
],
'Grant' => [
'summary' => '授权账号权限。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '目标实例ID,可调用DescribeInstances接口获取。',
'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',
'in' => 'query',
'schema' => [
'description' => '表名。星号(*)表示全局,即所有表。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'table',
],
],
[
'name' => 'AclActions',
'in' => 'query',
'schema' => [
'description' => '权限列表。多个权限之间使用半角逗号(,)分隔。'."\n"
.'- READ:读取权限。'."\n"
.'- WRITE:写入权限。'."\n"
.'- ADMIN:管理权限。'."\n"
.'- TRASH:清空权限。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'READ,WRITE',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9CBF8DF0-4931-4A54-9B60-4C6E1AB5****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9CBF8DF0-4931-4A54-9B60-4C6E1AB5****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9CBF8DF0-4931-4A54-9B60-4C6E1AB5****\\n","errorExample":""}]',
'title' => '授权账号权限',
],
'Revoke' => [
'summary' => '回收宽表账号权限',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '目标实例ID。',
'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',
'in' => 'query',
'schema' => [
'description' => '表名。星号(*)表示全局,即所有表。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'table',
],
],
[
'name' => 'AclActions',
'in' => 'query',
'schema' => [
'description' => '权限列表。多个权限之间使用半角逗号(,)分隔。'."\n"
.'- READ:读取权限。'."\n"
.'- WRITE:写入权限。'."\n"
.'- ADMIN:管理权限。'."\n"
.'- TRASH:清空权限。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'READ,WRITE',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C9085433-A56A-4089-B49A-DF5A4E2*****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C9085433-A56A-4089-B49A-DF5A4E2*****\\"\\n}","type":"json"}]',
'title' => '回收账号权限',
],
'TagResources' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例所属的地域ID,可调用[DescribeRegions](~~144489~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '实例ID列表,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'array',
'items' => [
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'ld-bp17pwu1541ia****',
],
'required' => true,
'example' => 'bds-bp15e022622fk0w1',
'maxItems' => 51,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签的键。'."\n"
."\n"
.'> N表示传入第几个标签的键。例如:'."\n"
.'- Tag.1.Key表示传入第一个标签的键。
'."\n"
.'- Tag.2.Key表示传入第二个标签的键。
',
'type' => 'string',
'required' => false,
'example' => 'key1',
],
'Value' => [
'description' => '标签的值。'."\n"
."\n"
.'> N表示传入第几个标签的值。例如:'."\n"
.'- Tag.1.Value表示传入第一个标签的值。
'."\n"
.'- Tag.2.Value表示传入第二个标签的值。
',
'type' => 'string',
'required' => false,
'example' => 'value1',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '2656FA19-6059-40C8-A157-3FFBEAEC2369',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2656FA19-6059-40C8-A157-3FFBEAEC2369\\"\\n}","errorExample":""},{"type":"xml","example":"9CBF8DF0-4931-4A54-9B60-4C6E1AB59286","errorExample":""}]',
'title' => '实例增加Tag标签',
'summary' => '实例增加Tag标签。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UnTagResources' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '区域Id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => [
'description' => '是否删除全部标签。如果传入了TagKey,则只按TagKey删除。为true/false,为true时切未传入TagKey时删除全部标签,',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '要删除的第N个资源Id,此处是为集群Id。如果有多个,可以传参数名为ResourceId.2、ResourceId.3等等。N为正整数',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => 'bds-bp15e022622fk0w1',
'maxItems' => 51,
],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '第N个要删除的标签的键,可传多个,TagKey.2、TagKey.3等待。N为正整数',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => 'key1',
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '9CBF8DF0-4931-4A54-9B60-4C6E1AB59286',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9CBF8DF0-4931-4A54-9B60-4C6E1AB59286\\"\\n}","errorExample":""},{"type":"xml","example":"9CBF8DF0-4931-4A54-9B60-4C6E1AB59286","errorExample":""}]',
'title' => '删除资源标签',
'summary' => '对照TagResources。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListTagResources' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '如果数据过多,会返回NextToken,用于查询下一页。',
'type' => 'string',
'required' => false,
'example' => 'NextToken',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '第N个资源Id,此处是为集群Id。可同时查询多个资源,可以传参数名为ResourceId.2、ResourceId.3等等。N为正整数。',
'type' => 'array',
'items' => [
'description' => '第N个资源Id,此处是为集群Id。可同时查询多个资源,可以传参数名为ResourceId.2、ResourceId.3等等。N为正整数。',
'type' => 'string',
'required' => false,
'example' => 'bds-bp15e022622f****',
],
'required' => false,
'example' => 'bds-bp15e022622f****',
'maxItems' => 51,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '要查询的标签的key,可有多个。N为正整数。',
'type' => 'string',
'required' => false,
'example' => 'key1',
],
'Value' => [
'description' => '要查询的标签的value,可有多个。N为正整数。',
'type' => 'string',
'required' => false,
'example' => 'value1',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => [
'description' => '下一页开始的Token,NextToken为空说明没有下一页。',
'type' => 'string',
'example' => '1d2db86sca4384811e0b5e8707e68****',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '74F02441-9A8D-48F6-933F-E317AEB28DBF',
],
'TagResources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagResource' => [
'description' => '资源列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagValue' => [
'description' => '标签值。',
'type' => 'string',
'example' => 'v2',
],
'ResourceType' => [
'description' => '资源类型。',
'type' => 'string',
'example' => 'ALIYUN::MULTIMOD::CLUSTER',
],
'ResourceId' => [
'description' => '资源ID。',
'type' => 'string',
'example' => 'bds-bp15e022622f****',
],
'TagKey' => [
'description' => '标签键。',
'type' => 'string',
'example' => 'k1',
],
],
],
],
],
],
],
],
],
],
'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":"1d2db86sca4384811e0b5e8707e68****\\n74F02441-9A8D-48F6-933F-E317AEB28DBF\\n\\n \\n k1\\n ALIYUN::MULTIMOD::CLUSTER\\n v2\\n bds-bp15e022622f****\\n \\n","errorExample":""}]',
'title' => 'ListTagResources',
'summary' => '通过ResourceId或者Tag(Key查询、key和value同时查询)获取标签列表。',
'description' => 'ResourceId和Tag两个参数中必须有一个传参,否则报错。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListTags' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID,可通过DescribeRegions获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-shanghai',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '36D1BE9B-3C4A-425B-947A-69E3D77999C4',
],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => 'Tag列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagValue' => [
'description' => 'tag值',
'type' => 'string',
'example' => 'v2',
],
'TagKey' => [
'description' => 'tag键',
'type' => 'string',
'example' => 'k1',
],
],
],
],
],
],
],
],
],
],
'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":"\\n \\n \\n k1\\n \\n \\n v1\\n k1\\n \\n \\n v2\\n k1\\n \\n \\n v2\\n k2\\n \\n \\n v3\\n k3\\n \\n \\n single\\n type\\n \\n\\n36D1BE9B-3C4A-425B-947A-69E3D77999C4","errorExample":""}]',
'title' => '获取 Region下所有标签',
'summary' => '根据region获取该region下所有Tag。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateServerlessCluster' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例所属的地域ID,可调用[DescribeRegions](~~144489~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'description' => '可用区ID,可调用[DescribeRegions](~~144489~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou-f',
],
],
[
'name' => 'ClusterName',
'in' => 'query',
'schema' => [
'description' => '实例名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'serverless-name',
],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => [
'description' => '专有网络ID。'."\n"
."\n"
.'> 本参数与VswitchId参数同时为空时表示实例的网络类型为经典网络。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'vpc-bp120k6ixs4eog****',
],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => [
'description' => '专有网络下的虚拟交换机ID。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'vsw-bp191ipotqj1ssyl*****',
],
],
[
'name' => 'PayType',
'in' => 'query',
'schema' => [
'description' => '实例的付费类型,取值:'."\n"
."\n"
.'- **Prepaid**:包年包月(预付费)。'."\n"
.'- **Postpaid**:按量付费(后付费)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Prepaid',
],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
'description' => '包年包月实例的购买单位,取值:'."\n"
."\n"
.'- **year**:年。'."\n"
.'- **month**:月。'."\n"
."\n"
.'> 仅当实例的付费类型为**Prepaid**时,需要填写此参数。',
'type' => 'string',
'required' => false,
'example' => 'month',
],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => [
'description' => '包年包月实例的购买时长,取值:'."\n"
."\n"
.'- 当PeriodUnit为year时,取值范围为**1**~**3**。'."\n"
.'- 当PeriodUnit为month时,取值范围为**1**~**9**。'."\n"
."\n"
.'> 仅当实例的付费类型为**Prepaid**时,需要填写此参数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '60',
'minimum' => '0',
'example' => '6',
'default' => '0',
],
],
[
'name' => 'AutoRenewPeriod',
'in' => 'query',
'schema' => [
'description' => '设置实例自动续费周期,单位为月。'."\n"
."\n"
.'> - 自动续费周期默认值为0,表示实例到期后不自动续费。
'."\n"
.'- 例如自动续费周期设置为2,表示实例到期后自动续费2个月。
',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '36',
'minimum' => '0',
'example' => '2',
'default' => '0',
],
],
[
'name' => 'ServerlessSpec',
'in' => 'query',
'schema' => [
'description' => '基础型,取值:不填或者**serverless.small**。',
'type' => 'string',
'required' => false,
'example' => 'serverless.small',
'default' => 'serverless.small',
],
],
[
'name' => 'ServerlessCapability',
'in' => 'query',
'schema' => [
'description' => '单元处理能力,单位为CU。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '20000',
'minimum' => '50',
'example' => '1000',
'default' => '50',
],
],
[
'name' => 'ServerlessStorage',
'in' => 'query',
'schema' => [
'description' => '存储大小,单位为GB。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '20000',
'minimum' => '10',
'example' => '100',
'default' => '10',
],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => [
'description' => 'HBase Serverless实例的引擎类型。取值:**serverlesshbase**。',
'type' => 'string',
'required' => false,
'example' => 'serverlesshbase',
'default' => 'serverlesshbase',
],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => [
'description' => '引擎版本。',
'type' => 'string',
'required' => false,
'example' => '2.0',
'default' => '2.0',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。',
'type' => 'string',
'required' => false,
'example' => 'ETnLKlblzczshOTUbOCz****',
],
],
[
'name' => 'ClientType',
'in' => 'query',
'schema' => [
'description' => '这个参数是为了区分创建的来源,公有云默认为空,可不填写。',
'type' => 'string',
'required' => false,
'example' => 'xx',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '资源组ID。资源组详情请参见[查看资源组基本信息](~~151181~~)。',
'type' => 'string',
'required' => false,
'example' => 'rg-j4d53glb3****',
],
],
[
'name' => 'DiskType',
'in' => 'query',
'schema' => [
'description' => '实例的磁盘类型,取值:'."\n"
."\n"
.'- **cloud_efficiency**:高效云盘。'."\n"
.'- **cloud_ssd**:SSD云盘。'."\n"
.'- **local_hdd_pro**:本地HDD盘。'."\n"
.'- **local_ssd_pro**:本地SSD盘。'."\n"
.'- **cloud_essd_pl1**:ESSD云盘。',
'type' => 'string',
'required' => false,
'example' => 'cloud_ssd',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '3E19E345-101D-4014-946C-************',
],
'PassWord' => [
'description' => '集群访问密码。',
'type' => 'string',
'example' => '*********',
],
'OrderId' => [
'description' => '订单ID。',
'type' => 'string',
'example' => '23232453233*****',
],
'ClusterId' => [
'description' => 'HBase Serverless实例ID。',
'type' => 'string',
'example' => 'sh-bp1a969y7681****',
],
],
],
],
],
'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":"3E19E345-101D-4014-946C-************\\nsh-bp1a969y7681****\\n23232453233*****\\n*********","errorExample":""}]',
'title' => 'CreateServerlessCluster',
'summary' => '新建HBase Serverless集群。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteServerlessCluster' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sh-bp1pj13wh9****',
],
],
[
'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',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '46950E74-59C4-4E3E-9B38-A33B*********',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"46950E74-59C4-4E3E-9B38-A33B*********\\"\\n}","errorExample":""},{"type":"xml","example":"46950E74-59C4-4E3E-9B38-A33B*********","errorExample":""}]',
'title' => '删除HBase Serverless集群',
'summary' => '删除HBase Serverless集群。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeServerlessCluster' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'description' => '实例所属可用区ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sdh0b7f4k5f****',
],
],
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群ID,系统生成的唯一标识码。可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-bp16f1441y6p2****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'VpcId' => [
'description' => '实例所属的专有网络ID。',
'type' => 'string',
'example' => 'vpc-bp120k6ixs4eoghz****',
],
'Status' => [
'description' => '当前状态:'."\n"
.'- **CREATING**:创建中。'."\n"
.'- **ACTIVATION**:运行中'."\n"
.'- **DELETING**:删除中。'."\n"
.'- **RESTARTING**:重启中。',
'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' => '付费类型:'."\n"
.'- **Prepaid**:预付费。'."\n"
.'- **Postpaid**:后付费。',
'type' => 'string',
'example' => 'Postpaid',
],
'MainVersion' => [
'description' => '主版本。',
'type' => 'string',
'example' => '2.0.8',
],
'LockMode' => [
'description' => '集群锁定类型。'."\n"
.'> 该参数无返回值。',
'type' => 'string',
'example' => '过期',
],
'HasUser' => [
'description' => '是否有用户。'."\n"
.'- **true**:有用户。'."\n"
.'- **false**:无用户。',
'type' => 'string',
'example' => 'false',
],
'HaType' => [
'description' => '是否高可用:'."\n"
.'- **true**:高可用。'."\n"
.'- **false**:非高可用。',
'type' => 'string',
'example' => 'false',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '89F81C30-320B-4550-91DB-C37C81D2358F',
],
'UpdateStatus' => [
'description' => '小版本升级的状态:'."\n"
.'- **YES**:可以升级。'."\n"
.'- **NO**:不可以升级。'."\n"
.'- **PENDING**:升级中。',
'type' => 'string',
'example' => 'NO',
],
'ReserverMaxQpsNum' => [
'description' => ' 预留最大QPS大小。',
'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' => 'CU大小。',
'type' => 'string',
'example' => '150',
],
'ExpireTime' => [
'description' => '失效时间。',
'type' => 'string',
'example' => '2019-10-12T14:40:46',
],
'ReserverMinQpsNum' => [
'description' => ' 预留最小QPS大小。',
'type' => 'string',
'example' => '50',
],
'AutoRenew' => [
'description' => '是否续费:'."\n"
.'- **true**:续费。'."\n"
.'- **false**:不续费。',
'type' => 'string',
'example' => 'false',
],
'DiskSize' => [
'description' => '节点磁盘大小,单位为G。',
'type' => 'string',
'example' => '200',
],
'InstanceId' => [
'description' => '集群ID。',
'type' => 'string',
'example' => 'hb-bp16f1441y6p2****',
],
'IsDeletionProtection' => [
'description' => '是否开启保护。',
'type' => 'string',
'example' => 'true',
],
'RegionId' => [
'description' => '实例所属地域ID。',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'VSwitchId' => [
'description' => '虚拟交换机ID。',
'type' => 'string',
'example' => 'vsw-bp191ipotqf****',
],
'ClusterType' => [
'description' => '集群类型。'."\n"
.'- **Cluster**:集群版。'."\n"
.'- **Single**:单节点。',
'type' => 'string',
'example' => 'single',
],
'ResourceGroupId' => [
'description' => '资源所在的资源组ID。',
'type' => 'string',
'example' => 'rg-fjm2d4v7sf****',
],
'ZoneId' => [
'description' => '实例所属可用区ID。',
'type' => 'string',
'example' => 'cn-hangzhou-f',
],
],
],
],
],
'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":"string\\nrg-fjm2d4v7sf****\\nstring\\nfalse\\n50\\ntrue\\n200\\n100\\n150\\nstring\\nACTIVATION\\n2.0.8\\ncn-hangzhou-f\\n89F81C30-320B-4550-91DB-C37C81D2358F\\nhb-bp16f1441y6p2****\\nfalse\\n2019-10-12T14:40:46\\nvsw-bp191ipotqf****\\nfalse\\nPostpaid\\n过期\\nsingle\\ntest\\nvpc-bp120k6ixs4eoghz****\\ncn-hangzhou\\n2019-10-12T14:40:46","errorExample":""}]',
'title' => '获取 Serverless 集群',
'summary' => '调用DescribeServerlessCluster查询Serverless集群详情。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateHbaseHaSlb' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'BdsId',
'in' => 'query',
'schema' => [
'description' => 'BDS集群ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'bds-t4n3496whj23****',
],
],
[
'name' => 'HaId',
'in' => 'query',
'schema' => [
'description' => 'BDS主备双活管理中的高可用ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ha-v21tmnxjwh2yu****',
],
],
[
'name' => 'HaTypes',
'in' => 'query',
'schema' => [
'description' => '高可用类型,取值:'."\n"
."\n"
.'- thrift'."\n"
.'- phoenix',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'thrift',
],
],
[
'name' => 'HbaseType',
'in' => 'query',
'schema' => [
'description' => '高可用类型在主实例或者备实例。取值:'."\n"
."\n"
.'- Active:高可用类型在主实例。'."\n"
.'- Standby:高可用类型在备实例。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Active',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。',
'type' => 'string',
'required' => false,
'example' => 'ETnLKlblzczshOTUbOCz****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C9D568D9-A59C-4AF2-8FBB-F086A841D58E',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C9D568D9-A59C-4AF2-8FBB-F086A841D58E\\"\\n}","errorExample":""},{"type":"xml","example":"C9D568D9-A59C-4AF2-8FBB-F086A841D58E","errorExample":""}]',
'title' => 'CreateHbaseHaSlb',
'summary' => 'BDS集群创建高可用HBase后,此接口可用于创建对应的高可用thrift或高可用phoenix。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteHbaseHaSlb' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'BdsId',
'in' => 'query',
'schema' => [
'description' => 'BDS集群ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'bds-t4n3496whj23ia4k',
],
],
[
'name' => 'HaId',
'in' => 'query',
'schema' => [
'description' => 'bds高可用管理里的高可用Id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ha-v21tmnxjwh2yuy1il',
],
],
[
'name' => 'HaTypes',
'in' => 'query',
'schema' => [
'description' => '高可用类型。可选值'."\n"
.'1. thrift'."\n"
.'2. phoenix',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'thrift',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'C9D568D9-A59C-4AF2-8FBB-F086A841D58E',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C9D568D9-A59C-4AF2-8FBB-F086A841D58E\\"\\n}","errorExample":""},{"type":"xml","example":"C9D568D9-A59C-4AF2-8FBB-F086A841D58E","errorExample":""}]',
'title' => 'DeleteHbaseHaSlb',
'summary' => '对照CreateHbaseHaSlb接口,此接口用于删除对应的高可用thrift或高可用phoenix。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SwitchHbaseHaSlb' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'BdsId',
'in' => 'query',
'schema' => [
'description' => 'BDS集群ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'bds-t4n3496whj23ia4k',
],
],
[
'name' => 'HaId',
'in' => 'query',
'schema' => [
'description' => 'bds高可用管理里的高可用Id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ha-v21tmnxjwh2yuy1il',
],
],
[
'name' => 'HaTypes',
'in' => 'query',
'schema' => [
'description' => '高可用类型。可选值'."\n"
.'1. thrift'."\n"
.'2. phoenix',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'thrift',
],
],
[
'name' => 'HbaseType',
'in' => 'query',
'schema' => [
'description' => '高可用切换到主实例还是备实例。可选值'."\n"
.'1. Active 切换到主实例'."\n"
.'2. Standby 切换到备实例',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Active',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C9D568D9-A59C-4AF2-8FBB-F086A841D58E',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C9D568D9-A59C-4AF2-8FBB-F086A841D58E\\"\\n}","errorExample":""},{"type":"xml","example":"C9D568D9-A59C-4AF2-8FBB-F086A841D58E","errorExample":""}]',
'title' => 'SwitchHbaseHaSlb',
'summary' => '对照CreateHbaseHaSlb接口,此接口用于高可用thrift或高可用phoenix的主备切换。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateGlobalResource' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '目标实例ID,可调用DescribeInstances接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-t4naqsay5gn****',
],
],
[
'name' => 'ResourceName',
'in' => 'query',
'schema' => [
'description' => '资源名称,取值:'."\n"
.'- HbaseSLBThriftVip:表示Thrift SLB服务资源。'."\n"
."\n"
.'- SolrSlbVip:表示Solr SLB服务资源。'."\n"
."\n"
.'- PhoenixSLBQueryServerVip:表示Phoenix SLB服务资源。'."\n"
."\n"
.'- PubHbaseSLBThriftVip:表示Thrift SLB公网资源。'."\n"
."\n"
.'- PubPhoenixSLBQueryServerVip:表示Phoenix SLB公网资源。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'PubPhoenixSLBQueryServerVip',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型,取值固定为**GLOBAL_VIP**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'GLOBAL_VIP',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '该参数发送请求时自动补充,无需填写。',
'type' => 'string',
'required' => false,
'example' => 'xxxxx-xxxxx-xxxxx',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例所属的地域ID。',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '1AB9ABDF-7E1E-44AD-8610-70A005115DD1',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AB9ABDF-7E1E-44AD-8610-70A005115DD1\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AB9ABDF-7E1E-44AD-8610-70A005115DD1\\n","errorExample":""}]',
'title' => '创建全局资源',
'summary' => '通过CreateGlobalResource创建集群里的全局资源。',
],
'DeleteGlobalResource' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-t4naqsay5gn******',
],
],
[
'name' => 'ResourceName',
'in' => 'query',
'schema' => [
'description' => '资源名称。'."\n"
.'PubPhoenixSLBQueryServerVip 释放HBase SQL服务的外网地址。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'PubPhoenixSLBQueryServerVip',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'GLOBAL_VIP',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求Id。',
'type' => 'string',
'example' => 'BD0B0B9A-79E8-4FDD-9C51-93443490B784',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BD0B0B9A-79E8-4FDD-9C51-93443490B784\\"\\n}","errorExample":""},{"type":"xml","example":"BD0B0B9A-79E8-4FDD-9C51-93443490B784","errorExample":""}]',
'title' => '删除全局资源',
'summary' => '通过DeleteGlobalResource删除该集群的全局资源。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDBInstanceUsage' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '目标实例ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-bp1u0639js2h7****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Result' => [
'description' => '实例磁盘的使用情况,包括以下参数:'."\n"
.'- disk_used:表示磁盘使用量。'."\n"
.'- disk_total:表示磁盘总量。'."\n"
.'- usage_rate:表示磁盘使用率。',
'type' => 'string',
'example' => '{\\"disk_usage_record\\":{\\"disk_used\\":\\"0.9GB\\",\\"disk_total\\":\\"1156.1GB\\",\\"usage_rate\\":\\"1%\\"}}',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'A2D841CE-D066-53E8-B9AC-3731DCC85397',
],
],
],
],
],
'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":"\\n A2D841CE-D066-53E8-B9AC-3731DCC85397\\n {\\"disk_usage_record\\":{\\"disk_used\\":\\"0.0GB\\",\\"disk_total\\":\\"800.0GB\\",\\"usage_rate\\":\\"0.0%\\"}}\\n","errorExample":""}]',
'title' => '查询数据库实例用量',
'summary' => '调用DescribeDBInstanceUsage根据集群id获取HBase集群运行水位状态。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeMultiZoneAvailableResource' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => [
'description' => '付费类型:'."\n"
.'- Prepaid:预付费。'."\n"
.'- Postpaid:后付费。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Prepaid',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ZoneCombination',
'in' => 'query',
'schema' => [
'description' => '可选值,不填时查询该region下全部的组合。',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou-bef-aliyun',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求Id。',
'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' => '所属地域Id。',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'MasterResources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MasterResource' => [
'description' => 'master节点资源信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceType' => [
'description' => '实例规格。',
'type' => 'string',
'example' => 'hbase.sn2.large',
],
'InstanceTypeDetail' => [
'description' => '实例规格详情。',
'type' => 'object',
'properties' => [
'Mem' => [
'description' => '内存大小,单位 GB。',
'type' => 'integer',
'format' => 'int32',
'example' => '16',
],
'Cpu' => [
'description' => 'cpu个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
],
],
],
],
],
],
],
'SupportedEngines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SupportedEngine' => [
'description' => '支持的服务类型列表,目前仅支持hbaseue。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Engine' => [
'description' => '支持的服务类型,目前仅支持hbaseue。',
'type' => 'string',
'example' => 'hbaseue',
],
'SupportedEngineVersions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SupportedEngineVersion' => [
'description' => '支持的服务版本号列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Version' => [
'description' => '服务版本号,目前仅支持hbaseue 2.0版本。',
'type' => 'string',
'example' => '2.0',
],
'SupportedCategories' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SupportedCategories' => [
'description' => '支持的分类列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Category' => [
'description' => '目前仅支持cluster集群版。',
'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' => 'core节点资源集合。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceType' => [
'description' => '规格类型。',
'type' => 'string',
'example' => 'hbase.sn2.2xlarge',
],
'MaxCoreCount' => [
'description' => '最大core节点数。',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'DBInstanceStorageRange' => [
'description' => '存储大小的范围。',
'type' => 'object',
'properties' => [
'MaxSize' => [
'description' => '最大规格,单位GB。',
'type' => 'integer',
'format' => 'int32',
'example' => '64000',
],
'StepSize' => [
'description' => '单次增加的最小步长,单位GB,每次增加的可选值为最小步长的整数倍。',
'type' => 'integer',
'format' => 'int32',
'example' => '40',
],
'MinSize' => [
'description' => '最小规格,单位GB。',
'type' => 'integer',
'format' => 'int32',
'example' => '400',
],
],
],
'InstanceTypeDetail' => [
'description' => '规格类型详情。',
'type' => 'object',
'properties' => [
'Mem' => [
'description' => '内存大小,单位GB。',
'type' => 'integer',
'format' => 'int32',
'example' => '8',
],
'Cpu' => [
'description' => 'cpu个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '32',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'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":"B2EEBBA9-C627-4415-81A0-B77BC54F1D52\\n\\n \\n \\n \\n \\n 16\\n 4\\n \\n hbase.sn2.large\\n \\n \\n \\n 4\\n 2\\n \\n hbase.sn1.medium\\n \\n \\n \\n 8\\n 4\\n \\n hbase.sn1.large\\n \\n \\n \\n 16\\n 8\\n \\n hbase.sn1.2xlarge\\n \\n \\n \\n 32\\n 8\\n \\n hbase.sn2.2xlarge\\n \\n \\n \\n 32\\n 16\\n \\n hbase.sn1.4xlarge\\n \\n \\n \\n 64\\n 16\\n \\n hbase.sn2.4xlarge\\n \\n \\n \\n 8\\n 4\\n \\n hbase.n1.large\\n \\n \\n cn-hangzhou-bef-aliyun\\n cn-hangzhou\\n \\n \\n \\n \\n 2.0\\n \\n \\n cluster\\n \\n \\n cloud_ssd\\n \\n \\n \\n 32\\n 8\\n \\n \\n 400\\n 40\\n 64000\\n \\n hbase.sn2.2xlarge\\n 30\\n \\n \\n \\n 8\\n 4\\n \\n \\n 400\\n 40\\n 64000\\n \\n hbase.sn1.large\\n 30\\n \\n \\n \\n 16\\n 8\\n \\n \\n 400\\n 40\\n 64000\\n \\n hbase.sn1.2xlarge\\n 30\\n \\n \\n \\n 32\\n 16\\n \\n \\n 400\\n 40\\n 64000\\n \\n hbase.sn1.4xlarge\\n 30\\n \\n \\n \\n 64\\n 32\\n \\n \\n 400\\n 40\\n 64000\\n \\n hbase.sn1.8xlarge\\n 30\\n \\n \\n \\n 16\\n 4\\n \\n \\n 400\\n 40\\n 64000\\n \\n hbase.sn2.large\\n 30\\n \\n \\n \\n 64\\n 16\\n \\n \\n 400\\n 40\\n 64000\\n \\n hbase.sn2.4xlarge\\n 30\\n \\n \\n \\n 128\\n 32\\n \\n \\n 400\\n 40\\n 8000\\n \\n hbase.sn2.8xlarge\\n 30\\n \\n \\n \\n \\n cloud_efficiency\\n \\n \\n \\n 32\\n 8\\n \\n \\n 400\\n 40\\n 64000\\n \\n hbase.sn2.2xlarge\\n 30\\n \\n \\n \\n 8\\n 4\\n \\n \\n 400\\n 40\\n 64000\\n \\n hbase.sn1.large\\n 30\\n \\n \\n \\n 16\\n 8\\n \\n \\n 400\\n 40\\n 64000\\n \\n hbase.sn1.2xlarge\\n 30\\n \\n \\n \\n 32\\n 16\\n \\n \\n 400\\n 40\\n 64000\\n \\n hbase.sn1.4xlarge\\n 30\\n \\n \\n \\n 64\\n 32\\n \\n \\n 400\\n 40\\n 64000\\n \\n hbase.sn1.8xlarge\\n 30\\n \\n \\n \\n 16\\n 4\\n \\n \\n 400\\n 40\\n 64000\\n \\n hbase.sn2.large\\n 30\\n \\n \\n \\n 64\\n 16\\n \\n \\n 400\\n 40\\n 64000\\n \\n hbase.sn2.4xlarge\\n 30\\n \\n \\n \\n 128\\n 32\\n \\n \\n 400\\n 40\\n 8000\\n \\n hbase.sn2.8xlarge\\n 30\\n \\n \\n \\n \\n local_hdd_pro\\n \\n \\n \\n 64\\n 16\\n \\n \\n 44000\\n 40\\n 44000\\n \\n hbase.d1.4xlarge\\n 30\\n \\n \\n \\n 96\\n 24\\n \\n \\n 66000\\n 40\\n 66000\\n \\n hbase.d1.6xlarge\\n 30\\n \\n \\n \\n \\n local_ssd_pro\\n \\n \\n \\n 32\\n 4\\n \\n \\n 894\\n 1\\n 894\\n \\n hbase.i2.xlarge\\n 30\\n \\n \\n \\n \\n \\n \\n \\n \\n hbaseue\\n \\n \\n \\n","errorExample":""}]',
'title' => '查询多区域可用资源',
'summary' => '通过DescribeMultiZoneAvailableResource获取多可用区可购买的资源。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyClusterDeletionProtection' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-****************',
],
],
[
'name' => 'Protection',
'in' => 'query',
'schema' => [
'description' => '是否进行删除保护。'."\n"
.'true 设置后删除时会提示删除保护中不能删除。'."\n"
.'false 设置后可随意删除。',
'type' => 'boolean',
'required' => true,
'docRequired' => true,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '24C80BD8-C710-4138-893A-D2AFED4FC13D',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"24C80BD8-C710-4138-893A-D2AFED4FC13D\\"\\n}","errorExample":""},{"type":"xml","example":"24C80BD8-C710-4138-893A-D2AFED4FC13D","errorExample":""}]',
'title' => 'ModifyClusterDeletionProtection',
'summary' => '通过ModifyClusterDeletionProtection设置实例的是否删除保护属性。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyMultiZoneClusterNodeType' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '多可用区实例Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-dj45g7d6rbrd****',
],
],
[
'name' => 'MasterInstanceType',
'in' => 'query',
'schema' => [
'description' => 'master节点规格,可填种类参考 DescribeInstanceType。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'hbase.sn1.8xlarge',
],
],
[
'name' => 'CoreInstanceType',
'in' => 'query',
'schema' => [
'description' => 'core节点规格,可填种类参考 DescribeInstanceType。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'hbase.sn1.large',
],
],
[
'name' => 'LogInstanceType',
'in' => 'query',
'schema' => [
'description' => 'log节点规格,可填种类参考 DescribeInstanceType。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'hbase.sn1.2xlarge',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OrderId' => [
'description' => '订单Id。',
'type' => 'string',
'example' => '12341234123****',
],
'RequestId' => [
'description' => '请求Id。',
'type' => 'string',
'example' => '06CF7A6F-A81C-431D-BACD-793F24A67C54',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"12341234123****\\",\\n \\"RequestId\\": \\"06CF7A6F-A81C-431D-BACD-793F24A67C54\\"\\n}","errorExample":""},{"type":"xml","example":"06CF7A6F-A81C-431D-BACD-793F24A67C54\\n123412341234123","errorExample":""}]',
'title' => '修改多区域集群节点类型',
'summary' => '通过ModifyMultiZoneClusterNodeType修改多可用区实例的节点规格。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryHBaseHaDB' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BdsId',
'in' => 'query',
'schema' => [
'description' => 'BDS集群ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'bds-t4n3496whj23ia4k',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '页面大小',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'RequestId' => [
'description' => '请求Id',
'type' => 'string',
'example' => '963355AD-A3B1-4654-AFFC-B5186EB8F889',
],
'PageNumber' => [
'description' => '页码',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalCount' => [
'description' => '列表总数',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'ClusterList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Cluster' => [
'description' => '高可用列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BdsName' => [
'description' => 'bdsId',
'type' => 'string',
'example' => 'bds-t4n3496whj23ia4k',
],
'ActiveName' => [
'description' => '主实例Id',
'type' => 'string',
'example' => 'hb-t4nn7dy1u1etbzmzm',
],
'HaName' => [
'description' => '高可用Id',
'type' => 'string',
'example' => 'ha-v21tmnxjwh2yuy1il',
],
'StandbyName' => [
'description' => '备实例Id',
'type' => 'string',
'example' => 'hb-t4n0ye37832tx22vz',
],
'HaSlbConnList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'HaSlbConn' => [
'description' => '该高可用实例下的高可用slb链接',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'HbaseType' => [
'description' => '目前绑定的是主实例还是备实例。值:'."\n"
.'1. Active 主'."\n"
.'2. Standby 备',
'type' => 'string',
'example' => 'Standby',
],
'SlbType' => [
'description' => '高可用类型。可选值'."\n"
.'1. thrift'."\n"
.'2. phoenix',
'type' => 'string',
'example' => 'phoenix',
],
'SlbConnAddr' => [
'description' => 'thrift/phoenix高可用链接地址',
'type' => 'string',
'example' => 'ha-v21tmnxjwh2yuy1il-phoenix.bds.9b78df04-b.rds.aliyuncs.com:8765',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'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":"1\\n\\n \\n hb-t4nn7dy1u1etbzmzm\\n bds-t4n3496whj23ia4k\\n ha-v21tmnxjwh2yuy1il\\n hb-t4n0ye37832tx22vz\\n \\n \\n Standby\\n ha-v21tmnxjwh2yuy1il-phoenix.bds.9b78df04-b.rds.aliyuncs.com:8765\\n phoenix\\n \\n \\n Active\\n ha-v21tmnxjwh2yuy1il-thrift.bds.9b78df04-b.rds.aliyuncs.com:9099\\n thrift\\n \\n \\n \\n\\n10\\n963355AD-A3B1-4654-AFFC-B5186EB8F889\\n1","errorExample":""}]',
'title' => '查询 HaDB 列表',
'summary' => 'BDS集群查询高可用HBase列表。对照CreateHaCluster与CreateHbaseHaSlb。该接口会返回对应的高可用列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CheckComponentsVersion' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-t4naqsay5gn****',
],
],
[
'name' => 'Components',
'in' => 'query',
'schema' => [
'description' => '要检查的组件:'."\n"
."\n"
.'- **HBASE**'."\n"
.'- **HADOOP**'."\n"
.'- **PHOENIX**'."\n"
.'- **SOLR**'."\n"
.'- **THRIFT**',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'HBASE,HADOOP',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E3537EB4-1100-41CA-A147-C74CCC8BB12C',
],
'Components' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Component' => [
'description' => '组件是否为最新版本的信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'IsLatestVersion' => [
'description' => '组件版本是否为最新版本。',
'type' => 'string',
'example' => 'true',
],
'Component' => [
'description' => '组件名称。',
'type' => 'string',
'example' => 'HBASE',
],
],
],
],
],
],
],
],
],
],
'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":"\\n \\n true\\n HBASE\\n \\n \\n true\\n HADOOP\\n \\n\\nE3537EB4-1100-41CA-A147-C74CCC8BB12C","errorExample":""}]',
'title' => '检查组件版本',
'summary' => '调用CheckComponentsVersion检查组件的版本是否为最新版本。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateHBaseSlbServer' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-t4naqsay5gn****',
],
],
[
'name' => 'SlbServer',
'in' => 'query',
'schema' => [
'description' => '需要创建的负载均衡服务,取值:'."\n"
."\n"
.'- **thrift**:表示跨语言、跨平台的RPC(Remote Procedure Call,远程过程调用)协议服务。'."\n"
.'- **rest**:表示HTTP协议服务。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'thrift',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端令牌信息。',
'type' => 'string',
'required' => false,
'example' => 'xxxxx-xxxxx-xxxxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '61FC5B21-87B0-41BC-9686-9DA395EB40B6',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"61FC5B21-87B0-41BC-9686-9DA395EB40B6\\"\\n}","errorExample":""},{"type":"xml","example":"61FC5B21-87B0-41BC-9686-9DA395EB40B6","errorExample":""}]',
'title' => '创建HBase负载均衡服务器',
'summary' => '通过CreateHBaseSlbServer创建负载均衡服务。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteHBaseSlbServer' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-t4naqsay5gn****',
],
],
[
'name' => 'SlbServer',
'in' => 'query',
'schema' => [
'description' => '负载均衡服务。目前支持'."\n"
.'thrift'."\n"
.'rest',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'thrift',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求Id。',
'type' => 'string',
'example' => '7242130A-82CF-49BF-AB32-30DCB819EBA6',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7242130A-82CF-49BF-AB32-30DCB819EBA6\\"\\n}","errorExample":""},{"type":"xml","example":"7242130A-82CF-49BF-AB32-30DCB819EBA6","errorExample":""}]',
'title' => '删除已开通的负载均衡服务器',
'summary' => '调用DeleteHBaseSlbServer删除已开通的负载均衡服务。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeColdStorage' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '目标实例ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-bp1uoihlf82e8****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OpenStatus' => [
'description' => '冷存储开启状态,返回值:'."\n"
.'- **open**: 已开启。'."\n"
.'- **close**:未开启。',
'type' => 'string',
'example' => 'open',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'DCB9479E-F05F-4D1C-AFB7-C639B87764B7',
],
'PayType' => [
'description' => '实例的付费类型,返回值:'."\n"
.'- **PREPAY** :包年包月(预付费)。'."\n"
.'- **POSTPAY**:按量付费(后付费)。',
'type' => 'string',
'example' => 'POSTPAY',
],
'ColdStorageUsePercent' => [
'description' => '冷存储空间的使用率,单位为%。'."\n"
."\n"
.'> 当**OpenStatus**返回值为**open**时才会返回此参数。',
'type' => 'string',
'example' => '20.00',
],
'ColdStorageUseAmount' => [
'description' => '冷存储空间的使用量,单位为GB。'."\n"
."\n"
.'> 当**OpenStatus**返回值为**open**时才会返回此参数。',
'type' => 'string',
'example' => '20.00',
],
'ColdStorageSize' => [
'description' => '冷存储的总存储容量,单位为GB。'."\n"
."\n"
.'> 当**OpenStatus**返回值为**open**时才会返回此参数。',
'type' => 'string',
'example' => '800',
],
'ColdStorageType' => [
'description' => '冷存储类型,新创建的BDS实例冷存储类型为**BdsColdStorage**,其他默认不返回此参数。',
'type' => 'string',
'example' => 'BdsColdStorage',
],
'ClusterId' => [
'description' => '实例ID。',
'type' => 'string',
'example' => 'ld-bp1uoihlf82e8****',
],
],
],
],
],
'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":"\\n20.00\\n800\\nDCB9479E-F05F-4D1C-AFB7-C639B87764B7\\nld-bp1uoihlf82e8****\\n20.00\\nPOSTPAY\\nopen\\n","errorExample":""}]',
'title' => '获取该集群冷存储状态',
'summary' => '调用DescribeColdStorage获取实例的冷存储信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetMultimodeCmsUrl' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-t4naqsay5gn******',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MultimodCmsUrl' => [
'description' => '云监控地址。',
'type' => 'string',
'example' => 'htpp://***********',
],
'RequestId' => [
'description' => '请求Id。',
'type' => 'string',
'example' => '44183B05-852E-4716-B902-52977140190F',
],
'ClusterId' => [
'description' => '集群Id。',
'type' => 'string',
'example' => 'hb-t4naqsay5gn******',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"MultimodCmsUrl\\": \\"htpp://***********\\",\\n \\"RequestId\\": \\"44183B05-852E-4716-B902-52977140190F\\",\\n \\"ClusterId\\": \\"hb-t4naqsay5gn******\\"\\n}","errorExample":""},{"type":"xml","example":"44183B05-852E-4716-B902-52977140190F\\nhb-t4naqsay5gn******\\nhtpp://***********","errorExample":""}]',
'title' => '获取多模式CMS URL',
'summary' => '根据集群id获取监控地址。',
'description' => '云监控已迁移,该接口不再使用。具体监控可在 集群管理-监控与报警 页面上点击。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListHBaseInstances' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'VpcId',
'in' => 'query',
'schema' => [
'description' => '专有网络ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'vpc-t4nx81tmlixcq5i****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '89F81C30-320B-4550-91DB-C37C81D2358F',
],
'Instances' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Instance' => [
'description' => '实例集合。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'IsDefault' => [
'description' => '固定返回值为false。',
'type' => 'boolean',
'example' => 'false',
],
'InstanceId' => [
'description' => '相同专有网络的云数据库HBase实例ID。',
'type' => 'string',
'example' => 'hb-t4naqsay5gn****',
],
'InstanceName' => [
'description' => '实例名称。',
'type' => 'string',
'example' => 'name_test',
],
],
],
],
],
],
],
],
],
],
'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":"\\n 89F81C30-320B-4550-91DB-C37C81D2358F\\n \\n false\\n hb-t4naqsay5gn****\\n name_test\\n \\n","errorExample":""}]',
'title' => '查询 HBase 实例列表',
'summary' => '调用ListHBaseInstances获取同一个vpc下的HBase实例。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListInstanceServiceConfigHistories' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群Id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-t4naqsay5gn******',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '页码,不填时默认1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页面大小,不填时默认10。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求Id。',
'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',
],
],
],
],
],
],
],
],
],
],
'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":"1\\n10\\n658C1549-2C02-4FD9-9490-EB3B285F9DCA\\n1\\n\\n \\n 10485760\\n 1608708923000\\n hbase#hbase-site.xml#hbase.client.keyvalue.maxsize\\n 10485770\\n false\\n \\n","errorExample":""}]',
'title' => '查询实例服务配置历史列表',
'summary' => '通过ListInstanceServiceConfigHistories获取集群参数的修改历史。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListInstanceServiceConfigurations' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '集群ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-t4naqsay5gn****',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '页码。不填时默认1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页面大小。不填时默认10。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '配置项类型。'."\n"
.'- INT:整型。'."\n"
.'- STR: 字符串类型。'."\n"
.'- FLOAT:单浮点型。',
'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' => '更改该配置项后是否需要重启'."\n"
.'- true:重启。'."\n"
.'- false:不重启。',
'type' => 'string',
'example' => 'true',
],
],
],
],
],
],
],
],
],
],
'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":"42\\n10\\n1DD84F22-4615-451E-8F05-58405EDB7236\\n1\\n\\n \\n R[10485760,52428800]\\n 10485760\\n hbase client keyvalue maxsize\\n INT\\n hbase#hbase-site.xml#hbase.client.keyvalue.maxsize\\n true\\n 10485760\\n \\n \\n G[true|false]\\n false\\n Enable dynamic class loader\\n STR\\n hbase#hbase-site.xml#hbase.dynamic.jars.enabled\\n true\\n false\\n \\n \\n G[.+]\\n true\\n STR\\n hbase#hbase-site.xml#hbase.exporter.enabled\\n true\\n true\\n \\n \\n R[0,604800000]\\n 604800000\\n The time (in miliseconds) between major compactions of all HStoreFiles in a region\\n INT\\n hbase#hbase-site.xml#hbase.hregion.majorcompaction\\n true\\n 604800000\\n \\n \\n R[0.0,0.7]\\n 0.0\\n 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.\\n FLOAT\\n hbase#hbase-site.xml#hbase.ipc.server.callqueue.read.ratio\\n true\\n 0.0\\n \\n \\n R[0.0,0.7]\\n 0.0\\n 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.\\n FLOAT\\n hbase#hbase-site.xml#hbase.ipc.server.callqueue.scan.ratio\\n true\\n 0.0\\n \\n \\n R[0.24,0.475]|E[0.8*${hbase#hbase-site.xml#hbase.regionserver.global.memstore.size}<=${hbase#hbase-site.xml#hbase.regionserver.global.memstore.lowerLimit}]|E[0.95*${hbase#hbase-site.xml#hbase.regionserver.global.memstore.size}>=${hbase#hbase-site.xml#hbase.regionserver.global.memstore.lowerLimit}]\\n 0.3\\n Maximum size of all memstores in a region server before flushes are forced. Defaults to 95% of hbase.regionserver.global.memstore.size (0.95).\\n FLOAT\\n hbase#hbase-site.xml#hbase.regionserver.global.memstore.lowerLimit\\n true\\n 0.3\\n \\n \\n R[0.3,0.5]|E[${hbase#hbase-site.xml#hfile.block.cache.size}+${hbase#hbase-site.xml#hbase.regionserver.global.memstore.size}<=0.8]\\n 0.35\\n Maximum size of all memstores in a region server before new updates are blocked and flushes are forced\\n FLOAT\\n hbase#hbase-site.xml#hbase.regionserver.global.memstore.size\\n true\\n 0.35\\n \\n \\n R[16,256]\\n 32\\n If more than this many logs, force flush of oldest region to oldest edit goes to disk.\\n INT\\n hbase#hbase-site.xml#hbase.regionserver.maxlogs\\n true\\n 32\\n \\n \\n R[1,10]\\n 1\\n Large compaction threads\\n INT\\n hbase#hbase-site.xml#hbase.regionserver.thread.compaction.large\\n false\\n 1\\n \\n","errorExample":""}]',
'title' => '获取实例服务配置列表',
'summary' => '通过ListInstanceServiceConfigurations获取集群配置项信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyInstanceServiceConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '目标实例ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-t4naqsay5gn****',
],
],
[
'name' => 'Restart',
'in' => 'query',
'schema' => [
'description' => '更改配置项后是否需要重启实例,取值:'."\n"
."\n"
.'- **true**:重启。'."\n"
.'- **false**:不重启。',
'type' => 'boolean',
'required' => false,
'docRequired' => true,
'example' => 'false',
],
],
[
'name' => 'ConfigureName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '待修改的配置项名称,可调用[ListInstanceServiceConfigurations](~~201980~~)接口查看。'."\n"
.'待修改的配置项名称。'."\n"
."\n"
.'> 如果您需要修改多个配置项,请输入Parameters参数。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hbase#hbase-site.xml#hbase.client.keyvalue.maxsize',
],
],
[
'name' => 'ConfigureValue',
'in' => 'query',
'schema' => [
'description' => '待修改的配置项值,可调用[ListInstanceServiceConfigurations](~~201980~~)接口查看。'."\n"
.'待修改的配置项值。'."\n"
."\n"
.'> 如果您需要修改多个配置项,请输入Parameters参数。'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '10485770',
],
],
[
'name' => 'Parameters',
'in' => 'query',
'schema' => [
'description' => '如果需要修改多个配置项,可以在该参数里配置JSON参数。key表示配置项的名称,value表示配置项的值。',
'type' => 'string',
'required' => false,
'example' => '{"key1=value1", "key2=value2"}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F008B7AB-025D-4C20-AE12-047C8F8C3D97',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F008B7AB-025D-4C20-AE12-047C8F8C3D97\\"\\n}","errorExample":""},{"type":"xml","example":"\\n F008B7AB-025D-4C20-AE12-047C8F8C3D97\\n","errorExample":""}]',
'title' => '修改实例服务配置',
'summary' => '调用ModifyInstanceServiceConfig更改集群配置,可修改的配置项可通过ListInstanceServiceConfigurations接口查看。',
],
'RelateDbForHBaseHa' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => 'BDS集群ID,可调用[DescribeInstances](~~144595~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'bds-t4nj9v2x85******',
],
],
[
'name' => 'HaTables',
'in' => 'query',
'schema' => [
'description' => 'HaMigrateType为TABLE级别时该项为必填,多个表用半角逗号(,)隔开。',
'type' => 'string',
'required' => false,
'example' => 'test,test1',
],
],
[
'name' => 'HaActiveHdfsUri',
'in' => 'query',
'schema' => [
'description' => '主实例的hdfs链接地址。主实例为非标准实例(即IsActiveStandard为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',
],
],
[
'name' => 'HaActiveHbaseFsDir',
'in' => 'query',
'schema' => [
'description' => '主实例hdfs的目录。主实例为非标准实例(即IsActiveStandard为false)时,参数必填。'."\n",
'type' => 'string',
'required' => false,
'example' => '/hbase',
],
],
[
'name' => 'HaActiveClusterKey',
'in' => 'query',
'schema' => [
'description' => '主实例zk地址。主实例为非标准实例(即IsActiveStandard为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',
],
],
[
'name' => 'HaActiveVersion',
'in' => 'query',
'schema' => [
'description' => '主实例数据库版本。主实例为非标准实例(即IsActiveStandard为false)时,参数必填。'."\n"
.'- **HBase1x**:hbase1.x版本。'."\n"
.'- **HBase2x**:hbase2.x版本。'."\n"
.'- **HBaseUE**:hbaseue版本。',
'type' => 'string',
'required' => false,
'example' => 'HBase2x',
],
],
[
'name' => 'HaActiveUser',
'in' => 'query',
'schema' => [
'description' => '主实例用户名。主实例为**HBaseue**时必填。',
'type' => 'string',
'required' => false,
'example' => 'root',
],
],
[
'name' => 'HaActivePassword',
'in' => 'query',
'schema' => [
'description' => '主实例用户名对应的密码。主实例为**HBaseue**时必填。',
'type' => 'string',
'required' => false,
'example' => 'root',
],
],
[
'name' => 'HaStandbyHdfsUri',
'in' => 'query',
'schema' => [
'description' => '备实例的hdfs链接地址。备实例为非标准实例(即IsStandbyStandard为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',
],
],
[
'name' => 'HaStandbyHbaseFsDir',
'in' => 'query',
'schema' => [
'description' => '备实例hdfs的目录。备实例为非标准实例(即IsStandbyStandard为false)时,参数必填。',
'type' => 'string',
'required' => false,
'example' => '/hbase',
],
],
[
'name' => 'HaStandbyClusterKey',
'in' => 'query',
'schema' => [
'description' => '备实例zk地址。备实例为非标准实例(即IsStandbyStandard为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',
],
],
[
'name' => 'HaStandbyVersion',
'in' => 'query',
'schema' => [
'description' => '备实例数据库版本。备实例为非标准实例(即IsStandbyStandard为false)时,参数必填。'."\n"
.'- **HBase1x** :hbase1.x版本。'."\n"
.'- **HBase2x**:hbase2.x版本。'."\n"
.'- **HBaseUE** :hbaseue版本。',
'type' => 'string',
'required' => false,
'example' => 'HBase2x',
],
],
[
'name' => 'HaStandbyUser',
'in' => 'query',
'schema' => [
'description' => '备实例用户名。备实例为**hbaseue**时必填。',
'type' => 'string',
'required' => false,
'example' => 'root',
],
],
[
'name' => 'HaStandbyPassword',
'in' => 'query',
'schema' => [
'description' => '备实例用户名对应的密码。备实例为**hbaseue**时必填。',
'type' => 'string',
'required' => false,
'example' => 'root',
],
],
[
'name' => 'HaActive',
'in' => 'query',
'schema' => [
'description' => '主实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-bp1w6krp539******',
],
],
[
'name' => 'HaStandby',
'in' => 'query',
'schema' => [
'description' => '备实例集群ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hb-bp1bl7iqzka******',
],
],
[
'name' => 'HaActiveDBType',
'in' => 'query',
'schema' => [
'description' => '主实例集群类型,目前支持**HBase**和**HBaseue**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hbase',
],
],
[
'name' => 'HaStandbyDBType',
'in' => 'query',
'schema' => [
'description' => '备实例集群类型。目前支持**HBase**和**HBaseue**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hbase',
],
],
[
'name' => 'IsActiveStandard',
'in' => 'query',
'schema' => [
'description' => '主实例是否为标准实例,标准实例为**true**。',
'type' => 'boolean',
'required' => true,
'docRequired' => true,
'example' => 'true',
],
],
[
'name' => 'IsStandbyStandard',
'in' => 'query',
'schema' => [
'description' => '备实例是否为标准实例,标准实例为**true**。',
'type' => 'boolean',
'required' => true,
'docRequired' => true,
'example' => 'true',
],
],
[
'name' => 'HaMigrateType',
'in' => 'query',
'schema' => [
'description' => '同步类型。'."\n"
.'- **CLUSTER**:实例级别。'."\n"
.'- **TABLE**: 表级别。'."\n"
.'- **SKIP**:无需同步。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'CLUSTER',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'DC654531-0799-4502-AFA5-80EE1C16829A',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DC654531-0799-4502-AFA5-80EE1C16829A\\"\\n}","errorExample":""},{"type":"xml","example":"DC654531-0799-4502-AFA5-80EE1C16829A","errorExample":""}]',
'title' => '在BDS集群中添加主备双活实例',
'summary' => '调用此接口在BDS集群中增加添加主备双活实例。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CancelActiveOperationTasks' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Ids',
'in' => 'query',
'schema' => [
'description' => '运维任务ID,多个ID间使用英文逗号(,)分隔。'."\n"
."\n"
.'> 您可以调用[DescribeActiveOperationTasks](~~414458~~)获取运维任务ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '11111,22222',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Ids' => [
'description' => '运维任务ID,多个ID间使用英文逗号(,)分隔。'."\n",
'type' => 'string',
'example' => '11111,22222',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'AE4F6C34-065F-45AA-F5BN-4B8D816F6305',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AE4F6C34-065F-45AA-F5BN-4B8D816F6305\\",\\n \\"Ids\\": \\"11111,22222\\"\\n}","errorExample":""},{"type":"xml","example":"\\n AE4F6C34-065F-45AA-F5BN-4B8D816F6305\\n 11111,22222\\n","errorExample":""}]',
'title' => 'CancelActiveOperationTasks',
'summary' => '调用CancelActiveOperationTasks接口取消运维事件任务。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeActiveOperationTaskType' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'IsHistory',
'in' => 'query',
'schema' => [
'description' => '是否返回历史运维任务。取值:'."\n"
."\n"
.'- **0**:仅返回当前待处理的运维任务。'."\n"
.'- **1**:返回历史运维任务。'."\n"
."\n"
.'默认值:**0**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'EC7E27FC-58F8-4722-89CF-D1B6B0971956',
],
'TypeList' => [
'description' => '任务列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TaskType' => [
'description' => '任务类型,返回值:**rds_apsaradb_upgrade**表示小版本升级。',
'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',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'RequiredParam.NotFound',
'errorMessage' => 'Required input param is not found.',
],
],
],
'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":"\\r\\n EC7E27FC-58F8-4722-89CF-D1B6B0971956\\r\\n \\r\\n 小版本升级\\r\\n rds_apsaradb_upgrade\\r\\n 1\\r\\n rds_apsaradb_upgrade\\r\\n \\r\\n","errorExample":""}]',
'title' => 'DescribeActiveOperationTaskType',
'summary' => '调用DescribeActiveOperationTaskType接口查询HBase实例的运维任务类型,各类型的任务数量和详请。',
],
'ModifyActiveOperationTasks' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Ids',
'in' => 'query',
'schema' => [
'description' => '运维任务ID,多个ID间使用英文逗号(,)分隔。'."\n"
."\n"
.'> 您可以调用[DescribeActiveOperationTasks](~~414458~~)获取运维任务ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1111,2222',
],
],
[
'name' => 'SwitchTime',
'in' => 'query',
'schema' => [
'description' => '要设置的计划切换时间,格式为_yyyy-MM-ddTHH:mm:ssZ_(UTC时间)。'."\n"
."\n"
.'> 不能晚于最晚操作时间,您可以调用[DescribeActiveOperationTasks](~~414458~~),通过返回参数**Deadline**的值来获取最晚操作时间。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2022-02-17T18:50:00Z',
],
],
[
'name' => 'ImmediateStart',
'in' => 'query',
'schema' => [
'description' => '是否立即执行运维任务,取值:'."\n"
."\n"
.'- **1**:立即执行。'."\n"
.'- **0**:指定时间执行。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Ids' => [
'description' => '运维任务ID,多个ID间使用英文逗号(,)分隔。',
'type' => 'string',
'example' => '1111,2222',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8C9CC46A-9532-4752-B59F-580112C5A45B',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8C9CC46A-9532-4752-B59F-580112C5A45B\\",\\n \\"Ids\\": \\"1111,2222\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 8C9CC46A-9532-4752-B59F-580112C5A45B\\n 1111,2222\\n","errorExample":""}]',
'title' => 'ModifyActiveOperationTasks',
'summary' => '调用ModifyActiveOperationTasks接口修改运维任务的计划切换时间。',
'description' => '云数据库HBase的运维事件(例如小版本升级)除了通过短信、语音、邮件或站内信通知之外,还会在控制台进行通知。除通过调用本接口修改计划切换时间以外,您还可以通过控制台来修改,具体操作,请参见[查询或管理待处理事件](~~405057~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeActiveOperationTasks' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'Region',
'in' => 'query',
'schema' => [
'description' => '待处理事件所属的地域ID,可调用[DescribeRegions](~~144489~~)接口获取。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'TaskType',
'in' => 'query',
'schema' => [
'description' => '任务类型,取值:**rds_apsaradb_upgrade**表示小版本升级。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'rds_apsaradb_upgrade',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页可展示的最大记录数,取值需大于**10**,默认值为**30**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '10',
'example' => '30',
'default' => '30',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页码,大于**0**且不超过Integer数据类型的最大值,默认值为**1**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2147483647',
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'ProductId',
'in' => 'query',
'schema' => [
'description' => '产品名, 默认值为**hbase**。',
'type' => 'string',
'required' => false,
'example' => 'hbase',
],
],
[
'name' => 'DbType',
'in' => 'query',
'schema' => [
'description' => '数据库类型,取值:'."\n"
."\n"
.'- **hbaseue**:云数据库HBase增强版。'."\n"
.'- **hbase**:云数据库HBase标准版。'."\n"
.'- **bds**:BDS数据同步服务。',
'type' => 'string',
'required' => false,
'example' => 'hbaseue',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '任务运行状态,取值:'."\n"
."\n"
.'- **2**:等待用户指定时间。'."\n"
.'- **3**:等待处理。'."\n"
.'- **4**:处理中。'."\n"
.'- **5**:成功。'."\n"
.'- **6**:失败。'."\n"
.'- **7**:已取消。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '5',
],
],
[
'name' => 'InsName',
'in' => 'query',
'schema' => [
'description' => 'HBase实例ID。',
'type' => 'string',
'required' => false,
'example' => 'ld-bp150tns0sjxs****',
],
],
[
'name' => 'AllowChange',
'in' => 'query',
'schema' => [
'description' => '是否允许修改时间,取值:'."\n"
."\n"
.'- **0**:不允许。'."\n"
.'- **1**:允许。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'AllowCancel',
'in' => 'query',
'schema' => [
'description' => '是否允许取消,取值:'."\n"
."\n"
.'- **0**:不允许。'."\n"
.'- **1**:允许。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'ChangeLevel',
'in' => 'query',
'schema' => [
'description' => '变更级别,取值:'."\n"
."\n"
.'- **S0**:异常修复。'."\n"
.'- **S1**:系统运维。',
'type' => 'string',
'required' => false,
'example' => 'S1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '请求ID。',
'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' => '任务运行状态,返回值:'."\n"
."\n"
.'- **2**:等待用户指定时间。'."\n"
.'- **3**:等待处理。'."\n"
.'- **4**:处理中。'."\n"
.'- **5**:成功。'."\n"
.'- **6**:失败。'."\n"
.'- **7**:已取消。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'ChangeLevelEn' => [
'description' => '变更级别名称的英文。',
'type' => 'string',
'example' => 'Risk repairment',
],
'TaskType' => [
'description' => '任务类型,返回值:**rds_apsaradb_upgrade**表示小版本升级。',
'type' => 'string',
'example' => 'rds_apsaradb_upgrade',
],
'InsName' => [
'description' => 'HBase实例ID。',
'type' => 'string',
'example' => 'ld-bp150tns0sjxs****',
],
'Region' => [
'description' => '地域ID。',
'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' => '当前AVZ。',
'type' => 'string',
'example' => 'cn-shanghai-et-a',
],
'AllowChange' => [
'description' => '是否允许修改时间,返回值:'."\n"
."\n"
.'- **0**:不允许'."\n"
.'- **1**:允许',
'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' => '是否允许取消,返回值:'."\n"
."\n"
.'- **0**:不允许'."\n"
.'- **1**:允许',
'type' => 'string',
'example' => '1',
],
'DbType' => [
'description' => '数据库类型,返回值:'."\n"
.'- **hbaseue**:云数据库HBase增强版。'."\n"
.'- **hbase**:云数据库HBase标准版。'."\n"
.'- **bds**:BDS数据同步服务。',
'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' => '运维任务ID。',
'type' => 'integer',
'format' => 'int32',
'example' => '111111',
],
'SubInsNames' => [
'type' => 'array',
'items' => [
'description' => '子实例列表项。',
'type' => 'string',
'example' => 'ld-bp150tns0sjxs****',
],
],
],
],
],
],
],
],
],
'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":"\\n1\\n30\\nC634E813-42FA-53D2-A7EB-B881C4B264CC\\n1\\n\\n 5\\n 2022-02-15 23:59:59\\n cn-shanghai-et-a\\n 2022-02-19 23:59:59\\n 2022-02-19 10:00:00\\n ld-bp150tns0sjxs****\\n all\\n hbaseue\\n Transient instance disconnection\\n --\\n 风险修复\\n 1\\n 小版本升级\\n Risk repairment\\n 2022-02-19 14:00:00\\n 2.0\\n rds_apsaradb_upgrade\\n 中断\\n 1\\n rds_apsaradb_upgrade\\n 14:00:00\\n cn-hanghzou\\n 111111\\n 2022-02-19 14:00:00\\n ld-bp150tns0sjxs****\\n\\n","errorExample":""}]',
'title' => 'DescribeActiveOperationTasks',
'summary' => '调用DescribeActiveOperationTasks接口查询HBase实例的运维任务详情。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SwitchService' => [
'summary' => '开通或关闭扩展服务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ld-uf6r2hn2zrxxxxxx',
],
],
[
'name' => 'ServiceName',
'in' => 'query',
'schema' => [
'description' => '服务名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'HBaseProxy',
],
],
[
'name' => 'Operate',
'in' => 'query',
'schema' => [
'description' => '- open: 开通'."\n"
.'- close:关闭',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'open',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => 'F1005DE4-D981-559F-9E37-5172DXXXXXX',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F1005DE4-D981-559F-9E37-5172DXXXXXX\\"\\n}","type":"json"}]',
'description' => '扩展服务'."\n"
.'如:lindorm兼容HBaseProxy协议的服务,',
],
],
'endpoints' => [
[
'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',
],
[
'regionId' => 'cn-guangzhou',
'endpoint' => 'hbase.aliyuncs.com',
],
[
'regionId' => 'cn-chengdu',
'endpoint' => 'hbase.cn-chengdu.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong',
'endpoint' => 'hbase.cn-hongkong.aliyuncs.com',
],
[
'regionId' => 'ap-northeast-1',
'endpoint' => 'hbase.ap-northeast-1.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-2',
'endpoint' => 'hbase.ap-southeast-2.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-3',
'endpoint' => 'hbase.ap-southeast-3.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-5',
'endpoint' => 'hbase.ap-southeast-5.aliyuncs.com',
],
[
'regionId' => 'us-east-1',
'endpoint' => 'hbase.us-east-1.aliyuncs.com',
],
[
'regionId' => 'us-west-1',
'endpoint' => 'hbase.us-west-1.aliyuncs.com',
],
[
'regionId' => 'eu-west-1',
'endpoint' => 'hbase.eu-west-1.aliyuncs.com',
],
[
'regionId' => 'eu-central-1',
'endpoint' => 'hbase.eu-central-1.aliyuncs.com',
],
[
'regionId' => 'ap-south-1',
'endpoint' => 'hbase.ap-south-1.aliyuncs.com',
],
[
'regionId' => 'me-east-1',
'endpoint' => 'hbase.me-east-1.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-finance',
'endpoint' => 'hbase.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-finance-1',
'endpoint' => 'hbase.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-finance-1',
'endpoint' => 'hbase.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-finance-1',
'endpoint' => 'hbase.aliyuncs.com',
],
[
'regionId' => 'me-central-1',
'endpoint' => 'hbase.me-central-1.aliyuncs.com',
],
],
];