summaryrefslogtreecommitdiff
path: root/data/zh_cn/starrocks/2022-10-19
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/starrocks/2022-10-19
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/starrocks/2022-10-19')
-rw-r--r--data/zh_cn/starrocks/2022-10-19/api-docs.php12736
1 files changed, 10322 insertions, 2414 deletions
diff --git a/data/zh_cn/starrocks/2022-10-19/api-docs.php b/data/zh_cn/starrocks/2022-10-19/api-docs.php
index 83cf4d3..eba6166 100644
--- a/data/zh_cn/starrocks/2022-10-19/api-docs.php
+++ b/data/zh_cn/starrocks/2022-10-19/api-docs.php
@@ -1,57 +1,47 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'ROA',
- 'product' => 'starrocks',
- 'version' => '2022-10-19',
- ],
+ 'info' => ['style' => 'ROA', 'product' => 'starrocks', 'version' => '2022-10-19'],
'directories' => [
[
- 'id' => 306065,
- 'title' => '实例管理',
+ 'children' => ['AddGateway'],
'type' => 'directory',
- 'children' => [
- 'CreateInstanceV1',
- 'RestartInstance',
- 'ReleaseInstance',
- 'UpdateInstanceName',
- 'DescribeInstances',
- 'DescribeNodeGroups',
- 'TagResources',
- 'UnTagResources',
- 'ChangeResourceGroup',
- ],
+ 'title' => '网关管理',
+ 'id' => 404764,
],
[
- 'id' => 306075,
- 'title' => '版本管理',
+ 'children' => ['CreateInstanceV1', 'DescribeNodeGroups'],
'type' => 'directory',
- 'children' => [
- 'UpgradeVersion',
- 'QueryUpgradableVersions',
- ],
+ 'title' => '实例管理',
+ 'id' => 195305,
],
[
- 'id' => 306078,
- 'title' => '资源变配',
+ 'children' => ['QueryUpgradableVersions'],
'type' => 'directory',
- 'children' => [
- 'ModifyNodeNumberPreCheck',
- 'ModifyNodeNumber',
- 'ModifyCuPreCheck',
- 'ModifyDiskPerformanceLevel',
- 'ModifyDiskSize',
- 'ModifyDiskNumber',
- 'ModifyCu',
- ],
+ 'title' => '版本管理',
+ 'id' => 159859,
],
[
- 'id' => 306086,
- 'title' => '其他',
+ 'children' => ['ModifyNodeNumberPreCheck', 'ModifyNodeNumber', 'ModifyCuPreCheck', 'ModifyDiskPerformanceLevel', 'ModifyDiskSize', 'ModifyDiskNumber', 'ModifyCu'],
+ 'type' => 'directory',
+ 'title' => '资源变配',
+ 'id' => 159862,
+ ],
+ [
+ 'children' => ['DescribeConfigHistory', 'ModifyInstanceConfigPreCheck', 'RollbackConfigModification'],
'type' => 'directory',
+ 'title' => '配置管理',
+ 'id' => 412927,
+ ],
+ [
'children' => [
- 'CreateServiceLinkedRole',
+ 'DeleteInnerIpWhitelistGroup', 'DescribeSystemTimezone', 'EnableInternalSlb', 'IsolateLeader', 'ModifyUserPassword', 'QueryUnpaidOrder', 'RestartNodeGroup', 'RestartNodes', 'SwitchActiveStandbyZones', 'ToggleAutoMinorVersionUpgrade', 'TogglePublicSlb', 'UpdateBackup', 'AddBackupPolicy', 'CheckInventory', 'CreateAgentResource', 'DescribeEventNames', 'DescribeInnerIpWhitelistGroups', 'DescribeInstanceDiagnosisResult', 'DescribeInstanceMetaToken', 'DescribeResourceConstraints',
+ 'DescribeTimeTriggerScalingRules', 'DisableSSLConnection', 'EnableMultiAz', 'EnableSSLConnection', 'GetInstanceFeatureGate', 'GetNodeGroupFeatureGate', 'ListOperationActivity', 'ListOperationHistory', 'ListSSLDetails', 'ModifyDiskType', 'ModifyHostAlias', 'ModifyMaintainableTime', 'ModifySpecType', 'ModifySpecTypePreCheck', 'QueryEnableMultiAzPrice', 'QueryMinorVersion', 'QueryModifyChargeTypePrice', 'QueryModifyCuPrice', 'QueryModifyDiskNumberPrice', 'QueryModifyDiskPerformanceLevelPrice',
+ 'QueryModifyDiskSizePrice', 'QueryModifyDiskTypePrice', 'QueryModifyNodeNumberPrice', 'QueryModifySpecTypePrice', 'QueryPriceV1', 'QueryRefundPrice', 'QueryRenewPrice', 'RebootECS', 'UpdateBackupPolicy', 'UpdateInnerIpWhitelistGroup', 'UpdateNodeGroupDescription', 'ChangeResourceGroup', 'CreateScalingRule', 'CreateServiceLinkedRole', 'DeleteBackup', 'DeleteBackupPolicy', 'DeleteGateway', 'DeleteScalingRule', 'DescribeAvailableZones', 'DescribeBackupPolicies',
+ 'DescribeBackups', 'DescribeInstanceConfigs', 'DescribeInstances', 'DescribeRegions', 'ListGateway', 'ModifyChargeType', 'ModifyInstanceConfig', 'ModifyScalingRule', 'ReleaseInstance', 'RenewInstance', 'RestartInstance', 'RestoreInstance', 'ResumeInstance', 'TagResources', 'UnTagResources', 'UpdateGateway', 'UpdateInstanceName', 'UpdatePublicNetworkStatus', 'UpgradeVersion',
],
+ 'type' => 'directory',
+ 'title' => '其他',
+ 'id' => 159870,
],
],
'components' => [
@@ -60,26 +50,10 @@
'title' => 'A short description of struct',
'type' => 'object',
'properties' => [
- 'nodeGroupId' => [
- 'title' => '计算组 ID，只有当参数为计算组独享参数时才需要，其他场景可以置为空或者设置为集群 ID。',
- 'type' => 'string',
- 'example' => 'ng-e24924dxxxxx',
- ],
- 'configType' => [
- 'title' => '配置类型。',
- 'type' => 'string',
- 'example' => 'BE',
- ],
- 'configKey' => [
- 'title' => '配置项名称。',
- 'type' => 'string',
- 'example' => 'storage_root_path',
- ],
- 'configValue' => [
- 'title' => '配置项的值。',
- 'type' => 'string',
- 'example' => 'value1',
- ],
+ 'nodeGroupId' => ['title' => '计算组 ID，只有当参数为计算组独享参数时才需要，其他场景可以置为空或者设置为集群 ID。', 'type' => 'string', 'example' => 'ng-e24924dxxxxx'],
+ 'configType' => ['title' => '配置类型。', 'type' => 'string', 'example' => 'BE'],
+ 'configKey' => ['title' => '配置项名称。', 'type' => 'string', 'example' => 'storage_root_path'],
+ 'configValue' => ['title' => '配置项的值。', 'type' => 'string', 'example' => 'value1'],
],
],
'ResourceSpec' => [
@@ -87,73 +61,500 @@
'description' => '资源规格。',
'type' => 'object',
'properties' => [
- 'cu' => [
- 'title' => 'cu',
- 'description' => 'CU数量。CU (Compute Unit) 是服务的基本计量单元，1 CU=1 核 CPU+4GiB 内存 。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
+ 'cu' => ['title' => 'cu', 'description' => 'CU数量。CU (Compute Unit) 是服务的基本计量单元，1 CU=1 核 CPU+4GiB 内存 。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'storageSize' => ['title' => '存储大小', 'description' => '存储大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'nodeNumber' => ['title' => '节点数', 'description' => '节点数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'storagePerformanceLevel' => ['title' => '云盘的性能级别', 'description' => '云盘的性能级别。包含以下取值：'."\n"
+ .'- pl0：单盘最高随机读写 IOPS 1 万。'."\n"
+ .'- pl1：单盘最高随机读写 IOPS 5 万。'."\n"
+ .'- pl2：单盘最高随机读写 IOPS 10 万。'."\n"
+ .'- pl3：单盘最高随机读写 IOPS 100 万。', 'type' => 'string', 'example' => 'pl1'],
+ 'localStorageInstanceType' => ['title' => '本地盘的机型', 'description' => '节点组本地SSD实例规格, 仅在基于Ecs实例且SpecType为本地SSD/大规格存储时该值才有意义。', 'type' => 'string', 'example' => 'local_ssd_4_4xlarge'],
+ 'specType' => ['title' => '规格类型', 'description' => '节点组规格类型。包括以下类型：'."\n"
+ .'- standard，标准版，ECS + 云盘。'."\n"
+ .'- localSSD ，本地SSD。'."\n"
+ .'- bigData，大规格存储。', 'type' => 'string', 'example' => 'standard'],
+ 'diskNumber' => ['title' => '磁盘块数', 'description' => '磁盘块数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ ],
+ ],
+ ],
+ 'apis' => [
+ 'AddBackupPolicy' => [
+ 'path' => '/webapi/backupRestore/policy/add',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '250705',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求参数信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => '实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-0104730e9de40215'],
+ 'RecurrenceType' => [
+ 'description' => '指定时间规则的执行类型。取值范围：'."\n"
+ .'- DAILY：按天重复。'."\n"
+ .'- WEEKLY：按周重复。'."\n"
+ .'- MONTHLY：按月重复。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'MONTHLY',
+ 'enum' => ['Once', 'Daily', 'Weekly', 'Monthly'],
+ ],
+ 'RecurrenceValues' => [
+ 'description' => '策略执行周期的数值。',
+ 'type' => 'array',
+ 'items' => ['description' => '策略执行周期的数值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '31', 'minimum' => '1', 'example' => '1'],
+ 'required' => false,
+ ],
+ 'Hour' => ['description' => '小时。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '23', 'minimum' => '0', 'example' => '2', 'default' => '0'],
+ 'Minute' => ['description' => '分钟。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '59', 'minimum' => '0', 'example' => '30', 'default' => '0'],
+ 'ExpireDays' => ['description' => '备份数据有效天数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7'],
+ 'TimeoutSeconds' => ['description' => '备份任务超时时间。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3600'],
+ ],
+ 'required' => false,
],
- 'storageSize' => [
- 'title' => '存储大小',
- 'description' => '存储大小。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]'],
+ 'Data' => ['description' => '返回结果。', 'type' => 'boolean', 'example' => 'true'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
],
- 'nodeNumber' => [
- 'title' => '节点数',
- 'description' => '节点数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'storagePerformanceLevel' => [
- 'title' => '云盘的性能级别',
- 'description' => '云盘的性能级别。包含以下取值：'."\n"
- .'- pl0：单盘最高随机读写 IOPS 1 万。'."\n"
- .'- pl1：单盘最高随机读写 IOPS 5 万。'."\n"
- .'- pl2：单盘最高随机读写 IOPS 10 万。'."\n"
- .'- pl3：单盘最高随机读写 IOPS 100 万。',
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => '新增备份策略',
+ 'summary' => '新增备份策略',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:AddBackupPolicy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'AddGateway' => [
+ 'path' => '/webapi/gateway/add',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '270146',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'GatewayName',
+ 'in' => 'query',
+ 'schema' => ['description' => '私有网关别名。', 'type' => 'string', 'required' => false, 'example' => 'eas_automation_test'],
+ ],
+ [
+ 'name' => 'FeNodeNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '网关节点数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'."\n"],
+ 'Data' => ['description' => '返回数据。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '新增网关',
+ 'summary' => '新建网关',
+ 'description' => '新增网关支持软件栈版本大于等于1.7.6，要求FE节点数量大于等于3',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sr:AddGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\\\n\\",\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'ChangeResourceGroup' => [
+ 'path' => '/webapi/resourceGroup/change',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '233515',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'NewResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['title' => '目标资源组', 'description' => '目标资源组ID。', 'type' => 'string', 'required' => true, 'example' => 'rg-4352gdf****'],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '地域Id', 'description' => '集群所在的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ 'schema' => ['description' => '资源类型，目前仅支持instance。', 'type' => 'string', 'required' => true, 'example' => 'instance'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'c-1854345****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '是否转组成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '修改资源组',
+ 'summary' => '本接口用于修改 Serverless StarRocks 实例的资源组。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sr:ChangeResourceGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Success\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'CheckInventory' => [
+ 'path' => '/webapi/check/inventory',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '158062',
+ 'abilityTreeNodes' => ['FEATUREemapreduce6STB1S'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ZoneId',
+ 'in' => 'query',
+ 'schema' => ['description' => '可用区。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h'],
+ ],
+ [
+ 'name' => 'ClusterInfo',
+ 'in' => 'query',
+ 'schema' => ['description' => '集群信息', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
+ .' "clusterType": "sr",'."\n"
+ .' "regionId": "cn-hangzhou",'."\n"
+ .' "packageType": "official",'."\n"
+ .' "runMode": "shared_data",'."\n"
+ .' "beResourceSpec": {'."\n"
+ .' "cu": 8,'."\n"
+ .' "storageSize": 200,'."\n"
+ .' "nodeNumber": 3,'."\n"
+ .' "diskNumber": 1,'."\n"
+ .' "storagePerformanceLevel": "pl1",'."\n"
+ .' "diskType": "essd",'."\n"
+ .' "specType": "standard"'."\n"
+ .' },'."\n"
+ .' "feResourceSpec": {'."\n"
+ .' "cu": 8,'."\n"
+ .' "storageSize": 100,'."\n"
+ .' "nodeNumber": 3,'."\n"
+ .' "specType": "standard"'."\n"
+ .' }'."\n"
+ .'}'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'."\n"],
+ 'Data' => ['description' => '返回数据。', 'type' => 'boolean', 'example' => 'true'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '校验资源库存',
+ 'summary' => '校验资源库存',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:CheckInventory',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\\\n\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'CreateAgentResource' => [
+ 'path' => '/webapi/lifecycle/createAgentNodeGroup',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '250696',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PayType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '付费类型：'."\n"
+ .'<ol>'."\n"
+ .'<li>包年包月（prePaid）。</li>'."\n"
+ .'<li>按量付费（postPaid）。</li>'."\n"
+ .'</ol>'."\n"
+ .' '."\n"
+ .' ',
'type' => 'string',
- 'example' => 'pl1',
+ 'required' => true,
+ 'example' => 'prePay',
+ 'enum' => ['postPaid', 'prePaid'],
],
- 'localStorageInstanceType' => [
- 'title' => '本地盘的机型',
- 'description' => '节点组本地SSD实例规格, 仅在基于Ecs实例且SpecType为本地SSD/大规格存储时该值才有意义。',
+ ],
+ [
+ 'name' => 'Duration',
+ 'in' => 'query',
+ 'schema' => ['description' => '购买时长。仅在 payType 为 PrePaid 时有意义。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '12', 'minimum' => '1', 'example' => '2'],
+ ],
+ [
+ 'name' => 'PricingCycle',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '购买时长单位：'."\n"
+ .'<ul>'."\n"
+ .'<li> 月（Month）</li>'."\n"
+ .'<li> 年（Year）</li>'."\n"
+ .'</ul>'."\n"
+ .'仅在 payType 为 PrePaid 时有意义。',
'type' => 'string',
- 'example' => 'local_ssd_4_4xlarge',
- ],
- 'specType' => [
- 'title' => '规格类型',
- 'description' => '节点组规格类型。包括以下类型：'."\n"
- .'- standard，标准版，ECS + 云盘。'."\n"
- .'- localSSD ，本地SSD。'."\n"
- .'- bigData，大规格存储。',
+ 'required' => false,
+ 'example' => 'Month',
+ 'enum' => ['Month', 'Year'],
+ ],
+ ],
+ [
+ 'name' => 'AutoRenew',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否开启自动续费，仅在 payType 为 PrePaid 时有意义。默认不开启。', 'type' => 'boolean', 'required' => false, 'example' => 'True', 'default' => 'false'],
+ ],
+ [
+ 'name' => 'SpecType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '计算组规格类型。',
'type' => 'string',
+ 'required' => false,
'example' => 'standard',
+ 'enum' => ['standard'],
],
- 'diskNumber' => [
- 'title' => '磁盘块数',
- 'description' => '磁盘块数。',
+ ],
+ [
+ 'name' => 'Cu',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'CU数量。CU (Compute Unit) 是服务的基本计量单元，1 CU=1 核 CPU+4GiB 内存，仅在 SpecType 为内存增强型时 1 CU=1 核 CPU+8GiB 内存。',
'type' => 'integer',
'format' => 'int32',
- 'example' => '1',
+ 'required' => true,
+ 'maximum' => '16',
+ 'minimum' => '2',
+ 'example' => '2',
+ 'enum' => ['2', '4', '8', '16'],
],
],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'PromotionOptionNo',
+ 'in' => 'query',
+ 'schema' => ['description' => '优惠券ID。', 'type' => 'string', 'required' => false, 'example' => '2345'],
+ ],
],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'B67D142D-D54E-184F-A306-22BDC01B2XXX'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OrderId' => ['description' => '订单ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '241526000650XXX'],
+ 'NodeGroupId' => ['description' => '计算组 ID。', 'type' => 'string', 'example' => 'ng-5e2ba600fee3****'],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建Agent计算组',
+ 'summary' => '创建Agent计算组',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:CreateAgentResource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"B67D142D-D54E-184F-A306-22BDC01B2XXX\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": {\\n \\"OrderId\\": 0,\\n \\"NodeGroupId\\": \\"ng-5e2ba600fee3****\\"\\n }\\n}","type":"json"}]',
],
- ],
- 'apis' => [
'CreateInstanceV1' => [
- 'summary' => '本接口用于创建 Serverless StarRocks 实例。',
'path' => '/webapi/cluster/createV1',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -166,9 +567,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '240406',
- 'abilityTreeNodes' => [
- 'FEATUREemapreduceUHHTB7',
- ],
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
],
'parameters' => [
[
@@ -180,35 +579,10 @@
'description' => '请求结构体。',
'type' => 'object',
'properties' => [
- 'InstanceName' => [
- 'title' => '实例名称。',
- 'description' => '实例名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c1',
- ],
- 'AdminPassword' => [
- 'title' => '实例管理员密码。',
- 'description' => '实例管理员密码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'password_example',
- ],
- 'Version' => [
- 'title' => '实例主版本。',
- 'description' => '实例主版本。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '3',
- ],
- 'AutoRenew' => [
- 'title' => '是否开启自动续费，仅在 payType 为 PrePaid 时有意义。默认不开启。',
- 'description' => '是否开启自动续费，仅在 payType 为 PrePaid 时有意义。默认不开启。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'false',
- ],
+ 'InstanceName' => ['title' => '实例名称。', 'description' => '实例名称。', 'type' => 'string', 'required' => true, 'example' => 'c1'],
+ 'AdminPassword' => ['title' => '实例管理员密码。', 'description' => '实例管理员密码。', 'type' => 'string', 'required' => true, 'example' => 'password_example'],
+ 'Version' => ['title' => '实例主版本。', 'description' => '实例主版本。', 'type' => 'string', 'required' => true, 'example' => '3'],
+ 'AutoRenew' => ['title' => '是否开启自动续费，仅在 payType 为 PrePaid 时有意义。默认不开启。', 'description' => '是否开启自动续费，仅在 payType 为 PrePaid 时有意义。默认不开启。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
'RunMode' => [
'title' => '集群的运行模式：'."\n"
.' - 存算一体（shared_nothing）。'."\n"
@@ -222,19 +596,9 @@
'type' => 'string',
'required' => true,
'example' => 'shared_data',
- 'enum' => [
- 'lakehouse',
- 'shared_nothing',
- 'shared_data',
- ],
- ],
- 'RegionId' => [
- 'title' => '地域 ID。',
- 'description' => '地域 ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
+ 'enum' => ['lakehouse', 'shared_nothing', 'shared_data'],
],
+ 'RegionId' => ['title' => '地域 ID。', 'description' => '地域 ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
'PackageType' => [
'title' => '实例系列：'."\n"
.' 入门版（trial）。'."\n"
@@ -247,10 +611,7 @@
'type' => 'string',
'required' => true,
'example' => 'official',
- 'enum' => [
- 'official',
- 'trial',
- ],
+ 'enum' => ['official', 'trial'],
],
'PayType' => [
'title' => '付费类型：'."\n"
@@ -270,18 +631,9 @@
'type' => 'string',
'required' => true,
'example' => 'prePaid',
- 'enum' => [
- 'prePaid',
- 'postPaid',
- ],
- ],
- 'VpcId' => [
- 'title' => 'VPC ID。',
- 'description' => 'VPC ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vpc-bp1fll2mci6d7pw8m****',
+ 'enum' => ['prePaid', 'postPaid'],
],
+ 'VpcId' => ['title' => 'VPC ID。', 'description' => 'VPC ID。', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp1fll2mci6d7pw8m****'],
'PricingCycle' => [
'title' => '购买时长单位：'."\n"
.' 月（Month）'."\n"
@@ -296,10 +648,7 @@
'type' => 'string',
'required' => false,
'example' => 'Month',
- 'enum' => [
- 'Month',
- 'Year',
- ],
+ 'enum' => ['Month', 'Year'],
],
'VSwitches' => [
'title' => 'VSwitch 信息和可用区信息。',
@@ -309,47 +658,16 @@
'description' => '交换机信息。',
'type' => 'object',
'properties' => [
- 'VswId' => [
- 'title' => '交换机 ID。',
- 'description' => '交换机 ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vsw-bp19mlh98tm9teyyd****',
- ],
- 'ZoneId' => [
- 'description' => '交换机可用区 ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou-i',
- ],
+ 'VswId' => ['title' => '交换机 ID。', 'description' => '交换机 ID。', 'type' => 'string', 'required' => true, 'example' => 'vsw-bp19mlh98tm9teyyd****'],
+ 'ZoneId' => ['description' => '交换机可用区 ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i'],
],
'required' => false,
],
'required' => false,
],
- 'ZoneId' => [
- 'title' => '可用区 ID。',
- 'description' => '主可用区 ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou-i',
- ],
- 'OssAccessingRoleName' => [
- 'title' => '用于免密访问OSS的角色名称。',
- 'description' => '用于免密访问OSS的角色名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AliyunEMRStarRocksAccessingOSSRole',
- 'default' => 'AliyunEMRStarRocksAccessingOSSRole',
- ],
- 'Duration' => [
- 'title' => '购买时长。仅在 payType 为 PrePaid 时有意义。',
- 'description' => '购买时长。仅在 payType 为 PrePaid 时有意义。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'ZoneId' => ['title' => '可用区 ID。', 'description' => '主可用区 ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-i'],
+ 'OssAccessingRoleName' => ['title' => '用于免密访问OSS的角色名称。', 'description' => '用于免密访问OSS的角色名称。', 'type' => 'string', 'required' => false, 'example' => 'AliyunEMRStarRocksAccessingOSSRole', 'default' => 'AliyunEMRStarRocksAccessingOSSRole'],
+ 'Duration' => ['title' => '购买时长。仅在 payType 为 PrePaid 时有意义。', 'description' => '购买时长。仅在 payType 为 PrePaid 时有意义。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'Tags' => [
'title' => '实例标签。',
'description' => '实例标签。',
@@ -359,39 +677,15 @@
'description' => '标签结构体。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'title' => '标签键。',
- 'description' => '标签键。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'k1',
- ],
- 'Value' => [
- 'title' => '标签值。',
- 'description' => '标签值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'v1',
- ],
+ 'Key' => ['title' => '标签键。', 'description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'k1'],
+ 'Value' => ['title' => '标签值。', 'description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'v1'],
],
'required' => false,
],
'required' => false,
],
- 'ResourceGroupId' => [
- 'title' => '资源组 ID。',
- 'description' => '资源组 ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aekzllkih7jqxxx',
- ],
- 'ClientToken' => [
- 'title' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。',
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123e4567-e89b-12d3-a456-426655440000',
- ],
+ 'ResourceGroupId' => ['title' => '资源组 ID。', 'description' => '资源组 ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzllkih7jqxxx'],
+ 'ClientToken' => ['title' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。', 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
'ObserverNodeGroups' => [
'description' => 'Observer计算组信息。仅在需要开启多可用区容灾时填写该字段，且 Observer 的配置必须和 FE 节点组的规格保持一致。',
'type' => 'array',
@@ -399,58 +693,14 @@
'description' => 'Observer计算组信息。',
'type' => 'object',
'properties' => [
- 'cu' => [
- 'description' => 'CU数量。CU (Compute Unit) 是服务的基本计量单元，1 CU=1 核 CPU+4GiB 内存。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '8',
- ],
- 'storageSize' => [
- 'description' => '存储大小。单位为 GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
- ],
- 'storagePerformanceLevel' => [
- 'description' => '云盘的性能级别。仅支持 pl1，单盘最高随机读写 IOPS 5 万。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'pl1',
- ],
- 'diskNumber' => [
- 'description' => '磁盘数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'residentNodeNumber' => [
- 'description' => '节点数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
- 'specType' => [
- 'description' => '计算组规格类型。仅支持标准版（standard）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'standard',
- ],
- 'localStorageInstanceType' => [
- 'description' => '本地SSD实例规格，Observer 计算组无需设置该字段。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'zoneId' => [
- 'description' => '可用区ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou-i',
- ],
+ 'cu' => ['description' => 'CU数量。CU (Compute Unit) 是服务的基本计量单元，1 CU=1 核 CPU+4GiB 内存。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8'],
+ 'storageSize' => ['description' => '存储大小。单位为 GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
+ 'storagePerformanceLevel' => ['description' => '云盘的性能级别。仅支持 pl1，单盘最高随机读写 IOPS 5 万。', 'type' => 'string', 'required' => false, 'example' => 'pl1'],
+ 'diskNumber' => ['description' => '磁盘数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'residentNodeNumber' => ['description' => '节点数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
+ 'specType' => ['description' => '计算组规格类型。仅支持标准版（standard）。', 'type' => 'string', 'required' => false, 'example' => 'standard'],
+ 'localStorageInstanceType' => ['description' => '本地SSD实例规格，Observer 计算组无需设置该字段。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'zoneId' => ['description' => '可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i'],
],
'required' => false,
],
@@ -463,20 +713,8 @@
'description' => 'BE 或者 CN 计算组信息。',
'type' => 'object',
'properties' => [
- 'cu' => [
- 'description' => 'CU数量。CU (Compute Unit) 是服务的基本计量单元，1 CU=1 核 CPU+4GiB 内存，仅在 SpecType 为内存增强型时 1 CU=1 核 CPU+8GiB 内存。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '8',
- ],
- 'storageSize' => [
- 'description' => '存储大小。单位为 GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
- ],
+ 'cu' => ['description' => 'CU数量。CU (Compute Unit) 是服务的基本计量单元，1 CU=1 核 CPU+4GiB 内存，仅在 SpecType 为内存增强型时 1 CU=1 核 CPU+8GiB 内存。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8'],
+ 'storageSize' => ['description' => '存储大小。单位为 GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
'storagePerformanceLevel' => [
'description' => '云盘的性能级别。包含以下取值：'."\n"
."\n"
@@ -487,28 +725,10 @@
'type' => 'string',
'required' => false,
'example' => 'pl1',
- 'enum' => [
- 'pl0',
- 'pl1',
- 'pl2',
- 'pl3',
- ],
- ],
- 'diskNumber' => [
- 'description' => '磁盘数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '1',
- ],
- 'residentNodeNumber' => [
- 'description' => '节点数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
+ 'enum' => ['pl0', 'pl1', 'pl2', 'pl3'],
],
+ 'diskNumber' => ['description' => '磁盘数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '1'],
+ 'residentNodeNumber' => ['description' => '节点数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
'specType' => [
'description' => '计算组规格类型。包括以下类型：'."\n"
."\n"
@@ -520,27 +740,10 @@
'type' => 'string',
'required' => false,
'example' => 'standard',
- 'enum' => [
- 'standard',
- 'ramEnhanced',
- 'networkEnhanced',
- 'bigData',
- 'localSSD',
- 'cpuEnhanced',
- ],
- ],
- 'localStorageInstanceType' => [
- 'description' => '节点组本地SSD实例规格, 仅在基于Ecs实例且SpecType为本地SSD/大规格存储时该值才有意义。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'local_ssd_4_4xlarge',
- ],
- 'zoneId' => [
- 'description' => '可用区ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou-i',
+ 'enum' => ['standard', 'ramEnhanced', 'networkEnhanced', 'bigData', 'localSSD', 'cpuEnhanced'],
],
+ 'localStorageInstanceType' => ['description' => '节点组本地SSD实例规格, 仅在基于Ecs实例且SpecType为本地SSD/大规格存储时该值才有意义。', 'type' => 'string', 'required' => false, 'example' => 'local_ssd_4_4xlarge'],
+ 'zoneId' => ['description' => '可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i'],
],
'required' => false,
],
@@ -552,134 +755,45 @@
'items' => [
'type' => 'object',
'properties' => [
- 'cu' => [
- 'description' => 'CU数量。CU (Compute Unit) 是服务的基本计量单元，1 CU=1 核 CPU+4GiB 内存。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '8',
- ],
- 'storageSize' => [
- 'description' => '存储大小。单位为 GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
- ],
- 'storagePerformanceLevel' => [
- 'description' => '云盘的性能级别。仅支持 pl1，单盘最高随机读写 IOPS 5 万。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'pl1',
- ],
- 'diskNumber' => [
- 'description' => '磁盘数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'residentNodeNumber' => [
- 'description' => '节点数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
+ 'cu' => ['description' => 'CU数量。CU (Compute Unit) 是服务的基本计量单元，1 CU=1 核 CPU+4GiB 内存。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8'],
+ 'storageSize' => ['description' => '存储大小。单位为 GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
+ 'storagePerformanceLevel' => ['description' => '云盘的性能级别。仅支持 pl1，单盘最高随机读写 IOPS 5 万。', 'type' => 'string', 'required' => false, 'example' => 'pl1'],
+ 'diskNumber' => ['description' => '磁盘数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'residentNodeNumber' => ['description' => '节点数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
'specType' => [
'description' => '计算组规格类型。仅支持标准版（standard）。',
'type' => 'string',
'required' => false,
'example' => 'standard',
- 'enum' => [
- 'standard',
- 'ramEnhanced',
- ],
- ],
- 'localStorageInstanceType' => [
- 'description' => '本地SSD实例规格，FE计算组无需设置该字段。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- 'zoneId' => [
- 'description' => '可用区ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou-i',
+ 'enum' => ['standard', 'ramEnhanced'],
],
+ 'localStorageInstanceType' => ['description' => '本地SSD实例规格，FE计算组无需设置该字段。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ 'zoneId' => ['description' => '可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i'],
],
'required' => false,
+ 'description' => '',
],
'required' => false,
],
- 'PromotionOptionNo' => [
- 'description' => '优惠券ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '165445235634',
- ],
- 'Encrypted' => [
- 'description' => '是否加密。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'KmsKeyId' => [
- 'description' => 'KMS密钥ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'fdsdf****',
- ],
- 'GatewayType' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'PromotionOptionNo' => ['description' => '优惠券ID。', 'type' => 'string', 'required' => false, 'example' => '165445235634'],
+ 'Encrypted' => ['description' => '是否加密。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'KmsKeyId' => ['description' => 'KMS密钥ID。', 'type' => 'string', 'required' => false, 'example' => 'fdsdf****'],
+ 'GatewayType' => ['type' => 'string', 'required' => false, 'description' => ''],
'AgentNodeGroup' => [
'type' => 'object',
'properties' => [
- 'cu' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
+ 'cu' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
],
'required' => false,
- ],
- 'AutoPay' => [
- 'type' => 'boolean',
- 'required' => false,
- ],
- 'LinkedRamUserName' => [
- 'title' => '关联的RAM用户名称或者RAM角色名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aliyun.test1',
- ],
- 'DlfCatalogName' => [
- 'title' => 'DLF Catalog名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'paimon_test',
- ],
- 'DlfCatalogType' => [
- 'title' => 'DLF Catalog类型，paimon或者iceberg',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'paimon',
- ],
- 'PrincipalType' => [
- 'title' => 'RAM认证类型。RAM用户为RS，RAM角色为RR',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'RR',
- ],
- 'RamUserId' => [
- 'title' => 'RAM用户ID或者RAM角色ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123456',
- ],
+ 'description' => '',
+ ],
+ 'AutoPay' => ['type' => 'boolean', 'required' => false, 'description' => ''],
+ 'LinkedRamUserName' => ['type' => 'string', 'example' => 'aliyun.test1'],
+ 'DlfCatalogName' => ['type' => 'string', 'example' => 'paimon_test'],
+ 'DlfCatalogType' => ['type' => 'string', 'example' => 'paimon'],
+ 'PrincipalType' => ['type' => 'string', 'example' => 'RR'],
+ 'RamUserId' => ['type' => 'string', 'example' => '123456'],
+ 'EnableMultiAz' => ['type' => 'boolean'],
],
'required' => false,
],
@@ -690,84 +804,165 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'HttpStatusCode' => [
- 'title' => 'HTTP请求状态码。',
- 'description' => 'HTTP请求状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'title' => '请求 ID。',
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => 'B67D142D-D54E-184F-A306-22BDC01B2XXX',
- ],
- 'Success' => [
- 'title' => '请求是否成功。',
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrCode' => [
- 'title' => '错误码。',
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'InvalidParams',
- ],
- 'ErrMessage' => [
- 'title' => '错误信息。',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]',
- ],
+ 'HttpStatusCode' => ['title' => 'HTTP请求状态码。', 'description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['title' => '请求 ID。', 'description' => '请求 ID。', 'type' => 'string', 'example' => 'B67D142D-D54E-184F-A306-22BDC01B2XXX'],
+ 'Success' => ['title' => '请求是否成功。', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'ErrCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['title' => '错误信息。', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]'],
'Data' => [
'title' => '返回数据。',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'OrderId' => [
- 'title' => '订单 ID。',
- 'description' => '订单 ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '241526000650XXX',
- ],
- 'InstanceId' => [
- 'title' => '实例 ID。',
- 'description' => '实例 ID。',
- 'type' => 'string',
- 'example' => 'c-b25e21e243889XXX',
- ],
+ 'OrderId' => ['title' => '订单 ID。', 'description' => '订单 ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '241526000650XXX'],
+ 'InstanceId' => ['title' => '实例 ID。', 'description' => '实例 ID。', 'type' => 'string', 'example' => 'c-b25e21e243889XXX'],
],
],
- 'AccessDeniedDetail' => [
- 'title' => '权限校验失败详情。',
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }',
- ],
+ 'AccessDeniedDetail' => ['title' => '权限校验失败详情。', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"B67D142D-D54E-184F-A306-22BDC01B2XXX\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]\\",\\n \\"Data\\": {\\n \\"OrderId\\": 0,\\n \\"InstanceId\\": \\"c-b25e21e243889XXX\\"\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
'title' => '创建实例',
+ 'summary' => '本接口用于创建 Serverless StarRocks 实例。',
'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[计费项](https://help.aliyun.com/zh/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c4g.11186623.help-menu-28066.d_0_1_1.4db82b05p3Gg0G)</props><props="intl">[计费项](https://www.alibabacloud.com/help/en/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c63.p38356.help-menu-28066.d_0_1_0.3aaf4b0b69jN1P)</props>。',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-12T07:46:43.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-07-30T11:08:03.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sr:CreateInstanceV1',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"B67D142D-D54E-184F-A306-22BDC01B2XXX\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]\\",\\n \\"Data\\": {\\n \\"OrderId\\": 0,\\n \\"InstanceId\\": \\"c-b25e21e243889XXX\\"\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
],
- 'RestartInstance' => [
- 'summary' => '本接口用于重启 Serverless StarRocks 实例。',
- 'path' => '/webapi/starrocks/restartCluster',
- 'methods' => [
- 'post',
+ 'CreateScalingRule' => [
+ 'summary' => '新建一条弹性规则',
+ 'path' => '/webapi/scalingRule/createScalingRule',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '278814',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ [
+ 'name' => 'TriggerType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '触发类型',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'TIME_TRIGGER',
+ 'enum' => ['TIME_TRIGGER'],
+ ],
+ ],
+ [
+ 'name' => 'Rule',
+ 'in' => 'query',
+ 'schema' => ['description' => '规则内容。', 'type' => 'string', 'required' => true, 'example' => '{'."\n"
+ .' "nodeNumber": 1,'."\n"
+ .' "scalingRuleName": "test1",'."\n"
+ .' "scalingOutRule": {'."\n"
+ .' "year": 2026,'."\n"
+ .' "month": 3,'."\n"
+ .' "day": 2,'."\n"
+ .' "hour": 5,'."\n"
+ .' "minute": 50,'."\n"
+ .' "second": 0,'."\n"
+ .' "recurrenceInterval": 1,'."\n"
+ .' "recurrenceType": "DAILY",'."\n"
+ .' "recurrenceValues": null'."\n"
+ .' },'."\n"
+ .' "scalingInRule": {'."\n"
+ .' "year": 2026,'."\n"
+ .' "month": 3,'."\n"
+ .' "day": 2,'."\n"
+ .' "hour": 6,'."\n"
+ .' "minute": 50,'."\n"
+ .' "second": 0,'."\n"
+ .' "recurrenceInterval": 1,'."\n"
+ .' "recurrenceType": "DAILY",'."\n"
+ .' "recurrenceValues": null'."\n"
+ .' }'."\n"
+ .'}'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'boolean', 'example' => 'true'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '新建弹性规则',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:CreateScalingRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'CreateServiceLinkedRole' => [
+ 'summary' => '该接口用于为用户创建 AliyunServiceRoleForEMRStarRocks 角色。',
+ 'path' => '/webapi/user/create_default_role',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -777,33 +972,152 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
- 'abilityTreeCode' => '189752',
- 'abilityTreeNodes' => [
- 'FEATUREemapreduceUHHTB7',
+ 'abilityTreeCode' => '163986',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
+ 'Total' => ['description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'Data' => ['description' => '创建角色是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
],
],
+ 'title' => '创建服务角色',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:CreateServiceLinkedRole',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"null\\",\\n \\"Total\\": 3,\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteBackup' => [
+ 'path' => '/webapi/backup/manage/delete',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '250728',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
'parameters' => [
[
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'BackupTaskId',
+ 'in' => 'query',
+ 'schema' => ['description' => '备份任务ID', 'type' => 'string', 'required' => true, 'example' => 'bk-yi2378sdhf2'],
+ ],
+ [
'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '实例 ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c-b25e21e24388****',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => '删除数据备份',
+ 'summary' => '删除数据备份',
+ 'description' => '删除数据备份',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'FastMode',
- 'in' => 'query',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:DeleteBackup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"null\\",\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'DeleteBackupPolicy' => [
+ 'path' => '/webapi/backupRestore/policy/delete',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '250713',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'description' => '是否以快速重启模式重启。默认为false。'."\n"
- .'- true：以快速重启模式重启计算节点。分为多个批次重启计算节点，批次内并行重启，批次间串行执行；'."\n"
- .'- false：以滚动重启模式重启计算节点。',
- 'type' => 'boolean',
+ 'description' => '请求结构体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => '实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-0104730e9d*****'],
+ 'PolicyId' => ['description' => '策略ID。', 'type' => 'string', 'required' => false, 'example' => 'bp-298ahiu289'],
+ ],
'required' => false,
- 'example' => 'true',
- 'default' => 'false',
],
],
],
@@ -812,87 +1126,226 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'HttpStatusCode' => [
- 'description' => 'HTTP请求状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ErrCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'InvalidParams',
- ],
- 'ErrMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Unsupported.Non.Whitelist.Operation',
- ],
- 'Data' => [
- 'description' => '返回数据。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'AccessDeniedDetail' => [
- 'title' => 'AccessDeniedDetail',
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }',
- ],
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'."\n"],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'boolean', 'example' => 'true'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Unsupported.Non.Whitelist.Operation\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
- 'title' => '重启实例',
- 'description' => '该接口为异步接口，实例的重启不是立即完成的，成功调用后，实例会先进入重启中（restarting）状态，当返回的状态为运行中（running）时代表重启成功。',
- ],
- 'ReleaseInstance' => [
- 'summary' => '本接口仅用于释放 Serverless StarRocks 按量付费实例。包年包月实例请到用户中心退订管理页进行退订。',
- 'path' => '/webapi/cluster/release',
- 'methods' => [
- 'post',
+ 'title' => '删除备份策略',
+ 'summary' => '删除备份策略',
+ 'description' => '删除备份策略。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:DeleteBackupPolicy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\\\n\\",\\n \\"ErrMessage\\": \\"null\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteGateway' => [
+ 'path' => '/webapi/gateway/delete',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
- 'abilityTreeCode' => '173986',
- 'abilityTreeNodes' => [
- 'FEATUREemapreduceUHHTB7',
- ],
+ 'abilityTreeCode' => '270150',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'GatewayId',
+ 'in' => 'query',
+ 'schema' => ['description' => '网关ID。', 'type' => 'string', 'required' => false, 'example' => 'dg-2r69r8kpmn56k5s3'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'boolean', 'example' => '24151320976****'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '删除网关',
+ 'summary' => '删除网关',
+ 'description' => '删除网关分组，删除之后网关下的FE节点自动划分到默认网关分组',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'sr:DeleteGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'DeleteInnerIpWhitelistGroup' => [
+ 'path' => '/webapi/securityGroup/delete',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '240832',
+ 'abilityTreeNodes' => ['FEATUREemapreduceRZEU20'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求参数信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-0104730e9de40215'],
+ 'InnerIpWhitelistGroupId' => ['description' => '内网白名单分组名称。', 'type' => 'string', 'required' => true, 'example' => 'test-g1', 'maxLength' => 120, 'minLength' => 2, 'pattern' => '^[a-z][a-z0-9_]*[a-z0-9]$'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]'],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => '删除内网白名单分组',
+ 'summary' => '删除内网白名单分组',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:DeleteInnerIpWhitelistGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteScalingRule' => [
+ 'path' => '/webapi/scalingRule/deleteScalingRule',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '278775',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ [
+ 'name' => 'ScalingRuleId',
+ 'in' => 'query',
+ 'schema' => ['description' => '待删除伸缩规则的ID。', 'type' => 'string', 'required' => true, 'example' => 'r-d01a1cac4081s****'],
+ ],
+ [
+ 'name' => 'TriggerType',
+ 'in' => 'query',
'schema' => [
- 'description' => '实例ID。',
+ 'description' => '触发类型',
'type' => 'string',
'required' => true,
- 'example' => 'c-b25e21e24388****',
+ 'example' => 'TIME_TRIGGER',
+ 'enum' => ['TIME_TRIGGER'],
],
],
],
@@ -901,63 +1354,109 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'HttpStatusCode' => [
- 'description' => 'HTTP请求状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ErrCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'InvalidParams',
- ],
- 'ErrMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Invalid params: [instance not exists].',
- ],
- 'Data' => [
- 'description' => '返回数据。',
- 'type' => 'boolean',
- ],
- 'AccessDeniedDetail' => [
- 'title' => 'AccessDeniedDetail',
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }',
- ],
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'."\n"],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
+ 'Data' => ['description' => '可升级的版本号。', 'type' => 'boolean', 'example' => '24151320976****'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除弹性规则',
+ 'summary' => '删除一条弹性规则',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
- 'title' => '释放实例',
- 'description' => '><danger>释放实例后，实例所使用的物理资源都被回收，相关数据全部丢失且不可恢复。></danger>',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:DeleteScalingRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\\\n\\",\\n \\"ErrMessage\\": \\"null\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
],
- 'UpdateInstanceName' => [
- 'summary' => '本接口用于修改 Serverless StarRocks 实例名称。',
- 'path' => '/webapi/cluster/update_name',
- 'methods' => [
- 'post',
+ 'DescribeAvailableZones' => [
+ 'path' => '/webapi/zone/describeZones',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '214130',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]'],
+ 'Data' => [
+ 'description' => '可用区列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TrialAvailableZones' => [
+ 'description' => '试用版。',
+ 'type' => 'array',
+ 'items' => ['description' => '可用区。', 'type' => 'string', 'example' => 'cn-hangzhou-h'],
+ ],
+ 'OfficialAvailableZones' => [
+ 'description' => '正式版。',
+ 'type' => 'array',
+ 'items' => ['description' => '可用区。', 'type' => 'string', 'example' => 'cn-hangzhou-h'],
+ ],
+ ],
+ ],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查看地域可用区列表',
+ 'summary' => '查看地域可用区列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"Success\\",\\n \\"ErrMessage\\": \\"Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]\\",\\n \\"Data\\": {\\n \\"TrialAvailableZones\\": [\\n \\"cn-hangzhou-h\\"\\n ],\\n \\"OfficialAvailableZones\\": [\\n \\"cn-hangzhou-h\\"\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeBackupPolicies' => [
+ 'path' => '/webapi/backupRestore/policy/describe',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -966,91 +1465,479 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '159094',
- 'abilityTreeNodes' => [
- 'FEATUREemapreduceUHHTB7',
- ],
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '250707',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
],
'parameters' => [
[
- 'name' => 'ClusterName',
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'PolicyId',
'in' => 'query',
+ 'schema' => ['description' => '策略ID。', 'type' => 'string', 'required' => false, 'example' => 'bk-policy-26ec5bc0ea67b5ef'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '新的实例名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'new_name',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]'],
+ 'Data' => [
+ 'description' => '实例信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => '实例 ID。', 'type' => 'string', 'example' => 'c-96f3bc7f04b2****'],
+ 'PolicyId' => ['description' => '标签策略ID。', 'type' => 'string', 'example' => '1'],
+ 'RecurrenceValues' => [
+ 'description' => '策略执行周期的数值。',
+ 'type' => 'array',
+ 'items' => ['description' => '策略执行周期的数值。'."\n"
+ .' <ul>'."\n"
+ .' <li>1: 周一</li>'."\n"
+ .' <li>2: 周二</li>'."\n"
+ .' <li>3: 周三</li>'."\n"
+ .' <li>4: 周四</li>'."\n"
+ .' <li>5: 周五</li>'."\n"
+ .' <li>6: 周六</li>'."\n"
+ .' <li>7: 周日</li>'."\n"
+ .' </ul>', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ 'Hour' => ['description' => '小时。', 'type' => 'string', 'example' => '2'],
+ 'Minute' => ['description' => '分钟。', 'type' => 'string', 'example' => '30'],
+ 'ExpireDays' => ['description' => '备份数据保留天数。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'],
+ 'TimeoutSeconds' => ['description' => '备份任务超时时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'],
+ ],
+ ],
+ ],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ 'Total' => ['description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => '获取备份策略详情',
+ 'summary' => '获取备份策略详情',
+ 'description' => '获取备份策略详情。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeBackupPolicies',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"c-96f3bc7f04b2****\\",\\n \\"PolicyId\\": \\"1\\",\\n \\"RecurrenceValues\\": [\\n 1\\n ],\\n \\"Hour\\": \\"2\\",\\n \\"Minute\\": \\"30\\",\\n \\"ExpireDays\\": 7,\\n \\"TimeoutSeconds\\": 3600\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\",\\n \\"Total\\": 100\\n}","type":"json"}]',
+ ],
+ 'DescribeBackups' => [
+ 'summary' => '获取备份详情',
+ 'path' => '/webapi/backup/manage/describe',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '250714',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
[
'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'BackupTaskId',
+ 'in' => 'query',
+ 'schema' => ['description' => '备份任务Id', 'type' => 'string', 'required' => false, 'example' => 'bt-2389hsdui12m'],
+ ],
+ [
+ 'name' => 'Statuses',
+ 'in' => 'query',
+ 'schema' => ['description' => '状态列表。', 'type' => 'string', 'required' => false, 'example' => 'COMPLETED'],
+ ],
+ [
+ 'name' => 'TimePeriodStartTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '备份任务查询开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1747708000'],
+ ],
+ [
+ 'name' => 'TimePeriodEndTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '备份任务查询结束时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1747728000'],
+ ],
+ [
+ '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' => [
- 'description' => '实例 ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c-b25e21e24388****',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'."\n"],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'InstanceId' => ['description' => '实例 ID。', 'type' => 'string', 'example' => 'c-d4be777ff5e8cXXX'],
+ 'Size' => ['description' => '云盘大小，单位为GiB。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'Status' => ['description' => '备份任务状态。', 'type' => 'string', 'example' => 'RUNNING'],
+ 'Description' => ['description' => '任务描述。', 'type' => 'string', 'example' => '任务描述'],
+ 'SubTasks' => [
+ 'description' => '备份子任务列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'StartTime' => ['description' => '任务开始日期。', 'type' => 'integer', 'format' => 'int64', 'example' => '1747708190'],
+ 'FinishedTime' => ['description' => '任务结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1747718190'],
+ 'SnapshotName' => ['description' => '快照名称。', 'type' => 'string', 'example' => '2025-02-10_backup'],
+ 'DataBase' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'test1'],
+ 'Table' => ['description' => '数据表名称。', 'type' => 'string', 'example' => 'cdc_ods_t2030_lcpf_api_topic_msg'],
+ 'Size' => ['description' => '数据大小。单位：GiB。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Status' => ['description' => '备份任务状态。', 'type' => 'string', 'example' => 'success'],
+ 'Detail' => ['description' => '快照ID。', 'type' => 'string', 'example' => '[]'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'BackupStartTime' => ['description' => '本次备份开始时间。 ', 'type' => 'integer', 'format' => 'int64', 'example' => '1742179018000'],
+ 'BackupFinishedTime' => ['description' => '本次备份结束时间。 ', 'type' => 'integer', 'format' => 'int64', 'example' => '1742179028000'],
+ 'ExpireTime' => ['description' => '备份数据过期时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1742189008000'],
+ 'BackupTaskId' => ['description' => '备份任务Id。', 'type' => 'string', 'example' => 'bt-12sui21312dd'],
+ 'BackupType' => ['description' => '备份类型：'."\n"
+ ."\n"
+ .'- **0**：快速备份；'."\n"
+ .'- **1**：一致性备份。', 'type' => 'string', 'example' => 'FullBackup'],
+ 'InstanceSnapshot' => [
+ 'description' => '备份实例信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'c-37708ec80b5****'],
+ 'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-2ze0cez8106f2n85c2d7i'],
+ 'RunMode' => ['description' => '集群的运行模式：'."\n"
+ .'- 存算一体（shared_nothing）。'."\n"
+ .'- 存算分离（shared_data）。'."\n", 'type' => 'string', 'example' => 'shared_data'],
+ 'SpecType' => ['description' => '计算组规格类型。包括以下类型：'."\n"
+ ."\n"
+ .'- standard，标准版。'."\n"
+ .'- localSSD ，本地SSD。'."\n"
+ .'- bigData，大规格存储。'."\n"
+ .'- ramEnhanced，内存增强型。'."\n"
+ .'- networkEnhanced，网络增强型。', 'type' => 'string', 'example' => 'standard'],
+ 'ResourceGroupId' => ['description' => '资源组 ID。', 'type' => 'string', 'example' => 'rg-aekzd7frphchx3a'],
+ 'Version' => ['description' => '集群版本。', 'type' => 'string', 'example' => '3.3'],
+ 'MinorVersion' => ['description' => '小版本版本号。', 'type' => 'string', 'example' => '3.3.13-1.0-1.7.2'],
+ 'NodeGroups' => [
+ 'description' => '计算组信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ComponentType' => ['description' => '计算组类型。包含以下取值：'."\n"
+ ."\n"
+ .'- FE'."\n"
+ .'- BE'."\n"
+ .'- CN'."\n"
+ .'- OBSERVER'."\n"
+ .'- AGENT', 'type' => 'string', 'example' => 'FE'],
+ 'Cu' => ['description' => 'CU数量。CU (Compute Unit) 是服务的基本计量单元，1 CU=1 核 CPU+4GiB 内存，仅在 SpecType 为内存增强型时 1 CU=1 核 CPU+8GiB 内存。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'StorageSize' => ['description' => '存储大小。单位为 GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'StoragePerformanceLevel' => ['description' => '云盘的性能级别。包含以下取值：'."\n"
+ ."\n"
+ .'- pl0：单盘最高随机读写 IOPS 1 万。'."\n"
+ .'- pl1：单盘最高随机读写 IOPS 5 万。'."\n"
+ .'- pl2：单盘最高随机读写 IOPS 10 万。'."\n"
+ .'- pl3：单盘最高随机读写 IOPS 100 万。', 'type' => 'string', 'example' => 'pl1'],
+ 'DiskNumber' => ['description' => '磁盘数量。', 'type' => 'string', 'example' => '2'],
+ 'ResidentNodeNumber' => ['description' => '节点数量。', 'type' => 'string', 'example' => '3'],
+ 'SpecType' => ['description' => '计算组规格类型。包括以下类型：'."\n"
+ ."\n"
+ .'- standard，标准版。'."\n"
+ .'- localSSD ，本地SSD。'."\n"
+ .'- bigData，大规格存储。'."\n"
+ .'- ramEnhanced，内存增强型。'."\n"
+ .'- networkEnhanced，网络增强型。', 'type' => 'string', 'example' => 'standard'],
+ 'LocalStorageInstanceType' => ['description' => '节点组本地SSD实例规格, 仅在基于Ecs实例且SpecType为本地SSD/大规格存储时该值才有意义。', 'type' => 'string', 'example' => 'null'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'RegionId' => ['description' => '实例所属地域ID。', 'type' => 'string', 'example' => 'cn-beijing'],
+ 'Tags' => [
+ 'description' => '标签信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签键。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'bk-time'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => '1747708000'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Total' => ['description' => '查询结果总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ 'description' => '',
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => '获取备份详情',
+ 'description' => '该接口为异步接口，实例的重启不是立即完成的，成功调用后，实例会先进入重启中（restarting）状态，当返回的状态为运行中（running）时代表重启成功。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeBackups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"Success\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\\\n\\",\\n \\"Data\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceId\\": \\"c-d4be777ff5e8cXXX\\",\\n \\"Size\\": 100,\\n \\"Status\\": \\"RUNNING\\",\\n \\"Description\\": \\"任务描述\\",\\n \\"SubTasks\\": [\\n {\\n \\"StartTime\\": 1747708190,\\n \\"FinishedTime\\": 1747718190,\\n \\"SnapshotName\\": \\"2025-02-10_backup\\",\\n \\"DataBase\\": \\"test1\\",\\n \\"Table\\": \\"cdc_ods_t2030_lcpf_api_topic_msg\\",\\n \\"Size\\": 1,\\n \\"Status\\": \\"success\\",\\n \\"Detail\\": \\"[]\\"\\n }\\n ],\\n \\"BackupStartTime\\": 1742179018000,\\n \\"BackupFinishedTime\\": 1742179028000,\\n \\"ExpireTime\\": 1742189008000,\\n \\"BackupTaskId\\": \\"bt-12sui21312dd\\",\\n \\"BackupType\\": \\"FullBackup\\",\\n \\"InstanceSnapshot\\": {\\n \\"InstanceName\\": \\"c-37708ec80b5****\\",\\n \\"VpcId\\": \\"vpc-2ze0cez8106f2n85c2d7i\\",\\n \\"RunMode\\": \\"shared_data\\",\\n \\"SpecType\\": \\"standard\\",\\n \\"ResourceGroupId\\": \\"rg-aekzd7frphchx3a\\",\\n \\"Version\\": \\"3.3\\",\\n \\"MinorVersion\\": \\"3.3.13-1.0-1.7.2\\",\\n \\"NodeGroups\\": [\\n {\\n \\"ComponentType\\": \\"FE\\",\\n \\"Cu\\": 4,\\n \\"StorageSize\\": 200,\\n \\"StoragePerformanceLevel\\": \\"pl1\\",\\n \\"DiskNumber\\": \\"2\\",\\n \\"ResidentNodeNumber\\": \\"3\\",\\n \\"SpecType\\": \\"standard\\",\\n \\"LocalStorageInstanceType\\": \\"null\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"bk-time\\",\\n \\"Value\\": \\"1747708000\\"\\n }\\n ]\\n }\\n }\\n ],\\n \\"Total\\": 1\\n}","type":"json"}]',
+ ],
+ 'DescribeConfigHistory' => [
+ 'path' => '/webapi/config/describeConfigHistory',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '163275',
+ 'abilityTreeNodes' => ['FEATUREemapreduceRZEU20'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'NeedTotal',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否返回全部配置。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '查询页码，默认值是1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时每页的条目数。默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '修改历史的起始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1742178604000'],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '修改历史的结束时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1742178604000'],
+ ],
+ [
+ 'name' => 'EffectStatuses',
+ 'in' => 'query',
+ 'schema' => ['description' => '生效状态。', 'type' => 'string', 'required' => false, 'example' => 'effective'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'HttpStatusCode' => [
- 'description' => 'HTTP请求状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ErrCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'InvalidParams',
- ],
- 'ErrMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Invalid params: [instance not exists].',
- ],
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Total' => ['description' => '总记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'Data' => [
'description' => '返回数据。',
- 'type' => 'boolean',
- ],
- 'AccessDeniedDetail' => [
- 'title' => 'AccessDeniedDetail',
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'GmtCreate' => ['description' => '配置修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1742178604000'],
+ 'OperatorId' => ['description' => '修改配置的用户ID。', 'type' => 'string', 'example' => '149920818483****'],
+ 'Reason' => ['description' => '修改配置的原因。', 'type' => 'string', 'example' => 'Test.'],
+ 'Effected' => ['description' => '配置修改是否生效。', 'type' => 'boolean', 'example' => 'true'],
+ 'ConfigMementos' => [
+ 'description' => '配置修改前后值记录。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '配置修改前后值记录。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ConfigType' => ['description' => '配置类型。有以下取值：'."\n"
+ ."\n"
+ .'- FE'."\n"
+ ."\n"
+ .'- BE'."\n"
+ ."\n"
+ .'- core-site.xml'."\n"
+ ."\n"
+ .'- hdfs-site.xml'."\n"
+ ."\n"
+ .'- kerberos.keytab'."\n"
+ ."\n"
+ .'- krb5.conf'."\n"
+ ."\n"
+ .'- jindosdk.cfg'."\n"
+ ."\n"
+ .'- hadoop-env.sh'."\n"
+ ."\n"
+ .'- hive-site.xml', 'type' => 'string', 'example' => 'FE'],
+ 'ConfigKey' => ['description' => '配置项名称。', 'type' => 'string', 'example' => 'create_tablet_worker_count'],
+ 'Before' => ['description' => '修改前的值。', 'type' => 'string', 'example' => '3'],
+ 'After' => ['description' => '修改后的值。', 'type' => 'string', 'example' => '4'],
+ 'Action' => ['description' => '修改类型。包含以下取值：'."\n"
+ ."\n"
+ .'- MODIFY'."\n"
+ ."\n"
+ .'- ADD'."\n"
+ ."\n"
+ .'- DELETE', 'type' => 'string', 'example' => 'MODIFY'],
+ ],
+ ],
+ ],
+ 'ConfigHistoryId' => ['description' => '配置历史 ID。', 'type' => 'string', 'example' => '6838'],
+ 'Rollback' => ['description' => '是否为一次配置回滚。', 'type' => 'boolean', 'example' => 'false'],
+ 'EffectStatus' => ['description' => '生效状态。', 'type' => 'string', 'example' => 'effective'],
+ 'ConfigHistoryEffectDetails' => [
+ 'description' => '配置变更历史明细。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'NodeGroupId' => ['description' => '计算组 ID。', 'type' => 'string', 'example' => 'ng-e6e15d2cdefdb38c'],
+ 'NodeId' => ['description' => '节点 ID。', 'type' => 'string', 'example' => '10000367486'],
+ 'EffectStatus' => ['description' => '生效状态。', 'type' => 'string', 'example' => 'effective'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
- 'title' => '修改实例名称',
- ],
- 'DescribeInstances' => [
- 'summary' => '本接口用于查询Serverless StarRocks 实例，支持根据实例名称或标签等信息进行过滤。',
- 'path' => '/webapi/starrocks/describeInstances',
- 'methods' => [
- 'post',
+ 'title' => '查询配置修改历史',
+ 'summary' => '查询实例配置历史',
+ 'description' => '该接口为异步接口，实例的重启不是立即完成的，成功调用后，实例会先进入重启中（restarting）状态，当返回的状态为运行中（running）时代表重启成功。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeConfigHistory',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Total\\": 3,\\n \\"Data\\": [\\n {\\n \\"GmtCreate\\": 1742178604000,\\n \\"OperatorId\\": \\"149920818483****\\",\\n \\"Reason\\": \\"Test.\\",\\n \\"Effected\\": true,\\n \\"ConfigMementos\\": [\\n {\\n \\"ConfigType\\": \\"FE\\",\\n \\"ConfigKey\\": \\"create_tablet_worker_count\\",\\n \\"Before\\": \\"3\\",\\n \\"After\\": \\"4\\",\\n \\"Action\\": \\"MODIFY\\"\\n }\\n ],\\n \\"ConfigHistoryId\\": \\"6838\\",\\n \\"Rollback\\": false,\\n \\"EffectStatus\\": \\"effective\\",\\n \\"ConfigHistoryEffectDetails\\": [\\n {\\n \\"NodeGroupId\\": \\"ng-e6e15d2cdefdb38c\\",\\n \\"NodeId\\": \\"10000367486\\",\\n \\"EffectStatus\\": \\"effective\\"\\n }\\n ]\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeEventNames' => [
+ 'path' => '/webapi/event/describeEventNames',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1060,113 +1947,554 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '244638',
- 'abilityTreeNodes' => [
- 'FEATUREemapreduceUHHTB7',
- ],
+ 'abilityTreeCode' => '282053',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
],
'parameters' => [
[
- 'name' => 'InstanceName',
+ 'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '实例名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'starrocks_1',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'Total' => ['description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'array',
+ 'items' => ['description' => '事件名称。', 'type' => 'string', 'example' => '当前用户下行带宽超过流控阈值'],
+ 'example' => 'User downstream bandwidth exceeds throttling threshold',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取集群事件名称',
+ 'summary' => '获取集群事件名称',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeEventNames',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": false,\\n \\"Total\\": 3,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": [\\n \\"当前用户下行带宽超过流控阈值\\"\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribeInnerIpWhitelistGroups' => [
+ 'summary' => '查询内网白名单分组',
+ 'path' => '/webapi/securityGroup/list',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '240836',
+ 'abilityTreeNodes' => ['FEATUREemapreduceRZEU20'],
+ ],
+ 'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '实例 ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'c-a0cb1c8ad6d35XXX',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'."\n"],
+ 'data' => [
+ 'description' => '设备列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InnerIpWhitelistGroupId' => ['description' => '白名单分组名称。', 'type' => 'string', 'example' => 'test1'],
+ 'CidrIpList' => [
+ 'description' => 'IP段列表',
+ 'type' => 'array',
+ 'items' => ['description' => 'IP段', 'type' => 'string', 'example' => '192.168.0.0/16'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => '查询内网白名单分组',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeInnerIpWhitelistGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\\\n\\",\\n \\"data\\": [\\n {\\n \\"InnerIpWhitelistGroupId\\": \\"test1\\",\\n \\"CidrIpList\\": [\\n \\"192.168.0.0/16\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribeInstanceConfigs' => [
+ 'summary' => '查询实例配置',
+ 'path' => '/webapi/config/describeInstanceConfigs',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '163265',
+ 'abilityTreeNodes' => ['FEATUREemapreduceRZEU20'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'ConfigType',
+ 'in' => 'query',
+ 'schema' => ['description' => '配置项类型。包含以下取值：'."\n"
+ ."\n"
+ .'- FE'."\n"
+ ."\n"
+ .'- BE'."\n"
+ ."\n"
+ .'- CORE', 'type' => 'string', 'required' => false, 'example' => 'FE'],
+ ],
+ [
+ 'name' => 'ConfigKey',
+ 'in' => 'query',
+ 'schema' => ['description' => '配置项键。', 'type' => 'string', 'required' => false, 'example' => 'enable_udf'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '配置项功能描述。', 'type' => 'string', 'required' => false, 'example' => 'Whether to enable UDF.'],
+ ],
+ [
+ 'name' => 'AllowModify',
+ 'in' => 'query',
+ 'schema' => ['description' => '配置项是否允许修改。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'NeedTotal',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否返回全部配置项。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
[
'name' => 'PageNumber',
'in' => 'query',
+ 'schema' => ['description' => '查询页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时每页的条目数，默认值为20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => false, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '查询页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '10000',
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Total' => ['description' => '查询结果总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ConfigType' => ['description' => '配置项类型。包含以下取值：'."\n"
+ ."\n"
+ .'- FE'."\n"
+ ."\n"
+ .'- BE'."\n"
+ ."\n"
+ .'- CORE', 'type' => 'string', 'example' => 'FE'],
+ 'ConfigKey' => ['description' => '配置项键。', 'type' => 'string', 'example' => 'enable_udf'],
+ 'DefaultValue' => ['description' => '配置项默认值。', 'type' => 'string', 'example' => 'true'],
+ 'ConfigValue' => ['description' => '配置项值。', 'type' => 'string', 'example' => 'false'],
+ 'Restart' => ['description' => '更改配置项后是否需要重启实例，取值：'."\n"
+ ."\n"
+ .'- **true**：重启。'."\n"
+ .'- **false**：不重启。', 'type' => 'boolean', 'example' => 'true'],
+ 'Unit' => ['description' => '配置项单位。没有则返回空串。', 'type' => 'string', 'example' => 's'],
+ 'ValueType' => ['description' => '配置项值的数据类型。', 'type' => 'string', 'example' => 'INT'],
+ 'ValueRange' => ['description' => '配置项值的取值范围。没有则返回空串。', 'type' => 'string', 'example' => 'true,false'],
+ 'AllowModify' => ['description' => '配置项是否允许修改。', 'type' => 'string', 'example' => 'true'],
+ 'Description' => ['description' => '配置项功能描述。', 'type' => 'string', 'example' => 'Whether to enable UDF.'],
+ 'Custom' => ['description' => '是否为用户自定义配置项。', 'type' => 'boolean', 'example' => 'false'],
+ 'NodeGroupId' => ['description' => '计算组 ID。', 'type' => 'string', 'example' => 'ng-3d5ce6454354****'],
+ 'DefaultNodeGroup' => ['description' => '是否为默认计算组。', 'type' => 'boolean', 'example' => 'true'],
+ 'NodeGroupName' => ['description' => '计算组名称。', 'type' => 'string', 'example' => 'ng_1'],
+ 'DescriptionEn' => ['description' => '配置项英文描述。', 'type' => 'string', 'example' => 'A boolean value to control whether to enable the synchronization of the tablet metadata. true indicates enabling synchronization, and false indicates disabling it.'],
+ ],
+ ],
+ ],
+ 'AccessDeniedDetail' => ['description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询实例配置',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeInstanceConfigs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Total\\": 4,\\n \\"Data\\": [\\n {\\n \\"ConfigType\\": \\"FE\\",\\n \\"ConfigKey\\": \\"enable_udf\\",\\n \\"DefaultValue\\": \\"true\\",\\n \\"ConfigValue\\": \\"false\\",\\n \\"Restart\\": true,\\n \\"Unit\\": \\"s\\",\\n \\"ValueType\\": \\"INT\\",\\n \\"ValueRange\\": \\"true,false\\",\\n \\"AllowModify\\": \\"true\\",\\n \\"Description\\": \\"Whether to enable UDF.\\",\\n \\"Custom\\": false,\\n \\"NodeGroupId\\": \\"ng-3d5ce6454354****\\",\\n \\"DefaultNodeGroup\\": true,\\n \\"NodeGroupName\\": \\"ng_1\\",\\n \\"DescriptionEn\\": \\"A boolean value to control whether to enable the synchronization of the tablet metadata. true indicates enabling synchronization, and false indicates disabling it.\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeInstanceDiagnosisResult' => [
+ 'path' => '/webapi/diagnosis/describe',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '268147',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时的页码。默认值是1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'example' => '3', 'default' => '1'],
+ ],
[
'name' => 'PageSize',
'in' => 'query',
+ 'schema' => ['description' => '分页查询时每页展示的授权条目数。默认值为10，最大值为50。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000', 'minimum' => '1', 'example' => '10', 'default' => '10'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'Dimension',
+ 'in' => 'query',
+ 'schema' => ['description' => '评估维度。', 'type' => 'string', 'required' => false, 'example' => 'table_analysis'],
+ ],
+ [
+ 'name' => 'Statuses',
+ 'in' => 'query',
+ 'schema' => ['description' => '状态集合。', 'type' => 'string', 'required' => false, 'example' => 'healthy'],
+ ],
+ [
+ 'name' => 'ReportDate',
+ 'in' => 'query',
+ 'schema' => ['description' => '报告时间。', 'type' => 'string', 'required' => false, 'example' => '2026-03-08'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '分页查询时，每页包含的条目数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100000',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Total' => ['description' => '查询结果总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'AccessDeniedDetail' => ['description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Dimension' => ['description' => '评估维度。', 'type' => 'string', 'example' => 'table_analysis'],
+ 'ItemId' => ['description' => '评估项ID。', 'type' => 'string', 'example' => '02cf887a'],
+ 'ItemName' => ['description' => '评估项名称。', 'type' => 'string', 'example' => 'Evaluate unreasonable partition and bucket configuration'],
+ 'Introduction' => ['description' => '评估项介绍。', 'type' => 'string', 'example' => 'for autotest'],
+ 'FullScore' => ['description' => '评估项目满分。', 'type' => 'number', 'format' => 'double', 'example' => '10.0'],
+ 'InstanceId' => ['description' => '实例 ID。', 'type' => 'string', 'example' => 'c-b25e21e243889XXX'],
+ 'EvaluationTime' => ['description' => '评估时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '2026-03-08T02:12:32Z'],
+ 'Status' => ['description' => '状态列表。'."\n"
+ ."\n"
+ .'- healthy'."\n"
+ ."\n"
+ .'- info'."\n"
+ ."\n"
+ .'- medium'."\n"
+ ."\n"
+ .'- critical', 'type' => 'string', 'example' => 'healthy'],
+ 'Description' => ['description' => '诊断项描述。', 'type' => 'string', 'example' => 'Evaluate unreasonable partition and bucket configuration'],
+ 'Score' => ['description' => '诊断分数。', 'type' => 'number', 'format' => 'double', 'example' => '10.0'],
+ 'Suggestion' => ['description' => '诊断建议。', 'type' => 'string', 'example' => '未出现分桶大小超过5GB的情况，评估结果为健康。'],
+ 'BestPractice' => ['description' => '最佳实践。', 'type' => 'string', 'example' => '无'],
+ 'ReportDate' => ['description' => '报告日期', 'type' => 'string', 'example' => '2026-03-08'],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取实例的健康诊断结果',
+ 'summary' => '获取实例的健康诊断结果',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'RegionId',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeInstanceDiagnosisResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Total\\": 3,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\",\\n \\"Data\\": [\\n {\\n \\"Dimension\\": \\"table_analysis\\",\\n \\"ItemId\\": \\"02cf887a\\",\\n \\"ItemName\\": \\"Evaluate unreasonable partition and bucket configuration\\",\\n \\"Introduction\\": \\"for autotest\\",\\n \\"FullScore\\": 10,\\n \\"InstanceId\\": \\"c-b25e21e243889XXX\\",\\n \\"EvaluationTime\\": 0,\\n \\"Status\\": \\"healthy\\",\\n \\"Description\\": \\"Evaluate unreasonable partition and bucket configuration\\",\\n \\"Score\\": 10,\\n \\"Suggestion\\": \\"未出现分桶大小超过5GB的情况，评估结果为健康。\\",\\n \\"BestPractice\\": \\"无\\",\\n \\"ReportDate\\": \\"2026-03-08\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribeInstanceMetaToken' => [
+ 'summary' => '获取 StarRocks 实例的 Meta Token。',
+ 'path' => '/webapi/migration/getMetaToken',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '266738',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '实例所属地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Total' => ['description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'Data' => ['description' => 'token信息。', 'type' => 'string', 'example' => '4ac66c5b-f3ef-4fce-8b52-d7f5f9*******'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => '获取实例迁移的Meta Token',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeInstanceMetaToken',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Success\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Total\\": 3,\\n \\"Data\\": \\"4ac66c5b-f3ef-4fce-8b52-d7f5f9*******\\",\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeInstances' => [
+ 'path' => '/webapi/starrocks/describeInstances',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '244638',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceName',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => false, 'example' => 'starrocks_1'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-a0cb1c8ad6d35XXX'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '查询页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时，每页包含的条目数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000', 'minimum' => '1', 'example' => '10', 'default' => '10'],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例所属地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
[
'name' => 'InstanceStatus',
'in' => 'query',
- 'schema' => [
- 'description' => '根据实例状态进行检索，多个实例状态以逗号分割，包括以下状态：'."\n"
- .'<ul>'."\n"
- .'<li>待支付（unpaid）</li>'."\n"
- .'<li>已支付（paid）</li>'."\n"
- .'<li>启动中（creating）</li>'."\n"
- .'<li>运行中（running）</li>'."\n"
- .'<li>升级中（updating）</li>'."\n"
- .'<li>不可用（disable）</li>'."\n"
- .'<li>释放中（deleting）</li>'."\n"
- .'<li>扩容中（scaling_out）</li>'."\n"
- .'<li>缩容中（scaling_in）</li>'."\n"
- .'<li>升配中（scaling_up）</li>'."\n"
- .'<li>降配中（scaling_down）</li>'."\n"
- .'<li>版本升级中（upgrading）</li>'."\n"
- .'<li>更新配置中（modifying_config）</li>'."\n"
- .'<li>开通公网中（enable_public_network）</li>'."\n"
- .'<li>关闭公网中（disable_public_network）</li>'."\n"
- .'<li>实例系列升级中（convert_from_trial_to_official）</li>'."\n"
- .'<li>集群重启中（restarting）</li>'."\n"
- .'<li>集群迁移中（migration_cluster_to_serverless）</li>'."\n"
- .'<li>已停机（actively_disabled）</li>'."\n"
- .'<li>恢复中（enabling）</li>'."\n"
- .'<li>Agent 创建中（agent_creating）</li>'."\n"
- .'<li>Agent 升配中（agent_scaling_up）</li>'."\n"
- .'</ul>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'running,creating',
- ],
+ 'schema' => ['description' => '根据实例状态进行检索，多个实例状态以逗号分割，包括以下状态：'."\n"
+ .'<ul>'."\n"
+ .'<li>待支付（unpaid）</li>'."\n"
+ .'<li>已支付（paid）</li>'."\n"
+ .'<li>启动中（creating）</li>'."\n"
+ .'<li>运行中（running）</li>'."\n"
+ .'<li>升级中（updating）</li>'."\n"
+ .'<li>不可用（disable）</li>'."\n"
+ .'<li>释放中（deleting）</li>'."\n"
+ .'<li>扩容中（scaling_out）</li>'."\n"
+ .'<li>缩容中（scaling_in）</li>'."\n"
+ .'<li>升配中（scaling_up）</li>'."\n"
+ .'<li>降配中（scaling_down）</li>'."\n"
+ .'<li>版本升级中（upgrading）</li>'."\n"
+ .'<li>更新配置中（modifying_config）</li>'."\n"
+ .'<li>开通公网中（enable_public_network）</li>'."\n"
+ .'<li>关闭公网中（disable_public_network）</li>'."\n"
+ .'<li>实例系列升级中（convert_from_trial_to_official）</li>'."\n"
+ .'<li>集群重启中（restarting）</li>'."\n"
+ .'<li>集群迁移中（migration_cluster_to_serverless）</li>'."\n"
+ .'<li>已停机（actively_disabled）</li>'."\n"
+ .'<li>恢复中（enabling）</li>'."\n"
+ .'<li>Agent 创建中（agent_creating）</li>'."\n"
+ .'<li>Agent 升配中（agent_scaling_up）</li>'."\n"
+ .'</ul>', 'type' => 'string', 'required' => false, 'example' => 'running,creating'],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '资源组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-acfmygmtrcenXXX',
- ],
+ 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmygmtrcenXXX'],
],
[
'name' => 'Tag',
@@ -1179,18 +2507,8 @@
'description' => '标签信息。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '标签键。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'k1',
- ],
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'v1',
- ],
+ 'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'k1'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'v1'],
],
'required' => false,
],
@@ -1203,38 +2521,12 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'HttpStatusCode' => [
- 'description' => 'HTTP请求状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n",
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Total' => [
- 'description' => '实例总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'ErrCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'InvalidParams'."\n",
- ],
- 'ErrMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Invalid params: [instance not exists].',
- ],
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'Total' => ['description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'."\n"],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
'Data' => [
'description' => '查询结果。',
'type' => 'array',
@@ -1242,69 +2534,45 @@
'description' => '实例信息。',
'type' => 'object',
'properties' => [
- 'InstanceId' => [
- 'description' => '实例 ID。',
- 'type' => 'string',
- 'example' => 'c-d4be777ff5e8cXXX',
- ],
- 'RegionId' => [
- 'description' => '地域 ID 。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'InstanceStatus' => [
- 'description' => '实例状态。包含以下取值：'."\n"
- ."\n"
- .'- not_init，未初始化'."\n"
- .'- unpaid，待支付'."\n"
- .'- paid，已支付'."\n"
- .'- creating，创建中'."\n"
- .'- creating_failed，创建失败'."\n"
- .'- created，创建成功'."\n"
- .'- running，运行中'."\n"
- .'- updating，升级中'."\n"
- .'- agent_creating，Agent创建中'."\n"
- .'- agent_scaling_up，Agent升配中'."\n"
- .'- modifying_config，更新配置中'."\n"
- .'- scaling_out，扩容中'."\n"
- .'- restarting，重启中'."\n"
- .'- scaling_in，缩容中'."\n"
- .'- scaling_up，升配中'."\n"
- .'- scaling_down，降配中'."\n"
- .'- upgrading，版本升级中'."\n"
- .'- enable_public_network，开通公网中'."\n"
- .'- disable_public_network，关闭公网中'."\n"
- .'- convert_from_trial_to_official，版本转换中'."\n"
- .'- migration_cluster_to_serverless，集群迁移中'."\n"
- .'- modifying_timezone，修改时区中'."\n"
- .'- switch_az，主备可用区切换中'."\n"
- .'- enabling，恢复中'."\n"
- .'- disable，不可用'."\n"
- .'- actively_disabled，不可用'."\n"
- .'- deleting，删除中'."\n"
- .'- deleting_failed，删除失败'."\n"
- .'- deleted_with_error，创建失败结束'."\n"
- .'- deleted，已删除',
- 'type' => 'string',
- 'example' => 'running',
- ],
- 'InstanceName' => [
- 'description' => '实例名称。',
- 'type' => 'string',
- 'example' => 'sr_test_1',
- ],
- 'PackageType' => [
- 'description' => '实例系列。取值范围：'."\n"
- .'- 入门版（trial）。'."\n"
- .'- 标准版（official）。',
- 'type' => 'string',
- 'example' => 'official',
- ],
- 'ResourceGroupId' => [
- 'description' => '资源组 ID。',
- 'type' => 'string',
- 'example' => 'rg-acfmytyuofb****',
- ],
+ 'InstanceId' => ['description' => '实例 ID。', 'type' => 'string', 'example' => 'c-d4be777ff5e8cXXX'],
+ 'RegionId' => ['description' => '地域 ID 。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'InstanceStatus' => ['description' => '实例状态。包含以下取值：'."\n"
+ ."\n"
+ .'- not_init，未初始化'."\n"
+ .'- unpaid，待支付'."\n"
+ .'- paid，已支付'."\n"
+ .'- creating，创建中'."\n"
+ .'- creating_failed，创建失败'."\n"
+ .'- created，创建成功'."\n"
+ .'- running，运行中'."\n"
+ .'- updating，升级中'."\n"
+ .'- agent_creating，Agent创建中'."\n"
+ .'- agent_scaling_up，Agent升配中'."\n"
+ .'- modifying_config，更新配置中'."\n"
+ .'- scaling_out，扩容中'."\n"
+ .'- restarting，重启中'."\n"
+ .'- scaling_in，缩容中'."\n"
+ .'- scaling_up，升配中'."\n"
+ .'- scaling_down，降配中'."\n"
+ .'- upgrading，版本升级中'."\n"
+ .'- enable_public_network，开通公网中'."\n"
+ .'- disable_public_network，关闭公网中'."\n"
+ .'- convert_from_trial_to_official，版本转换中'."\n"
+ .'- migration_cluster_to_serverless，集群迁移中'."\n"
+ .'- modifying_timezone，修改时区中'."\n"
+ .'- switch_az，主备可用区切换中'."\n"
+ .'- enabling，恢复中'."\n"
+ .'- disable，不可用'."\n"
+ .'- actively_disabled，不可用'."\n"
+ .'- deleting，删除中'."\n"
+ .'- deleting_failed，删除失败'."\n"
+ .'- deleted_with_error，创建失败结束'."\n"
+ .'- deleted，已删除', 'type' => 'string', 'example' => 'running'],
+ 'InstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'sr_test_1'],
+ 'PackageType' => ['description' => '实例系列。取值范围：'."\n"
+ .'- 入门版（trial）。'."\n"
+ .'- 标准版（official）。', 'type' => 'string', 'example' => 'official'],
+ 'ResourceGroupId' => ['description' => '资源组 ID。', 'type' => 'string', 'example' => 'rg-acfmytyuofb****'],
'Tags' => [
'description' => '实例所绑定的标签。',
'type' => 'array',
@@ -1312,37 +2580,14 @@
'description' => '标签信息。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '标签键。',
- 'type' => 'string',
- 'example' => 'k1',
- ],
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'example' => 'v1',
- ],
+ 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'k1'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'v1'],
],
],
],
- 'BeginTime' => [
- 'description' => '集群创建时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1733292921000',
- ],
- 'ExpireTime' => [
- 'description' => '集群到期时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4889001600000',
- ],
- 'RunningTime' => [
- 'description' => '集群当前已经运行的时间。单位为秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3645445',
- ],
+ 'BeginTime' => ['description' => '集群创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1733292921000'],
+ 'ExpireTime' => ['description' => '集群到期时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '4889001600000'],
+ 'RunningTime' => ['description' => '集群当前已经运行的时间。单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '3645445'],
'VSwitches' => [
'description' => '交换机列表。',
'type' => 'array',
@@ -1350,175 +2595,102 @@
'description' => '交换机信息。',
'type' => 'object',
'properties' => [
- 'ZoneId' => [
- 'description' => '可用区 ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-i',
- ],
- 'VswId' => [
- 'description' => '交换机 ID。',
- 'type' => 'string',
- 'example' => 'vsw-bp1p0mldwx5av55v0xXXX',
- ],
- 'Primary' => [
- 'description' => '是否为主交换机。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'ZoneId' => ['description' => '可用区 ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i'],
+ 'VswId' => ['description' => '交换机 ID。', 'type' => 'string', 'example' => 'vsw-bp1p0mldwx5av55v0xXXX'],
+ 'Primary' => ['description' => '是否为主交换机。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
- 'PayType' => [
- 'description' => '付费类型：'."\n"
- .'- 包年包月（prePaid）。'."\n"
- .'- 按量付费（postPaid）。',
- 'type' => 'string',
- 'example' => 'postPaid',
- ],
- 'Version' => [
- 'description' => '集群版本。',
- 'type' => 'string',
- 'example' => '3.2',
- ],
- 'VpcId' => [
- 'description' => 'VPC ID。',
- 'type' => 'string',
- 'example' => 'vpc-bp1rbvag1cafkj4prwXXX',
- ],
- 'RunMode' => [
- 'description' => '集群的运行模式：'."\n"
- .'- 存算一体（shared_nothing）。'."\n"
- .'- 存算分离（shared_data）。'."\n"
- .'- 数据湖分析（lakehouse）。',
- 'type' => 'string',
- 'example' => 'shared_nothing',
- ],
- 'MaintainablePeriod' => [
- 'description' => '实例可维护时间段，包括以下取值：'."\n"
- ."\n"
- .'- 00:00-06:00'."\n"
- .'- 06:00-07:00'."\n"
- .'- 07:00-08:00'."\n"
- .'- 08:00-09:00'."\n"
- .'- 09:00-10:00'."\n"
- .'- 10:00-11:00'."\n"
- .'- 11:00-12:00'."\n"
- .'- 12:00-13:00'."\n"
- .'- 13:00-14:00'."\n"
- .'- 14:00-15:00'."\n"
- .'- 15:00-16:00'."\n"
- .'- 16:00-17:00'."\n"
- .'- 17:00-18:00'."\n"
- .'- 18:00-19:00'."\n"
- .'- 19:00-20:00'."\n"
- .'- 20:00-21:00'."\n"
- .'- 21:00-22:00'."\n"
- .'- 22:00-23:00'."\n"
- .'- 23:00-24:00',
- 'type' => 'string',
- 'example' => '00:00-06:00',
- ],
- 'MinorVersion' => [
- 'description' => '小版本版本号。',
- 'type' => 'string',
- 'example' => '3.2.11-1.79-1.6.5',
- ],
- 'EnableAutoMinorVersionUpgrade' => [
- 'description' => '是否允许自动小版本升级',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'EnabledAuditLoader' => [
- 'description' => '是否开启审计插件。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'MonitorType' => [
- 'description' => '监控服务类型。',
- 'type' => 'string',
- 'example' => 'cms',
- ],
- 'Architecture' => [
- 'description' => '实例架构。包含以下取值：'."\n"
- ."\n"
- .'- onEci，基于ECI部署。'."\n"
- .'- onECS，基于ECS部署。'."\n"
- .'- onBareMetal，基于裸金属资源池部署。',
- 'type' => 'string',
- 'example' => 'onECS',
- ],
- 'AclId' => [
- 'description' => '网络ACL（Network Access Control List）ID。',
- 'type' => 'string',
- 'example' => 'acl-bp1xc6b9vs013jjtp****',
- ],
- 'SgId' => [
- 'description' => '安全组 ID。',
- 'type' => 'string',
- 'example' => 'sg-8vbaz2etr66a62b9****',
- ],
- 'OssLocation' => [
- 'description' => 'OSS 地址。',
- 'type' => 'string',
- 'example' => 'oss://sr-c-****',
- ],
- 'SecurityGroupManaged' => [
- 'description' => '是否托管安全组。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'IsolateLeader' => [
- 'description' => '是否开启读写分离（Leader FE节点处理写请求，其余节点处理读请求）。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'EnableSSL' => [
- 'description' => '是否开启SSL。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Encrypted' => [
- 'description' => '是否加密。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'KmsKeyId' => [
- 'description' => 'KMS密钥ID。',
- 'type' => 'string',
- 'example' => 'rewqfds****',
- ],
+ 'PayType' => ['description' => '付费类型：'."\n"
+ .'- 包年包月（prePaid）。'."\n"
+ .'- 按量付费（postPaid）。', 'type' => 'string', 'example' => 'postPaid'],
+ 'Version' => ['description' => '集群版本。', 'type' => 'string', 'example' => '3.2'],
+ 'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-bp1rbvag1cafkj4prwXXX'],
+ 'RunMode' => ['description' => '集群的运行模式：'."\n"
+ .'- 存算一体（shared_nothing）。'."\n"
+ .'- 存算分离（shared_data）。'."\n"
+ .'- 数据湖分析（lakehouse）。', 'type' => 'string', 'example' => 'shared_nothing'],
+ 'MaintainablePeriod' => ['description' => '实例可维护时间段，包括以下取值：'."\n"
+ ."\n"
+ .'- 00:00-06:00'."\n"
+ .'- 06:00-07:00'."\n"
+ .'- 07:00-08:00'."\n"
+ .'- 08:00-09:00'."\n"
+ .'- 09:00-10:00'."\n"
+ .'- 10:00-11:00'."\n"
+ .'- 11:00-12:00'."\n"
+ .'- 12:00-13:00'."\n"
+ .'- 13:00-14:00'."\n"
+ .'- 14:00-15:00'."\n"
+ .'- 15:00-16:00'."\n"
+ .'- 16:00-17:00'."\n"
+ .'- 17:00-18:00'."\n"
+ .'- 18:00-19:00'."\n"
+ .'- 19:00-20:00'."\n"
+ .'- 20:00-21:00'."\n"
+ .'- 21:00-22:00'."\n"
+ .'- 22:00-23:00'."\n"
+ .'- 23:00-24:00', 'type' => 'string', 'example' => '00:00-06:00'],
+ 'MinorVersion' => ['description' => '小版本版本号。', 'type' => 'string', 'example' => '3.2.11-1.79-1.6.5'],
+ 'EnableAutoMinorVersionUpgrade' => ['description' => '是否允许自动小版本升级', 'type' => 'boolean', 'example' => 'true'],
+ 'EnabledAuditLoader' => ['description' => '是否开启审计插件。', 'type' => 'boolean', 'example' => 'true'],
+ 'MonitorType' => ['description' => '监控服务类型。', 'type' => 'string', 'example' => 'cms'],
+ 'Architecture' => ['description' => '实例架构。包含以下取值：'."\n"
+ ."\n"
+ .'- onEci，基于ECI部署。'."\n"
+ .'- onECS，基于ECS部署。'."\n"
+ .'- onBareMetal，基于裸金属资源池部署。', 'type' => 'string', 'example' => 'onECS'],
+ 'AclId' => ['description' => '网络ACL（Network Access Control List）ID。', 'type' => 'string', 'example' => 'acl-bp1xc6b9vs013jjtp****'],
+ 'SgId' => ['description' => '安全组 ID。', 'type' => 'string', 'example' => 'sg-8vbaz2etr66a62b9****'],
+ 'OssLocation' => ['description' => 'OSS 地址。', 'type' => 'string', 'example' => 'oss://sr-c-****'],
+ 'SecurityGroupManaged' => ['description' => '是否托管安全组。', 'type' => 'boolean', 'example' => 'true'],
+ 'IsolateLeader' => ['description' => '是否开启读写分离（Leader FE节点处理写请求，其余节点处理读请求）。', 'type' => 'boolean', 'example' => 'true'],
+ 'EnableSSL' => ['description' => '是否开启SSL。', 'type' => 'boolean', 'example' => 'true'],
+ 'Encrypted' => ['description' => '是否加密。', 'type' => 'boolean', 'example' => 'true'],
+ 'KmsKeyId' => ['description' => 'KMS密钥ID。', 'type' => 'string', 'example' => 'rewqfds****'],
+ 'EnableAiFunction' => ['type' => 'boolean'],
+ 'EnableMultiAz' => ['type' => 'boolean'],
+ 'AiFunctionInstanceId' => ['type' => 'string'],
],
],
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": false,\\n \\"Total\\": 3,\\n \\"ErrCode\\": \\"InvalidParams\\\\n\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"c-d4be777ff5e8cXXX\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceStatus\\": \\"running\\",\\n \\"InstanceName\\": \\"sr_test_1\\",\\n \\"PackageType\\": \\"official\\",\\n \\"ResourceGroupId\\": \\"rg-acfmytyuofb****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\"\\n }\\n ],\\n \\"BeginTime\\": 1733292921000,\\n \\"ExpireTime\\": 4889001600000,\\n \\"RunningTime\\": 3645445,\\n \\"VSwitches\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"VswId\\": \\"vsw-bp1p0mldwx5av55v0xXXX\\",\\n \\"Primary\\": true\\n }\\n ],\\n \\"PayType\\": \\"postPaid\\",\\n \\"Version\\": \\"3.2\\",\\n \\"VpcId\\": \\"vpc-bp1rbvag1cafkj4prwXXX\\",\\n \\"RunMode\\": \\"shared_nothing\\",\\n \\"MaintainablePeriod\\": \\"00:00-06:00\\",\\n \\"MinorVersion\\": \\"3.2.11-1.79-1.6.5\\",\\n \\"EnableAutoMinorVersionUpgrade\\": true,\\n \\"EnabledAuditLoader\\": true,\\n \\"MonitorType\\": \\"cms\\",\\n \\"Architecture\\": \\"onECS\\",\\n \\"AclId\\": \\"acl-bp1xc6b9vs013jjtp****\\",\\n \\"SgId\\": \\"sg-8vbaz2etr66a62b9****\\",\\n \\"OssLocation\\": \\"oss://sr-c-****\\",\\n \\"SecurityGroupManaged\\": true,\\n \\"IsolateLeader\\": true,\\n \\"EnableSSL\\": true,\\n \\"Encrypted\\": true,\\n \\"KmsKeyId\\": \\"rewqfds****\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询实例',
+ 'summary' => '本接口用于查询Serverless StarRocks 实例，支持根据实例名称或标签等信息进行过滤。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeInstances',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": false,\\n \\"Total\\": 3,\\n \\"ErrCode\\": \\"InvalidParams\\\\n\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"c-d4be777ff5e8cXXX\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceStatus\\": \\"running\\",\\n \\"InstanceName\\": \\"sr_test_1\\",\\n \\"PackageType\\": \\"official\\",\\n \\"ResourceGroupId\\": \\"rg-acfmytyuofb****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\"\\n }\\n ],\\n \\"BeginTime\\": 1733292921000,\\n \\"ExpireTime\\": 4889001600000,\\n \\"RunningTime\\": 3645445,\\n \\"VSwitches\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"VswId\\": \\"vsw-bp1p0mldwx5av55v0xXXX\\",\\n \\"Primary\\": true\\n }\\n ],\\n \\"PayType\\": \\"postPaid\\",\\n \\"Version\\": \\"3.2\\",\\n \\"VpcId\\": \\"vpc-bp1rbvag1cafkj4prwXXX\\",\\n \\"RunMode\\": \\"shared_nothing\\",\\n \\"MaintainablePeriod\\": \\"00:00-06:00\\",\\n \\"MinorVersion\\": \\"3.2.11-1.79-1.6.5\\",\\n \\"EnableAutoMinorVersionUpgrade\\": true,\\n \\"EnabledAuditLoader\\": true,\\n \\"MonitorType\\": \\"cms\\",\\n \\"Architecture\\": \\"onECS\\",\\n \\"AclId\\": \\"acl-bp1xc6b9vs013jjtp****\\",\\n \\"SgId\\": \\"sg-8vbaz2etr66a62b9****\\",\\n \\"OssLocation\\": \\"oss://sr-c-****\\",\\n \\"SecurityGroupManaged\\": true,\\n \\"IsolateLeader\\": true,\\n \\"EnableSSL\\": true,\\n \\"Encrypted\\": true,\\n \\"KmsKeyId\\": \\"rewqfds****\\",\\n \\"EnableAiFunction\\": true,\\n \\"EnableMultiAz\\": true,\\n \\"AiFunctionInstanceId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeNodeGroups' => [
- 'summary' => '获取节点组信息',
'path' => '/webapi/nodegroup/describeNodeGroups',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- 'application/x-www-form-urlencoded',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
@@ -1526,48 +2698,23 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '219304',
- 'abilityTreeNodes' => [
- 'FEATUREemapreduceUHHTB7',
- ],
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时的页码。默认值是1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '10000',
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => '分页查询时的页码。默认值是1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的条目数。默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100000',
- 'minimum' => '1',
- 'example' => '20',
- 'default' => '10',
- ],
+ 'schema' => ['description' => '分页查询时每页的条目数。默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000', 'minimum' => '1', 'example' => '20', 'default' => '10'],
],
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'c-718fb04c7112****',
- ],
+ 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'c-718fb04c7112****'],
],
[
'name' => 'body',
@@ -1577,12 +2724,7 @@
'description' => '请求参数信息。',
'type' => 'object',
'properties' => [
- 'instanceId' => [
- 'description' => '实例 ID。该字段已废弃。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'instanceId' => ['description' => '实例 ID。该字段已废弃。', 'type' => 'string', 'required' => false, 'example' => 'null'],
'componentType' => [
'description' => '计算组类型。包含以下取值：'."\n"
."\n"
@@ -1594,58 +2736,47 @@
'type' => 'string',
'required' => false,
'example' => 'FE',
- 'enum' => [
- 'FE',
- 'BE',
- 'CN',
- 'AGENT',
- 'OBSERVER',
- ],
+ 'enum' => ['FE', 'BE', 'CN', 'AGENT', 'OBSERVER'],
],
'nodeGroupIds' => [
'description' => '待查询的计算组 ID 列表。',
'type' => 'array',
- 'items' => [
- 'description' => '计算组 ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ng-a9b2e9148196****'."\n",
- ],
+ 'items' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => false, 'example' => 'ng-a9b2e9148196****'."\n"],
'required' => false,
],
- 'nodeGroupName' => [
- 'description' => '计算组名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ng_1',
- ],
- 'status' => [
- 'description' => '计算组状态，包含以下取值：'."\n"
- ."\n"
- .'- UNPAID：未支付。'."\n"
- .'- PAID：已支付。'."\n"
- .'- CREATING_FAILED：创建失败。'."\n"
- .'- CREATING：创建中。'."\n"
- .'- RUNNING：运行中。'."\n"
- .'- MODIFYING_CONFIG：修改配置中。'."\n"
- .'- MODIFYING_TIMEZONE：修改时区中。'."\n"
- .'- ELASTIC_SCALING_OUT：弹性扩容中。'."\n"
- .'- ELASTIC_SCALING_IN：弹性缩容中。'."\n"
- .'- SCALING_OUT：扩容中。'."\n"
- .'- RESTARTING：重启中。'."\n"
- .'- SCALING_IN：缩容中。'."\n"
- .'- SCALING_UP：升配中。'."\n"
- .'- SCALING_DOWN：降配中。'."\n"
- .'- UPGRADING：升级中。'."\n"
- .'- ENABLE_PUBLIC_NETWORK：开通公网中。'."\n"
- .'- DISABLE_PUBLIC_NETWORK：关闭公网中。'."\n"
- .'- SWITCH_AZ：切换可用区中。'."\n"
- .'- DISABLE：已禁用。'."\n"
- .'- DELETING：删除中。'."\n"
- .'- DELETED：已删除',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'RUNNING',
+ 'nodeGroupName' => ['description' => '计算组名称。', 'type' => 'string', 'required' => false, 'example' => 'ng_1'],
+ 'status' => ['description' => '计算组状态，包含以下取值：'."\n"
+ ."\n"
+ .'- UNPAID：未支付。'."\n"
+ .'- PAID：已支付。'."\n"
+ .'- CREATING_FAILED：创建失败。'."\n"
+ .'- CREATING：创建中。'."\n"
+ .'- RUNNING：运行中。'."\n"
+ .'- MODIFYING_CONFIG：修改配置中。'."\n"
+ .'- MODIFYING_TIMEZONE：修改时区中。'."\n"
+ .'- ELASTIC_SCALING_OUT：弹性扩容中。'."\n"
+ .'- ELASTIC_SCALING_IN：弹性缩容中。'."\n"
+ .'- SCALING_OUT：扩容中。'."\n"
+ .'- RESTARTING：重启中。'."\n"
+ .'- SCALING_IN：缩容中。'."\n"
+ .'- SCALING_UP：升配中。'."\n"
+ .'- SCALING_DOWN：降配中。'."\n"
+ .'- UPGRADING：升级中。'."\n"
+ .'- ENABLE_PUBLIC_NETWORK：开通公网中。'."\n"
+ .'- DISABLE_PUBLIC_NETWORK：关闭公网中。'."\n"
+ .'- SWITCH_AZ：切换可用区中。'."\n"
+ .'- DISABLE：已禁用。'."\n"
+ .'- DELETING：删除中。'."\n"
+ .'- DELETED：已删除', 'type' => 'string', 'required' => false, 'example' => 'RUNNING'],
+ 'tags' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'key' => ['type' => 'string'],
+ 'value' => ['type' => 'string'],
+ ],
+ ],
],
],
'required' => false,
@@ -1657,32 +2788,11 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'HttpStatusCode' => [
- 'description' => 'HTTP请求状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => 'F285E0EC-E928-5E0B-B2C3-7F3FE42F2BE5',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'ErrCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'InvalidParams',
- ],
- 'ErrMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Invalid params: [instance not exists].',
- ],
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'F285E0EC-E928-5E0B-B2C3-7F3FE42F2BE5'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
'Data' => [
'description' => '返回数据。',
'type' => 'array',
@@ -1690,474 +2800,1011 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'RegionId' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'InstanceId' => [
- 'description' => '实例 ID。',
- 'type' => 'string',
- 'example' => 'c-96f3bc7f04b2****',
- ],
- 'NodeGroupId' => [
- 'description' => '计算组 ID。',
- 'type' => 'string',
- 'example' => 'ng-5e2ba600fee3****',
- ],
- 'NodeGroupName' => [
- 'description' => '计算组名称。',
- 'type' => 'string',
- 'example' => 'ng_1',
- ],
- 'Description' => [
- 'description' => '计算组描述。',
- 'type' => 'string',
- 'example' => 'ETL计算组',
+ 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'InstanceId' => ['description' => '实例 ID。', 'type' => 'string', 'example' => 'c-96f3bc7f04b2****'],
+ 'NodeGroupId' => ['description' => '计算组 ID。', 'type' => 'string', 'example' => 'ng-5e2ba600fee3****'],
+ 'NodeGroupName' => ['description' => '计算组名称。', 'type' => 'string', 'example' => 'ng_1'],
+ 'Description' => ['description' => '计算组描述。', 'type' => 'string', 'example' => 'ETL计算组'],
+ 'Status' => ['description' => '计算组状态，包含以下取值：'."\n"
+ ."\n"
+ .'- UNPAID：未支付。'."\n"
+ .'- PAID：已支付。'."\n"
+ .'- CREATING_FAILED：创建失败。'."\n"
+ .'- CREATING：创建中。'."\n"
+ .'- RUNNING：运行中。'."\n"
+ .'- MODIFYING_CONFIG：修改配置中。'."\n"
+ .'- MODIFYING_TIMEZONE：修改时区中。'."\n"
+ .'- ELASTIC_SCALING_OUT：弹性扩容中。'."\n"
+ .'- ELASTIC_SCALING_IN：弹性缩容中。'."\n"
+ .'- SCALING_OUT：扩容中。'."\n"
+ .'- RESTARTING：重启中。'."\n"
+ .'- SCALING_IN：缩容中。'."\n"
+ .'- SCALING_UP：升配中。'."\n"
+ .'- SCALING_DOWN：降配中。'."\n"
+ .'- UPGRADING：升级中。'."\n"
+ .'- ENABLE_PUBLIC_NETWORK：开通公网中。'."\n"
+ .'- DISABLE_PUBLIC_NETWORK：关闭公网中。'."\n"
+ .'- SWITCH_AZ：切换可用区中。'."\n"
+ .'- DISABLE：已禁用。'."\n"
+ .'- DELETING：删除中。'."\n"
+ .'- DELETED：已删除', 'type' => 'string', 'example' => 'RUNNING'],
+ 'ComponentType' => ['description' => '计算组类型。包含以下取值：'."\n"
+ ."\n"
+ .'- FE'."\n"
+ .'- BE'."\n"
+ .'- CN'."\n"
+ .'- OBSERVER'."\n"
+ .'- AGENT', 'type' => 'string', 'example' => 'FE'],
+ 'PayType' => ['description' => '付费类型：'."\n"
+ .'<ol>'."\n"
+ .'<li>包年包月（prePaid）。</li>'."\n"
+ .'<li>按量付费（postPaid）。</li>'."\n"
+ .'</ol>', 'type' => 'string', 'example' => 'prePaid'],
+ 'Cu' => ['description' => 'CU数量。CU (Compute Unit) 是服务的基本计量单元，1 CU=1 核 CPU+4GiB 内存，仅在 SpecType 为内存增强型时 1 CU=1 核 CPU+8GiB 内存。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'MemoryCpuRatio' => ['description' => '内存大小与CU数量之比，SpecType 为内存增强型时值为8，其余规格类型该比值为4。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'StorageSize' => ['description' => '存储大小。单位为 GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'StoragePerformanceLevel' => ['description' => '云盘的性能级别。包含以下取值：'."\n"
+ ."\n"
+ .'- pl0：单盘最高随机读写 IOPS 1 万。'."\n"
+ .'- pl1：单盘最高随机读写 IOPS 5 万。'."\n"
+ .'- pl2：单盘最高随机读写 IOPS 10 万。'."\n"
+ .'- pl3：单盘最高随机读写 IOPS 100 万。', 'type' => 'string', 'example' => 'pl1'],
+ 'DiskNumber' => ['description' => '磁盘数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ResidentNodeNumber' => ['description' => '节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'SpecType' => ['description' => '计算组规格类型。包括以下类型：'."\n"
+ ."\n"
+ .'- standard，标准版。'."\n"
+ .'- localSSD ，本地SSD。'."\n"
+ .'- bigData，大规格存储。'."\n"
+ .'- ramEnhanced，内存增强型。'."\n"
+ .'- networkEnhanced，网络增强型。', 'type' => 'string', 'example' => 'standard'],
+ 'Architecture' => ['description' => '计算组架构。包含以下取值：'."\n"
+ ."\n"
+ .'- onEci，基于ECI部署。'."\n"
+ .'- onECS，基于ECS部署。'."\n"
+ .'- onBareMetal，基于裸金属资源池部署。', 'type' => 'string', 'example' => 'onEci'],
+ 'LocalStorageInstanceType' => ['description' => '节点组本地SSD实例规格, 仅在基于Ecs实例且SpecType为本地SSD/大规格存储时该值才有意义。', 'type' => 'string', 'example' => 'local_ssd_4_4xlarge'],
+ 'ElasticNodeNumber' => ['description' => '弹性节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'Endpoint' => ['description' => '计算组 endpoint。', 'type' => 'string', 'example' => 'be-c-79b0bb9f58ef****-internal.starrocks.aliyuncs.com'],
+ 'EnablePublicNetwork' => ['description' => '是否开通公网。', 'type' => 'boolean', 'example' => 'false'],
+ 'PublicAddress' => ['description' => '公网地址。仅当EnablePublicNetwork为true时有值。', 'type' => 'string', 'example' => 'fe-c-79b0bb9f58ef****.starrocks.aliyuncs.com'],
+ 'BeginTime' => ['description' => '计算组创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1742179008000'],
+ 'ExpireTime' => ['description' => '计算组到期时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1742179008000'],
+ 'DefaultGroup' => ['description' => '是否为默认计算组。', 'type' => 'boolean', 'example' => 'true'],
+ 'RunningTime' => ['description' => '计算组已经运行的时间，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
+ 'TargetElasticNodeNumber' => ['description' => '目标弹性节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'HttpPort' => ['description' => '计算组 Http 端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '8030'],
+ 'AccountStatus' => ['description' => '账户状态。包含以下取值：'."\n"
+ ."\n"
+ .'- NORMAL，账户当前处于正常状态。'."\n"
+ .'- OVERDUE，账户当前处于欠费状态。', 'type' => 'string', 'example' => 'OVERDUE'],
+ 'BillingInstanceId' => ['description' => '帐单对应的实例 ID。对于默认计算组（FE计算组和默认的BE计算组），该字段的值为实例 ID，否则为计算组 ID。', 'type' => 'string', 'example' => 'c-96f3bc7f04b2****'],
+ 'CommodityCode' => ['description' => '商品代码。', 'type' => 'string', 'example' => 'emapreduce_starrockspost_public_cn'],
+ 'NodeInfo' => [
+ 'description' => '计算组包含的节点的信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '节点信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'NodeId' => ['description' => '节点 ID。', 'type' => 'string', 'example' => 'cn-e1733d44-0'],
+ ],
+ ],
],
- 'Status' => [
- 'description' => '计算组状态，包含以下取值：'."\n"
- ."\n"
- .'- UNPAID：未支付。'."\n"
- .'- PAID：已支付。'."\n"
- .'- CREATING_FAILED：创建失败。'."\n"
- .'- CREATING：创建中。'."\n"
- .'- RUNNING：运行中。'."\n"
- .'- MODIFYING_CONFIG：修改配置中。'."\n"
- .'- MODIFYING_TIMEZONE：修改时区中。'."\n"
- .'- ELASTIC_SCALING_OUT：弹性扩容中。'."\n"
- .'- ELASTIC_SCALING_IN：弹性缩容中。'."\n"
- .'- SCALING_OUT：扩容中。'."\n"
- .'- RESTARTING：重启中。'."\n"
- .'- SCALING_IN：缩容中。'."\n"
- .'- SCALING_UP：升配中。'."\n"
- .'- SCALING_DOWN：降配中。'."\n"
- .'- UPGRADING：升级中。'."\n"
- .'- ENABLE_PUBLIC_NETWORK：开通公网中。'."\n"
- .'- DISABLE_PUBLIC_NETWORK：关闭公网中。'."\n"
- .'- SWITCH_AZ：切换可用区中。'."\n"
- .'- DISABLE：已禁用。'."\n"
- .'- DELETING：删除中。'."\n"
- .'- DELETED：已删除',
- 'type' => 'string',
- 'example' => 'RUNNING',
+ 'ZoneId' => ['description' => '可用区 ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i'],
+ 'Tags' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['type' => 'string'],
+ 'Value' => ['type' => 'string'],
+ ],
+ ],
],
- 'ComponentType' => [
- 'description' => '计算组类型。包含以下取值：'."\n"
- ."\n"
- .'- FE'."\n"
- .'- BE'."\n"
- .'- CN'."\n"
- .'- OBSERVER'."\n"
- .'- AGENT',
- 'type' => 'string',
- 'example' => 'FE',
- ],
- 'PayType' => [
- 'description' => '付费类型：'."\n"
- .'<ol>'."\n"
- .'<li>包年包月（prePaid）。</li>'."\n"
- .'<li>按量付费（postPaid）。</li>'."\n"
- .'</ol>',
- 'type' => 'string',
- 'example' => 'prePaid',
- ],
- 'Cu' => [
- 'description' => 'CU数量。CU (Compute Unit) 是服务的基本计量单元，1 CU=1 核 CPU+4GiB 内存，仅在 SpecType 为内存增强型时 1 CU=1 核 CPU+8GiB 内存。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'MemoryCpuRatio' => [
- 'description' => '内存大小与CU数量之比，SpecType 为内存增强型时值为8，其余规格类型该比值为4。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'StorageSize' => [
- 'description' => '存储大小。单位为 GiB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'StoragePerformanceLevel' => [
- 'description' => '云盘的性能级别。包含以下取值：'."\n"
- ."\n"
- .'- pl0：单盘最高随机读写 IOPS 1 万。'."\n"
- .'- pl1：单盘最高随机读写 IOPS 5 万。'."\n"
- .'- pl2：单盘最高随机读写 IOPS 10 万。'."\n"
- .'- pl3：单盘最高随机读写 IOPS 100 万。',
- 'type' => 'string',
- 'example' => 'pl1',
+ ],
+ ],
+ ],
+ 'Total' => ['description' => '查询结果总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'AccessDeniedDetail' => ['description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询计算组',
+ 'summary' => '获取节点组信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeNodeGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"F285E0EC-E928-5E0B-B2C3-7F3FE42F2BE5\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceId\\": \\"c-96f3bc7f04b2****\\",\\n \\"NodeGroupId\\": \\"ng-5e2ba600fee3****\\",\\n \\"NodeGroupName\\": \\"ng_1\\",\\n \\"Description\\": \\"ETL计算组\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ComponentType\\": \\"FE\\",\\n \\"PayType\\": \\"prePaid\\",\\n \\"Cu\\": 1,\\n \\"MemoryCpuRatio\\": 4,\\n \\"StorageSize\\": 100,\\n \\"StoragePerformanceLevel\\": \\"pl1\\",\\n \\"DiskNumber\\": 1,\\n \\"ResidentNodeNumber\\": 3,\\n \\"SpecType\\": \\"standard\\",\\n \\"Architecture\\": \\"onEci\\",\\n \\"LocalStorageInstanceType\\": \\"local_ssd_4_4xlarge\\",\\n \\"ElasticNodeNumber\\": 3,\\n \\"Endpoint\\": \\"be-c-79b0bb9f58ef****-internal.starrocks.aliyuncs.com\\",\\n \\"EnablePublicNetwork\\": false,\\n \\"PublicAddress\\": \\"fe-c-79b0bb9f58ef****.starrocks.aliyuncs.com\\",\\n \\"BeginTime\\": 1742179008000,\\n \\"ExpireTime\\": 1742179008000,\\n \\"DefaultGroup\\": true,\\n \\"RunningTime\\": 10000,\\n \\"TargetElasticNodeNumber\\": 3,\\n \\"HttpPort\\": 8030,\\n \\"AccountStatus\\": \\"OVERDUE\\",\\n \\"BillingInstanceId\\": \\"c-96f3bc7f04b2****\\",\\n \\"CommodityCode\\": \\"emapreduce_starrockspost_public_cn\\",\\n \\"NodeInfo\\": [\\n {\\n \\"NodeId\\": \\"cn-e1733d44-0\\"\\n }\\n ],\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"Total\\": 100,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeRegions' => [
+ 'path' => '/webapi/region/list',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '158044',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => [
+ 'description' => '实例信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionName' => ['description' => '地域名称', 'type' => 'string', 'example' => '华东1（杭州）'],
+ 'Description' => ['description' => '地域描述。', 'type' => 'string', 'example' => 'Hangzhou'],
+ 'RegionId' => ['description' => '地域 ID 。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'DescriptionEn' => ['description' => '英文描述', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ ],
+ ],
+ ],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '查看可用地域',
+ 'summary' => '查看可用地域列表。',
+ 'description' => '该接口为异步接口，实例的重启不是立即完成的，成功调用后，实例会先进入重启中（restarting）状态，当返回的状态为运行中（running）时代表重启成功。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"Success\\": false,\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": [\\n {\\n \\"RegionName\\": \\"华东1（杭州）\\",\\n \\"Description\\": \\"Hangzhou\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DescriptionEn\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeResourceConstraints' => [
+ 'summary' => '获取资源约束配置',
+ 'path' => '/webapi/starrocks/describeResourceConstraints',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '158059',
+ 'abilityTreeNodes' => ['FEATUREemapreduceRZEU20'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PackageType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '实例系列。取值范围：'."\n"
+ .'- 入门版（trial）。'."\n"
+ .'- 标准版（official）。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'trial',
+ 'enum' => ['trial', 'official'],
+ ],
+ ],
+ [
+ 'name' => 'RunMode',
+ 'in' => 'query',
+ 'schema' => ['description' => '集群的运行模式：'."\n"
+ .'- 存算一体（shared_nothing）。'."\n"
+ .'- 存算分离（shared_data）。'."\n"
+ .'- 数据湖分析（lakehouse）。', 'type' => 'string', 'required' => false, 'example' => 'shared_data'],
+ ],
+ [
+ 'name' => 'Architecture',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例架构。包含以下取值：'."\n"
+ ."\n"
+ .'- onEci，基于ECI部署。'."\n"
+ .'- onEcs，基于ECS部署。'."\n"
+ .'- onBareMetal，基于裸金属资源池部署。', 'type' => 'string', 'required' => false, 'example' => 'onEcs'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'B67D142D-D54E-184F-A306-22BDC01B2XXX'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'ErrorCode' => ['description' => '错误码。200标识查询任务成功。', 'type' => 'string', 'example' => 'Success'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'BeCu' => [
+ 'description' => 'BE节点CU大小。',
+ 'type' => 'array',
+ 'items' => ['description' => 'CU大小', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
+ ],
+ 'BeNumber' => [
+ 'description' => 'be节点配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'Min' => ['description' => '最小值。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Max' => ['description' => '最大值。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Step' => ['description' => '步长。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Default' => ['description' => '默认值。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
- 'DiskNumber' => [
- 'description' => '磁盘数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ ],
+ 'FeCu' => [
+ 'description' => 'FE节点CU大小。',
+ 'type' => 'array',
+ 'items' => ['description' => 'CU大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
+ ],
+ 'FeStorage' => [
+ 'description' => 'FE节点存储大小。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Min' => ['description' => '最小值。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Max' => ['description' => '最大值。', 'type' => 'integer', 'format' => 'int32', 'example' => '5000'],
+ 'Step' => ['description' => '步长。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'Default' => ['description' => '默认值。', 'type' => 'integer', 'format' => 'int32', 'example' => '500'],
],
- 'ResidentNodeNumber' => [
- 'description' => '节点数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
+ ],
+ 'FeNumber' => [
+ 'description' => 'FE节点数量',
+ 'type' => 'object',
+ 'properties' => [
+ 'Min' => ['description' => '最小值。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Max' => ['description' => '最大值', 'type' => 'integer', 'format' => 'int32', 'example' => '11'],
+ 'Step' => ['description' => '步长。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'Default' => ['description' => '默认值。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
],
- 'SpecType' => [
- 'description' => '计算组规格类型。包括以下类型：'."\n"
- ."\n"
- .'- standard，标准版。'."\n"
- .'- localSSD ，本地SSD。'."\n"
- .'- bigData，大规格存储。'."\n"
- .'- ramEnhanced，内存增强型。'."\n"
- .'- networkEnhanced，网络增强型。',
- 'type' => 'string',
- 'example' => 'standard',
+ ],
+ 'HaFeResourceSpec' => [
+ 'description' => '高可用FE节点配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'Cu' => ['description' => 'CU大小', 'type' => 'integer', 'format' => 'int32', 'example' => '16'],
+ 'StorageSize' => ['description' => '存储大小。单位为 GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'NodeNumber' => ['description' => '节点总数', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
],
- 'Architecture' => [
- 'description' => '计算组架构。包含以下取值：'."\n"
- ."\n"
- .'- onEci，基于ECI部署。'."\n"
- .'- onECS，基于ECS部署。'."\n"
- .'- onBareMetal，基于裸金属资源池部署。',
- 'type' => 'string',
- 'example' => 'onEci',
+ ],
+ 'NormalFeResourceSpec' => [
+ 'description' => '常规FE资源配置。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Cu' => ['description' => 'CU大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '64'],
+ 'StorageSize' => ['description' => '存储大小。单位为 GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '500'],
+ 'NodeNumber' => ['description' => '节点总数', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
],
- 'LocalStorageInstanceType' => [
- 'description' => '节点组本地SSD实例规格, 仅在基于Ecs实例且SpecType为本地SSD/大规格存储时该值才有意义。',
- 'type' => 'string',
- 'example' => 'local_ssd_4_4xlarge',
+ ],
+ 'VersionConstraint' => [
+ 'description' => '版本约束。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Versions' => [
+ 'description' => '版本定义。',
+ 'type' => 'array',
+ 'items' => ['description' => '版本列表。', 'type' => 'string', 'example' => '["3.2","3.3","3.5"]'],
+ ],
+ 'DefaultVersion' => ['description' => '默认版本。', 'type' => 'string', 'example' => '3.3'],
+ 'BetaVersions' => [
+ 'description' => 'Beta版本。',
+ 'type' => 'array',
+ 'items' => ['description' => 'Beta版本列表。', 'type' => 'string', 'example' => '3.5'],
+ ],
],
- 'ElasticNodeNumber' => [
- 'description' => '弹性节点数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
+ ],
+ 'BeStorageConstraints' => [
+ 'description' => 'BE存储约束',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Level' => ['description' => '磁盘等级。', 'type' => 'string', 'example' => 'PL1'],
+ 'Desc' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'BE 存储约束描述'],
+ 'ValueConstraint' => [
+ 'description' => '取值约束。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Min' => ['description' => '最小值', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Max' => ['description' => '最大值。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'Step' => ['description' => '步长。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Default' => ['description' => '默认值。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ ],
+ 'IsDefault' => ['description' => '是否默认。', 'type' => 'boolean', 'example' => 'true'],
+ 'DiskNumberConstraint' => [
+ 'description' => '磁盘块数约束。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Min' => ['description' => '磁盘块数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Max' => ['description' => '最大值。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Step' => ['description' => '步长。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Default' => ['description' => '默认值。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ ],
+ ],
+ 'description' => '',
],
- 'Endpoint' => [
- 'description' => '计算组 endpoint。',
- 'type' => 'string',
- 'example' => 'be-c-79b0bb9f58ef****-internal.starrocks.aliyuncs.com',
+ ],
+ 'SpecType' => [
+ 'description' => '计算组规格类型。包括以下类型：'."\n"
+ ."\n"
+ .'- standard，标准版。'."\n"
+ .'- localSSD ，本地SSD。'."\n"
+ .'- bigData，大规格存储。'."\n"
+ .'- ramEnhanced，内存增强型。'."\n"
+ .'- networkEnhanced，网络增强型。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'standard'],
+ 'Display' => ['description' => '展示名称。', 'type' => 'string', 'example' => '标准版'],
+ ],
+ 'description' => '',
],
- 'EnablePublicNetwork' => [
- 'description' => '是否开通公网。',
- 'type' => 'boolean',
- 'example' => 'false',
+ 'example' => 'standard',
+ ],
+ 'FeSpecType' => [
+ 'description' => 'FE规格类型',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'standard'],
+ 'Display' => ['description' => '展示名称。', 'type' => 'string', 'example' => '标准版'],
+ ],
+ 'description' => '',
],
- 'PublicAddress' => [
- 'description' => '公网地址。仅当EnablePublicNetwork为true时有值。',
- 'type' => 'string',
- 'example' => 'fe-c-79b0bb9f58ef****.starrocks.aliyuncs.com',
- ],
- 'BeginTime' => [
- 'description' => '计算组创建时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1742179008000',
- ],
- 'ExpireTime' => [
- 'description' => '计算组到期时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1742179008000',
- ],
- 'DefaultGroup' => [
- 'description' => '是否为默认计算组。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RunningTime' => [
- 'description' => '计算组已经运行的时间，单位为秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10000',
- ],
- 'TargetElasticNodeNumber' => [
- 'description' => '目标弹性节点数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'HttpPort' => [
- 'description' => '计算组 Http 端口。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8030',
- ],
- 'AccountStatus' => [
- 'description' => '账户状态。包含以下取值：'."\n"
- ."\n"
- .'- NORMAL，账户当前处于正常状态。'."\n"
- .'- OVERDUE，账户当前处于欠费状态。',
- 'type' => 'string',
- 'example' => 'OVERDUE',
+ ],
+ 'BigDataInstanceTypeConstraints' => [
+ 'description' => '大数据实例类型规格约束。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceType' => ['description' => '实例类型。', 'type' => 'string', 'example' => 'local_hdd_2s_5xlarge'],
+ 'EcsInstanceType' => ['description' => '对应的ECS实例规格族。', 'type' => 'string', 'example' => 'ecs.d2s.5xlarge'],
+ 'DiskNumber' => ['description' => '磁盘数量。', 'type' => 'string', 'example' => '8'],
+ 'StorageSize' => ['description' => '存储大小。单位为 GiB。', 'type' => 'string', 'example' => '7300'],
+ 'Display' => ['description' => '展示名称。', 'type' => 'string', 'example' => '20核 88GiB 8*7300GiB 本地HDD盘'],
+ 'IsDefault' => ['description' => '是否为默认资源，目前该参数只支持传入true，暂不支持false。', 'type' => 'string', 'example' => 'false'],
+ 'Cpu' => ['description' => 'CPU 核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'Memory' => ['description' => '内存大小，单位GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '88'],
+ ],
+ 'description' => '',
],
- 'BillingInstanceId' => [
- 'description' => '帐单对应的实例 ID。对于默认计算组（FE计算组和默认的BE计算组），该字段的值为实例 ID，否则为计算组 ID。',
- 'type' => 'string',
- 'example' => 'c-96f3bc7f04b2****',
+ ],
+ 'LocalSSDInstanceTypeConstraints' => [
+ 'description' => '本地SSD实例类型约束。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceType' => ['description' => '实例类型', 'type' => 'string', 'example' => 'local_ssd_2g_4xlarge'],
+ 'EcsInstanceType' => ['description' => '对应的ECS实例规格族。', 'type' => 'string', 'example' => 'ecs.i2g.4xlarge'],
+ 'DiskNumber' => ['description' => '磁盘数量。', 'type' => 'string', 'example' => '1'],
+ 'StorageSize' => ['description' => '存储大小。单位为 GiB。', 'type' => 'string', 'example' => '1788'],
+ 'Display' => ['description' => '展示名称', 'type' => 'string', 'example' => '[i2g]16核 64GiB 1*1788GiB 本地SSD盘'],
+ 'IsDefault' => ['description' => '是否默认。', 'type' => 'string', 'example' => 'true'],
+ 'Cpu' => ['description' => 'CPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'],
+ 'Memory' => ['description' => '内存大小，单位 GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '64'],
+ ],
+ 'description' => '',
],
- 'CommodityCode' => [
- 'description' => '商品代码。',
- 'type' => 'string',
- 'example' => 'emapreduce_starrockspost_public_cn',
+ ],
+ 'ZoneSupportedSpecTypes' => [
+ 'description' => '可用区支持的类型。',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'example' => 'standard', 'description' => '可用区支持类型规格列表。'],
+ 'description' => '可用区。',
+ 'example' => 'cn-beijing-h',
],
- 'NodeInfo' => [
- 'description' => '计算组包含的节点的信息。',
+ ],
+ 'ZoneSupportedEedTypes' => [
+ 'description' => '可用区支持EED类型',
+ 'type' => 'object',
+ 'additionalProperties' => [
'type' => 'array',
- 'items' => [
- 'description' => '节点信息。',
- 'type' => 'object',
- 'properties' => [
- 'NodeId' => [
- 'description' => '节点 ID。',
- 'type' => 'string',
- 'example' => 'cn-e1733d44-0',
- ],
- ],
+ 'items' => ['type' => 'string', 'example' => 'eed_standard', 'description' => '可用区支持 EED 类型列表。'],
+ 'example' => 'cn-beijing-h',
+ 'description' => '可用区。',
+ ],
+ ],
+ 'SplitDiskThresholdMap' => [
+ 'description' => '已废弃。',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'example' => '已废弃。', 'description' => '已废弃。'],
+ 'example' => '已废弃。',
+ 'description' => '已废弃。',
],
+ 'description' => '已废弃。',
+ 'example' => '已废弃。',
],
- 'ZoneId' => [
- 'description' => '可用区 ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-i',
+ 'example' => 'Deprecated.',
+ ],
+ 'FeCuOnEcs' => [
+ 'description' => 'ON ECS FeCu 大小',
+ 'type' => 'array',
+ 'items' => ['description' => 'CU 大小', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
+ ],
+ 'BeCuOnEcs' => [
+ 'description' => 'ON ECS BeCu大小',
+ 'type' => 'array',
+ 'items' => ['description' => 'CU大小', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
+ ],
+ 'AgentCu' => [
+ 'description' => 'Agent Cu大小',
+ 'type' => 'array',
+ 'items' => ['description' => 'CU大小', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
+ ],
+ 'compactionServiceCuConstraint' => [
+ 'description' => 'Compaction 服务CU约束。',
+ 'type' => 'object',
+ 'properties' => [
+ 'min' => ['description' => '最小值。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
+ 'max' => ['description' => '最大值。', 'type' => 'integer', 'format' => 'int32', 'example' => '256'],
+ 'def' => ['description' => '默认值。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'],
+ 'step' => ['description' => '步长。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
],
- 'Tags' => [
+ ],
+ 'zoneSupportCompactionService' => [
+ 'type' => 'object',
+ 'additionalProperties' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Key' => [
- 'type' => 'string',
- ],
- 'Value' => [
- 'type' => 'string',
- ],
+ 'zoneId' => ['type' => 'string'],
+ 'resourceLevel' => ['type' => 'string'],
+ 'recommended' => ['type' => 'boolean'],
],
],
],
],
],
],
- 'Total' => [
- 'description' => '查询结果总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'AccessDeniedDetail' => [
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }',
- ],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '获取资源约束配置',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"F285E0EC-E928-5E0B-B2C3-7F3FE42F2BE5\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceId\\": \\"c-96f3bc7f04b2****\\",\\n \\"NodeGroupId\\": \\"ng-5e2ba600fee3****\\",\\n \\"NodeGroupName\\": \\"ng_1\\",\\n \\"Description\\": \\"ETL计算组\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ComponentType\\": \\"FE\\",\\n \\"PayType\\": \\"prePaid\\",\\n \\"Cu\\": 1,\\n \\"MemoryCpuRatio\\": 4,\\n \\"StorageSize\\": 100,\\n \\"StoragePerformanceLevel\\": \\"pl1\\",\\n \\"DiskNumber\\": 1,\\n \\"ResidentNodeNumber\\": 3,\\n \\"SpecType\\": \\"standard\\",\\n \\"Architecture\\": \\"onEci\\",\\n \\"LocalStorageInstanceType\\": \\"local_ssd_4_4xlarge\\",\\n \\"ElasticNodeNumber\\": 3,\\n \\"Endpoint\\": \\"be-c-79b0bb9f58ef****-internal.starrocks.aliyuncs.com\\",\\n \\"EnablePublicNetwork\\": false,\\n \\"PublicAddress\\": \\"fe-c-79b0bb9f58ef****.starrocks.aliyuncs.com\\",\\n \\"BeginTime\\": 1742179008000,\\n \\"ExpireTime\\": 1742179008000,\\n \\"DefaultGroup\\": true,\\n \\"RunningTime\\": 10000,\\n \\"TargetElasticNodeNumber\\": 3,\\n \\"HttpPort\\": 8030,\\n \\"AccountStatus\\": \\"OVERDUE\\",\\n \\"BillingInstanceId\\": \\"c-96f3bc7f04b2****\\",\\n \\"CommodityCode\\": \\"emapreduce_starrockspost_public_cn\\",\\n \\"NodeInfo\\": [\\n {\\n \\"NodeId\\": \\"cn-e1733d44-0\\"\\n }\\n ],\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"Total\\": 100,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
- 'title' => '查询计算组',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"B67D142D-D54E-184F-A306-22BDC01B2XXX\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": {\\n \\"BeCu\\": [\\n 8\\n ],\\n \\"BeNumber\\": {\\n \\"Min\\": 1,\\n \\"Max\\": 10,\\n \\"Step\\": 1,\\n \\"Default\\": 1\\n },\\n \\"FeCu\\": [\\n 8\\n ],\\n \\"FeStorage\\": {\\n \\"Min\\": 200,\\n \\"Max\\": 5000,\\n \\"Step\\": 100,\\n \\"Default\\": 500\\n },\\n \\"FeNumber\\": {\\n \\"Min\\": 1,\\n \\"Max\\": 11,\\n \\"Step\\": 2,\\n \\"Default\\": 3\\n },\\n \\"HaFeResourceSpec\\": {\\n \\"Cu\\": 16,\\n \\"StorageSize\\": 100,\\n \\"NodeNumber\\": 5\\n },\\n \\"NormalFeResourceSpec\\": {\\n \\"Cu\\": 64,\\n \\"StorageSize\\": 500,\\n \\"NodeNumber\\": 5\\n },\\n \\"VersionConstraint\\": {\\n \\"Versions\\": [\\n \\"[\\\\\\"3.2\\\\\\",\\\\\\"3.3\\\\\\",\\\\\\"3.5\\\\\\"]\\"\\n ],\\n \\"DefaultVersion\\": \\"3.3\\",\\n \\"BetaVersions\\": [\\n \\"3.5\\"\\n ]\\n },\\n \\"BeStorageConstraints\\": [\\n {\\n \\"Level\\": \\"PL1\\",\\n \\"Desc\\": \\"BE 存储约束描述\\",\\n \\"ValueConstraint\\": {\\n \\"Min\\": 1,\\n \\"Max\\": 5,\\n \\"Step\\": 1,\\n \\"Default\\": 1\\n },\\n \\"IsDefault\\": true,\\n \\"DiskNumberConstraint\\": {\\n \\"Min\\": 1,\\n \\"Max\\": 10,\\n \\"Step\\": 1,\\n \\"Default\\": 1\\n }\\n }\\n ],\\n \\"SpecType\\": [\\n {\\n \\"Name\\": \\"standard\\",\\n \\"Display\\": \\"标准版\\"\\n }\\n ],\\n \\"FeSpecType\\": [\\n {\\n \\"Name\\": \\"standard\\",\\n \\"Display\\": \\"标准版\\"\\n }\\n ],\\n \\"BigDataInstanceTypeConstraints\\": [\\n {\\n \\"InstanceType\\": \\"local_hdd_2s_5xlarge\\",\\n \\"EcsInstanceType\\": \\"ecs.d2s.5xlarge\\",\\n \\"DiskNumber\\": \\"8\\",\\n \\"StorageSize\\": \\"7300\\",\\n \\"Display\\": \\"20核 88GiB 8*7300GiB 本地HDD盘\\",\\n \\"IsDefault\\": \\"false\\",\\n \\"Cpu\\": 20,\\n \\"Memory\\": 88\\n }\\n ],\\n \\"LocalSSDInstanceTypeConstraints\\": [\\n {\\n \\"InstanceType\\": \\"local_ssd_2g_4xlarge\\",\\n \\"EcsInstanceType\\": \\"ecs.i2g.4xlarge\\",\\n \\"DiskNumber\\": \\"1\\",\\n \\"StorageSize\\": \\"1788\\",\\n \\"Display\\": \\"[i2g]16核 64GiB 1*1788GiB 本地SSD盘\\",\\n \\"IsDefault\\": \\"true\\",\\n \\"Cpu\\": 16,\\n \\"Memory\\": 64\\n }\\n ],\\n \\"ZoneSupportedSpecTypes\\": {\\n \\"key\\": [\\n \\"standard\\"\\n ]\\n },\\n \\"ZoneSupportedEedTypes\\": {\\n \\"key\\": [\\n \\"eed_standard\\"\\n ]\\n },\\n \\"SplitDiskThresholdMap\\": {\\n \\"key\\": {\\n \\"key\\": [\\n \\"已废弃。\\"\\n ]\\n }\\n },\\n \\"FeCuOnEcs\\": [\\n 8\\n ],\\n \\"BeCuOnEcs\\": [\\n 8\\n ],\\n \\"AgentCu\\": [\\n 8\\n ],\\n \\"compactionServiceCuConstraint\\": {\\n \\"min\\": 8,\\n \\"max\\": 256,\\n \\"def\\": 16,\\n \\"step\\": 8\\n },\\n \\"zoneSupportCompactionService\\": {\\n \\"key\\": [\\n {\\n \\"zoneId\\": \\"\\",\\n \\"resourceLevel\\": \\"\\",\\n \\"recommended\\": true\\n }\\n ]\\n }\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
],
- 'TagResources' => [
- 'summary' => '为指定资源绑定标签。',
- 'path' => '/webapi/tags',
- 'methods' => [
- 'post',
+ 'DescribeSystemTimezone' => [
+ 'path' => '/webapi/timezone/query',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '254973',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Total' => ['description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'string', 'example' => 'Asia/Shanghai'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => '获取实例的系统时区',
+ 'summary' => '获取 starrocks 实例的系统时区',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeSystemTimezone',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Total\\": 100,\\n \\"Data\\": \\"Asia/Shanghai\\",\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeTimeTriggerScalingRules' => [
+ 'path' => '/webapi/scalingRule/describeTimeTriggerScalingRules',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '236086',
- 'abilityTreeNodes' => [
- 'FEATUREemapreduceUHHTB7',
- ],
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '221751',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => false, 'example' => 'ng-d332aa8bca48****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '请求体参数。',
'type' => 'object',
'properties' => [
- 'ResourceType' => [
- 'title' => '资源类型',
- 'description' => '资源类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'instance',
- ],
- 'RegionId' => [
- 'title' => '地域',
- 'description' => '地域 ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
- 'ResourceId' => [
- 'title' => '资源ID,最多 50个子项',
- 'description' => '资源 ID 列表，最多 50 个子项。',
- 'type' => 'array',
- 'items' => [
- 'description' => '资源 ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'c-b25e21e243889XXX'."\n",
- ],
- 'required' => true,
- ],
- 'Tag' => [
- 'title' => '对应新增标签列表，最多包含20个子项',
- 'description' => '新增标签列表，最多包含20个子项',
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => [
+ 'description' => '返回数据。',
'type' => 'array',
'items' => [
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'title' => '标签键',
- 'description' => '标签键',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'k1',
+ 'ScalingRuleId' => ['description' => '弹性规则 ID。', 'type' => 'string', 'example' => 'r-d1775b776110****'],
+ 'NodeNumber' => ['description' => '弹性节点数量。', 'type' => 'string', 'example' => '3'],
+ 'ScalingOutRule' => [
+ 'description' => '弹出规则。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RecurrenceType' => ['description' => '触发方式：'."\n"
+ ."\n"
+ .'- 单次：ONCE'."\n"
+ ."\n"
+ .'- 每天：DAILY'."\n"
+ ."\n"
+ .'- 每周：WEEKLY'."\n"
+ ."\n"
+ .'- 每月：MONTHLY', 'type' => 'string', 'example' => 'ONCE'],
+ 'RecurrenceInterval' => ['description' => '触发间隔：在不同的 RecurrenceType 下表示不同的语义。'."\n"
+ ."\n"
+ .'- DAILY：表示每隔几天执行一次'."\n"
+ ."\n"
+ .'- WEEKLY：表示每隔几周执行一次'."\n"
+ ."\n"
+ .'- MONTHLY：表示每隔几月执行一次', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'RecurrenceValues' => [
+ 'description' => '触发值：在不同的 RecurrenceType 下表示不同的语义，'."\n"
+ ."\n"
+ .'-WEEKLY：表示每周的哪几天需要执行'."\n"
+ ."\n"
+ .'-MONTHLY：表示每月的哪几天需要执行',
+ 'type' => 'array',
+ 'items' => ['description' => '执行日期。', 'type' => 'string', 'example' => '1'],
+ ],
+ 'Year' => ['description' => '执行时间的年。', 'type' => 'integer', 'format' => 'int32', 'example' => '2024'],
+ 'Month' => ['description' => '执行时间的月。', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
+ 'Day' => ['description' => '执行时间的日。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Hour' => ['description' => '执行时间的小时。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'Minute' => ['description' => '执行时间的分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'Second' => ['description' => '执行时间的秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ ],
],
- 'Value' => [
- 'title' => '标签值',
- 'description' => '标签值',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'v1',
+ 'ScalingInRule' => [
+ 'description' => '收缩规则。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RecurrenceType' => ['description' => '触发方式：'."\n"
+ ."\n"
+ .'- 单次：ONCE'."\n"
+ ."\n"
+ .'- 每天：DAILY'."\n"
+ ."\n"
+ .'- 每周：WEEKLY'."\n"
+ ."\n"
+ .'- 每月：MONTHLY', 'type' => 'string', 'example' => 'ONCE'],
+ 'RecurrenceInterval' => ['description' => '触发间隔：在不同的 RecurrenceType 下表示不同的语义。'."\n"
+ ."\n"
+ .'- DAILY：表示每隔几天执行一次'."\n"
+ ."\n"
+ .'- WEEKLY：表示每隔几周执行一次'."\n"
+ ."\n"
+ .'- MONTHLY：表示每隔几月执行一次', 'type' => 'integer', 'format' => 'int32', 'example' => 'WEEKLY'],
+ 'RecurrenceValues' => [
+ 'description' => '触发值：在不同的 RecurrenceType 下表示不同的语义，'."\n"
+ ."\n"
+ .'-WEEKLY：表示每周的哪几天需要执行'."\n"
+ ."\n"
+ .'-MONTHLY：表示每月的哪几天需要执行',
+ 'type' => 'array',
+ 'items' => ['description' => '执行日期。', 'type' => 'string', 'example' => '1'],
+ ],
+ 'Year' => ['description' => '执行时间的年。', 'type' => 'integer', 'format' => 'int32', 'example' => '2025'],
+ 'Month' => ['description' => '执行时间的月。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'Day' => ['description' => '执行时间的日。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Hour' => ['description' => '执行时间的小时。', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
+ 'Minute' => ['description' => '执行时间的分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '24'],
+ 'Second' => ['description' => '执行时间的秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ ],
],
+ 'Status' => ['description' => '规则当前的状态：'."\n"
+ ."\n"
+ .'- INACTIVE：规则未被触发。'."\n"
+ ."\n"
+ .'- ACTIVE：规则被触发'."\n"
+ ."\n"
+ .'- DISABLED：规则由于欠费被禁用', 'type' => 'string', 'example' => 'INACTIVE'],
+ 'ScalingRuleName' => ['description' => '弹性伸缩策略名称。'."\n", 'type' => 'string', 'example' => 'scale-test1'],
],
- 'required' => false,
],
- 'required' => true,
],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '查询基于时间触发的弹性规则',
+ 'summary' => '获取时间触发规则信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeTimeTriggerScalingRules',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => false,
],
],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": [\\n {\\n \\"ScalingRuleId\\": \\"r-d1775b776110****\\",\\n \\"NodeNumber\\": \\"3\\",\\n \\"ScalingOutRule\\": {\\n \\"RecurrenceType\\": \\"ONCE\\",\\n \\"RecurrenceInterval\\": 1,\\n \\"RecurrenceValues\\": [\\n \\"1\\"\\n ],\\n \\"Year\\": 2024,\\n \\"Month\\": 12,\\n \\"Day\\": 10,\\n \\"Hour\\": 3,\\n \\"Minute\\": 30,\\n \\"Second\\": 20\\n },\\n \\"ScalingInRule\\": {\\n \\"RecurrenceType\\": \\"ONCE\\",\\n \\"RecurrenceInterval\\": 0,\\n \\"RecurrenceValues\\": [\\n \\"1\\"\\n ],\\n \\"Year\\": 2025,\\n \\"Month\\": 3,\\n \\"Day\\": 1,\\n \\"Hour\\": 12,\\n \\"Minute\\": 24,\\n \\"Second\\": 30\\n },\\n \\"Status\\": \\"INACTIVE\\",\\n \\"ScalingRuleName\\": \\"scale-test1\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'DisableSSLConnection' => [
+ 'path' => '/webapi/starrocks/disableSSLConnection',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '276254',
+ 'abilityTreeNodes' => ['FEATUREemapreduceZXY046'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX',
- ],
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'."\n"],
+ 'Data' => ['description' => '可升级的版本号。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\"\\n}","type":"json"}]',
- 'title' => '绑定标签',
- ],
- 'UnTagResources' => [
- 'summary' => '为指定的资源列表统一解绑标签。',
- 'path' => '/webapi/tags',
- 'methods' => [
- 'delete',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'StarRocks连接关闭SSL',
+ 'summary' => 'StarRocks连接关闭SSL',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:DisableSSLConnection',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\\\n\\",\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'EnableInternalSlb' => [
+ 'path' => '/webapi/gateway/enableInternalSlb',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '236098',
- 'abilityTreeNodes' => [
- 'FEATUREemapreduceUHHTB7',
- ],
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '270152',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '地域',
- 'description' => '地域 ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'title' => '开启内网SLB',
+ 'summary' => '默认网关开启内网SLB',
+ 'description' => '调用该接口时实例必须处于运行中（Running）状态。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'ResourceType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '资源类型',
- 'description' => '资源类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'instance',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:EnableInternalSlb',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'EnableMultiAz' => [
+ 'summary' => '开启Multi AZ',
+ 'path' => '/webapi/lifecycle/enableMultiAz',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'ResourceId',
- 'in' => 'query',
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '283095',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
'style' => 'json',
'schema' => [
- 'title' => '资源ID,最多 50个子项',
- 'description' => '资源 ID列表，最多包含 50个子项。',
- 'type' => 'array',
- 'items' => [
- 'description' => '资源 ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'c-b25e21e243889XXX'."\n",
+ 'description' => '请求结构体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'instanceId' => ['description' => '实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-238sjh237s12***'],
+ 'promotionOptionNo' => ['description' => '优惠券。', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_12378dfj6'],
+ 'observers' => [
+ 'description' => '多可用区信息',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'zoneId' => ['description' => '可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h'],
+ 'vswId' => ['description' => '交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-x1232js012'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ ],
],
- 'required' => true,
+ 'required' => false,
],
],
- [
- 'name' => 'TagKey',
- 'in' => 'query',
- 'style' => 'json',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '对应标签键列表，最多包含20个子项',
- 'description' => '待解绑的标签键列表，最多包含 20 个子项。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签键。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'k1',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'."\n"],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ 'Data' => [
+ 'description' => '订单信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OrderId' => ['description' => '订单ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '24782976697****'],
+ 'NodeGroupId' => ['description' => '计算组 ID。', 'type' => 'string', 'example' => 'ng-a9b2e9148196****'],
+ ],
+ ],
],
- 'required' => false,
+ 'description' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '实例开启多可用区',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'All',
- 'in' => 'query',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:EnableMultiAz',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\\\n\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\",\\n \\"Data\\": {\\n \\"OrderId\\": 0,\\n \\"NodeGroupId\\": \\"ng-a9b2e9148196****\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'EnableSSLConnection' => [
+ 'summary' => 'StarRocks连接开启SSL',
+ 'path' => '/webapi/starrocks/enableSSLConnection',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '273603',
+ 'abilityTreeNodes' => ['FEATUREemapreduceZXY046'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => '是否全部删除，只针对tags为空时有效。取值范围： true false True False 默认是 false',
- 'description' => '是否全部删除，只针对 tags 为空时有效。默认为 false。',
- 'type' => 'boolean',
+ 'description' => '请求结构体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CustomSSLCertificate' => ['description' => '自定义SSL证书', 'type' => 'string', 'required' => false, 'example' => 'MIIP0wIBAzCCD4wGCSqGSIb3DQEHAaCCD30Egg95MIIPdTCCBbwGCSqGSIb3DQEHAaCCBa0EggWpMIIFpTCCBaEGCyqGSIb3DQEMCgECoIIFQDCCBTwwZgYJKoZIhvcNAQUNMFkwOAYJKoZIhvcNAQUMMCsEFHkQJTDaeFabOsRTB4Q7hgW6if7hAgInEAIBIDAMBggqhkiG9w0CCQU'],
+ 'InstanceId' => ['description' => '实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-0104730e9de40215'],
+ 'EnableCustom' => ['description' => '自定义证书', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'SslKeystorePassword' => ['description' => 'KeyStore密码', 'type' => 'string', 'required' => false, 'example' => '21esSd9Ao'],
+ 'SslKeyPassword' => ['description' => 'Key密码', 'type' => 'string', 'required' => false, 'example' => 'KoZ13vcNAQ'],
+ 'Renewal' => ['description' => '是否为证书更新', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
'required' => false,
- 'example' => 'true',
- 'default' => 'false',
],
],
],
@@ -2166,27 +3813,43 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX',
- ],
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '可升级的版本号。', 'type' => 'boolean', 'example' => '24151320976****'],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\"\\n}","type":"json"}]',
- 'title' => '解绑标签',
- ],
- 'ChangeResourceGroup' => [
- 'summary' => '本接口用于修改 Serverless StarRocks 实例的资源组。',
- 'path' => '/webapi/resourceGroup/change',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'StarRocks连接开启SSL',
+ 'description' => '调用该接口时实例必须处于运行中（Running）状态。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:EnableSSLConnection',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'GetInstanceFeatureGate' => [
+ 'path' => '/webapi/features/featureGate',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2195,54 +3858,127 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '233515',
- 'abilityTreeNodes' => [
- 'FEATUREemapreduceUHHTB7',
- ],
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '240415',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'NewResourceGroupId',
+ 'name' => 'InstanceId',
'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '目标资源组',
- 'description' => '目标资源组ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rg-4352gdf****',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'B67D142D-D54E-184F-A306-22BDC01B2XXX'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Total' => ['description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'MountDlfMetaToken' => ['description' => '支持挂载 DLF meta token', 'type' => 'boolean', 'example' => 'true'],
+ 'FullManagedSecurityGroup' => ['description' => '托管安全组', 'type' => 'boolean', 'example' => 'true'],
+ 'SupportFastRestart' => ['description' => '支持快速重启', 'type' => 'boolean', 'example' => 'true'],
+ 'SupportAddConfigTypes' => [
+ 'description' => '新增的配置类型列表',
+ 'type' => 'array',
+ 'items' => ['description' => '新增的配置类型', 'type' => 'string', 'example' => 'lake_compaction_max_tasks'],
+ ],
+ 'SupportCreateAgent' => ['description' => '支持创建Agent', 'type' => 'boolean', 'example' => 'true'],
+ 'SupportModifyTimezone' => ['description' => '支持修改时区', 'type' => 'boolean', 'example' => 'true'],
+ 'SupportBackup' => ['description' => '是否支持数据备份，取值说明：'."\n"
+ ."\n"
+ .'- **1**：支持数据备份。'."\n"
+ .'- **2**：不支持数据备份。', 'type' => 'boolean', 'example' => 'true'],
+ 'SupportMultiAZ' => ['description' => '支持多AZ部署 Observer', 'type' => 'boolean', 'example' => 'true'],
+ 'SupportFastModeModifyResource' => ['description' => '支持以快速重启的方式修改资源', 'type' => 'boolean', 'example' => 'true'],
+ 'SupportFastModeModifyConfig' => ['description' => '支持在配置变更时快速重启', 'type' => 'boolean', 'example' => 'true'],
+ 'SupportCreateNonStandardNodeGroup' => ['description' => '支持创建standard之外的规格类型计算组', 'type' => 'boolean', 'example' => 'true'],
+ 'UseComputeNode' => ['description' => '使用CN', 'type' => 'boolean', 'example' => 'true'],
+ 'SupportFeGateway' => ['description' => '支持FE网关', 'type' => 'boolean', 'example' => 'true'],
+ 'ConsoleControlRestart' => ['description' => '支持控制台来控制重启流程', 'type' => 'boolean', 'example' => 'true'],
+ 'EnableManageMv' => ['description' => '支持管理物化视图', 'type' => 'boolean', 'example' => 'true'],
+ 'SupportEnableSSL' => ['description' => '支持开启SSL', 'type' => 'boolean', 'example' => 'true'],
+ 'SupportHostAlias' => ['description' => '支持自定义域名', 'type' => 'boolean', 'example' => 'true'],
+ 'SupportEed' => ['description' => '支持弹性临时盘', 'type' => 'boolean', 'example' => 'true'],
+ 'supportCompactionService' => ['type' => 'boolean'],
+ 'supportCompactionServiceWhiteList' => ['description' => '是否支持Compaction Service白名单功能', 'type' => 'boolean', 'example' => 'true'],
+ 'SupportEnableAi' => ['description' => '支持AI Function', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ ],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => 'StarRocks集群实例的特性开关',
+ 'summary' => '获取StarRocks集群实例的特性开关',
+ 'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[计费项](https://help.aliyun.com/zh/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c4g.11186623.help-menu-28066.d_0_1_1.4db82b05p3Gg0G)</props><props="intl">[计费项](https://www.alibabacloud.com/help/en/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c63.p38356.help-menu-28066.d_0_1_0.3aaf4b0b69jN1P)</props>。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '地域Id',
- 'description' => '集群所在的地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:GetInstanceFeatureGate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"B67D142D-D54E-184F-A306-22BDC01B2XXX\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Total\\": 100,\\n \\"Data\\": {\\n \\"MountDlfMetaToken\\": true,\\n \\"FullManagedSecurityGroup\\": true,\\n \\"SupportFastRestart\\": true,\\n \\"SupportAddConfigTypes\\": [\\n \\"lake_compaction_max_tasks\\"\\n ],\\n \\"SupportCreateAgent\\": true,\\n \\"SupportModifyTimezone\\": true,\\n \\"SupportBackup\\": true,\\n \\"SupportMultiAZ\\": true,\\n \\"SupportFastModeModifyResource\\": true,\\n \\"SupportFastModeModifyConfig\\": true,\\n \\"SupportCreateNonStandardNodeGroup\\": true,\\n \\"UseComputeNode\\": true,\\n \\"SupportFeGateway\\": true,\\n \\"ConsoleControlRestart\\": true,\\n \\"EnableManageMv\\": true,\\n \\"SupportEnableSSL\\": true,\\n \\"SupportHostAlias\\": true,\\n \\"SupportEed\\": true,\\n \\"supportCompactionService\\": true,\\n \\"supportCompactionServiceWhiteList\\": true,\\n \\"SupportEnableAi\\": true\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'GetNodeGroupFeatureGate' => [
+ 'path' => '/webapi/features/nodeGroupFeatureGate',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '247437',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
[
- 'name' => 'ResourceType',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '资源类型，目前仅支持instance。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'instance',
- ],
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'NodeGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c-1854345****',
- ],
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-d332aa8bca48****'],
],
],
'responses' => [
@@ -2250,115 +3986,143 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'HttpStatusCode' => [
- 'description' => 'HTTP请求状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n",
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'ErrCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'ErrMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Invalid params: [instance not exists].',
- ],
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Total' => ['description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'Data' => [
- 'description' => '是否转组成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'AccessDeniedDetail' => [
- 'title' => 'AccessDeniedDetail',
- 'description' => 'AccessDeniedDetail',
- 'type' => 'string',
- 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'SupportFastRestart' => ['description' => '支持快速重启', 'type' => 'boolean', 'example' => 'true'],
+ 'SupportFastModeModifyResource' => ['description' => '支持以快速重启的方式修改资源', 'type' => 'boolean', 'example' => 'true'],
+ 'SupportModifySpecType' => ['description' => '支持修改规格类型', 'type' => 'boolean', 'example' => 'true'],
+ 'NeedRestartAfterModifyDiskSize' => ['description' => '修改磁盘大小后需要重启节点', 'type' => 'boolean', 'example' => 'true'],
+ ],
],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"Success\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
- 'title' => '修改资源组',
- ],
- 'UpgradeVersion' => [
- 'summary' => '本接口用于升级 Serverless StarRocks 实例版本。Serverless StarRocks 有两层版本定义，一层是主版本，即集群详情页“版本”所显示的内容，另一层是小版本，即集群详情页“小版本”所显示的内容。本接口既可以用于升级小版本，也可以用于升级主版本。'."\n"
- .'可以使用接口 QueryUpgradableVersions 查询集群的可升级版本。',
- 'path' => '/webapi/starrocks/upgradeVersion',
- 'methods' => [
- 'post',
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '获取计算组实例的特性开关',
+ 'summary' => '获取StarRocks 计算组实例的特性开关',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:GetNodeGroupFeatureGate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Total\\": 3,\\n \\"Data\\": {\\n \\"SupportFastRestart\\": true,\\n \\"SupportFastModeModifyResource\\": true,\\n \\"SupportModifySpecType\\": true,\\n \\"NeedRestartAfterModifyDiskSize\\": true\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'IsolateLeader' => [
+ 'path' => '/webapi/gateway/isolateLeader',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '181121',
- 'abilityTreeNodes' => [
- 'FEATUREemapreduceZXY046',
- ],
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '270153',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '实例 ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c-b25e21e24388****',
- ],
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
],
[
- 'name' => 'TargetVersion',
+ 'name' => 'IsolateLeader',
'in' => 'query',
+ 'schema' => ['description' => '是否开启读写分离（Leader FE节点处理写请求，其余节点处理读请求）。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '目标版本号。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '3.3.2-1.77-1.6.4',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'boolean', 'example' => '24151320976****'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'title' => '开启读写分离',
+ 'summary' => '是否开启读写分离（Leader FE 节点处理写请求，其余节点处理读请求）。',
+ 'description' => '调用该接口时实例必须处于运行中（Running）状态。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Minor',
- 'in' => 'query',
- 'schema' => [
- 'description' => '本次升级是否为小版本升级。默认值为 true 即升级小版本。'."\n"
- .'- true：小版本升级；'."\n"
- .'- false：大版本升级。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:IsolateLeader',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"Success\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'ListGateway' => [
+ 'path' => '/webapi/gateway/list',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'FastMode',
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '270155',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'type' => 'boolean',
- 'required' => false,
- ],
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
],
],
'responses' => [
@@ -2366,63 +4130,63 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'HttpStatusCode' => [
- 'description' => 'HTTP请求状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ErrCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'InvalidParams',
- ],
- 'ErrMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Invalid instance status: [cannot upgrade when instance is not running].',
- ],
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
'Data' => [
'description' => '返回数据。',
- 'type' => 'boolean',
- ],
- 'AccessDeniedDetail' => [
- 'title' => 'AccessDeniedDetail',
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'GatewayId' => ['description' => '网关ID。', 'type' => 'string', 'example' => '13822'],
+ 'GatewayName' => ['description' => '网关名称。', 'type' => 'string', 'example' => 'Gateway 1'],
+ 'GatewayType' => ['description' => '网关类型，一般为Slb或者Privatezone', 'type' => 'string', 'example' => 'slb'],
+ 'InternalSlbId' => ['description' => '内网slbId', 'type' => 'string', 'example' => 'lb-123abc'],
+ 'PublicSlbId' => ['description' => '公网slbId', 'type' => 'string', 'example' => 'lb-abc123'],
+ 'EnablePublicNet' => ['description' => '是否开启公网访问', 'type' => 'boolean', 'example' => 'true'],
+ 'FeNodeNumber' => ['description' => '网关节点数量', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'InternalDomain' => ['description' => '内网访问域名', 'type' => 'string', 'example' => 'fe-c-b25e21e24388****-ab8sjd-internal.starrocks.aliyuncs.com'],
+ 'PublicDomain' => ['description' => '公网访问域名', 'type' => 'string', 'example' => 'fe-c-b25e21e24388****-8s272d.starrocks.aliyuncs.com'],
+ 'PrivatezoneId' => ['description' => 'PrivatezoneId', 'type' => 'string', 'example' => 'a62des2123243881b9s2sa220k2l38m9'],
+ 'PublicSlbAclId' => ['description' => '公网访问的权限控制AclId', 'type' => 'string', 'example' => 'acl-hsb123ksi2'],
+ ],
+ ],
],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid instance status: [cannot upgrade when instance is not running].\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
- 'title' => '升级版本',
- 'description' => '调用该接口时实例必须处于运行中（Running）状态。',
- ],
- 'QueryUpgradableVersions' => [
- 'summary' => '本接口用于查询 Serverless StarRocks 实例可升级的版本列表。Serverless StarRocks 有两层版本定义，一层是主版本，即集群详情页“版本”所显示的内容，另一层是小版本，即集群详情页“小版本”所显示的内容。本接口既可以用于查询可升级的小版本，也可以用于查询可升级的主版本。',
- 'path' => '/webapi/starrocks/queryUpgradableVersions',
- 'methods' => [
- 'post',
+ 'title' => '网关列表',
+ 'summary' => '获取网关列表',
+ 'description' => '获取集群网关列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ListGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": [\\n {\\n \\"GatewayId\\": \\"13822\\",\\n \\"GatewayName\\": \\"Gateway 1\\",\\n \\"GatewayType\\": \\"slb\\",\\n \\"InternalSlbId\\": \\"lb-123abc\\",\\n \\"PublicSlbId\\": \\"lb-abc123\\",\\n \\"EnablePublicNet\\": true,\\n \\"FeNodeNumber\\": 2,\\n \\"InternalDomain\\": \\"fe-c-b25e21e24388****-ab8sjd-internal.starrocks.aliyuncs.com\\",\\n \\"PublicDomain\\": \\"fe-c-b25e21e24388****-8s272d.starrocks.aliyuncs.com\\",\\n \\"PrivatezoneId\\": \\"a62des2123243881b9s2sa220k2l38m9\\",\\n \\"PublicSlbAclId\\": \\"acl-hsb123ksi2\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListOperationActivity' => [
+ 'path' => '/webapi/operation/listOperationActivity',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2432,154 +4196,703 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '168030',
- 'abilityTreeNodes' => [
- 'FEATUREemapreduceGZP0FZ',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '205914',
+ 'abilityTreeNodes' => ['FEATUREemapreduceGZP0FZ'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '实例 ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c-b25e21e24388****',
- ],
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
],
[
- 'name' => 'Minor',
+ 'name' => 'OperationId',
'in' => 'query',
+ 'schema' => ['description' => '操作 ID。', 'type' => 'string', 'required' => false, 'example' => 'op-f49743caa809****'."\n"],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '使用查询可升级的小版本列表。默认值为 true：'."\n"
- .'- true：查询可升级的小版本列表；'."\n"
- .'- false：查询可升级的主版本列表。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ActivityId' => ['description' => '活动 ID。', 'type' => 'string', 'example' => 'ac-8f3f7c4026e3****'],
+ 'Name' => ['description' => '活动名称。', 'type' => 'string', 'example' => 'UpdateClusterStatusToModifyingConfigStatus'],
+ 'ActivityStatus' => ['description' => '活动状态。包括以下取值：'."\n"
+ ."\n"
+ .'- COMPLETED'."\n"
+ .'- RUNNING', 'type' => 'string', 'example' => 'COMPLETED'],
+ 'StartTime' => ['description' => '活动开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1742178604000'],
+ 'EndTime' => ['description' => '活动结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1742178604000'],
+ 'ErrMessage' => ['type' => 'string'],
+ 'ConsoleRetryCount' => ['type' => 'integer', 'format' => 'int32'],
+ ],
+ ],
+ ],
+ 'Total' => ['description' => '查询结果总数量', 'type' => 'integer', 'format' => 'int32', 'example' => '440'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询操作详情',
+ 'summary' => '获取操作的详细信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ListOperationActivity',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": [\\n {\\n \\"ActivityId\\": \\"ac-8f3f7c4026e3****\\",\\n \\"Name\\": \\"UpdateClusterStatusToModifyingConfigStatus\\",\\n \\"ActivityStatus\\": \\"COMPLETED\\",\\n \\"StartTime\\": 1742178604000,\\n \\"EndTime\\": 1742178604000,\\n \\"ErrMessage\\": \\"\\",\\n \\"ConsoleRetryCount\\": 0\\n }\\n ],\\n \\"Total\\": 440,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'ListOperationHistory' => [
+ 'path' => '/webapi/operation/listOperationHistory',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '189493',
+ 'abilityTreeNodes' => ['FEATUREemapreduceGZP0FZ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '当前分页的页码数。默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时每页的条目数。默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000', 'minimum' => '1', 'example' => '10', 'default' => '10'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'OperationId',
+ 'in' => 'query',
+ 'schema' => ['description' => '操作 ID。', 'type' => 'string', 'required' => false, 'example' => 'op-f49743caa809****'],
+ ],
+ [
+ 'name' => 'OperationType',
+ 'in' => 'query',
+ 'schema' => ['description' => '操作类型。包含以下取值：'."\n"
+ .'- trial_to_official：入门版转标准版'."\n"
+ .'- upgrade_version：版本升级'."\n"
+ .'- update_configuration：配置更新'."\n"
+ .'- update_public_network_status：更新公网状态'."\n"
+ .'- create_cluster：创建集群'."\n"
+ .'- delete_cluster：删除集群'."\n"
+ .'- disable_cluster：集群停机'."\n"
+ .'- enable_cluster：恢复集群'."\n"
+ .'- restart_cluster：重启集群'."\n"
+ .'- migrate_cluster：迁移集群'."\n"
+ .'- renew_cluster：续费集群'."\n"
+ .'- modify_charge_type：变更付费类型'."\n"
+ .'- UPGRADE：升级集群'."\n"
+ .'- DOWNGRADE：降级集群'."\n"
+ .'- create_node_group：创建节点组'."\n"
+ .'- delete_node_group：删除节点组'."\n"
+ .'- disable_node_group：停机节点组'."\n"
+ .'- enable_node_group：恢复节点组'."\n"
+ .'- sre_operation：运维集群'."\n"
+ .'- resource_change：资源变化'."\n"
+ .'- disable_postpaid_resource：禁用按量付费资源'."\n"
+ .'- enable_postpaid_resource：恢复按量付费资源'."\n"
+ .'- restart_node_group：重启计算组'."\n"
+ .'- enable_ha_cluster：集群开启高可用'."\n"
+ .'- restart_node：重启节点'."\n"
+ .'- backup：数据备份'."\n"
+ .'- delete_backup：删除数据备份'."\n"
+ .'- cancel_backup_task：取消数据备份'."\n"
+ .'- modify_timezone：修改系统时区'."\n"
+ .'- restore：数据恢复'."\n"
+ .'- switch_az：切换主备可用区'."\n"
+ .'- rollback_upgrade_version：版本升级回滚'."\n"
+ .'- scale_out_fe：扩容 FE'."\n"
+ .'- scale_in_fe：缩容 FE'."\n"
+ .'- upgrade_fe_cu：升配 FE CU 规格'."\n"
+ .'- downgrade_fe_cu：降配 FE CU 规格'."\n"
+ .'- increase_fe_disk_size：增加 FE 磁盘大小'."\n"
+ .'- decrease_fe_disk_size：减小 FE 磁盘大小'."\n"
+ .'- increase_fe_disk_number：增加 FE 磁盘块数'."\n"
+ .'- decrease_fe_disk_number：减小 FE 磁盘块数'."\n"
+ .'- upgrade_fe_disk_performance_level：升配 FE 磁盘性能级别'."\n"
+ .'- downgrade_fe_disk_performance_level：降配 FE 磁盘性能级别'."\n"
+ .'- create_agent：创建Agent'."\n"
+ .'- upgrade_agent_cu：升配 Agent CU 规格'."\n"
+ .'- scale_out_be：扩容 BE'."\n"
+ .'- scale_in_be：缩容 BE'."\n"
+ .'- upgrade_be_cu：升配 BE CU 规格'."\n"
+ .'- downgrade_be_cu：降配 BE CU 规格'."\n"
+ .'- increase_be_disk_size：增加 BE 磁盘大小'."\n"
+ .'- decrease_be_disk_size：减小 BE 磁盘大小'."\n"
+ .'- increase_be_disk_number：增加 BE 磁盘块数'."\n"
+ .'- decrease_be_disk_number：减小 BE 磁盘块数'."\n"
+ .'- upgrade_be_disk_performance_level：升配 BE 磁盘性能级别'."\n"
+ .'- downgrade_be_disk_performance_level：降配 BE 磁盘性能级别'."\n"
+ .'- upgrade_be_spec_type：升配 BE 规格类型'."\n"
+ .'- downgrade_be_spec_type：降配 BE 规格类型'."\n"
+ .'- scale_out_cn：扩容 CN'."\n"
+ .'- scale_in_cn：缩容 CN'."\n"
+ .'- upgrade_cn_cu：升配 CN CU 规格'."\n"
+ .'- downgrade_cn_cu：降配 CN CU 规格'."\n"
+ .'- increase_cn_disk_size：增加 CN 磁盘大小'."\n"
+ .'- decrease_cn_disk_size：减小 CN 磁盘大小'."\n"
+ .'- increase_cn_disk_number：增加 CN 磁盘块数'."\n"
+ .'- decrease_cn_disk_number：减小 CN 磁盘块数'."\n"
+ .'- upgrade_cn_disk_performance：升配 CN 磁盘性能级别'."\n"
+ .'- downgrade_cn_disk_performance：降配 CN 磁盘性能级别'."\n"
+ .'- upgrade_cn_spec_type：升配 CN 规格类型'."\n"
+ .'- downgrade_cn_spec_type：降配 CN 规格类型'."\n"
+ .'- elastic_scale_out_cn：弹性扩容 CN'."\n"
+ .'- elastic_scale_in_cn：弹性缩容 CN', 'type' => 'string', 'required' => false, 'example' => 'update_configuration'],
+ ],
+ [
+ 'name' => 'OperationStatus',
+ 'in' => 'query',
+ 'schema' => ['description' => '操作状态：'."\n"
+ ."\n"
+ .'- COMPLETED：已完成'."\n"
+ .'- TERMINATED：已终止'."\n"
+ .'- HUMAN_PROCESSING：待人工处理', 'type' => 'string', 'required' => false, 'example' => 'COMPLETED'],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '操作开始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1742179008000'],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '操作结束时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1742179008000'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'HttpStatusCode' => [
- 'description' => 'HTTP请求状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ErrCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'InvalidParams',
- ],
- 'ErrMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Invalid params: [instance not exists].',
- ],
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
'Data' => [
- 'description' => '可升级的版本列表。',
+ 'description' => '返回数据。',
'type' => 'array',
'items' => [
- 'description' => '可升级的版本号。',
- 'type' => 'string',
- 'example' => '3.3.2-1.77-1.6.4',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => '实例 ID。', 'type' => 'string', 'example' => 'c-cd7a3a6f2186d5c9'],
+ 'OperationId' => ['description' => '操作ID', 'type' => 'string', 'example' => 'op-f49743caa809****'],
+ 'OperationType' => ['description' => '操作类型。包含以下取值：'."\n"
+ .'- trial_to_official：入门版转标准版'."\n"
+ .'- upgrade_version：版本升级'."\n"
+ .'- update_configuration：配置更新'."\n"
+ .'- update_public_network_status：更新公网状态'."\n"
+ .'- create_cluster：创建集群'."\n"
+ .'- delete_cluster：删除集群'."\n"
+ .'- disable_cluster：集群停机'."\n"
+ .'- enable_cluster：恢复集群'."\n"
+ .'- restart_cluster：重启集群'."\n"
+ .'- migrate_cluster：迁移集群'."\n"
+ .'- renew_cluster：续费集群'."\n"
+ .'- modify_charge_type：变更付费类型'."\n"
+ .'- UPGRADE：升级集群'."\n"
+ .'- DOWNGRADE：降级集群'."\n"
+ .'- create_node_group：创建节点组'."\n"
+ .'- delete_node_group：删除节点组'."\n"
+ .'- disable_node_group：停机节点组'."\n"
+ .'- enable_node_group：恢复节点组'."\n"
+ .'- sre_operation：运维集群'."\n"
+ .'- resource_change：资源变化'."\n"
+ .'- disable_postpaid_resource：禁用按量付费资源'."\n"
+ .'- enable_postpaid_resource：恢复按量付费资源'."\n"
+ .'- restart_node_group：重启计算组'."\n"
+ .'- enable_ha_cluster：集群开启高可用'."\n"
+ .'- restart_node：重启节点'."\n"
+ .'- backup：数据备份'."\n"
+ .'- delete_backup：删除数据备份'."\n"
+ .'- cancel_backup_task：取消数据备份'."\n"
+ .'- modify_timezone：修改系统时区'."\n"
+ .'- restore：数据恢复'."\n"
+ .'- switch_az：切换主备可用区'."\n"
+ .'- rollback_upgrade_version：版本升级回滚'."\n"
+ .'- scale_out_fe：扩容 FE'."\n"
+ .'- scale_in_fe：缩容 FE'."\n"
+ .'- upgrade_fe_cu：升配 FE CU 规格'."\n"
+ .'- downgrade_fe_cu：降配 FE CU 规格'."\n"
+ .'- increase_fe_disk_size：增加 FE 磁盘大小'."\n"
+ .'- decrease_fe_disk_size：减小 FE 磁盘大小'."\n"
+ .'- increase_fe_disk_number：增加 FE 磁盘块数'."\n"
+ .'- decrease_fe_disk_number：减小 FE 磁盘块数'."\n"
+ .'- upgrade_fe_disk_performance_level：升配 FE 磁盘性能级别'."\n"
+ .'- downgrade_fe_disk_performance_level：降配 FE 磁盘性能级别'."\n"
+ .'- create_agent：创建Agent'."\n"
+ .'- upgrade_agent_cu：升配 Agent CU 规格'."\n"
+ .'- scale_out_be：扩容 BE'."\n"
+ .'- scale_in_be：缩容 BE'."\n"
+ .'- upgrade_be_cu：升配 BE CU 规格'."\n"
+ .'- downgrade_be_cu：降配 BE CU 规格'."\n"
+ .'- increase_be_disk_size：增加 BE 磁盘大小'."\n"
+ .'- decrease_be_disk_size：减小 BE 磁盘大小'."\n"
+ .'- increase_be_disk_number：增加 BE 磁盘块数'."\n"
+ .'- decrease_be_disk_number：减小 BE 磁盘块数'."\n"
+ .'- upgrade_be_disk_performance_level：升配 BE 磁盘性能级别'."\n"
+ .'- downgrade_be_disk_performance_level：降配 BE 磁盘性能级别'."\n"
+ .'- upgrade_be_spec_type：升配 BE 规格类型'."\n"
+ .'- downgrade_be_spec_type：降配 BE 规格类型'."\n"
+ .'- scale_out_cn：扩容 CN'."\n"
+ .'- scale_in_cn：缩容 CN'."\n"
+ .'- upgrade_cn_cu：升配 CN CU 规格'."\n"
+ .'- downgrade_cn_cu：降配 CN CU 规格'."\n"
+ .'- increase_cn_disk_size：增加 CN 磁盘大小'."\n"
+ .'- decrease_cn_disk_size：减小 CN 磁盘大小'."\n"
+ .'- increase_cn_disk_number：增加 CN 磁盘块数'."\n"
+ .'- decrease_cn_disk_number：减小 CN 磁盘块数'."\n"
+ .'- upgrade_cn_disk_performance：升配 CN 磁盘性能级别'."\n"
+ .'- downgrade_cn_disk_performance：降配 CN 磁盘性能级别'."\n"
+ .'- upgrade_cn_spec_type：升配 CN 规格类型'."\n"
+ .'- downgrade_cn_spec_type：降配 CN 规格类型'."\n"
+ .'- elastic_scale_out_cn：弹性扩容 CN'."\n"
+ .'- elastic_scale_in_cn：弹性缩容 CN', 'type' => 'string', 'example' => 'upgrade_version'],
+ 'BeforeValue' => ['description' => '操作之前的值。', 'type' => 'string', 'example' => 'FE enable = false'],
+ 'AfterValue' => ['description' => '操作之后的值。', 'type' => 'string', 'example' => 'FE enable = true'],
+ 'GmtCreate' => ['description' => '操作开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1742179008000'],
+ 'GmtEnd' => ['description' => '操作结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1742179008000'],
+ 'OperationStatus' => ['description' => '操作状态：'."\n"
+ ."\n"
+ .'- COMPLETED：已完成'."\n"
+ .'- TERMINATED：已终止'."\n"
+ .'- HUMAN_PROCESSING：待人工处理', 'type' => 'string', 'example' => 'COMPLETED'],
+ 'Progress' => ['description' => '操作进度。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'OperationDetail' => ['description' => '操作详情。', 'type' => 'string', 'example' => '库存不足，操作失败，已退款'],
+ ],
],
],
- 'AccessDeniedDetail' => [
- 'title' => 'AccessDeniedDetail',
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }',
- ],
+ 'Total' => ['description' => '总记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '832'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询集群操作历史',
+ 'summary' => '获取集群的操作历史',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": [\\n \\"3.3.2-1.77-1.6.4\\"\\n ],\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
- 'title' => '查询可升级的版本列表',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ListOperationHistory',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"c-cd7a3a6f2186d5c9\\",\\n \\"OperationId\\": \\"op-f49743caa809****\\",\\n \\"OperationType\\": \\"upgrade_version\\",\\n \\"BeforeValue\\": \\"FE enable = false\\",\\n \\"AfterValue\\": \\"FE enable = true\\",\\n \\"GmtCreate\\": 1742179008000,\\n \\"GmtEnd\\": 1742179008000,\\n \\"OperationStatus\\": \\"COMPLETED\\",\\n \\"Progress\\": 100,\\n \\"OperationDetail\\": \\"库存不足，操作失败，已退款\\"\\n }\\n ],\\n \\"Total\\": 832,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
],
- 'ModifyNodeNumberPreCheck' => [
- 'summary' => '本接口用于对修改 Serverless StarRocks 实例的计算组中节点数量的操作进行预检查。',
- 'path' => '/webapi/resourceChange/modifyNodeNumberPreCheck',
- 'methods' => [
- 'post',
+ 'ListSSLDetails' => [
+ 'summary' => '获取集群SSL证书详情',
+ 'path' => '/webapi/starrocks/listSSLDetails',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '275931',
+ 'abilityTreeNodes' => ['FEATUREemapreduceZXY046'],
+ 'tenantRelevance' => 'tenant',
],
- 'schemes' => [
- 'http',
- 'https',
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'IsValid' => ['description' => '是否有效', 'type' => 'boolean', 'example' => 'true'],
+ 'EnableSSL' => ['description' => '是否开启SSL。', 'type' => 'boolean', 'example' => 'true'],
+ 'NotBefore' => ['description' => '证书有效期的开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1751000702000'],
+ 'NotAfter' => ['description' => '证书有效期的截止时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1751010702000'],
+ 'Aliases' => ['description' => '证书的别名。', 'type' => 'string', 'example' => 'starrocks-ssl'],
+ 'SubjectDN' => ['description' => 'CA证书的DN（Distinguished Name）属性，表示证书的使用者，具体包含以下信息：'."\n"
+ ."\n"
+ .'- **C**：组织机构所在国家代码。'."\n"
+ .'- **O**：组织机构的名称。'."\n"
+ .'- **OU**：组织机构下的部门。'."\n"
+ .'- **L**：组织机构所在城市。'."\n"
+ .'- **CN**：组织机构的通用名称或简称。', 'type' => 'string', 'example' => 'CN=fe-{clusterId}-internal.starrocks.aliyuncs.com, OU=Aliyun Big Data Platform EMR StarRocks, O=Aliyun, L=BJ, ST=CN, C=CN'],
+ 'IssuerDN' => ['description' => '系统自签名证书时，因为是自签名，IssuerDN 和 SubjectDN 内容相同（自己签自己）。用户自定义证书时，取 x509Cert.getIssuerDN().getName()，指向实际签发该证书的 CA 机构', 'type' => 'string', 'example' => 'CN=fe-sr-cn-xxx123-internal.starrocks.aliyuncs.com, OU=Aliyun Big Data Platform EMR StarRocks, O=Aliyun, L=BJ, ST=CN, C=CN'],
+ 'SslCertificateText' => ['description' => '存储的是证书文件的 Base64 编码内容（PKCS#12 格式的 .p12 文件）。系统证书是生成的 P12 文件 Base64 后的字符串；自定义证书则是用户上传时传入的 customSSLCertificate 原始值', 'type' => 'string', 'example' => 'MIIJkAIBAzCCCVYGCSqGSIb3DQEHAaCCCUcEgglDMIIJPzCCA+8GCSqGSIb3DQEHBqCCA+AwggPc'."\n"
+ .'AgEAMIID1QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQI3e4V2eXgGFMCAggAgIIDqJ/L8sA'."\n"
+ .'......'."\n"
+ .'AB3eKpMa7rQc=='],
+ 'CustomCert' => ['description' => '系统自动生成的证书固定为 false；用户上传自定义证书时固定为 true。', 'type' => 'boolean', 'example' => 'true'],
+ 'Status' => ['description' => '状态列表。'."\n"
+ ."\n"
+ .'- valid'."\n"
+ ."\n"
+ .'- expired'."\n"
+ ."\n"
+ .'- unknown', 'type' => 'string', 'example' => 'valid'],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'SSL证书详情',
+ 'description' => '获取集群SSL证书详情',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ListSSLDetails',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": {\\n \\"IsValid\\": true,\\n \\"EnableSSL\\": true,\\n \\"NotBefore\\": 1751000702000,\\n \\"NotAfter\\": 1751010702000,\\n \\"Aliases\\": \\"starrocks-ssl\\",\\n \\"SubjectDN\\": \\"CN=fe-{clusterId}-internal.starrocks.aliyuncs.com, OU=Aliyun Big Data Platform EMR StarRocks, O=Aliyun, L=BJ, ST=CN, C=CN\\",\\n \\"IssuerDN\\": \\"CN=fe-sr-cn-xxx123-internal.starrocks.aliyuncs.com, OU=Aliyun Big Data Platform EMR StarRocks, O=Aliyun, L=BJ, ST=CN, C=CN\\",\\n \\"SslCertificateText\\": \\"MIIJkAIBAzCCCVYGCSqGSIb3DQEHAaCCCUcEgglDMIIJPzCCA+8GCSqGSIb3DQEHBqCCA+AwggPc\\\\nAgEAMIID1QYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQI3e4V2eXgGFMCAggAgIIDqJ/L8sA\\\\n......\\\\nAB3eKpMa7rQc==\\",\\n \\"CustomCert\\": true,\\n \\"Status\\": \\"valid\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ModifyChargeType' => [
+ 'path' => '/webapi/cluster/modifyChargeType',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- 'application/x-www-form-urlencoded',
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '181466',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['title' => '集群id', 'description' => '集群id', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'AutoRenew',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否开启自动续费，仅在 payType 为 PrePaid 时有意义。默认不开启。', 'type' => 'boolean', 'required' => false, 'example' => 'True'],
+ ],
+ [
+ 'name' => 'Duration',
+ 'in' => 'query',
+ 'schema' => ['description' => '购买时长。仅在 payType 为 PrePaid 时有意义。', 'type' => 'string', 'required' => false, 'example' => '2'],
+ ],
+ [
+ 'name' => 'PricingCycle',
+ 'in' => 'query',
+ 'schema' => ['description' => '购买时长单位：'."\n"
+ .'<ul>'."\n"
+ .'<li> 月（Month）</li>'."\n"
+ .'<li> 年（Year）</li>'."\n"
+ .'</ul>'."\n"
+ .'仅在 payType 为 PrePaid 时有意义。', 'type' => 'string', 'required' => false, 'example' => 'Month'],
+ ],
+ [
+ 'name' => 'BillingInstanceIds',
+ 'in' => 'query',
+ 'schema' => ['title' => '需要续费的计费实例 ID 列表，多个计费实例 ID 用逗号隔开。', 'description' => '需要续费的计费实例 ID 列表，多个计费实例 ID 用逗号隔开。', 'type' => 'string', 'required' => false, 'example' => 'c-3d6dc31ba67b1839'],
+ ],
+ [
+ 'name' => 'PromotionOptionNo',
+ 'in' => 'query',
+ 'schema' => ['description' => '优惠券ID。', 'type' => 'string', 'required' => false, 'example' => '2345'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'integer', 'format' => 'int64', 'example' => '24151320976****'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '修改实例的付费类型',
+ 'summary' => '修改实例的付费类型',
+ 'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[计费项](https://help.aliyun.com/zh/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c4g.11186623.help-menu-28066.d_0_1_1.4db82b05p3Gg0G)</props><props="intl">[计费项](https://www.alibabacloud.com/help/en/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c63.p38356.help-menu-28066.d_0_1_0.3aaf4b0b69jN1P)</props>。'."\n"
+ ."\n"
+ .'调用该接口时，您需要注意：'."\n"
+ ."\n"
+ .'- 只有标准版实例支持修改计算组 CU 数量，入门版实例不支持。'."\n"
+ ."\n"
+ .'- 只有计算组规格类型为标准版 (standard) 的实例支持增加磁盘数量。'."\n"
+ ."\n"
+ .'- 实例必须处于运行中（Running）状态。'."\n"
+ ."\n"
+ .'修改 CU 数量后，计费变化情况如下：'."\n"
+ ."\n"
+ .'- 按量付费：按照新的 CU 数量计费。'."\n"
+ ."\n"
+ .'- 包年包月：在计费周期内，会根据新旧配置的价格差和剩余天数（从次日 0 点到有效期结束）来计算应补缴的费用。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyChargeType',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'produces' => [
- 'application/json',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": 0,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyCu' => [
+ 'path' => '/webapi/resourceChange/modifyCu',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '221371',
- 'abilityTreeNodes' => [
- 'FEATUREemapreduceUHHTB7',
- ],
+ 'abilityTreeCode' => '220680',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ [
+ 'name' => 'Target',
+ 'in' => 'query',
'schema' => [
- 'description' => '实例 ID。',
- 'type' => 'string',
+ 'description' => '目标 CU 数量。',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => true,
- 'example' => 'c-b25e21e24388****',
+ 'maximum' => '64',
+ 'minimum' => '4',
+ 'example' => '4',
+ 'enum' => ['4', '8', '16', '32', '64'],
],
],
[
- 'name' => 'NodeGroupId',
+ 'name' => 'FastMode',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否以快速重启模式重启。默认为 false。'."\n"
+ ."\n"
+ .'- true：以快速重启模式重启计算节点。分为多个批次重启计算节点，批次内并行重启，批次间串行执行；'."\n"
+ .'- false：以滚动重启模式重启计算节点。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'PromotionOptionNo',
'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '计算组 ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ng-3d5ce6454354****',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'."\n"],
+ 'Data' => ['description' => '订单 ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '24151320976****'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改CU数量',
+ 'summary' => '本接口用于修改 Serverless StarRocks 实例计算组节点的 CU 数量。',
+ 'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[计费项](https://help.aliyun.com/zh/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c4g.11186623.help-menu-28066.d_0_1_1.4db82b05p3Gg0G)</props><props="intl">[计费项](https://www.alibabacloud.com/help/en/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c63.p38356.help-menu-28066.d_0_1_0.3aaf4b0b69jN1P)</props>。'."\n"
+ ."\n"
+ .'调用该接口时，您需要注意：'."\n"
+ ."\n"
+ .'- 只有标准版实例支持修改计算组 CU 数量，入门版实例不支持。'."\n"
+ ."\n"
+ .'- 只有计算组规格类型为标准版 (standard) 的实例支持增加磁盘数量。'."\n"
+ ."\n"
+ .'- 实例必须处于运行中（Running）状态。'."\n"
+ ."\n"
+ .'修改 CU 数量后，计费变化情况如下：'."\n"
+ ."\n"
+ .'- 按量付费：按照新的 CU 数量计费。'."\n"
+ ."\n"
+ .'- 包年包月：在计费周期内，会根据新旧配置的价格差和剩余天数（从次日 0 点到有效期结束）来计算应补缴的费用。',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-30T11:04:49.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-02-20T08:18:19.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyCu',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\\\n\\",\\n \\"Data\\": 0,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyCuPreCheck' => [
+ 'path' => '/webapi/resourceChange/modifyCuPreCheck',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '221372',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-d332aa8bca48****'],
+ ],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
- 'description' => '目标节点数量。',
+ 'description' => '目标 CU 数量。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '100',
'minimum' => '0',
- 'example' => '3',
+ 'example' => '2',
+ 'enum' => ['2', '4', '8', '16', '32', '64'],
],
],
],
@@ -2588,152 +4901,633 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'HttpStatusCode' => [
- 'description' => 'HTTP请求状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ErrCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'InvalidParams',
- ],
- 'ErrMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Invalid params: [instance not exists].',
- ],
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Allow' => [
- 'description' => '是否允许修改节点数量。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Reason' => [
- 'description' => '无法修改节点数量的原因。',
- 'type' => 'string',
- 'example' => 'Failed to find node group[ng-3d5ce6454354****].',
- ],
+ 'Allow' => ['description' => '是否允许修改 CU 数量。', 'type' => 'boolean', 'example' => 'false'],
+ 'Reason' => ['description' => '无法修改 CU 数量的原因。', 'type' => 'string', 'example' => 'Failed to find node group[ng-3d5ce6454354****].'],
],
],
- 'AccessDeniedDetail' => [
- 'title' => 'AccessDeniedDetail',
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }',
- ],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '计算组节点CU修改前的预检查',
+ 'summary' => '本接口用于对修改 Serverless StarRocks 实例的 FE、BE、CN 计算组中节点 CU 数量的操作进行预检查操作，以判断能否执行 CU 的升配或者降配操作。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": {\\n \\"Allow\\": true,\\n \\"Reason\\": \\"Failed to find node group[ng-3d5ce6454354****].\\"\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
- 'title' => '计算组节点数量修改前的预检查',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyCuPreCheck',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": {\\n \\"Allow\\": false,\\n \\"Reason\\": \\"Failed to find node group[ng-3d5ce6454354****].\\"\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
],
- 'ModifyNodeNumber' => [
- 'summary' => '本接口用于修改 Serverless StarRocks 实例计算组的节点数量。',
- 'path' => '/webapi/resourceChange/modifyNodeNumber',
- 'methods' => [
- 'post',
+ 'ModifyDiskNumber' => [
+ 'path' => '/webapi/resourceChange/modifyDiskNumber',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '220689',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ [
+ 'name' => 'Target',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标磁盘数量。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '0', 'example' => '3'],
+ ],
+ [
+ 'name' => 'FastMode',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否以快速重启模式重启。默认为 false。'."\n"
+ ."\n"
+ .'- true：以快速重启模式重启计算节点。分为多个批次重启计算节点，批次内并行重启，批次间串行执行；'."\n"
+ .'- false：以滚动重启模式重启计算节点。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'PromotionOptionNo',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '订单 ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '24151320976****'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '增加磁盘数量',
+ 'summary' => '本接口用于增加 Serverless StarRocks 实例计算组的节点磁盘块数。',
+ 'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[计费项](https://help.aliyun.com/zh/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c4g.11186623.help-menu-28066.d_0_1_1.4db82b05p3Gg0G)</props><props="intl">[计费项](https://www.alibabacloud.com/help/en/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c63.p38356.help-menu-28066.d_0_1_0.3aaf4b0b69jN1P)</props>。'."\n"
+ .'调用该接口时，您需要注意：'."\n"
+ ."\n"
+ .'- 只有标准版实例支持增加磁盘数量，入门版实例不支持。'."\n"
+ ."\n"
+ .'- 只有计算组规格类型为标准版 (standard) 的实例支持增加磁盘数量。'."\n"
+ ."\n"
+ .'- 实例必须处于运行中（Running）状态。'."\n"
+ ."\n"
+ .'增加磁盘数量后，计费变化情况如下：'."\n"
+ ."\n"
+ .'- 按量付费：按照新的磁盘类型计费。'."\n"
+ ."\n"
+ .'- 包年包月：在计费周期内，会根据新旧配置的价格差和剩余天数（从次日 0 点到有效期结束）来计算应补缴的费用。',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-30T11:04:49.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-02-20T08:18:19.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyDiskNumber',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": 0,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyDiskPerformanceLevel' => [
+ 'path' => '/webapi/resourceChange/modifyDiskPerformanceLevel',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- 'application/x-www-form-urlencoded',
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '220690',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
],
- 'produces' => [
- 'application/json',
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ [
+ 'name' => 'Target',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '目标磁盘性能级别。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'pl2',
+ 'enum' => ['pl0', 'pl1', 'pl2', 'pl3', 'eed_standard', 'eed_advanced'],
+ ],
+ ],
+ [
+ 'name' => 'PromotionOptionNo',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
+ ],
],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '订单 ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '24151320976****'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改磁盘性能级别',
+ 'summary' => '本接口用于修改 Serverless StarRocks 实例的计算组的节点磁盘性能级别。',
+ 'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[价格](https://www.aliyun.com/price/product?spm=openapi-amp.newDocPublishment.0.0.1837281f3hbi2d#/ecs/detail/vm)</props><props="intl">[价格](https://www.alibabacloud.com/zh/product/ecs?_p_lc=1#pricing)</props>。'."\n"
+ .'调用该接口时，您需要注意：'."\n"
+ ."\n"
+ .'- 只有标准版实例支持磁盘变配，入门版实例不支持。'."\n"
+ ."\n"
+ .'- 只有计算组规格类型为标准版 (standard) 的实例支持磁盘变配。'."\n"
+ ."\n"
+ .'- 实例必须处于运行中（Running）状态。'."\n"
+ ."\n"
+ .'- 不支持将磁盘降配到 PL0。'."\n"
+ ."\n"
+ .'- 由于 ESSD 云盘性能级别受容量限制，如果您无法升级性能级别，可以扩容后重新操作。更多信息，请参见<props="china">[ESSD云盘](https://help.aliyun.com/zh/ecs/user-guide/essds)</props><props="intl">[ESSD云盘](https://www.alibabacloud.com/help/en/ecs/user-guide/essds)</props>。'."\n"
+ ."\n"
+ .'磁盘变配后，计费变化情况如下：'."\n"
+ ."\n"
+ .'- 按量付费：按照新的磁盘类型计费。'."\n"
+ ."\n"
+ .'- 包年包月：在计费周期内，会根据新旧配置的价格差和剩余天数（从次日 0 点到有效期结束）来计算应补缴的费用。',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-10T11:40:59.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-06-30T11:04:49.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyDiskPerformanceLevel',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": 0,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyDiskSize' => [
+ 'summary' => '本接口用于对 Serverless StarRocks 实例计算组节点进行磁盘扩容。',
+ 'path' => '/webapi/resourceChange/modifyDiskSize',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '220610',
- 'abilityTreeNodes' => [
- 'FEATUREemapreduceUHHTB7',
- ],
+ 'abilityTreeCode' => '220685',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ [
+ 'name' => 'Target',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标磁盘大小。单位为 GB。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '65000', 'minimum' => '0', 'example' => '500'],
+ ],
+ [
+ 'name' => 'PromotionOptionNo',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
+ ],
+ [
+ 'name' => 'FastMode',
+ 'in' => 'query',
+ 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '实例 ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c-b25e21e24388****',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '订单 ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '24151320976****'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '磁盘扩容',
+ 'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[计费项](https://help.aliyun.com/zh/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c4g.11186623.help-menu-28066.d_0_1_1.4db82b05p3Gg0G)</props><props="intl">[计费项](https://www.alibabacloud.com/help/en/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c63.p38356.help-menu-28066.d_0_1_0.3aaf4b0b69jN1P)</props>。'."\n"
+ .'调用该接口时，您需要注意：'."\n"
+ ."\n"
+ .'- 只有标准版实例支持磁盘扩容，入门版实例不支持。'."\n"
+ ."\n"
+ .'- 只有计算组规格类型为标准版 (standard) 的实例支持磁盘扩容。'."\n"
+ ."\n"
+ .'- 实例必须处于运行中（Running）状态。'."\n"
+ ."\n"
+ .'磁盘扩容后，计费变化情况如下：'."\n"
+ ."\n"
+ .'- 按量付费：按照新的磁盘大小计费。'."\n"
+ ."\n"
+ .'- 包年包月：在计费周期内，会根据新旧配置的价格差和剩余天数（从次日 0 点到有效期结束）来计算应补缴的费用。',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-12T07:44:43.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-06-30T11:04:49.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyDiskSize',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": 0,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyDiskType' => [
+ 'path' => '/webapi/resourceChange/modifyDiskType',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '281276',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
[
'name' => 'NodeGroupId',
'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ [
+ 'name' => 'TargetPerformanceLevel',
+ 'in' => 'query',
'schema' => [
- 'description' => '计算组 ID。',
+ 'description' => '目标磁盘性能',
'type' => 'string',
'required' => true,
- 'example' => 'ng-3d5ce6454354****',
+ 'example' => 'pl2',
+ 'enum' => ['pl0', 'pl1', 'pl2', 'pl3', 'eed_standard', 'eed_advanced'],
],
],
[
- 'name' => 'Target',
+ 'name' => 'TargetDiskType',
'in' => 'query',
'schema' => [
- 'description' => '目标节点数量。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '目标磁盘类型',
+ 'type' => 'string',
'required' => true,
- 'maximum' => '100',
- 'minimum' => '0',
- 'example' => '3',
+ 'example' => 'essd',
+ 'enum' => ['eed', 'essd'],
],
],
[
'name' => 'PromotionOptionNo',
'in' => 'query',
+ 'schema' => ['description' => '优惠券ID。', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'type' => 'string',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'."\n"],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'integer', 'format' => 'int64', 'example' => 'true'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改计算组的节点磁盘类型',
+ 'summary' => '修改计算组的节点磁盘类型',
+ 'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[计费项](https://help.aliyun.com/zh/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c4g.11186623.help-menu-28066.d_0_1_1.4db82b05p3Gg0G)</props><props="intl">[计费项](https://www.alibabacloud.com/help/en/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c63.p38356.help-menu-28066.d_0_1_0.3aaf4b0b69jN1P)</props>。'."\n"
+ .'调用该接口时，您需要注意：'."\n"
+ ."\n"
+ .'- 只有标准版实例支持磁盘扩容，入门版实例不支持。'."\n"
+ ."\n"
+ .'- 只有计算组规格类型为标准版 (standard) 的实例支持磁盘扩容。'."\n"
+ ."\n"
+ .'- 实例必须处于运行中（Running）状态。'."\n"
+ ."\n"
+ .'磁盘扩容后，计费变化情况如下：'."\n"
+ ."\n"
+ .'- 按量付费：按照新的磁盘大小计费。'."\n"
+ ."\n"
+ .'- 包年包月：在计费周期内，会根据新旧配置的价格差和剩余天数（从次日 0 点到有效期结束）来计算应补缴的费用。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyDiskType',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\\\n\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": 0,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyHostAlias' => [
+ 'path' => '/webapi/network/modifyHostAlias',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '276723',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求参数信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'hostAliases' => [
+ 'description' => '主机别名列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'hostnames' => [
+ 'description' => '主机别名。',
+ 'type' => 'array',
+ 'items' => ['description' => '域名', 'type' => 'string', 'required' => false, 'example' => 'abc.122.com'],
+ 'required' => false,
+ ],
+ 'ip' => ['description' => '机器ip', 'type' => 'string', 'required' => false, 'example' => '26.15.54.221'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ ],
+ ],
'required' => false,
],
],
[
- 'name' => 'Parallelism',
+ 'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '订单 ID。', 'type' => 'boolean', 'example' => '24151320976****'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改主机别名',
+ 'summary' => '修改/etc/hosts',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'TerminationGracePeriodSeconds',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyHostAlias',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'ModifyInstanceConfig' => [
+ 'summary' => '本接口用于修改 Serverless StarRocks 实例配置。',
+ 'path' => '/webapi/config/modifyInstanceConfig',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '163273',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => '示例 ID', 'type' => 'string', 'required' => true, 'example' => 'c-991ca6180620****'],
+ ],
+ [
+ 'name' => 'ConfigList',
+ 'in' => 'query',
+ 'schema' => ['description' => '附加信息', 'type' => 'string', 'required' => false, 'example' => '[{\\"type\\":\\"sas_analysis_online-sas-operation-log-sh-sas-event-rasp\\",\\"configItemList\\":[{\\"key\\":\\"item_level\\",\\"valueList\\":[\\"all\\"]},{\\"key\\":\\"alert_type\\",\\"valueList\\":[\\"all\\"]}]}]'],
+ ],
+ [
+ 'name' => 'Reason',
+ 'in' => 'query',
+ 'schema' => ['description' => '修改原因', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ [
+ 'name' => 'AddConfigList',
+ 'in' => 'query',
+ 'schema' => ['description' => '【已废弃】新增配置列表', 'type' => 'string', 'required' => false, 'example' => '[]'],
+ ],
+ [
+ 'name' => 'DeleteConfigList',
+ 'in' => 'query',
+ 'schema' => ['description' => '【已废弃】待删除配置列表', 'type' => 'string', 'required' => false, 'example' => '[]'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '请求结构体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'configsToUpdate' => [
+ 'description' => '需要更新的配置',
+ 'type' => 'array',
+ 'items' => ['description' => '配置列表', 'required' => false, '$ref' => '#/components/schemas/InstanceConfigDto'],
+ 'required' => false,
+ ],
+ 'configsToAdd' => [
+ 'description' => '需要新增的配置',
+ 'type' => 'array',
+ 'items' => ['description' => '配置列表', 'required' => false, '$ref' => '#/components/schemas/InstanceConfigDto'],
+ 'required' => false,
+ ],
+ 'configsToDelete' => [
+ 'description' => '需要删除的配置',
+ 'type' => 'array',
+ 'items' => ['description' => '配置列表', 'required' => false, '$ref' => '#/components/schemas/InstanceConfigDto'],
+ 'required' => false,
+ ],
+ 'fastMode' => ['description' => '是否快速重启', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'restart' => ['description' => '是否重启。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
'required' => false,
],
],
@@ -2743,52 +5537,274 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'HttpStatusCode' => [
- 'description' => 'HTTP请求状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'false',
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'B1DBBA4E-6CD4-54F7-81E4-12C3425AB519'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '实例信息。', 'type' => 'boolean', 'example' => 'True'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => '修改实例配置',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyInstanceConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"B1DBBA4E-6CD4-54F7-81E4-12C3425AB519\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyInstanceConfigPreCheck' => [
+ 'path' => '/webapi/config/modifyInstanceConfigPreCheck',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '256709',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求结构体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'configsToUpdate' => [
+ 'description' => '需要更新的配置',
+ 'type' => 'array',
+ 'items' => ['description' => '配置列表', 'required' => false, '$ref' => '#/components/schemas/InstanceConfigDto'],
+ 'required' => false,
],
- 'ErrCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'InvalidParams',
+ 'configsToAdd' => [
+ 'description' => '需要新增的配置',
+ 'type' => 'array',
+ 'items' => ['description' => '配置列表', 'required' => false, '$ref' => '#/components/schemas/InstanceConfigDto'],
+ 'required' => false,
],
- 'ErrMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Invalid params: [instance not exists].',
+ 'configsToDelete' => [
+ 'description' => '需要删除的配置',
+ 'type' => 'array',
+ 'items' => ['description' => '配置列表', 'required' => false, '$ref' => '#/components/schemas/InstanceConfigDto'],
+ 'required' => false,
],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
'Data' => [
- 'description' => '订单 ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '24151320976****',
- ],
- 'AccessDeniedDetail' => [
- 'title' => 'AccessDeniedDetail',
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }',
+ 'description' => '返回数据。',
+ 'type' => 'array',
+ 'items' => ['description' => '返回数据。', 'type' => 'string', 'example' => '24151320976****'],
],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": 0,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ 'title' => '修改实例配置前的预检查',
+ 'summary' => '本接口用于对修改 Serverless StarRocks 实例配置操作进行预检查。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyInstanceConfigPreCheck',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"Success\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": [\\n \\"24151320976****\\"\\n ],\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyMaintainableTime' => [
+ 'summary' => '修改Starrocks实例的可维护时间',
+ 'path' => '/webapi/starrocks/modifyMaintainableTime',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '167788',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'MaintainableTimePeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例可维护时间段', 'type' => 'string', 'required' => true, 'example' => '08:00-09:00'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '是否修改成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '修改实例可维护时间',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyMaintainableTime',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyNodeNumber' => [
+ 'summary' => '本接口用于修改 Serverless StarRocks 实例计算组的节点数量。',
+ 'path' => '/webapi/resourceChange/modifyNodeNumber',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '220610',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ [
+ 'name' => 'Target',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标节点数量。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '0', 'example' => '3'],
+ ],
+ [
+ 'name' => 'PromotionOptionNo',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
+ ],
+ [
+ 'name' => 'Parallelism',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32'],
+ ],
+ [
+ 'name' => 'TerminationGracePeriodSeconds',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '订单 ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '24151320976****'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '修改节点数量',
'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[计费项](https://help.aliyun.com/zh/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c4g.11186623.help-menu-28066.d_0_1_1.4db82b05p3Gg0G)</props><props="intl">[计费项](https://www.alibabacloud.com/help/en/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c63.p38356.help-menu-28066.d_0_1_0.3aaf4b0b69jN1P)</props>。'."\n"
.'调用该接口时，您需要注意：'."\n"
@@ -2804,78 +5820,361 @@
.'- 按量付费：按照新的节点数量计费。'."\n"
."\n"
.'- 包年包月：在计费周期内，会根据新旧配置的价格差和剩余天数（从次日 0 点到有效期结束）来计算应补缴的费用。',
- ],
- 'ModifyCuPreCheck' => [
- 'summary' => '本接口用于对修改 Serverless StarRocks 实例的 FE、BE、CN 计算组中节点 CU 数量的操作进行预检查操作，以判断能否执行 CU 的升配或者降配操作。',
- 'path' => '/webapi/resourceChange/modifyCuPreCheck',
- 'methods' => [
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-25T07:23:42.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-06-30T11:04:49.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyNodeNumber',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": 0,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyNodeNumberPreCheck' => [
+ 'summary' => '本接口用于对修改 Serverless StarRocks 实例的计算组中节点数量的操作进行预检查。',
+ 'path' => '/webapi/resourceChange/modifyNodeNumberPreCheck',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- 'application/x-www-form-urlencoded',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '221372',
- 'abilityTreeNodes' => [
- 'FEATUREemapreduceUHHTB7',
- ],
+ 'abilityTreeCode' => '221371',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ [
+ 'name' => 'Target',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标节点数量。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '0', 'example' => '3'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '实例 ID。',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Allow' => ['description' => '是否允许修改节点数量。', 'type' => 'boolean', 'example' => 'true'],
+ 'Reason' => ['description' => '无法修改节点数量的原因。', 'type' => 'string', 'example' => 'Failed to find node group[ng-3d5ce6454354****].'],
+ ],
+ ],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '计算组节点数量修改前的预检查',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyNodeNumberPreCheck',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": {\\n \\"Allow\\": true,\\n \\"Reason\\": \\"Failed to find node group[ng-3d5ce6454354****].\\"\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyScalingRule' => [
+ 'summary' => '修改弹性伸缩规则',
+ 'path' => '/webapi/scalingRule/modifyScalingRule',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '278846',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ [
+ 'name' => 'OldTriggerType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '旧触发类型。',
'type' => 'string',
'required' => true,
- 'example' => 'c-b25e21e24388****',
+ 'example' => 'TIME_TRIGGER',
+ 'enum' => ['TIME_TRIGGER'],
],
],
[
- 'name' => 'NodeGroupId',
+ 'name' => 'NewTriggerType',
'in' => 'query',
'schema' => [
- 'description' => '计算组 ID。',
+ 'description' => '新触发类型。',
'type' => 'string',
'required' => true,
- 'example' => 'ng-d332aa8bca48****',
+ 'example' => 'TIME_TRIGGER',
+ 'enum' => ['TIME_TRIGGER'],
],
],
[
- 'name' => 'Target',
+ 'name' => 'ScalingRuleId',
+ 'in' => 'query',
+ 'schema' => ['description' => '待修改伸缩规则的ID。', 'type' => 'string', 'required' => true, 'example' => 'asr-bp10s4t9l21u9qtyrtco'],
+ ],
+ [
+ 'name' => 'Rule',
'in' => 'query',
+ 'schema' => ['description' => '规则内容。', 'type' => 'string', 'required' => true, 'example' => '{'."\n"
+ .' "nodeNumber": 1,'."\n"
+ .' "scalingRuleName": "test1",'."\n"
+ .' "scalingOutRule": {'."\n"
+ .' "year": 2026,'."\n"
+ .' "month": 3,'."\n"
+ .' "day": 2,'."\n"
+ .' "hour": 5,'."\n"
+ .' "minute": 50,'."\n"
+ .' "second": 0,'."\n"
+ .' "recurrenceInterval": 1,'."\n"
+ .' "recurrenceType": "DAILY",'."\n"
+ .' "recurrenceValues": null'."\n"
+ .' },'."\n"
+ .' "scalingInRule": {'."\n"
+ .' "year": 2026,'."\n"
+ .' "month": 3,'."\n"
+ .' "day": 2,'."\n"
+ .' "hour": 6,'."\n"
+ .' "minute": 50,'."\n"
+ .' "second": 0,'."\n"
+ .' "recurrenceInterval": 1,'."\n"
+ .' "recurrenceType": "DAILY",'."\n"
+ .' "recurrenceValues": null'."\n"
+ .' }'."\n"
+ .'}'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '目标 CU 数量。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]'],
+ 'Data' => ['description' => '订单 ID。', 'type' => 'boolean', 'example' => '24151320976****'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改弹性伸缩规则',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyScalingRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'ModifySpecType' => [
+ 'path' => '/webapi/resourceChange/modifySpecType',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '260887',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ [
+ 'name' => 'TargetSpecType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '目标规格类型。',
+ 'type' => 'string',
'required' => true,
- 'maximum' => '100',
- 'minimum' => '0',
- 'example' => '2',
- 'enum' => [
- '2',
- '4',
- '8',
- '16',
- '32',
- '64',
+ 'example' => 'standard',
+ 'enum' => ['standard', 'ramEnhanced', 'networkEnhanced', 'cpuEnhanced'],
+ ],
+ ],
+ [
+ 'name' => 'FastMode',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否以快速重启模式重启。默认为 false。'."\n"
+ ."\n"
+ .'- true：以快速重启模式重启计算节点。分为多个批次重启计算节点，批次内并行重启，批次间串行执行；'."\n"
+ .'- false：以滚动重启模式重启计算节点。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
+ ],
+ [
+ 'name' => 'PromotionOptionNo',
+ 'in' => 'query',
+ 'schema' => ['description' => '优惠券ID。', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '订单 ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '24151320976****'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改计算组的节点规格类型',
+ 'summary' => '修改计算组的节点规格类型',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ModifySpecType',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": 0,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'ModifySpecTypePreCheck' => [
+ 'path' => '/webapi/resourceChange/modifySpecTypePreCheck',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '260892',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ [
+ 'name' => 'TargetSpecType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '目标规格类型。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'standard',
+ 'enum' => ['standard', 'ramEnhanced', 'networkEnhanced', 'localSSD', 'bigData', 'cpuEnhanced'],
],
],
],
@@ -2884,116 +6183,881 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'HttpStatusCode' => [
- 'description' => 'HTTP请求状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ErrCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'InvalidParams',
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Allow' => ['description' => '是否允许修改 CU 数量。', 'type' => 'boolean', 'example' => 'false'],
+ 'Reason' => ['description' => '无法修改 CU 数量的原因。', 'type' => 'string', 'example' => 'Failed to find node group[ng-3d5ce6454354****].'],
+ ],
],
- 'ErrMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Invalid params: [instance not exists].',
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '修改计算组中节点规格类型预检查',
+ 'summary' => '修改计算组中节点规格类型预检查',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ModifySpecTypePreCheck',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"Success\\",\\n \\"ErrMessage\\": \\"Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]\\",\\n \\"Data\\": {\\n \\"Allow\\": false,\\n \\"Reason\\": \\"Failed to find node group[ng-3d5ce6454354****].\\"\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyUserPassword' => [
+ 'path' => '/webapi/password/modify',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '260421',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Password',
+ 'in' => 'query',
+ 'schema' => ['description' => '客户端的新密码。', 'type' => 'string', 'required' => false, 'example' => '***'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '订单 ID。', 'type' => 'boolean', 'example' => 'true'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改 starrocks 用户的密码',
+ 'summary' => '修改 starrocks 用户的密码',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyUserPassword',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"Success\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'QueryEnableMultiAzPrice' => [
+ 'path' => '/webapi/priceInquiry/enableMultiAz',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '283091',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求结构体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'instanceId' => ['description' => '实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-8dsy12g*****'],
+ 'promotionOptionNo' => ['description' => '优惠券', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_12378dfj6'],
+ 'observers' => [
+ 'description' => 'observers列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'zoneId' => ['description' => '可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-h'],
+ 'vswId' => ['description' => '交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-9sdur12t27s'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Allow' => [
- 'description' => '是否允许修改 CU 数量。',
- 'type' => 'boolean',
- 'example' => 'false',
+ 'OriginalAmount' => ['description' => '原价(原始金额)=目录价*计费用量', 'type' => 'number', 'format' => 'float', 'example' => '7641'],
+ 'DiscountAmount' => ['description' => '优惠金额=原始金额-账单应付金额(包括优惠券抵扣金额)', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '金额。', 'type' => 'number', 'format' => 'float', 'example' => '7641'],
+ 'ComponentPrices' => [
+ 'description' => '组件价格',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '组件价格',
+ 'type' => 'object',
+ 'properties' => [
+ 'ComponentName' => ['description' => '组件名称', 'type' => 'string', 'example' => 'multi-zone'],
+ 'OriginalAmount' => ['description' => '订单原价。', 'type' => 'number', 'format' => 'float', 'example' => '7641'],
+ 'DiscountAmount' => ['description' => '订单优惠金额。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '最终价，为原价减去折扣。', 'type' => 'number', 'format' => 'float', 'example' => '7641'],
+ ],
+ ],
],
- 'Reason' => [
- 'description' => '无法修改 CU 数量的原因。',
- 'type' => 'string',
- 'example' => 'Failed to find node group[ng-3d5ce6454354****].',
+ 'Currency' => ['description' => '币种。取值范围：'."\n"
+ .'- CNY：人民币。'."\n"
+ .'- USD：美元。'."\n"
+ .'- JPY：日元。', 'type' => 'string', 'example' => 'CNY'],
+ 'OptionalPromotions' => [
+ 'description' => '优惠券信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '优惠券编号',
+ 'type' => 'object',
+ 'properties' => [
+ 'PromotionOptionNo' => ['description' => '优惠券ID。', 'type' => 'string', 'example' => 'youhuiquan_12378dfj6'],
+ 'PromotionName' => ['description' => '优惠券名称。', 'type' => 'string', 'example' => 'youhuiquan_promotion_option_id_for_blank'],
+ 'PromotionDesc' => ['description' => '优惠券描述。', 'type' => 'string', 'example' => 'youhuiquan_desc'],
+ ],
+ ],
+ ],
+ 'StandPrice' => ['description' => '官网折扣价', 'type' => 'number', 'format' => 'float', 'example' => '7641'],
+ 'StandDiscountPrice' => ['description' => '基于官网折扣的优惠价格', 'type' => 'number', 'format' => 'float', 'example' => '7641'],
+ 'DepreciateInfo' => [
+ 'description' => '降价后官网总价。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CheapRate' => ['description' => '降价比例。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'CheapStandAmount' => ['description' => '降价后官网总价。', 'type' => 'number', 'format' => 'float', 'example' => '7641'],
+ 'OriginalStandAmount' => ['description' => '原始官网价总价', 'type' => 'number', 'format' => 'float', 'example' => '7641'],
+ 'IsShow' => ['description' => '是否展示降价幅度。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'example' => '7641',
+ ],
+ 'Rules' => [
+ 'description' => '返回数据结构。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '规则列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '规则名称', 'type' => 'string', 'example' => 'rule_28sdhsu2320t'],
+ 'RuleDescId' => ['description' => '规则ID。', 'type' => 'string', 'example' => '2ju2sd9dss'],
+ 'Amount' => ['description' => '数量', 'type' => 'number', 'format' => 'float', 'example' => '2'],
+ ],
+ ],
+ ],
+ 'ModuleInstance' => [
+ 'description' => '模块Id。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '属性代码。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ModuleName' => ['description' => '模块名称。', 'type' => 'string', 'example' => 'zone'],
+ 'TotalProductFee' => ['description' => '产品原价。', 'type' => 'string', 'example' => '7641'],
+ 'ModuleCode' => ['description' => '计价模块标识。', 'type' => 'string', 'example' => 'multi-zone'],
+ 'StandPrice' => ['description' => '折扣价。', 'type' => 'string', 'example' => '7641'],
+ ],
+ ],
],
],
],
- 'AccessDeniedDetail' => [
- 'title' => 'AccessDeniedDetail',
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }',
- ],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询开启多可用区的价格',
+ 'summary' => '查询开启多可用区的价格',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": {\\n \\"Allow\\": false,\\n \\"Reason\\": \\"Failed to find node group[ng-3d5ce6454354****].\\"\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
- 'title' => '计算组节点CU修改前的预检查',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryEnableMultiAzPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": {\\n \\"OriginalAmount\\": 7641,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 7641,\\n \\"ComponentPrices\\": [\\n {\\n \\"ComponentName\\": \\"multi-zone\\",\\n \\"OriginalAmount\\": 7641,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 7641\\n }\\n ],\\n \\"Currency\\": \\"CNY\\",\\n \\"OptionalPromotions\\": [\\n {\\n \\"PromotionOptionNo\\": \\"youhuiquan_12378dfj6\\",\\n \\"PromotionName\\": \\"youhuiquan_promotion_option_id_for_blank\\",\\n \\"PromotionDesc\\": \\"youhuiquan_desc\\"\\n }\\n ],\\n \\"StandPrice\\": 7641,\\n \\"StandDiscountPrice\\": 7641,\\n \\"DepreciateInfo\\": {\\n \\"CheapRate\\": 0,\\n \\"CheapStandAmount\\": 7641,\\n \\"OriginalStandAmount\\": 7641,\\n \\"IsShow\\": true\\n },\\n \\"Rules\\": [\\n {\\n \\"Name\\": \\"rule_28sdhsu2320t\\",\\n \\"RuleDescId\\": \\"2ju2sd9dss\\",\\n \\"Amount\\": 2\\n }\\n ],\\n \\"ModuleInstance\\": [\\n {\\n \\"ModuleName\\": \\"zone\\",\\n \\"TotalProductFee\\": \\"7641\\",\\n \\"ModuleCode\\": \\"multi-zone\\",\\n \\"StandPrice\\": \\"7641\\"\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
],
- 'ModifyDiskPerformanceLevel' => [
- 'summary' => '本接口用于修改 Serverless StarRocks 实例的计算组的节点磁盘性能级别。',
- 'path' => '/webapi/resourceChange/modifyDiskPerformanceLevel',
- 'methods' => [
- 'post',
+ 'QueryMinorVersion' => [
+ 'path' => '/webapi/starrocks/queryAppDefineVersion',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '266389',
+ 'abilityTreeNodes' => ['FEATUREemapreduceGZP0FZ'],
],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '集群所在的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'Version',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例主版本。', 'type' => 'string', 'required' => false, 'example' => '3.3'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '小版本号', 'type' => 'string', 'example' => '3.3.13-1.0-1.7.12'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '查询小版本号',
+ 'summary' => '查询当前主版本对应的最新小版本号',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryMinorVersion',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": \\"3.3.13-1.0-1.7.12\\",\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'QueryModifyChargeTypePrice' => [
+ 'path' => '/webapi/buy/query_modify_charge_type_price',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- 'application/x-www-form-urlencoded',
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '181463',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
],
- 'produces' => [
- 'application/json',
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['title' => '集群id', 'description' => '集群id', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'AutoRenew',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否开启自动续费，仅在 payType 为 PrePaid 时有意义。默认不开启。', 'type' => 'boolean', 'required' => false, 'example' => 'True'],
+ ],
+ [
+ 'name' => 'Duration',
+ 'in' => 'query',
+ 'schema' => ['description' => '购买时长。仅在 payType 为 PrePaid 时有意义。', 'type' => 'string', 'required' => false, 'example' => '2'],
+ ],
+ [
+ 'name' => 'PricingCycle',
+ 'in' => 'query',
+ 'schema' => ['description' => '购买时长单位：'."\n"
+ .'<ul>'."\n"
+ .'<li> 月（Month）</li>'."\n"
+ .'<li> 年（Year）</li>'."\n"
+ .'</ul>'."\n"
+ .'仅在 payType 为 PrePaid 时有意义。', 'type' => 'string', 'required' => false, 'example' => 'Month'],
+ ],
+ [
+ 'name' => 'BillingInstanceIds',
+ 'in' => 'query',
+ 'schema' => ['title' => '需要续费的计费实例 ID 列表，多个计费实例 ID 用逗号隔开', 'description' => '需要修改的计费实例 ID 列表，多个计费实例 ID 用逗号隔开', 'type' => 'string', 'required' => false, 'example' => 'c-3d6dc31ba67b1839'],
+ ],
+ [
+ 'name' => 'PromotionOptionNo',
+ 'in' => 'query',
+ 'schema' => ['description' => '优惠券ID。', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => [
+ 'description' => '订单金额',
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginalAmount' => ['description' => '原价(原始金额)=目录价*计费用量', 'type' => 'number', 'format' => 'float', 'example' => '7986'],
+ 'DiscountAmount' => ['description' => '优惠金额=原始金额-账单应付金额(包括优惠券抵扣金额)', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '金额。', 'type' => 'number', 'format' => 'float', 'example' => '7986'],
+ 'ComponentPrices' => [
+ 'description' => '组件价格',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ComponentName' => ['description' => '组件名称。', 'type' => 'string', 'example' => 'cu_num'],
+ 'OriginalAmount' => ['description' => '原价', 'type' => 'number', 'format' => 'float', 'example' => '7986'],
+ 'DiscountAmount' => ['description' => '订单优惠金额。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '最终价，为原价减去折扣金额。', 'type' => 'number', 'format' => 'float', 'example' => '7986'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'Currency' => ['description' => '币种。', 'type' => 'string', 'example' => 'CNY'],
+ 'OptionalPromotions' => [
+ 'description' => '优惠券信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '优惠券信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PromotionOptionNo' => ['description' => '优惠券ID。', 'type' => 'string', 'example' => 'youhuiquan_1238293'],
+ 'PromotionName' => ['description' => '优惠券名称。', 'type' => 'string', 'example' => 'youhuiquan_promotion_option_id_for_blank'],
+ 'PromotionDesc' => ['description' => '优惠券描述。', 'type' => 'string', 'example' => 'youhuiquan_desc'],
+ ],
+ ],
+ ],
+ 'StandPrice' => ['description' => '官网折扣价', 'type' => 'number', 'format' => 'float', 'example' => '7986'],
+ 'StandDiscountPrice' => ['description' => '折扣价格。', 'type' => 'number', 'format' => 'float', 'example' => '7986'],
+ 'DepreciateInfo' => [
+ 'description' => '优惠后费用。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CheapRate' => ['description' => '降价比例。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'CheapStandAmount' => ['description' => '降价后官网价总价', 'type' => 'number', 'format' => 'float', 'example' => '7986'],
+ 'OriginalStandAmount' => ['description' => '原始官网价总价', 'type' => 'number', 'format' => 'float', 'example' => '7986'],
+ 'IsShow' => ['description' => '是否展示降价幅度。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ ],
+ 'Rules' => [
+ 'description' => '价格计算规则。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回数据结构。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '规则名称。', 'type' => 'string', 'example' => 'rule1'],
+ 'RuleDescId' => ['description' => '规则ID。', 'type' => 'string', 'example' => 'rule-12iudfj'],
+ 'Amount' => ['description' => '金额', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ ],
+ ],
+ ],
+ 'ModuleInstance' => [
+ 'description' => '模块Id。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '属性类型。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ModuleName' => ['description' => '计价模块名称。', 'type' => 'string', 'example' => 'cu_num'],
+ 'TotalProductFee' => ['description' => '产品原价。', 'type' => 'string', 'example' => '7986'],
+ 'ModuleCode' => ['description' => '计价模块Code。', 'type' => 'string', 'example' => 'instance_type'],
+ 'StandPrice' => ['description' => '折扣价。', 'type' => 'string', 'example' => '7986'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '修改付费类型询价',
+ 'summary' => 'StarRocks修改付费类型询价',
+ 'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[计费项](https://help.aliyun.com/zh/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c4g.11186623.help-menu-28066.d_0_1_1.4db82b05p3Gg0G)</props><props="intl">[计费项](https://www.alibabacloud.com/help/en/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c63.p38356.help-menu-28066.d_0_1_0.3aaf4b0b69jN1P)</props>。'."\n"
+ ."\n"
+ .'调用该接口时，您需要注意：'."\n"
+ ."\n"
+ .'- 只有标准版实例支持修改计算组 CU 数量，入门版实例不支持。'."\n"
+ ."\n"
+ .'- 只有计算组规格类型为标准版 (standard) 的实例支持增加磁盘数量。'."\n"
+ ."\n"
+ .'- 实例必须处于运行中（Running）状态。'."\n"
+ ."\n"
+ .'修改 CU 数量后，计费变化情况如下：'."\n"
+ ."\n"
+ .'- 按量付费：按照新的 CU 数量计费。'."\n"
+ ."\n"
+ .'- 包年包月：在计费周期内，会根据新旧配置的价格差和剩余天数（从次日 0 点到有效期结束）来计算应补缴的费用。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:QueryModifyChargeTypePrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": {\\n \\"OriginalAmount\\": 7986,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 7986,\\n \\"ComponentPrices\\": [\\n {\\n \\"ComponentName\\": \\"cu_num\\",\\n \\"OriginalAmount\\": 7986,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 7986\\n }\\n ],\\n \\"Currency\\": \\"CNY\\",\\n \\"OptionalPromotions\\": [\\n {\\n \\"PromotionOptionNo\\": \\"youhuiquan_1238293\\",\\n \\"PromotionName\\": \\"youhuiquan_promotion_option_id_for_blank\\",\\n \\"PromotionDesc\\": \\"youhuiquan_desc\\"\\n }\\n ],\\n \\"StandPrice\\": 7986,\\n \\"StandDiscountPrice\\": 7986,\\n \\"DepreciateInfo\\": {\\n \\"CheapRate\\": 0,\\n \\"CheapStandAmount\\": 7986,\\n \\"OriginalStandAmount\\": 7986,\\n \\"IsShow\\": true\\n },\\n \\"Rules\\": [\\n {\\n \\"Name\\": \\"rule1\\",\\n \\"RuleDescId\\": \\"rule-12iudfj\\",\\n \\"Amount\\": 0\\n }\\n ],\\n \\"ModuleInstance\\": [\\n {\\n \\"ModuleName\\": \\"cu_num\\",\\n \\"TotalProductFee\\": \\"7986\\",\\n \\"ModuleCode\\": \\"instance_type\\",\\n \\"StandPrice\\": \\"7986\\"\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'QueryModifyCuPrice' => [
+ 'path' => '/webapi/priceInquiry/modifyCu',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '220690',
- 'abilityTreeNodes' => [
- 'FEATUREemapreduceUHHTB7',
- ],
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '220175',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ [
+ 'name' => 'Target',
+ 'in' => 'query',
'schema' => [
- 'description' => '实例 ID。',
- 'type' => 'string',
+ 'description' => '目标 CU 数量。',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => true,
- 'example' => 'c-b25e21e24388****',
+ 'example' => '2',
+ 'enum' => ['2', '4', '8', '16', '32', '64'],
+ ],
+ ],
+ [
+ 'name' => 'PromotionOptionNo',
+ 'in' => 'query',
+ 'schema' => ['description' => '优惠券ID。', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_12378dfj6'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'B67D142D-D54E-184F-A306-22BDC01B2XXX'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginalAmount' => ['description' => '原价(原始金额)=目录价*计费用量', 'type' => 'number', 'format' => 'float', 'example' => '7986'],
+ 'DiscountAmount' => ['description' => '优惠金额=原始金额-账单应付金额(包括优惠券抵扣金额)', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '金额。', 'type' => 'number', 'format' => 'float', 'example' => '7986'],
+ 'ComponentPrices' => [
+ 'description' => '组件价格',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '组件价格',
+ 'type' => 'object',
+ 'properties' => [
+ 'ComponentName' => ['description' => '组件名称。', 'type' => 'string', 'example' => 'cu_num'],
+ 'OriginalAmount' => ['description' => '原价', 'type' => 'number', 'format' => 'float', 'example' => '7986'],
+ 'DiscountAmount' => ['description' => '折扣金额。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '最终价，为原价减去折扣。', 'type' => 'number', 'format' => 'float', 'example' => '7986'],
+ ],
+ ],
+ ],
+ 'Currency' => ['description' => '货币。', 'type' => 'string', 'example' => 'CNY'],
+ 'OptionalPromotions' => [
+ 'description' => '优惠券信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '优惠券信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PromotionOptionNo' => ['description' => '优惠券ID。', 'type' => 'string', 'example' => 'youhuiquan_12378dfj6'],
+ 'PromotionName' => ['description' => '优惠券名称。', 'type' => 'string', 'example' => 'youhuiquan_promotion_option_id_for_blank'],
+ 'PromotionDesc' => ['description' => '优惠券描述。', 'type' => 'string', 'example' => 'youhuiquan_desc'],
+ ],
+ ],
+ ],
+ 'StandPrice' => ['description' => '官网折扣价', 'type' => 'number', 'format' => 'float', 'example' => '7986'],
+ 'StandDiscountPrice' => ['description' => '基于官网折扣的优惠价格', 'type' => 'number', 'format' => 'float', 'example' => '7986'],
+ 'DepreciateInfo' => [
+ 'description' => '降价比例',
+ 'type' => 'object',
+ 'properties' => [
+ 'CheapRate' => ['description' => '降价比例', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'CheapStandAmount' => ['description' => '降价后官网总价。', 'type' => 'number', 'format' => 'float', 'example' => '7986'],
+ 'OriginalStandAmount' => ['description' => '原始官网价总价', 'type' => 'number', 'format' => 'float', 'example' => '7986'],
+ 'IsShow' => ['description' => '是否展示降价幅度。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'example' => '0',
+ ],
+ 'Rules' => [
+ 'description' => '返回数据结构。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '价格计算规则。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '规则名称。', 'type' => 'string', 'example' => 'rule_123123'],
+ 'RuleDescId' => ['description' => '规则ID。', 'type' => 'string', 'example' => 'ak72hajsd'],
+ 'Amount' => ['description' => '查询批量购买某种配置的云服务器ECS的价格。取值范围：1~1000。'."\n"
+ ."\n"
+ .'默认值：1。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改计算组组节点Cu询价',
+ 'summary' => '修改计算组组节点Cu询价',
+ 'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[计费项](https://help.aliyun.com/zh/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c4g.11186623.help-menu-28066.d_0_1_1.4db82b05p3Gg0G)</props><props="intl">[计费项](https://www.alibabacloud.com/help/en/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c63.p38356.help-menu-28066.d_0_1_0.3aaf4b0b69jN1P)</props>。'."\n"
+ ."\n"
+ .'调用该接口时，您需要注意：'."\n"
+ ."\n"
+ .'- 只有标准版实例支持修改计算组 CU 数量，入门版实例不支持。'."\n"
+ ."\n"
+ .'- 只有计算组规格类型为标准版 (standard) 的实例支持增加磁盘数量。'."\n"
+ ."\n"
+ .'- 实例必须处于运行中（Running）状态。'."\n"
+ ."\n"
+ .'修改 CU 数量后，计费变化情况如下：'."\n"
+ ."\n"
+ .'- 按量付费：按照新的 CU 数量计费。'."\n"
+ ."\n"
+ .'- 包年包月：在计费周期内，会根据新旧配置的价格差和剩余天数（从次日 0 点到有效期结束）来计算应补缴的费用。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryModifyCuPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"B67D142D-D54E-184F-A306-22BDC01B2XXX\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"null\\",\\n \\"Data\\": {\\n \\"OriginalAmount\\": 7986,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 7986,\\n \\"ComponentPrices\\": [\\n {\\n \\"ComponentName\\": \\"cu_num\\",\\n \\"OriginalAmount\\": 7986,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 7986\\n }\\n ],\\n \\"Currency\\": \\"CNY\\",\\n \\"OptionalPromotions\\": [\\n {\\n \\"PromotionOptionNo\\": \\"youhuiquan_12378dfj6\\",\\n \\"PromotionName\\": \\"youhuiquan_promotion_option_id_for_blank\\",\\n \\"PromotionDesc\\": \\"youhuiquan_desc\\"\\n }\\n ],\\n \\"StandPrice\\": 7986,\\n \\"StandDiscountPrice\\": 7986,\\n \\"DepreciateInfo\\": {\\n \\"CheapRate\\": 0,\\n \\"CheapStandAmount\\": 7986,\\n \\"OriginalStandAmount\\": 7986,\\n \\"IsShow\\": true\\n },\\n \\"Rules\\": [\\n {\\n \\"Name\\": \\"rule_123123\\",\\n \\"RuleDescId\\": \\"ak72hajsd\\",\\n \\"Amount\\": 1\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'QueryModifyDiskNumberPrice' => [
+ 'path' => '/webapi/priceInquiry/modifyDiskNumber',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '220347',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
[
'name' => 'NodeGroupId',
'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ [
+ 'name' => 'Target',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => '目标节点数量。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '16', 'minimum' => '1', 'example' => '500'],
+ ],
+ [
+ 'name' => 'PromotionOptionNo',
+ 'in' => 'query',
+ 'schema' => ['description' => '优惠券ID。', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_12378dfj6'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '计算组 ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ng-3d5ce6454354****',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
+ 'Data' => [
+ 'description' => '订单 ID。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginalAmount' => ['description' => '原价(原始金额)=目录价*计费用量', 'type' => 'number', 'format' => 'float', 'example' => '17629'],
+ 'DiscountAmount' => ['description' => '优惠金额=原始金额-账单应付金额(包括优惠券抵扣金额)', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '金额。', 'type' => 'number', 'format' => 'float', 'example' => '17629'],
+ 'ComponentPrices' => [
+ 'description' => '组件价格',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '组件价格',
+ 'type' => 'object',
+ 'properties' => [
+ 'ComponentName' => ['description' => '组件名称。', 'type' => 'string', 'example' => 'disk'],
+ 'OriginalAmount' => ['description' => '原价。', 'type' => 'number', 'format' => 'float', 'example' => '17629'],
+ 'DiscountAmount' => ['description' => '订单优惠金额。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '最终价，为原价减去折扣。', 'type' => 'number', 'format' => 'float', 'example' => '17629'],
+ ],
+ ],
+ ],
+ 'Currency' => ['description' => '货币。', 'type' => 'string', 'example' => 'CNY'],
+ 'OptionalPromotions' => [
+ 'description' => '优惠券信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '优惠券信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PromotionOptionNo' => ['description' => '优惠券ID。', 'type' => 'string', 'example' => 'youhuiquan_12378dfj6'],
+ 'PromotionName' => ['description' => '优惠券名称。', 'type' => 'string', 'example' => 'youhuiquan_promotion_option_id_for_blank'],
+ 'PromotionDesc' => ['description' => '优惠券描述。', 'type' => 'string', 'example' => 'youhuiquan_desc'],
+ ],
+ ],
+ ],
+ 'StandPrice' => ['description' => '官网折扣价', 'type' => 'number', 'format' => 'float', 'example' => '17629'],
+ 'StandDiscountPrice' => ['description' => '折扣价格。', 'type' => 'number', 'format' => 'float', 'example' => '17629'],
+ 'DepreciateInfo' => [
+ 'description' => '降价后官网总价。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CheapRate' => ['description' => '降价比例', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'CheapStandAmount' => ['description' => '降价后官网价总价', 'type' => 'number', 'format' => 'float', 'example' => '17629'],
+ 'OriginalStandAmount' => ['description' => '原始官网总价。', 'type' => 'number', 'format' => 'float', 'example' => '17629'],
+ 'IsShow' => ['description' => '是否展示降价幅度', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'example' => '17629',
+ ],
+ 'Rules' => [
+ 'description' => '命中的规则列表，每一条为一个规则，只返回命中的规则信息和命中规则位置信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '价格计算规则。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '规则名称。', 'type' => 'string', 'example' => 'rule_12hus92'],
+ 'RuleDescId' => ['description' => '规则ID。', 'type' => 'string', 'example' => '6yhsi10223'],
+ 'Amount' => ['description' => '查询批量购买某种配置的云服务器ECS的价格。取值范围：1~1000。'."\n"
+ ."\n"
+ .'默认值：1。', 'type' => 'number', 'format' => 'float', 'example' => '3'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改计算组节点磁盘数量询价',
+ 'summary' => '修改计算组节点磁盘数量询价',
+ 'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[计费项](https://help.aliyun.com/zh/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c4g.11186623.help-menu-28066.d_0_1_1.4db82b05p3Gg0G)</props><props="intl">[计费项](https://www.alibabacloud.com/help/en/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c63.p38356.help-menu-28066.d_0_1_0.3aaf4b0b69jN1P)</props>。'."\n"
+ .'调用该接口时，您需要注意：'."\n"
+ ."\n"
+ .'- 只有标准版实例支持增加磁盘数量，入门版实例不支持。'."\n"
+ ."\n"
+ .'- 只有计算组规格类型为标准版 (standard) 的实例支持增加磁盘数量。'."\n"
+ ."\n"
+ .'- 实例必须处于运行中（Running）状态。'."\n"
+ ."\n"
+ .'增加磁盘数量后，计费变化情况如下：'."\n"
+ ."\n"
+ .'- 按量付费：按照新的磁盘类型计费。'."\n"
+ ."\n"
+ .'- 包年包月：在计费周期内，会根据新旧配置的价格差和剩余天数（从次日 0 点到有效期结束）来计算应补缴的费用。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryModifyDiskNumberPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"null\\",\\n \\"Data\\": {\\n \\"OriginalAmount\\": 17629,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 17629,\\n \\"ComponentPrices\\": [\\n {\\n \\"ComponentName\\": \\"disk\\",\\n \\"OriginalAmount\\": 17629,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 17629\\n }\\n ],\\n \\"Currency\\": \\"CNY\\",\\n \\"OptionalPromotions\\": [\\n {\\n \\"PromotionOptionNo\\": \\"youhuiquan_12378dfj6\\",\\n \\"PromotionName\\": \\"youhuiquan_promotion_option_id_for_blank\\",\\n \\"PromotionDesc\\": \\"youhuiquan_desc\\"\\n }\\n ],\\n \\"StandPrice\\": 17629,\\n \\"StandDiscountPrice\\": 17629,\\n \\"DepreciateInfo\\": {\\n \\"CheapRate\\": 0,\\n \\"CheapStandAmount\\": 17629,\\n \\"OriginalStandAmount\\": 17629,\\n \\"IsShow\\": true\\n },\\n \\"Rules\\": [\\n {\\n \\"Name\\": \\"rule_12hus92\\",\\n \\"RuleDescId\\": \\"6yhsi10223\\",\\n \\"Amount\\": 3\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'QueryModifyDiskPerformanceLevelPrice' => [
+ 'summary' => '修改计算组节点磁盘性能级别询价',
+ 'path' => '/webapi/priceInquiry/modifyDiskPerformanceLevel',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '220348',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-a7fa8b85ff6bced6'],
+ ],
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-204ea5d711860b4d'],
+ ],
[
'name' => 'Target',
'in' => 'query',
@@ -3002,23 +7066,13 @@
'type' => 'string',
'required' => true,
'example' => 'pl2',
- 'enum' => [
- 'pl0',
- 'pl1',
- 'pl2',
- 'pl3',
- 'eed_standard',
- 'eed_advanced',
- ],
+ 'enum' => ['pl0', 'pl1', 'pl2', 'pl3', 'eed_standard', 'eed_advanced'],
],
],
[
'name' => 'PromotionOptionNo',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => '优惠券ID。', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_12378dfj6'],
],
],
'responses' => [
@@ -3026,53 +7080,85 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'HttpStatusCode' => [
- 'description' => 'HTTP请求状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ErrCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'InvalidParams',
- ],
- 'ErrMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Invalid params: [instance not exists].',
- ],
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '86865DD4-7733-5446-B52B-C9DA71961B76'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
'Data' => [
'description' => '订单 ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '24151320976****',
- ],
- 'AccessDeniedDetail' => [
- 'title' => 'AccessDeniedDetail',
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }',
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginalAmount' => ['description' => '原价(原始金额)=目录价*计费用量', 'type' => 'number', 'format' => 'float', 'example' => '17629'],
+ 'DiscountAmount' => ['description' => '优惠金额=原始金额-账单应付金额(包括优惠券抵扣金额)', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '金额。', 'type' => 'number', 'format' => 'float', 'example' => '17629'],
+ 'ComponentPrices' => [
+ 'description' => '组件价格',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '组件价格',
+ 'type' => 'object',
+ 'properties' => [
+ 'ComponentName' => ['description' => '资源组ID', 'type' => 'string', 'example' => 'disk_type'],
+ 'OriginalAmount' => ['description' => '原价。', 'type' => 'number', 'format' => 'float', 'example' => '17629'],
+ 'DiscountAmount' => ['description' => '折扣', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '最终价，为原价减去折扣。', 'type' => 'number', 'format' => 'float', 'example' => '17629'],
+ ],
+ ],
+ ],
+ 'Currency' => ['description' => '币种。取值范围：'."\n"
+ .'- CNY：人民币。'."\n"
+ .'- USD：美元。'."\n"
+ .'- JPY：日元。', 'type' => 'string', 'example' => 'CNY'],
+ 'OptionalPromotions' => [
+ 'description' => '优惠券信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '优惠券信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PromotionOptionNo' => ['description' => '优惠券ID。', 'type' => 'string', 'example' => 'youhuiquan_12378dfj6'],
+ 'PromotionName' => ['description' => '优惠券名称。', 'type' => 'string', 'example' => 'youhuiquan_promotion_option_id_for_blank'],
+ 'PromotionDesc' => ['description' => '优惠券描述。', 'type' => 'string', 'example' => 'youhuiquan_desc'],
+ ],
+ ],
+ ],
+ 'StandPrice' => ['description' => '官网折扣价', 'type' => 'number', 'format' => 'float', 'example' => '17629'],
+ 'StandDiscountPrice' => ['description' => '基于官网折扣的优惠价格', 'type' => 'number', 'format' => 'float', 'example' => '17629'],
+ 'DepreciateInfo' => [
+ 'description' => '降价后官网价总价',
+ 'type' => 'object',
+ 'properties' => [
+ 'CheapRate' => ['description' => '降价比例', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'CheapStandAmount' => ['description' => '降价后官网价总价', 'type' => 'number', 'format' => 'float', 'example' => '17629'],
+ 'OriginalStandAmount' => ['description' => '原始官网价总价', 'type' => 'number', 'format' => 'float', 'example' => '17629'],
+ 'IsShow' => ['description' => '是否展示降价幅度', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'example' => '17629',
+ ],
+ 'Rules' => [
+ 'description' => '命中的规则列表，每一条为一个规则，只返回命中的规则信息和命中规则位置信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '命中的规则列表，每一条为一个规则，只返回命中的规则信息和命中规则位置信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '规则名称。', 'type' => 'string', 'example' => 'rule_128nsg182'],
+ 'RuleDescId' => ['description' => '规则ID。', 'type' => 'string', 'example' => '78hujis12jd'],
+ 'Amount' => ['description' => '购买资源的数量。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
+ ],
+ ],
+ ],
+ ],
],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": 0,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
- 'title' => '修改磁盘性能级别',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改计算组节点磁盘性能级别询价',
'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[价格](https://www.aliyun.com/price/product?spm=openapi-amp.newDocPublishment.0.0.1837281f3hbi2d#/ecs/detail/vm)</props><props="intl">[价格](https://www.alibabacloud.com/zh/product/ecs?_p_lc=1#pricing)</props>。'."\n"
.'调用该接口时，您需要注意：'."\n"
."\n"
@@ -3091,142 +7177,641 @@
.'- 按量付费：按照新的磁盘类型计费。'."\n"
."\n"
.'- 包年包月：在计费周期内，会根据新旧配置的价格差和剩余天数（从次日 0 点到有效期结束）来计算应补缴的费用。',
- ],
- 'ModifyDiskSize' => [
- 'summary' => '本接口用于对 Serverless StarRocks 实例计算组节点进行磁盘扩容。',
- 'path' => '/webapi/resourceChange/modifyDiskSize',
- 'methods' => [
- 'post',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryModifyDiskPerformanceLevelPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"86865DD4-7733-5446-B52B-C9DA71961B76\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": {\\n \\"OriginalAmount\\": 17629,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 17629,\\n \\"ComponentPrices\\": [\\n {\\n \\"ComponentName\\": \\"disk_type\\",\\n \\"OriginalAmount\\": 17629,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 17629\\n }\\n ],\\n \\"Currency\\": \\"CNY\\",\\n \\"OptionalPromotions\\": [\\n {\\n \\"PromotionOptionNo\\": \\"youhuiquan_12378dfj6\\",\\n \\"PromotionName\\": \\"youhuiquan_promotion_option_id_for_blank\\",\\n \\"PromotionDesc\\": \\"youhuiquan_desc\\"\\n }\\n ],\\n \\"StandPrice\\": 17629,\\n \\"StandDiscountPrice\\": 17629,\\n \\"DepreciateInfo\\": {\\n \\"CheapRate\\": 0,\\n \\"CheapStandAmount\\": 17629,\\n \\"OriginalStandAmount\\": 17629,\\n \\"IsShow\\": true\\n },\\n \\"Rules\\": [\\n {\\n \\"Name\\": \\"rule_128nsg182\\",\\n \\"RuleDescId\\": \\"78hujis12jd\\",\\n \\"Amount\\": 1\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'QueryModifyDiskSizePrice' => [
+ 'path' => '/webapi/priceInquiry/modifyDiskSize',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- 'application/x-www-form-urlencoded',
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '220346',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ [
+ 'name' => 'Target',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标磁盘大小。单位为 GB。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '65000', 'minimum' => '50', 'example' => '1000'],
+ ],
+ [
+ 'name' => 'PromotionOptionNo',
+ 'in' => 'query',
+ 'schema' => ['description' => '优惠券ID。', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_12378dfj6'],
+ ],
],
- 'produces' => [
- 'application/json',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
+ 'Data' => [
+ 'description' => '订单信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginalAmount' => ['description' => '原价(原始金额)=目录价*计费用量', 'type' => 'number', 'format' => 'float', 'example' => '9872'],
+ 'DiscountAmount' => ['description' => '优惠金额=原始金额-账单应付金额(包括优惠券抵扣金额)', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '金额。', 'type' => 'number', 'format' => 'float', 'example' => '9872'],
+ 'ComponentPrices' => [
+ 'description' => '组件价格',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '组件价格',
+ 'type' => 'object',
+ 'properties' => [
+ 'ComponentName' => ['description' => '组件名称，默认为组件ID。', 'type' => 'string', 'example' => 'disk_size'],
+ 'OriginalAmount' => ['description' => '原价。', 'type' => 'number', 'format' => 'float', 'example' => '9872'],
+ 'DiscountAmount' => ['description' => '订单优惠金额。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '最终价，为原价减去折扣。', 'type' => 'number', 'format' => 'float', 'example' => '9872'],
+ ],
+ ],
+ ],
+ 'Currency' => ['description' => '币种。取值范围：'."\n"
+ .'- CNY：人民币。'."\n"
+ .'- USD：美元。'."\n"
+ .'- JPY：日元。', 'type' => 'string', 'example' => 'CNY'],
+ 'OptionalPromotions' => [
+ 'description' => '优惠券信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '优惠券信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PromotionOptionNo' => ['description' => '优惠券ID。', 'type' => 'string', 'example' => 'youhuiquan_12378dfj6'],
+ 'PromotionName' => ['description' => '优惠券名称。', 'type' => 'string', 'example' => 'youhuiquan_promotion_option_id_for_blank'],
+ 'PromotionDesc' => ['description' => '优惠券描述。', 'type' => 'string', 'example' => 'youhuiquan_desc'],
+ ],
+ ],
+ ],
+ 'StandPrice' => ['description' => '官网折扣价', 'type' => 'number', 'format' => 'float', 'example' => '9872'],
+ 'StandDiscountPrice' => ['description' => '基于官网折扣的优惠价格', 'type' => 'number', 'format' => 'float', 'example' => '9872'],
+ 'DepreciateInfo' => [
+ 'description' => '是否展示降价幅度',
+ 'type' => 'object',
+ 'properties' => [
+ 'CheapRate' => ['description' => '降价比例。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'CheapStandAmount' => ['description' => '降价后官网价总价', 'type' => 'number', 'format' => 'float', 'example' => '9872'],
+ 'OriginalStandAmount' => ['description' => '原始官网价总价', 'type' => 'number', 'format' => 'float', 'example' => '9872'],
+ 'IsShow' => ['description' => '是否展示降价幅度', 'type' => 'boolean', 'example' => '0'],
+ ],
+ 'example' => 'true',
+ ],
+ 'Rules' => [
+ 'description' => '价格计算规则。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '活动规则。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '规则名称。', 'type' => 'string', 'example' => 'rule-083ja12'],
+ 'RuleDescId' => ['description' => '规则ID。', 'type' => 'string', 'example' => '7ysj12ksaa'],
+ 'Amount' => ['description' => '数量', 'type' => 'number', 'format' => 'float', 'example' => '10'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改计算组节点单盘存储大小询价',
+ 'summary' => '修改计算组节点单盘存储大小询价',
+ 'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[计费项](https://help.aliyun.com/zh/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c4g.11186623.help-menu-28066.d_0_1_1.4db82b05p3Gg0G)</props><props="intl">[计费项](https://www.alibabacloud.com/help/en/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c63.p38356.help-menu-28066.d_0_1_0.3aaf4b0b69jN1P)</props>。'."\n"
+ .'调用该接口时，您需要注意：'."\n"
+ ."\n"
+ .'- 只有标准版实例支持磁盘扩容，入门版实例不支持。'."\n"
+ ."\n"
+ .'- 只有计算组规格类型为标准版 (standard) 的实例支持磁盘扩容。'."\n"
+ ."\n"
+ .'- 实例必须处于运行中（Running）状态。'."\n"
+ ."\n"
+ .'磁盘扩容后，计费变化情况如下：'."\n"
+ ."\n"
+ .'- 按量付费：按照新的磁盘大小计费。'."\n"
+ ."\n"
+ .'- 包年包月：在计费周期内，会根据新旧配置的价格差和剩余天数（从次日 0 点到有效期结束）来计算应补缴的费用。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryModifyDiskSizePrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"null\\",\\n \\"Data\\": {\\n \\"OriginalAmount\\": 9872,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 9872,\\n \\"ComponentPrices\\": [\\n {\\n \\"ComponentName\\": \\"disk_size\\",\\n \\"OriginalAmount\\": 9872,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 9872\\n }\\n ],\\n \\"Currency\\": \\"CNY\\",\\n \\"OptionalPromotions\\": [\\n {\\n \\"PromotionOptionNo\\": \\"youhuiquan_12378dfj6\\",\\n \\"PromotionName\\": \\"youhuiquan_promotion_option_id_for_blank\\",\\n \\"PromotionDesc\\": \\"youhuiquan_desc\\"\\n }\\n ],\\n \\"StandPrice\\": 9872,\\n \\"StandDiscountPrice\\": 9872,\\n \\"DepreciateInfo\\": {\\n \\"CheapRate\\": 0,\\n \\"CheapStandAmount\\": 9872,\\n \\"OriginalStandAmount\\": 9872,\\n \\"IsShow\\": true\\n },\\n \\"Rules\\": [\\n {\\n \\"Name\\": \\"rule-083ja12\\",\\n \\"RuleDescId\\": \\"7ysj12ksaa\\",\\n \\"Amount\\": 10\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'QueryModifyDiskTypePrice' => [
+ 'path' => '/webapi/priceInquiry/modifyDiskType',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '220685',
- 'abilityTreeNodes' => [
- 'FEATUREemapreduceUHHTB7',
- ],
+ 'abilityTreeCode' => '281278',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-d332aa8bca48****'],
+ ],
+ [
+ 'name' => 'TargetPerformanceLevel',
+ 'in' => 'query',
'schema' => [
- 'description' => '实例 ID。',
+ 'description' => '目标磁盘性能',
'type' => 'string',
'required' => true,
- 'example' => 'c-b25e21e24388****',
+ 'example' => 'pl2',
+ 'enum' => ['pl0', 'pl1', 'pl2', 'pl3', 'eed_standard', 'eed_advanced'],
],
],
[
- 'name' => 'NodeGroupId',
+ 'name' => 'TargetDiskType',
'in' => 'query',
'schema' => [
- 'description' => '计算组 ID。',
+ 'description' => '目标磁盘类型',
'type' => 'string',
'required' => true,
- 'example' => 'ng-3d5ce6454354****',
+ 'example' => 'essd',
+ 'enum' => ['eed', 'essd'],
],
],
[
- 'name' => 'Target',
+ 'name' => 'PromotionOptionNo',
'in' => 'query',
+ 'schema' => ['description' => '优惠券ID。', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_12378dfj6'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '目标磁盘大小。单位为 GB。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '65000',
- 'minimum' => '0',
- 'example' => '500',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginalAmount' => ['description' => '原价(原始金额)=目录价*计费用量', 'type' => 'number', 'format' => 'float', 'example' => '10923'],
+ 'DiscountAmount' => ['description' => '优惠金额=原始金额-账单应付金额(包括优惠券抵扣金额)', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '金额。', 'type' => 'number', 'format' => 'float', 'example' => '10923'],
+ 'ComponentPrices' => [
+ 'description' => '组件价格',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '组件价格',
+ 'type' => 'object',
+ 'properties' => [
+ 'ComponentName' => ['description' => '资源组ID', 'type' => 'string', 'example' => 'disk_type'],
+ 'OriginalAmount' => ['description' => '原价', 'type' => 'number', 'format' => 'float', 'example' => '10923'],
+ 'DiscountAmount' => ['description' => '折扣', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '最终价，为原价减去折扣金额。', 'type' => 'number', 'format' => 'float', 'example' => '10923'],
+ ],
+ ],
+ ],
+ 'Currency' => ['description' => '货币。', 'type' => 'string', 'example' => 'CNY'],
+ 'OptionalPromotions' => [
+ 'description' => '优惠券信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '优惠券信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PromotionOptionNo' => ['description' => '优惠券ID。', 'type' => 'string', 'example' => 'youhuiquan_12378dfj6'],
+ 'PromotionName' => ['description' => '优惠券名称。', 'type' => 'string', 'example' => 'youhuiquan_promotion_option_id_for_blank'],
+ 'PromotionDesc' => ['description' => '优惠券描述。', 'type' => 'string', 'example' => 'youhuiquan_desc'],
+ ],
+ ],
+ ],
+ 'StandPrice' => ['description' => '官网折扣价', 'type' => 'number', 'format' => 'float', 'example' => '10923'],
+ 'StandDiscountPrice' => ['description' => '基于官网折扣的优惠价格', 'type' => 'number', 'format' => 'float', 'example' => '10923'],
+ 'DepreciateInfo' => [
+ 'description' => '降价比例',
+ 'type' => 'object',
+ 'properties' => [
+ 'CheapRate' => ['description' => '降价比例', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'CheapStandAmount' => ['description' => '降价后官网价总价', 'type' => 'number', 'format' => 'float', 'example' => '10923'],
+ 'OriginalStandAmount' => ['description' => '原始官网总价。', 'type' => 'number', 'format' => 'float', 'example' => '10923'],
+ 'IsShow' => ['description' => '是否展示降价幅度', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ ],
+ 'Rules' => [
+ 'description' => '返回数据结构。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回数据结构。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '规则名称。', 'type' => 'string', 'example' => 'rule-928shy23sa'],
+ 'RuleDescId' => ['description' => '规则ID。', 'type' => 'string', 'example' => '7dsu230ks23'],
+ 'Amount' => ['description' => '购买数量。', 'type' => 'number', 'format' => 'float', 'example' => '10'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改计算组节点磁盘类型询价',
+ 'summary' => '修改计算组节点磁盘类型询价',
+ 'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[计费项](https://help.aliyun.com/zh/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c4g.11186623.help-menu-28066.d_0_1_1.4db82b05p3Gg0G)</props><props="intl">[计费项](https://www.alibabacloud.com/help/en/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c63.p38356.help-menu-28066.d_0_1_0.3aaf4b0b69jN1P)</props>。'."\n"
+ .'调用该接口时，您需要注意：'."\n"
+ ."\n"
+ .'- 只有标准版实例支持磁盘扩容，入门版实例不支持。'."\n"
+ ."\n"
+ .'- 只有计算组规格类型为标准版 (standard) 的实例支持磁盘扩容。'."\n"
+ ."\n"
+ .'- 实例必须处于运行中（Running）状态。'."\n"
+ ."\n"
+ .'磁盘扩容后，计费变化情况如下：'."\n"
+ ."\n"
+ .'- 按量付费：按照新的磁盘大小计费。'."\n"
+ ."\n"
+ .'- 包年包月：在计费周期内，会根据新旧配置的价格差和剩余天数（从次日 0 点到有效期结束）来计算应补缴的费用。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryModifyDiskTypePrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]\\",\\n \\"Data\\": {\\n \\"OriginalAmount\\": 10923,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 10923,\\n \\"ComponentPrices\\": [\\n {\\n \\"ComponentName\\": \\"disk_type\\",\\n \\"OriginalAmount\\": 10923,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 10923\\n }\\n ],\\n \\"Currency\\": \\"CNY\\",\\n \\"OptionalPromotions\\": [\\n {\\n \\"PromotionOptionNo\\": \\"youhuiquan_12378dfj6\\",\\n \\"PromotionName\\": \\"youhuiquan_promotion_option_id_for_blank\\",\\n \\"PromotionDesc\\": \\"youhuiquan_desc\\"\\n }\\n ],\\n \\"StandPrice\\": 10923,\\n \\"StandDiscountPrice\\": 10923,\\n \\"DepreciateInfo\\": {\\n \\"CheapRate\\": 0,\\n \\"CheapStandAmount\\": 10923,\\n \\"OriginalStandAmount\\": 10923,\\n \\"IsShow\\": true\\n },\\n \\"Rules\\": [\\n {\\n \\"Name\\": \\"rule-928shy23sa\\",\\n \\"RuleDescId\\": \\"7dsu230ks23\\",\\n \\"Amount\\": 10\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'QueryModifyNodeNumberPrice' => [
+ 'path' => '/webapi/priceInquiry/modifyNodeNumber',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '220171',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ [
+ 'name' => 'Target',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标节点数量。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '0', 'example' => '4'],
+ ],
[
'name' => 'PromotionOptionNo',
'in' => 'query',
+ 'schema' => ['description' => '优惠券ID。', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_12378dfj6'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'type' => 'string',
- 'required' => false,
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => [
+ 'description' => '订单信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginalAmount' => ['description' => '原价(原始金额)=目录价*计费用量', 'type' => 'number', 'format' => 'float', 'example' => '26710'],
+ 'DiscountAmount' => ['description' => '优惠金额=原始金额-账单应付金额(包括优惠券抵扣金额)', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '金额。', 'type' => 'number', 'format' => 'float', 'example' => '26710'],
+ 'ComponentPrices' => [
+ 'description' => '组件价格',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '组件价格',
+ 'type' => 'object',
+ 'properties' => [
+ 'ComponentName' => ['description' => '组件名称。', 'type' => 'string', 'example' => 'RangerUserSync'],
+ 'OriginalAmount' => ['description' => '订单原价。', 'type' => 'number', 'format' => 'float', 'example' => '26710'],
+ 'DiscountAmount' => ['description' => '折扣', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '订单实际交易价格。', 'type' => 'number', 'format' => 'float', 'example' => '26710'],
+ ],
+ ],
+ ],
+ 'Currency' => ['description' => '币种。取值范围：'."\n"
+ .'- CNY：人民币。'."\n"
+ .'- USD：美元。'."\n"
+ .'- JPY：日元。', 'type' => 'string', 'example' => 'CNY'],
+ 'OptionalPromotions' => [
+ 'description' => '优惠券信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '优惠券信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PromotionOptionNo' => ['description' => '优惠券ID。', 'type' => 'string', 'example' => 'youhuiquan_12378dfj6'],
+ 'PromotionName' => ['description' => '优惠券名称。', 'type' => 'string', 'example' => 'youhuiquan_promotion_option_id_for_blank'],
+ 'PromotionDesc' => ['description' => '优惠券描述。', 'type' => 'string', 'example' => 'youhuiquan_desc'],
+ ],
+ ],
+ ],
+ 'StandPrice' => ['description' => '官网折扣价', 'type' => 'number', 'format' => 'float', 'example' => '26710'],
+ 'StandDiscountPrice' => ['description' => '基于官网折扣的优惠价格', 'type' => 'number', 'format' => 'float', 'example' => '26710'],
+ 'DepreciateInfo' => [
+ 'description' => '降价比例',
+ 'type' => 'object',
+ 'properties' => [
+ 'CheapRate' => ['description' => '降价比例', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'CheapStandAmount' => ['description' => '降价后官网价总价', 'type' => 'number', 'format' => 'float', 'example' => '26710'],
+ 'OriginalStandAmount' => ['description' => '原始官网价总价', 'type' => 'number', 'format' => 'float', 'example' => '26710'],
+ 'IsShow' => ['description' => '是否展示降价幅度', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'example' => '0',
+ ],
+ 'Rules' => [
+ 'description' => '返回数据结构。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '命中的规则列表，每一条为一个规则，只返回命中的规则信息和命中规则位置信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '规则名称。', 'type' => 'string', 'example' => 'rule_923su2sf'],
+ 'RuleDescId' => ['description' => '规则ID。', 'type' => 'string', 'example' => '8uy3sh12sa'],
+ 'Amount' => ['description' => '查询批量购买某种配置的云服务器ECS的价格。取值范围：1~1000。'."\n"
+ ."\n"
+ .'默认值：1。', 'type' => 'number', 'format' => 'float', 'example' => '10'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改计算组节点数量询价',
+ 'summary' => '修改计算组节点数量询价',
+ 'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[计费项](https://help.aliyun.com/zh/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c4g.11186623.help-menu-28066.d_0_1_1.4db82b05p3Gg0G)</props><props="intl">[计费项](https://www.alibabacloud.com/help/en/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c63.p38356.help-menu-28066.d_0_1_0.3aaf4b0b69jN1P)</props>。'."\n"
+ .'调用该接口时，您需要注意：'."\n"
+ ."\n"
+ .'- 只有标准版实例支持修改计算组节点数量，入门版实例不支持。'."\n"
+ ."\n"
+ .'- 实例必须处于运行中（Running）状态。'."\n"
+ ."\n"
+ .'- FE 节点的数量不能是偶数，且 FE 节点不支持缩容。'."\n"
+ ."\n"
+ .'修改节点数量后，计费变化情况如下：'."\n"
+ ."\n"
+ .'- 按量付费：按照新的节点数量计费。'."\n"
+ ."\n"
+ .'- 包年包月：在计费周期内，会根据新旧配置的价格差和剩余天数（从次日 0 点到有效期结束）来计算应补缴的费用。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'FastMode',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryModifyNodeNumberPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": {\\n \\"OriginalAmount\\": 26710,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 26710,\\n \\"ComponentPrices\\": [\\n {\\n \\"ComponentName\\": \\"RangerUserSync\\",\\n \\"OriginalAmount\\": 26710,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 26710\\n }\\n ],\\n \\"Currency\\": \\"CNY\\",\\n \\"OptionalPromotions\\": [\\n {\\n \\"PromotionOptionNo\\": \\"youhuiquan_12378dfj6\\",\\n \\"PromotionName\\": \\"youhuiquan_promotion_option_id_for_blank\\",\\n \\"PromotionDesc\\": \\"youhuiquan_desc\\"\\n }\\n ],\\n \\"StandPrice\\": 26710,\\n \\"StandDiscountPrice\\": 26710,\\n \\"DepreciateInfo\\": {\\n \\"CheapRate\\": 0,\\n \\"CheapStandAmount\\": 26710,\\n \\"OriginalStandAmount\\": 26710,\\n \\"IsShow\\": true\\n },\\n \\"Rules\\": [\\n {\\n \\"Name\\": \\"rule_923su2sf\\",\\n \\"RuleDescId\\": \\"8uy3sh12sa\\",\\n \\"Amount\\": 10\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'QueryModifySpecTypePrice' => [
+ 'summary' => '修改计算组规格类型询价',
+ 'path' => '/webapi/priceInquiry/modifySpecType',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '262047',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ [
+ 'name' => 'TargetSpecType',
'in' => 'query',
'schema' => [
- 'type' => 'boolean',
- 'required' => false,
- 'default' => 'false',
+ 'description' => '计算组节点类型。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'standard',
+ 'enum' => ['standard', 'ramEnhanced', 'networkEnhanced', 'cpuEnhanced'],
],
],
+ [
+ 'name' => 'PromotionOptionNo',
+ 'in' => 'query',
+ 'schema' => ['description' => '优惠券ID。', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_12378dfj6'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'HttpStatusCode' => [
- 'description' => 'HTTP请求状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ErrCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'InvalidParams',
- ],
- 'ErrMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Invalid params: [instance not exists].',
- ],
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
'Data' => [
- 'description' => '订单 ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '24151320976****',
- ],
- 'AccessDeniedDetail' => [
- 'title' => 'AccessDeniedDetail',
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginalAmount' => ['description' => '原价(原始金额)=目录价*计费用量', 'type' => 'number', 'format' => 'float', 'example' => '5612'],
+ 'DiscountAmount' => ['description' => '优惠金额=原始金额-账单应付金额(包括优惠券抵扣金额)', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '金额。', 'type' => 'number', 'format' => 'float', 'example' => '5612'],
+ 'ComponentPrices' => [
+ 'description' => '组件价格',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '组件价格',
+ 'type' => 'object',
+ 'properties' => [
+ 'ComponentName' => ['description' => '组件名称。', 'type' => 'string', 'example' => 'node_type'],
+ 'OriginalAmount' => ['description' => '原价。', 'type' => 'number', 'format' => 'float', 'example' => '5612'],
+ 'DiscountAmount' => ['description' => '折扣金额。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '最终价，为原价减去折扣。', 'type' => 'number', 'format' => 'float', 'example' => '5612'],
+ ],
+ ],
+ ],
+ 'Currency' => ['description' => '货币。', 'type' => 'string', 'example' => 'CNY'],
+ 'OptionalPromotions' => [
+ 'description' => '优惠券信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '优惠券信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PromotionOptionNo' => ['description' => '优惠券ID。', 'type' => 'string', 'example' => 'youhuiquan_12378dfj6'],
+ 'PromotionName' => ['description' => '优惠券名称。', 'type' => 'string', 'example' => 'youhuiquan_promotion_option_id_for_blank'],
+ 'PromotionDesc' => ['description' => '优惠券描述。', 'type' => 'string', 'example' => 'youhuiquan_desc'],
+ ],
+ ],
+ ],
+ 'StandPrice' => ['description' => '官网折扣价', 'type' => 'number', 'format' => 'float', 'example' => '5612'],
+ 'StandDiscountPrice' => ['description' => '基于官网折扣的优惠价格', 'type' => 'number', 'format' => 'float', 'example' => '5612'],
+ 'DepreciateInfo' => [
+ 'description' => '活动名称。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CheapRate' => ['description' => '降价比例', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'CheapStandAmount' => ['description' => '降价后官网价总价', 'type' => 'number', 'format' => 'float', 'example' => '5612'],
+ 'OriginalStandAmount' => ['description' => '原始官网价总价', 'type' => 'number', 'format' => 'float', 'example' => '5612'],
+ 'IsShow' => ['description' => '是否展示降价幅度', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ ],
+ 'Rules' => [
+ 'description' => '价格计算规则。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '价格计算规则。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '规则名称。', 'type' => 'string', 'example' => 'rule_827231sg1'],
+ 'RuleDescId' => ['description' => '规则ID。', 'type' => 'string', 'example' => '7usy32gs01'],
+ 'Amount' => ['description' => '资源数量。', 'type' => 'number', 'format' => 'float', 'example' => '10'],
+ ],
+ ],
+ ],
+ ],
],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": 0,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
- 'title' => '磁盘扩容',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改计算组规格类型询价',
'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[计费项](https://help.aliyun.com/zh/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c4g.11186623.help-menu-28066.d_0_1_1.4db82b05p3Gg0G)</props><props="intl">[计费项](https://www.alibabacloud.com/help/en/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c63.p38356.help-menu-28066.d_0_1_0.3aaf4b0b69jN1P)</props>。'."\n"
.'调用该接口时，您需要注意：'."\n"
."\n"
@@ -3241,91 +7826,543 @@
.'- 按量付费：按照新的磁盘大小计费。'."\n"
."\n"
.'- 包年包月：在计费周期内，会根据新旧配置的价格差和剩余天数（从次日 0 点到有效期结束）来计算应补缴的费用。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryModifySpecTypePrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": {\\n \\"OriginalAmount\\": 5612,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 5612,\\n \\"ComponentPrices\\": [\\n {\\n \\"ComponentName\\": \\"node_type\\",\\n \\"OriginalAmount\\": 5612,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 5612\\n }\\n ],\\n \\"Currency\\": \\"CNY\\",\\n \\"OptionalPromotions\\": [\\n {\\n \\"PromotionOptionNo\\": \\"youhuiquan_12378dfj6\\",\\n \\"PromotionName\\": \\"youhuiquan_promotion_option_id_for_blank\\",\\n \\"PromotionDesc\\": \\"youhuiquan_desc\\"\\n }\\n ],\\n \\"StandPrice\\": 5612,\\n \\"StandDiscountPrice\\": 5612,\\n \\"DepreciateInfo\\": {\\n \\"CheapRate\\": 0,\\n \\"CheapStandAmount\\": 5612,\\n \\"OriginalStandAmount\\": 5612,\\n \\"IsShow\\": true\\n },\\n \\"Rules\\": [\\n {\\n \\"Name\\": \\"rule_827231sg1\\",\\n \\"RuleDescId\\": \\"7usy32gs01\\",\\n \\"Amount\\": 10\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
],
- 'ModifyDiskNumber' => [
- 'summary' => '本接口用于增加 Serverless StarRocks 实例计算组的节点磁盘块数。',
- 'path' => '/webapi/resourceChange/modifyDiskNumber',
- 'methods' => [
- 'post',
+ 'QueryPriceV1' => [
+ 'path' => '/webapi/price/create',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '260340',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ 'tenantRelevance' => 'publicInformation',
],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求结构体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => ['description' => '地域 ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ 'PayType' => [
+ 'description' => '付费类型：'."\n"
+ .'<ol>'."\n"
+ .'<li>包年包月（prePaid）。</li>'."\n"
+ .'<li>按量付费（postPaid）。</li>'."\n"
+ .'</ol>'."\n"
+ .' '."\n"
+ .' ',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'prePaid',
+ 'enum' => ['postPaid', 'prePaid'],
+ ],
+ 'PackageType' => [
+ 'description' => '实例系列：'."\n"
+ .'<ul>'."\n"
+ .'<li> 入门版（trial）。</li>'."\n"
+ .'<li> 标准版（official）。</li>'."\n"
+ .'</ul>',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'official',
+ 'enum' => ['trial', 'official'],
+ ],
+ 'Duration' => ['description' => '购买时长。仅在 payType 为 PrePaid 时有意义。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'PricingCycle' => ['description' => '购买时长单位：'."\n"
+ .'<ul>'."\n"
+ .'<li> 月（Month）</li>'."\n"
+ .'<li> 年（Year）</li>'."\n"
+ .'</ul>'."\n"
+ .'仅在 payType 为 PrePaid 时有意义。', 'type' => 'string', 'required' => false, 'example' => 'Month'],
+ 'ObserverNodeGroups' => [
+ 'description' => 'Observer计算组信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Observer计算组信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'specType' => ['description' => '计算组规格类型。仅支持标准版（standard）。', 'type' => 'string', 'required' => false, 'example' => 'standard'],
+ 'cu' => ['description' => 'CU数量。CU (Compute Unit) 是服务的基本计量单元，1 CU=1 核 CPU+4GiB 内存。', 'type' => 'string', 'required' => false, 'example' => '8'],
+ 'storageSize' => ['description' => '存储大小。单位为 GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
+ 'storagePerformanceLevel' => ['description' => '云盘的性能级别。仅支持 pl1，单盘最高随机读写 IOPS 5 万。', 'type' => 'string', 'required' => false, 'example' => 'pl1'],
+ 'diskNumber' => ['description' => '磁盘数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'residentNodeNumber' => ['description' => '节点数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
+ 'localStorageInstanceType' => ['description' => '本地SSD实例规格，Observer 计算组无需设置该字段。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'FrontendNodeGroups' => [
+ 'description' => 'FE 节点组信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'FE 节点组信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'specType' => ['description' => '计算组规格类型。仅支持标准版（standard）。', 'type' => 'string', 'required' => false, 'example' => 'standard'],
+ 'cu' => ['description' => 'CU数量。CU (Compute Unit) 是服务的基本计量单元，1 CU=1 核 CPU+4GiB 内存。', 'type' => 'string', 'required' => false, 'example' => '8'],
+ 'storageSize' => ['description' => '存储大小。单位为 GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
+ 'storagePerformanceLevel' => ['description' => '云盘的性能级别。仅支持 pl1，单盘最高随机读写 IOPS 5 万。', 'type' => 'string', 'required' => false, 'example' => 'pl1'],
+ 'diskNumber' => ['description' => '磁盘数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'residentNodeNumber' => ['description' => '节点数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
+ 'localStorageInstanceType' => ['description' => '本地SSD实例规格，FE计算组无需设置该字段。', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'BackendNodeGroups' => [
+ 'description' => 'BE 或者 CN 计算组信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'BE 或者 CN 计算组信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'specType' => ['description' => '计算组规格类型。包括以下类型：'."\n"
+ ."\n"
+ .'- standard，标准版。'."\n"
+ .'- localSSD ，本地SSD。'."\n"
+ .'- bigData，大规格存储。'."\n"
+ .'- ramEnhanced，内存增强型。'."\n"
+ .'- networkEnhanced，网络增强型。', 'type' => 'string', 'required' => false, 'example' => 'standard'],
+ 'cu' => ['description' => 'CU数量。CU (Compute Unit) 是服务的基本计量单元，1 CU=1 核 CPU+4GiB 内存，仅在 SpecType 为内存增强型时 1 CU=1 核 CPU+8GiB 内存。', 'type' => 'string', 'required' => false, 'example' => '8'],
+ 'storageSize' => ['description' => '存储大小。单位为 GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
+ 'storagePerformanceLevel' => ['description' => '云盘的性能级别。包含以下取值：'."\n"
+ ."\n"
+ .'- pl0：单盘最高随机读写 IOPS 1 万。'."\n"
+ .'- pl1：单盘最高随机读写 IOPS 5 万。'."\n"
+ .'- pl2：单盘最高随机读写 IOPS 10 万。'."\n"
+ .'- pl3：单盘最高随机读写 IOPS 100 万。', 'type' => 'string', 'required' => false, 'example' => 'pl1'],
+ 'diskNumber' => ['description' => '磁盘数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'residentNodeNumber' => ['description' => '节点数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
+ 'localStorageInstanceType' => ['description' => '节点组本地SSD实例规格, 仅在基于Ecs实例且SpecType为本地SSD/大规格存储时该值才有意义。', 'type' => 'string', 'required' => false, 'example' => 'local_ssd_4_4xlarge'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'RunMode' => ['description' => '集群的运行模式：'."\n"
+ .'<ul>'."\n"
+ .'<li>存算一体（shared_nothing）。</li>'."\n"
+ .'<li>存算分离（shared_data）。</li>'."\n"
+ .'</ul>', 'type' => 'string', 'required' => false, 'example' => 'shared_data'],
+ 'PromotionOptionNo' => ['description' => '优惠券ID。', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_12378dfj6'],
+ 'AgentNodeGroup' => [
+ 'description' => 'agent计算组',
+ 'type' => 'object',
+ 'properties' => [
+ 'cu' => ['description' => 'CU数量。CU (Compute Unit) 是服务的基本计量单元，1 CU=1 核 CPU+4GiB 内存。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'."\n"],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginalAmount' => ['description' => '原价(原始金额)=目录价*计费用量', 'type' => 'number', 'format' => 'float', 'example' => '8094'],
+ 'DiscountAmount' => ['description' => '优惠金额=原始金额-账单应付金额(包括优惠券抵扣金额)', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '金额。', 'type' => 'number', 'format' => 'float', 'example' => '8094'],
+ 'ComponentPrices' => [
+ 'description' => '组件价格',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '组件价格',
+ 'type' => 'object',
+ 'properties' => [
+ 'ComponentName' => ['description' => '组件名称。', 'type' => 'string', 'example' => 'FE'],
+ 'OriginalAmount' => ['description' => '原价。', 'type' => 'number', 'format' => 'float', 'example' => '3192'],
+ 'DiscountAmount' => ['description' => '订单优惠金额。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '最终价，为原价减去折扣金额。', 'type' => 'number', 'format' => 'float', 'example' => '3192'],
+ ],
+ ],
+ ],
+ 'Currency' => ['description' => '币种', 'type' => 'string', 'example' => 'CNY'],
+ 'OptionalPromotions' => [
+ 'description' => '优惠券信息',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '优惠券编号',
+ 'type' => 'object',
+ 'properties' => [
+ 'PromotionOptionNo' => ['description' => '优惠券ID。', 'type' => 'string', 'example' => 'youhuiquan_12378dfj6'],
+ 'PromotionName' => ['description' => '优惠券名称。', 'type' => 'string', 'example' => 'youhuiquan_promotion_option_id_for_blank'],
+ 'PromotionDesc' => ['description' => '优惠券描述。', 'type' => 'string', 'example' => 'youhuiquan_desc'],
+ ],
+ ],
+ ],
+ 'StandPrice' => ['description' => '官网折扣价', 'type' => 'number', 'format' => 'float', 'example' => '8094'],
+ 'StandDiscountPrice' => ['description' => '折扣价格。', 'type' => 'number', 'format' => 'float', 'example' => '8094'],
+ 'DepreciateInfo' => [
+ 'description' => '活动信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CheapRate' => ['description' => '降价比例。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'CheapStandAmount' => ['description' => '降价后官网价总价', 'type' => 'number', 'format' => 'float', 'example' => '8094'],
+ 'OriginalStandAmount' => ['description' => '原始官网总价。', 'type' => 'number', 'format' => 'float', 'example' => '8094'],
+ 'IsShow' => ['description' => '是否展示降价幅度。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ ],
+ 'Rules' => [
+ 'description' => '返回数据结构。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '价格计算规则。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '规则名称', 'type' => 'string', 'example' => 'rule_8usi12321sa'],
+ 'RuleDescId' => ['description' => '规则ID。', 'type' => 'string', 'example' => '7u22yshaasds'],
+ 'Amount' => ['description' => '数量', 'type' => 'number', 'format' => 'float', 'example' => '1'],
+ ],
+ ],
+ ],
+ 'ModuleInstance' => [
+ 'description' => '产品原价。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '差价优惠（订单总价展示）。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ModuleName' => ['description' => '计价模块名称。', 'type' => 'string', 'example' => 'CU'],
+ 'TotalProductFee' => ['description' => '产品原价。', 'type' => 'string', 'example' => '1622'],
+ 'ModuleCode' => ['description' => '计价模块Code。', 'type' => 'string', 'example' => 'cu_num'],
+ 'StandPrice' => ['description' => '折扣价。', 'type' => 'string', 'example' => '1622'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '新购询价',
+ 'summary' => 'StarRocks新购询价接口',
+ 'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[计费项](https://help.aliyun.com/zh/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c4g.11186623.help-menu-28066.d_0_1_1.4db82b05p3Gg0G)</props><props="intl">[计费项](https://www.alibabacloud.com/help/en/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c63.p38356.help-menu-28066.d_0_1_0.3aaf4b0b69jN1P)</props>。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:QueryPriceV1',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\\\n\\",\\n \\"Data\\": {\\n \\"OriginalAmount\\": 8094,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 8094,\\n \\"ComponentPrices\\": [\\n {\\n \\"ComponentName\\": \\"FE\\",\\n \\"OriginalAmount\\": 3192,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 3192\\n }\\n ],\\n \\"Currency\\": \\"CNY\\",\\n \\"OptionalPromotions\\": [\\n {\\n \\"PromotionOptionNo\\": \\"youhuiquan_12378dfj6\\",\\n \\"PromotionName\\": \\"youhuiquan_promotion_option_id_for_blank\\",\\n \\"PromotionDesc\\": \\"youhuiquan_desc\\"\\n }\\n ],\\n \\"StandPrice\\": 8094,\\n \\"StandDiscountPrice\\": 8094,\\n \\"DepreciateInfo\\": {\\n \\"CheapRate\\": 0,\\n \\"CheapStandAmount\\": 8094,\\n \\"OriginalStandAmount\\": 8094,\\n \\"IsShow\\": true\\n },\\n \\"Rules\\": [\\n {\\n \\"Name\\": \\"rule_8usi12321sa\\",\\n \\"RuleDescId\\": \\"7u22yshaasds\\",\\n \\"Amount\\": 1\\n }\\n ],\\n \\"ModuleInstance\\": [\\n {\\n \\"ModuleName\\": \\"CU\\",\\n \\"TotalProductFee\\": \\"1622\\",\\n \\"ModuleCode\\": \\"cu_num\\",\\n \\"StandPrice\\": \\"1622\\"\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'QueryRefundPrice' => [
+ 'summary' => 'StarRocks退订包年包月计费实例询价',
+ 'path' => '/webapi/buy/queryRefundPrice',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- 'application/x-www-form-urlencoded',
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '290510',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ 'tenantRelevance' => 'tenant',
],
- 'produces' => [
- 'application/json',
+ 'parameters' => [
+ [
+ 'name' => 'billingInstanceIds',
+ 'in' => 'query',
+ 'schema' => ['description' => '退订的实例ID集合，多个实例ID以逗号分隔', 'type' => 'string', 'required' => false, 'example' => 'ng-1syeu23,ng-81293sa'],
+ ],
+ [
+ 'name' => 'instanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。该字段已废弃。', 'type' => 'string', 'required' => false, 'example' => 'c-82su12s0kl12'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'httpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'requestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8C69A6D0-49B7-54B9-BF21-9AF52172A5F7'],
+ 'success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'True'],
+ 'errCode' => ['description' => '错误码。', 'type' => 'string', 'example' => '0'],
+ 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'None'],
+ 'data' => ['description' => '退款金额', 'type' => 'number', 'format' => 'double', 'example' => '18837'],
+ 'accessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => 'None'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '退订包年包月计费实例询价',
+ 'description' => '><danger>释放实例后，实例所使用的物理资源都被回收，相关数据全部丢失且不可恢复。></danger>',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:QueryRefundPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"httpStatusCode\\": 200,\\n \\"requestId\\": \\"8C69A6D0-49B7-54B9-BF21-9AF52172A5F7\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"0\\",\\n \\"errMessage\\": \\"None\\",\\n \\"data\\": 18837,\\n \\"accessDeniedDetail\\": \\"None\\"\\n}","type":"json"}]',
+ ],
+ 'QueryRenewPrice' => [
+ 'path' => '/webapi/price/renew',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '220689',
- 'abilityTreeNodes' => [
- 'FEATUREemapreduceUHHTB7',
- ],
+ 'abilityTreeCode' => '161471',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****', 'pattern' => '^[0-9a-zA-Z_-]+$'],
+ ],
+ [
+ 'name' => 'Duration',
+ 'in' => 'query',
'schema' => [
- 'description' => '实例 ID。',
- 'type' => 'string',
+ 'description' => '续费周期',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => true,
- 'example' => 'c-b25e21e24388****',
+ 'maximum' => '12',
+ 'minimum' => '1',
+ 'example' => '2',
+ 'enum' => ['1', '2', '3', '6', '9'],
],
],
[
- 'name' => 'NodeGroupId',
+ 'name' => 'PricingCycle',
'in' => 'query',
'schema' => [
- 'description' => '计算组 ID。',
+ 'description' => '续费单位',
'type' => 'string',
'required' => true,
- 'example' => 'ng-3d5ce6454354****',
+ 'example' => 'Month',
+ 'enum' => ['Month', 'Year'],
],
],
[
- 'name' => 'Target',
+ 'name' => 'BillingInstanceIds',
'in' => 'query',
- 'schema' => [
- 'description' => '目标磁盘数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '100',
- 'minimum' => '0',
- 'example' => '3',
- ],
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => '需要续费的计费实例 ID 列表，多个计费实例 ID 用逗号隔开。', 'type' => 'string', 'required' => true, 'example' => 'c-3d6dc31ba67b1839', 'maxLength' => 200],
],
[
- 'name' => 'FastMode',
+ 'name' => 'PromotionOptionNo',
'in' => 'query',
+ 'schema' => ['description' => '优惠券ID。', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_12378dfj6'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '是否以快速重启模式重启。默认为 false。'."\n"
- ."\n"
- .'- true：以快速重启模式重启计算节点。分为多个批次重启计算节点，批次内并行重启，批次间串行执行；'."\n"
- .'- false：以滚动重启模式重启计算节点。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'OriginalAmount' => ['description' => '原价(原始金额)=目录价*计费用量', 'type' => 'number', 'format' => 'float', 'example' => '9812'],
+ 'DiscountAmount' => ['description' => '优惠金额=原始金额-账单应付金额(包括优惠券抵扣金额)', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'TradeAmount' => ['description' => '金额。', 'type' => 'number', 'format' => 'float', 'example' => '9812'],
+ 'Currency' => ['description' => '币种', 'type' => 'string', 'example' => 'CNY'],
+ 'BillingInstanceId' => ['description' => '帐单对应的实例 ID。对于默认计算组（FE计算组和默认的BE计算组），该字段的值为实例 ID，否则为计算组 ID。', 'type' => 'string', 'example' => 'c-96f3bc7f04b2****'],
+ 'OptionalPromotions' => [
+ 'description' => '优惠券编号',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '优惠券信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PromotionOptionNo' => ['description' => '优惠券ID。', 'type' => 'string', 'example' => 'youhuiquan_12378dfj6'],
+ 'PromotionName' => ['description' => '优惠券名称。', 'type' => 'string', 'example' => 'youhuiquan_promotion_option_id_for_blank'],
+ 'PromotionDesc' => ['description' => '优惠券描述。', 'type' => 'string', 'example' => 'youhuiquan_desc'],
+ ],
+ ],
+ ],
+ 'StandPrice' => ['description' => '官网折扣价', 'type' => 'number', 'format' => 'float', 'example' => '9812'],
+ 'StandDiscountPrice' => ['description' => '基于官网折扣的优惠价格', 'type' => 'number', 'format' => 'float', 'example' => '9812'],
+ 'DepreciateInfo' => [
+ 'description' => '降价后官网总价。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CheapRate' => ['description' => '降价比例', 'type' => 'number', 'format' => 'float', 'example' => '0'],
+ 'CheapStandAmount' => ['description' => '降价后官网价总价', 'type' => 'number', 'format' => 'float', 'example' => '9812'],
+ 'OriginalStandAmount' => ['description' => '原始官网总价。', 'type' => 'number', 'format' => 'float', 'example' => '9812'],
+ 'IsShow' => ['description' => '是否展示降价幅度。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'example' => '9812',
+ ],
+ 'Rules' => [
+ 'description' => '返回数据结构。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '命中的规则列表，每一条为一个规则，只返回命中的规则信息和命中规则位置信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '规则名称。', 'type' => 'string', 'example' => 'rule_8syh2j121ns'],
+ 'RuleDescId' => ['description' => '规则ID。', 'type' => 'string', 'example' => '8su2i3hsdf128'],
+ 'Amount' => ['description' => '资源数量。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'title' => '查询实例的续费价格',
+ 'summary' => '查询 StarRocks 计费实例的续费价格',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'PromotionOptionNo',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryRenewPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"null\\",\\n \\"Data\\": [\\n {\\n \\"OriginalAmount\\": 9812,\\n \\"DiscountAmount\\": 0,\\n \\"TradeAmount\\": 9812,\\n \\"Currency\\": \\"CNY\\",\\n \\"BillingInstanceId\\": \\"c-96f3bc7f04b2****\\",\\n \\"OptionalPromotions\\": [\\n {\\n \\"PromotionOptionNo\\": \\"youhuiquan_12378dfj6\\",\\n \\"PromotionName\\": \\"youhuiquan_promotion_option_id_for_blank\\",\\n \\"PromotionDesc\\": \\"youhuiquan_desc\\"\\n }\\n ],\\n \\"StandPrice\\": 9812,\\n \\"StandDiscountPrice\\": 9812,\\n \\"DepreciateInfo\\": {\\n \\"CheapRate\\": 0,\\n \\"CheapStandAmount\\": 9812,\\n \\"OriginalStandAmount\\": 9812,\\n \\"IsShow\\": true\\n },\\n \\"Rules\\": [\\n {\\n \\"Name\\": \\"rule_8syh2j121ns\\",\\n \\"RuleDescId\\": \\"8su2i3hsdf128\\",\\n \\"Amount\\": 1\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'QueryUnpaidOrder' => [
+ 'path' => '/webapi/order/queryUnpaidOrder',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '230184',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****', 'maxLength' => 30, 'pattern' => '^[0-9a-zA-Z_-]+$'],
+ ],
+ [
+ 'name' => 'BillingInstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '帐单对应的实例 ID。对于默认计算组（FE计算组和默认的BE计算组），该字段的值为实例 ID，否则为计算组 ID。', 'type' => 'string', 'required' => true, 'example' => 'ng-12zxs328sha2', 'maxLength' => 30, 'pattern' => '^[0-9a-zA-Z_-]+$'],
+ ],
+ [
+ 'name' => 'OrderType',
'in' => 'query',
'schema' => [
+ 'description' => '订单类型',
'type' => 'string',
'required' => false,
+ 'example' => 'BUY',
+ 'enum' => ['BUY', 'RENEW', 'RESOURCE_CHANGE'],
],
],
],
@@ -3334,158 +8371,565 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'HttpStatusCode' => [
- 'description' => 'HTTP请求状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ErrCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'InvalidParams',
- ],
- 'ErrMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Invalid params: [instance not exists].',
- ],
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'."\n"],
+ 'Data' => ['description' => '返回数据。', 'type' => 'integer', 'format' => 'int64', 'example' => 'true'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询计算组/集群的未支付订单',
+ 'summary' => '查询计算组/集群的未支付订单',
+ 'description' => '查询计算组/集群的未支付订单。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryUnpaidOrder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\\\n\\",\\n \\"Data\\": 0\\n}","type":"json"}]',
+ ],
+ 'QueryUpgradableVersions' => [
+ 'path' => '/webapi/starrocks/queryUpgradableVersions',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '168030',
+ 'abilityTreeNodes' => ['FEATUREemapreduceGZP0FZ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'Minor',
+ 'in' => 'query',
+ 'schema' => ['description' => '使用查询可升级的小版本列表。默认值为 true：'."\n"
+ .'- true：查询可升级的小版本列表；'."\n"
+ .'- false：查询可升级的主版本列表。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
'Data' => [
- 'description' => '订单 ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '24151320976****',
- ],
- 'AccessDeniedDetail' => [
- 'title' => 'AccessDeniedDetail',
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }',
+ 'description' => '可升级的版本列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '可升级的版本号。', 'type' => 'string', 'example' => '3.3.2-1.77-1.6.4'],
],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询可升级的版本列表',
+ 'summary' => '本接口用于查询 Serverless StarRocks 实例可升级的版本列表。Serverless StarRocks 有两层版本定义，一层是主版本，即集群详情页“版本”所显示的内容，另一层是小版本，即集群详情页“小版本”所显示的内容。本接口既可以用于查询可升级的小版本，也可以用于查询可升级的主版本。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": 0,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
- 'title' => '增加磁盘数量',
- 'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[计费项](https://help.aliyun.com/zh/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c4g.11186623.help-menu-28066.d_0_1_1.4db82b05p3Gg0G)</props><props="intl">[计费项](https://www.alibabacloud.com/help/en/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c63.p38356.help-menu-28066.d_0_1_0.3aaf4b0b69jN1P)</props>。'."\n"
- .'调用该接口时，您需要注意：'."\n"
- ."\n"
- .'- 只有标准版实例支持增加磁盘数量，入门版实例不支持。'."\n"
- ."\n"
- .'- 只有计算组规格类型为标准版 (standard) 的实例支持增加磁盘数量。'."\n"
- ."\n"
- .'- 实例必须处于运行中（Running）状态。'."\n"
- ."\n"
- .'增加磁盘数量后，计费变化情况如下：'."\n"
- ."\n"
- .'- 按量付费：按照新的磁盘类型计费。'."\n"
- ."\n"
- .'- 包年包月：在计费周期内，会根据新旧配置的价格差和剩余天数（从次日 0 点到有效期结束）来计算应补缴的费用。',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryUpgradableVersions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": [\\n \\"3.3.2-1.77-1.6.4\\"\\n ],\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
],
- 'ModifyCu' => [
- 'summary' => '本接口用于修改 Serverless StarRocks 实例计算组节点的 CU 数量。',
- 'path' => '/webapi/resourceChange/modifyCu',
- 'methods' => [
- 'post',
+ 'RebootECS' => [
+ 'path' => '/webapi/event/rebootEcs',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '279235',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RebootTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例的重启时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1772076782'],
+ ],
+ [
+ 'name' => 'EventId',
+ 'in' => 'query',
+ 'schema' => ['description' => '系统事件ID。', 'type' => 'string', 'required' => false, 'example' => '8c96a3fc8a0d4a48b5db5fdb9742fbbc'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'Total' => ['description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '重启是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'description' => '',
+ ],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '重启集群ECS实例',
+ 'summary' => '重启集群ECS实例',
+ 'description' => '该接口为异步接口，实例的重启不是立即完成的，成功调用后，实例会先进入重启中（restarting）状态，当返回的状态为运行中（running）时代表重启成功。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:RebootECS',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": true,\\n \\"Total\\": 100,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'ReleaseInstance' => [
+ 'path' => '/webapi/cluster/release',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- 'application/x-www-form-urlencoded',
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '173986',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'boolean'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '释放实例',
+ 'summary' => '本接口仅用于释放 Serverless StarRocks 按量付费实例。包年包月实例请到用户中心退订管理页进行退订。',
+ 'description' => '><danger>释放实例后，实例所使用的物理资源都被回收，相关数据全部丢失且不可恢复。></danger>',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'produces' => [
- 'application/json',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'sr:ReleaseInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'RenewInstance' => [
+ 'path' => '/webapi/order/renew_instance',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '220680',
- 'abilityTreeNodes' => [
- 'FEATUREemapreduceUHHTB7',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '162279',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****', 'pattern' => '^[0-9a-zA-Z_-]+$'],
+ ],
+ [
+ 'name' => 'Duration',
+ 'in' => 'query',
'schema' => [
- 'description' => '实例 ID。',
- 'type' => 'string',
+ 'description' => '购买时长。',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => true,
- 'example' => 'c-b25e21e24388****',
+ 'maximum' => '12',
+ 'minimum' => '1',
+ 'example' => '1',
+ 'enum' => ['1', '2', '3', '6', '9'],
],
],
[
- 'name' => 'NodeGroupId',
+ 'name' => 'PricingCycle',
'in' => 'query',
'schema' => [
- 'description' => '计算组 ID。',
+ 'description' => '购买时长单位：'."\n"
+ .'<ul>'."\n"
+ .'<li> 月（Month）</li>'."\n"
+ .'<li> 年（Year）</li>'."\n"
+ .'</ul>'."\n"
+ .'仅在 payType 为 PrePaid 时有意义。',
'type' => 'string',
'required' => true,
- 'example' => 'ng-3d5ce6454354****',
+ 'example' => 'Year',
+ 'enum' => ['Month', 'Year'],
],
],
[
- 'name' => 'Target',
+ 'name' => 'BillingInstanceIds',
'in' => 'query',
+ 'schema' => ['description' => '需要续费的计费实例 ID 列表，多个计费实例 ID 用逗号隔开。计费实例包括集群和计算组。', 'type' => 'string', 'required' => true, 'example' => 'ng-dd8933281e46****', 'maxLength' => 200],
+ ],
+ [
+ 'name' => 'PromotionOptionNo',
+ 'in' => 'query',
+ 'schema' => ['description' => '优惠券ID。', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_12378dfj6'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '目标 CU 数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '64',
- 'minimum' => '4',
- 'example' => '4',
- 'enum' => [
- '4',
- '8',
- '16',
- '32',
- '64',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OrderIds' => [
+ 'description' => '订单 ID 列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '订单ID', 'type' => 'string', 'example' => '24793054452****'],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '续费实例',
+ 'summary' => '续费实例',
+ 'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[计费项](https://help.aliyun.com/zh/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c4g.11186623.help-menu-28066.d_0_1_1.4db82b05p3Gg0G)</props><props="intl">[计费项](https://www.alibabacloud.com/help/en/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c63.p38356.help-menu-28066.d_0_1_0.3aaf4b0b69jN1P)</props>。'."\n"
+ ."\n"
+ .'调用该接口时，您需要注意：只有包年包月实例支持续费。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:RenewInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": {\\n \\"OrderIds\\": [\\n \\"24793054452****\\"\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'RestartInstance' => [
+ 'path' => '/webapi/starrocks/restartCluster',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '189752',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'FastMode',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否以快速重启模式重启。默认为false。'."\n"
+ .'- true：以快速重启模式重启计算节点。分为多个批次重启计算节点，批次内并行重启，批次间串行执行；'."\n"
+ .'- false：以滚动重启模式重启计算节点。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Unsupported.Non.Whitelist.Operation'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'boolean', 'example' => 'true'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => '重启实例',
+ 'summary' => '本接口用于重启 Serverless StarRocks 实例。',
+ 'description' => '该接口为异步接口，实例的重启不是立即完成的，成功调用后，实例会先进入重启中（restarting）状态，当返回的状态为运行中（running）时代表重启成功。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:RestartInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Unsupported.Non.Whitelist.Operation\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'RestartNodeGroup' => [
+ 'summary' => '重启指定的node group',
+ 'path' => '/webapi/nodegroup/restart',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '238196',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => false, 'example' => 'ng-3d5ce6454354****'],
+ ],
[
'name' => 'FastMode',
'in' => 'query',
+ 'schema' => ['description' => '是否以快速重启模式重启。默认为false。'."\n"
+ .'- true：以快速重启模式重启计算节点。分为多个批次重启计算节点，批次内并行重启，批次间串行执行；'."\n"
+ .'- false：以滚动重启模式重启计算节点。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '是否以快速重启模式重启。默认为 false。'."\n"
- ."\n"
- .'- true：以快速重启模式重启计算节点。分为多个批次重启计算节点，批次内并行重启，批次间串行执行；'."\n"
- .'- false：以滚动重启模式重启计算节点。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '订单 ID。', 'type' => 'boolean', 'example' => '24151320976****'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => '重启计算组',
+ 'description' => '该接口为异步接口，实例的重启不是立即完成的，成功调用后，实例会先进入重启中（restarting）状态，当返回的状态为运行中（running）时代表重启成功。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'PromotionOptionNo',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:RestartNodeGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'RestartNodes' => [
+ 'path' => '/webapi/restart/restart',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '253221',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'type' => 'string',
+ 'description' => '请求参数信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RestartNodeGroups' => [
+ 'description' => '需要重启的计算组节点信息',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'NodeGroupId' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => false, 'example' => 'ng-dcc7450e06a271b9'],
+ 'FastMode' => ['description' => '是否以快速重启模式重启。默认为false。'."\n"
+ .'- true：以快速重启模式重启计算节点。分为多个批次重启计算节点，批次内并行重启，批次间串行执行；'."\n"
+ .'- false：以滚动重启模式重启计算节点。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ 'NodeIds' => [
+ 'description' => '节点ID列表',
+ 'type' => 'array',
+ 'items' => ['description' => '节点ID。', 'type' => 'string', 'required' => false, 'example' => 'fe-0'],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ ],
+ ],
'required' => false,
],
],
@@ -3495,79 +8939,189 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'HttpStatusCode' => [
- 'description' => 'HTTP请求状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求 ID。',
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'."\n"],
+ 'Data' => ['description' => '实例信息。', 'type' => 'boolean', 'example' => '24151320976****'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => '重启集群节点',
+ 'summary' => '重启集群中的节点',
+ 'description' => '该接口为异步接口，实例的重启不是立即完成的，成功调用后，实例会先进入重启中（restarting）状态，当返回的状态为运行中（running）时代表重启成功。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:RestartNodes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"Success\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\\\n\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'RestoreInstance' => [
+ 'path' => '/webapi/restore/restoreInstance',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '257323',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求结构体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'AdminPassword' => ['title' => '集群管理员密码。', 'description' => '集群管理员密码。', 'type' => 'string', 'required' => false, 'example' => 'password_example'],
+ 'AutoRenew' => ['title' => '是否开启自动续费，仅在 payType 为 PrePaid 时有意义。默认不开启。', 'description' => '是否开启自动续费，仅在 payType 为 PrePaid 时有意义。默认不开启。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
+ 'RegionId' => ['title' => '地域 ID', 'description' => '地域 ID', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ 'PayType' => [
+ 'title' => '付费类型：'."\n"
+ .' 包年包月：prePaid'."\n"
+ .' 按量付费：postPaid',
+ 'description' => '付费类型：'."\n"
+ .' 包年包月：prePaid'."\n"
+ .' 按量付费：postPaid',
'type' => 'string',
- 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'false',
+ 'required' => false,
+ 'example' => 'prePaid',
+ 'enum' => ['prePaid', 'postPaid'],
],
- 'ErrCode' => [
- 'description' => '错误码。',
+ 'VpcId' => ['title' => 'vpc ID', 'description' => 'vpc ID', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1fll2mci6d7pw8m****'],
+ 'PricingCycle' => [
+ 'title' => '购买时长单位。仅在 payType 为 PrePaid 时有意义。'."\n"
+ .' 月：Month'."\n"
+ .' 年：Year',
+ 'description' => '购买时长单位。仅在 payType 为 PrePaid 时有意义。'."\n"
+ .' 月：Month'."\n"
+ .' 年：Year',
'type' => 'string',
- 'example' => 'InvalidParams',
+ 'required' => false,
+ 'example' => 'Month',
+ 'enum' => ['Month', 'Year'],
],
- 'ErrMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Invalid params: [instance not exists].'."\n",
+ 'VSwitches' => [
+ 'title' => 'VSwitch 信息和可用区信息',
+ 'description' => 'VSwitch 信息和可用区信息',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '交换机信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ZoneId' => ['description' => '交换机可用区 ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i'],
+ 'VswId' => ['description' => '交换机 ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp19mlh98tm9teyyd****'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
],
- 'Data' => [
- 'description' => '订单 ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '24151320976****',
+ 'Duration' => ['title' => '购买时长。仅在 payType 为 PrePaid 时有意义。', 'description' => '购买时长。仅在 payType 为 PrePaid 时有意义。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'BackupTaskId' => ['description' => '备份任务Id', 'type' => 'string', 'required' => false, 'example' => 'bk-adskj23hd9s'],
+ 'InstanceName' => ['description' => '实例名称。', 'type' => 'string', 'required' => false, 'example' => 'c1'],
+ 'ResourceGroupId' => ['description' => '资源组 ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzllkih7jqxxx'],
+ 'Tags' => [
+ 'description' => '标签结构体。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签结构体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'dukang-chengdu-sgueg'],
+ 'value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => '{\'reasons\': [], \'patterns\': [], \'aggregates\': [], \'event_statistic\': {\'statistic\': {}}}'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
],
- 'AccessDeniedDetail' => [
- 'title' => 'AccessDeniedDetail',
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }',
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'."\n"],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OrderId' => ['description' => '订单 ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '241526000650XXX'],
+ 'InstanceId' => ['description' => '实例 ID。', 'type' => 'string', 'example' => 'c-b25e21e243889XXX'],
+ ],
],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\\\n\\",\\n \\"Data\\": 0,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
- 'title' => '修改CU数量',
- 'description' => '请确保在使用该接口前，已充分了解 Serverless StarRocks 产品的收费方式和<props="china">[计费项](https://help.aliyun.com/zh/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c4g.11186623.help-menu-28066.d_0_1_1.4db82b05p3Gg0G)</props><props="intl">[计费项](https://www.alibabacloud.com/help/en/emr/emr-serverless-starrocks/product-overview/billable-items?spm=a2c63.p38356.help-menu-28066.d_0_1_0.3aaf4b0b69jN1P)</props>。'."\n"
- ."\n"
- .'调用该接口时，您需要注意：'."\n"
- ."\n"
- .'- 只有标准版实例支持修改计算组 CU 数量，入门版实例不支持。'."\n"
- ."\n"
- .'- 只有计算组规格类型为标准版 (standard) 的实例支持增加磁盘数量。'."\n"
- ."\n"
- .'- 实例必须处于运行中（Running）状态。'."\n"
- ."\n"
- .'修改 CU 数量后，计费变化情况如下：'."\n"
- ."\n"
- .'- 按量付费：按照新的 CU 数量计费。'."\n"
- ."\n"
- .'- 包年包月：在计费周期内，会根据新旧配置的价格差和剩余天数（从次日 0 点到有效期结束）来计算应补缴的费用。',
- ],
- 'CreateServiceLinkedRole' => [
- 'summary' => '该接口用于为用户创建 AliyunServiceRoleForEMRStarRocks 角色。',
- 'path' => '/webapi/user/create_default_role',
- 'methods' => [
- 'post',
+ 'title' => '从备份中恢复实例',
+ 'summary' => '从备份中恢复实例',
+ 'description' => '该接口为异步接口，实例的重启不是立即完成的，成功调用后，实例会先进入重启中（restarting）状态，当返回的状态为运行中（running）时代表重启成功。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sr:RestoreInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\\\n\\",\\n \\"ErrMessage\\": \\"null\\",\\n \\"Data\\": {\\n \\"OrderId\\": 0,\\n \\"InstanceId\\": \\"c-b25e21e243889XXX\\"\\n },\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'ResumeInstance' => [
+ 'summary' => '该接口用于恢复来自openlake自动停机的实例。',
+ 'path' => '/webapi/lifecycle/resumeInstance',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3576,122 +9130,2476 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '244097',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'boolean', 'example' => '24151320976****'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => '恢复已停机实例',
+ 'description' => '><danger>释放实例后，实例所使用的物理资源都被回收，相关数据全部丢失且不可恢复。></danger>',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:ResumeInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'RollbackConfigModification' => [
+ 'path' => '/webapi/config/rollbackConfigModification',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
'operationType' => 'none',
- 'abilityTreeCode' => '163986',
- 'abilityTreeNodes' => [
- 'FEATUREemapreduceUHHTB7',
+ 'abilityTreeCode' => '255694',
+ 'abilityTreeNodes' => ['FEATUREemapreduceRZEU20'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'ConfigHistoryId',
+ 'in' => 'query',
+ 'schema' => ['description' => '配置修改历史记录ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '187291'],
+ ],
+ [
+ 'name' => 'Restart',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => '更改配置项后是否需要重启实例，取值：'."\n"
+ ."\n"
+ .'- **true**：重启。'."\n"
+ .'- **false**：不重启。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'HttpStatusCode' => [
- 'description' => 'HTTP请求状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ErrCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'InvalidParams',
- ],
- 'ErrMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'null',
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'boolean', 'example' => 'true'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => '回滚之前的配置修改',
+ 'summary' => '回滚正在进行中的配置修改',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:RollbackConfigModification',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'SwitchActiveStandbyZones' => [
+ 'path' => '/webapi/recovery/switchZones',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '260492',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'TargetZoneId',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-k'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'."\n"],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
+ 'Data' => ['description' => '可升级的版本号。', 'type' => 'boolean', 'example' => '24151320976****'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '切换主备可用区',
+ 'summary' => '切换主备可用区。',
+ 'description' => '切换主备可用区。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:SwitchActiveStandbyZones',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\\\n\\",\\n \\"ErrMessage\\": \\"null\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'TagResources' => [
+ 'path' => '/webapi/tags',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '236086',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求体参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceType' => ['title' => '资源类型', 'description' => '资源类型。', 'type' => 'string', 'required' => true, 'example' => 'instance'],
+ 'RegionId' => ['title' => '地域', 'description' => '地域 ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
+ 'ResourceId' => [
+ 'title' => '资源ID,最多 50个子项',
+ 'description' => '资源 ID 列表，最多 50 个子项。',
+ 'type' => 'array',
+ 'items' => ['description' => '资源 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e243889XXX'."\n"],
+ 'required' => true,
],
- 'Total' => [
- 'description' => '实例总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
+ 'Tag' => [
+ 'title' => '对应新增标签列表，最多包含20个子项',
+ 'description' => '新增标签列表，最多包含20个子项',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '标签键', 'description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'k1'],
+ 'Value' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'v1'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => true,
],
- 'Data' => [
- 'description' => '创建角色是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求id', 'description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '绑定标签',
+ 'summary' => '为指定资源绑定标签。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sr:TagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\"\\n}","type":"json"}]',
+ ],
+ 'ToggleAutoMinorVersionUpgrade' => [
+ 'summary' => '开启/关闭StarRocks实例的小版本自动更新',
+ 'path' => '/webapi/starrocks/toggleAutoMinorVersionUpgrade',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '168127',
+ 'abilityTreeNodes' => ['FEATUREemapreduceZXY046'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'AutoUpgrade',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否开启小版本自动升级。取值：'."\n"
+ ."\n"
+ .'- true：开启'."\n"
+ .'- false：关闭', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'boolean', 'example' => '24151320976****'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '开启/关闭小版本自动升级',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:ToggleAutoMinorVersionUpgrade',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'TogglePublicSlb' => [
+ 'path' => '/webapi/gateway/togglePublicSlb',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '270432',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'GatewayId',
+ 'in' => 'query',
+ 'schema' => ['description' => '私有网关ID。', 'type' => 'string', 'required' => false, 'example' => 'gw-0002xci9buu68ongixvk'],
+ ],
+ [
+ 'name' => 'EnablePublicSlb',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否开启公网slb'."\n"
+ ."\n"
+ .'- 开启：true'."\n"
+ ."\n"
+ .'- 关闭：false', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'boolean', 'example' => '24151320976****'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '开启公网slb开关',
+ 'summary' => '公网SLB开关',
+ 'description' => '><danger>释放实例后，实例所使用的物理资源都被回收，相关数据全部丢失且不可恢复。></danger>',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sr:TogglePublicSlb',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'UnTagResources' => [
+ 'path' => '/webapi/tags',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '236098',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '地域', 'description' => '地域 ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ 'schema' => ['title' => '资源类型', 'description' => '资源类型。', 'type' => 'string', 'required' => true, 'example' => 'instance'],
+ ],
+ [
+ 'name' => 'ResourceId',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '资源ID,最多 50个子项',
+ 'description' => '资源 ID列表，最多包含 50个子项。',
+ 'type' => 'array',
+ 'items' => ['description' => '资源 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e243889XXX'."\n"],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'TagKey',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '对应标签键列表，最多包含20个子项',
+ 'description' => '待解绑的标签键列表，最多包含 20 个子项。',
+ 'type' => 'array',
+ 'items' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'k1'],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'All',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否全部删除，只针对tags为空时有效。取值范围： true false True False 默认是 false', 'description' => '是否全部删除，只针对 tags 为空时有效。默认为 false。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '解绑标签',
+ 'summary' => '为指定的资源列表统一解绑标签。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sr:UnTagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateBackup' => [
+ 'path' => '/webapi/backup/manage/update',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '250725',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '集群所在的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求参数信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'description' => ['description' => '备份描述。', 'type' => 'string', 'required' => false, 'example' => 'backupTask-desc1'],
+ 'backupTaskId' => ['description' => '备份任务id', 'type' => 'string', 'required' => false, 'example' => 'bk-t1232839'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'boolean', 'example' => '24151320976****'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => '更新备份任务信息',
+ 'summary' => '更新备份任务描述',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:UpdateBackup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]\\",\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'UpdateBackupPolicy' => [
+ 'summary' => '更新备份策略',
+ 'path' => '/webapi/backupRestore/policy/update',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '250709',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求结构体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => '实例 ID。', 'type' => 'string', 'required' => false, 'example' => 'c-0104730e9de40215'],
+ 'PolicyId' => ['description' => '备份策略ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'bk-9812023'],
+ 'RecurrenceValues' => [
+ 'description' => '策略执行周期的数值。',
+ 'type' => 'array',
+ 'items' => ['description' => '策略执行周期的数值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '31', 'minimum' => '1', 'example' => '2'],
+ 'required' => false,
],
- 'AccessDeniedDetail' => [
- 'title' => 'AccessDeniedDetail',
- 'description' => 'AccessDeniedDetail',
- 'type' => 'string',
- 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }',
+ 'Hour' => ['description' => '触发时间：小时', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '23', 'minimum' => '0', 'example' => '10', 'default' => '0'],
+ 'Minute' => ['description' => '触发时间：分', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '59', 'minimum' => '0', 'example' => '15', 'default' => '0'],
+ 'ExpireDays' => ['description' => '有效天数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7'],
+ 'TimeoutSeconds' => ['description' => '备份策略的超时时间'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3600'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
+ 'Data' => ['description' => '创建角色是否成功。', 'type' => 'boolean', 'example' => '24151320976****'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => '更新备份策略',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:UpdateBackupPolicy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"null\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateGateway' => [
+ 'path' => '/webapi/gateway/update',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '270148',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'GatewayId',
+ 'in' => 'query',
+ 'schema' => ['description' => '网关ID。', 'type' => 'string', 'required' => false, 'example' => 'dg-65u7d65p5960fjq7'],
+ ],
+ [
+ 'name' => 'GatewayName',
+ 'in' => 'query',
+ 'schema' => ['description' => '网关名称。', 'type' => 'string', 'required' => false, 'example' => 'polar-byd-glm-47'],
+ ],
+ [
+ 'name' => 'FeNodeNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '网关节点数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'boolean', 'example' => '24151320976****'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '更新节点数量',
+ 'summary' => '更新网关节点数量',
+ 'description' => '更新网关节点数量',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:UpdateGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"null\\",\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'UpdateInnerIpWhitelistGroup' => [
+ 'path' => '/webapi/securityGroup/update',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '240833',
+ 'abilityTreeNodes' => ['FEATUREemapreduceRZEU20'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '',
+ 'description' => '请求结构体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-0104730e9de40215'],
+ 'InnerIpWhitelistGroupId' => ['description' => '内网白名单ID', 'type' => 'string', 'required' => true, 'example' => 'sg-28sjsi12bs1', 'maxLength' => 120, 'minLength' => 2, 'pattern' => '^[a-z][a-z0-9_]*[a-z0-9]$'],
+ 'CidrIpList' => [
+ 'description' => '白名单ip列表',
+ 'type' => 'array',
+ 'items' => ['description' => '白名单ip', 'type' => 'string', 'required' => false, 'example' => '192.168.23.0/24', 'pattern' => '^((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.){3}(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\/([0-9]|[1-2]?\\d|3[0-2]))?$'],
+ 'required' => true,
+ 'maxItems' => 20,
],
],
+ 'required' => false,
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"null\\",\\n \\"Total\\": 3,\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
- 'title' => '创建服务角色',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX'."\n"],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'."\n"],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'."\n"],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => '更新内网白名单',
+ 'summary' => '更新白名单分组中的CIDR',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:UpdateInnerIpWhitelistGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\\\n\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\\\n\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\\\n\\"\\n}","type":"json"}]',
],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'starrocks.cn-beijing.aliyuncs.com',
+ 'UpdateInstanceName' => [
+ 'summary' => '本接口用于修改 Serverless StarRocks 实例名称。',
+ 'path' => '/webapi/cluster/update_name',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '159094',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ClusterName',
+ 'in' => 'query',
+ 'schema' => ['description' => '新的实例名称。', 'type' => 'string', 'required' => true, 'example' => 'new_name'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'boolean'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '修改实例名称',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:UpdateInstanceName',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
],
- [
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'starrocks.cn-qingdao.aliyuncs.com',
+ 'UpdateNodeGroupDescription' => [
+ 'path' => '/webapi/nodegroup/updateDescription',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '273259',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => false, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组描述。', 'type' => 'string', 'required' => false, 'example' => 'okcc'],
+ ],
+ [
+ 'name' => 'X-Acs-Ram-Auth-Context',
+ 'in' => 'query',
+ 'schema' => ['description' => 'ram授权信息', 'type' => 'string', 'required' => false, 'example' => 'Optional'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '更新计算组描述',
+ 'summary' => '更新计算组描述',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:UpdateNodeGroupDescription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"Success\\",\\n \\"ErrMessage\\": \\"null\\"\\n}","type":"json"}]',
],
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'starrocks.cn-zhangjiakou.aliyuncs.com',
+ 'UpdatePublicNetworkStatus' => [
+ 'path' => '/webapi/network/updatePublicNetworkStatus',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '164046',
+ 'abilityTreeNodes' => ['FEATUREemapreduceUHHTB7'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => '返回数据。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'ComponentType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '返回数据。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'BE',
+ 'enum' => ['FE', 'BE', 'CN'],
+ ],
+ ],
+ [
+ 'name' => 'PublicNetworkEnabled',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => '开启/关闭公网。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'NodeGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '计算组 ID。', 'type' => 'string', 'required' => false, 'example' => 'ng-3d5ce6454354****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid params: [instance not exists].'],
+ 'Total' => ['description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'boolean', 'example' => 'true'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => 'AccessDeniedDetail', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'title' => '开通/关闭 FE/BE的公网SLB',
+ 'summary' => '开通/关闭 FE/BE的公网SLB。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:UpdatePublicNetworkStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid params: [instance not exists].\\",\\n \\"Total\\": 100,\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'starrocks.cn-hangzhou.aliyuncs.com',
+ 'UpgradeVersion' => [
+ 'path' => '/webapi/starrocks/upgradeVersion',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '181121',
+ 'abilityTreeNodes' => ['FEATUREemapreduceZXY046'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'c-b25e21e24388****'],
+ ],
+ [
+ 'name' => 'TargetVersion',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标版本号。', 'type' => 'string', 'required' => true, 'example' => '3.3.2-1.77-1.6.4'],
+ ],
+ [
+ 'name' => 'Minor',
+ 'in' => 'query',
+ 'schema' => ['description' => '本次升级是否为小版本升级。默认值为 true 即升级小版本。'."\n"
+ .'- true：小版本升级；'."\n"
+ .'- false：大版本升级。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'FastMode',
+ 'in' => 'query',
+ 'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => ['description' => 'HTTP请求状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '32A44F0D-BFF6-5664-999A-218BBDE7****'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'false'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidParams'],
+ 'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Invalid instance status: [cannot upgrade when instance is not running].'],
+ 'Data' => ['description' => '返回数据。', 'type' => 'boolean'],
+ 'AccessDeniedDetail' => ['title' => 'AccessDeniedDetail', 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '升级版本',
+ 'summary' => '本接口用于升级 Serverless StarRocks 实例版本。Serverless StarRocks 有两层版本定义，一层是主版本，即集群详情页“版本”所显示的内容，另一层是小版本，即集群详情页“小版本”所显示的内容。本接口既可以用于升级小版本，也可以用于升级主版本。'."\n"
+ .'可以使用接口 QueryUpgradableVersions 查询集群的可升级版本。',
+ 'description' => '调用该接口时实例必须处于运行中（Running）状态。',
+ 'changeSet' => [
+ ['createdAt' => '2025-02-20T08:18:19.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:UpgradeVersion',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE7****\\",\\n \\"Success\\": false,\\n \\"ErrCode\\": \\"InvalidParams\\",\\n \\"ErrMessage\\": \\"Invalid instance status: [cannot upgrade when instance is not running].\\",\\n \\"Data\\": true,\\n \\"AccessDeniedDetail\\": \\"{ \\\\\\"PolicyType\\\\\\": \\\\\\"AccountLevelIdentityBasedPolicy\\\\\\", \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"xxx\\\\\\", \\\\\\"NoPermissionType\\\\\\": \\\\\\"ImplicitDeny\\\\\\", \\\\\\"AuthAction\\\\\\": \\\\\\"sr:xxx\\\\\\" }\\"\\n}","type":"json"}]',
],
+ ],
+ 'endpoints' => [
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'starrocks.ap-southeast-1.aliyuncs.com', 'endpoint' => 'starrocks.ap-southeast-1.aliyuncs.com', 'vpc' => 'starrocks-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'starrocks.ap-southeast-5.aliyuncs.com', 'endpoint' => 'starrocks.ap-southeast-5.aliyuncs.com', 'vpc' => 'starrocks-vpc.ap-southeast-5.aliyuncs.com'],
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'starrocks.cn-beijing.aliyuncs.com', 'endpoint' => 'starrocks.cn-beijing.aliyuncs.com', 'vpc' => 'starrocks-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'starrocks.cn-hangzhou.aliyuncs.com', 'endpoint' => 'starrocks.cn-hangzhou.aliyuncs.com', 'vpc' => 'starrocks-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'starrocks.cn-hongkong.aliyuncs.com', 'endpoint' => 'starrocks.cn-hongkong.aliyuncs.com', 'vpc' => 'starrocks-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'cn-qingdao', 'regionName' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'starrocks.cn-qingdao.aliyuncs.com', 'endpoint' => 'starrocks.cn-qingdao.aliyuncs.com', 'vpc' => 'starrocks-vpc.cn-qingdao.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'starrocks.cn-shanghai.aliyuncs.com', 'endpoint' => 'starrocks.cn-shanghai.aliyuncs.com', 'vpc' => 'starrocks-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'starrocks.cn-shenzhen.aliyuncs.com', 'endpoint' => 'starrocks.cn-shenzhen.aliyuncs.com', 'vpc' => 'starrocks-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'starrocks.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'starrocks.cn-wulanchabu.aliyuncs.com', 'vpc' => 'starrocks-vpc.cn-wulanchabu.aliyuncs.com'],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'starrocks.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'starrocks.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'starrocks-vpc.cn-zhangjiakou.aliyuncs.com'],
+ ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'starrocks.us-west-1.aliyuncs.com', 'endpoint' => 'starrocks.us-west-1.aliyuncs.com', 'vpc' => 'starrocks-vpc.us-west-1.aliyuncs.com'],
+ ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'starrocks.us-east-1.aliyuncs.com', 'endpoint' => 'starrocks.us-east-1.aliyuncs.com', 'vpc' => 'starrocks-vpc.us-east-1.aliyuncs.com'],
+ ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'starrocks.eu-central-1.aliyuncs.com', 'endpoint' => 'starrocks.eu-central-1.aliyuncs.com', 'vpc' => 'starrocks-vpc.eu-central-1.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'Action.Unsupported', 'message' => 'Unsupported operation: Unsupported reduce the storage size.', 'http_code' => 400, 'description' => '不支持的操作：不支持减少存储容量。'],
+ ['code' => 'Action.Unsupported', 'message' => 'Unsupported operation: Unsupported modify storage performance level at current architecture.', 'http_code' => 400, 'description' => '不支持的操作：当前架构不支持修改存储性能级别。'],
+ ['code' => 'Action.Unsupported', 'message' => 'Unsupported operation: FE node number can\'t be less than current node number.', 'http_code' => 400, 'description' => '不支持的操作：FE数量不能少于当前节点数量。'],
+ ['code' => 'Action.Unsupported', 'message' => 'Unsupported operation: FE node number can\'t be an even number.', 'http_code' => 400, 'description' => '不支持的操作：FE数量不能是偶数。'],
+ ['code' => 'Action.Unsupported', 'message' => 'Unsupported operation: Unsupported modify cu at current spec type.', 'http_code' => 400, 'description' => '不支持的操作：当前规格类型不支持修改cu'],
+ ['code' => 'Action.Unsupported', 'message' => 'Unsupported operation: fast restart.', 'http_code' => 400, 'description' => '不支持的操作：快速重启'],
+ ['code' => 'BillingInstance.NotFound', 'message' => 'Failed to find billing instance.', 'http_code' => 400, 'description' => '付费实例不存在'],
+ ['code' => 'ClusterNameUnset', 'message' => 'Cluster name needs to be set.', 'http_code' => 400, 'description' => '集群名称不能为空'],
+ ['code' => 'Duplicate.TagKey', 'message' => 'The Tag.N.Key contains duplicate keys.', 'http_code' => 400, 'description' => '存在重复的标签键'],
+ ['code' => 'IllegalClusterName', 'message' => 'Cluster name is illegal.', 'http_code' => 400, 'description' => '集群名称不合法'],
+ ['code' => 'InadequateSlbQuota', 'message' => 'Your slb quota is insufficient, please scale up and try again.', 'http_code' => 400, 'description' => 'SLB配额不足，请扩容后重试'],
+ ['code' => 'Instance.NotFound', 'message' => 'Failed to find instance.', 'http_code' => 400, 'description' => '实例不存在'],
+ ['code' => 'InsufficientResources', 'message' => 'Selected zone has insufficient resource.', 'http_code' => 400, 'description' => '可用区资源不足'],
+ ['code' => 'InvalidParams', 'message' => 'Invalid params: package type should not be null.', 'http_code' => 400, 'description' => '参数PackageType不能为空'],
+ ['code' => 'InvalidParams', 'message' => 'Package type should be select from set [trial, official, standard].', 'http_code' => 400, 'description' => 'PackageType 字段必须是 trial / official / standard 之一'],
+ ['code' => 'InvalidParams', 'message' => 'Region id should not be null.', 'http_code' => 400, 'description' => '地域ID不能为空'],
+ ['code' => 'InvalidParams', 'message' => 'Pay type should be select from set [prePaid, postPaid].', 'http_code' => 400, 'description' => '付费类型应是[prePaid, postPaid]之一'],
+ ['code' => 'InvalidParams', 'message' => 'Pay type should not be null.', 'http_code' => 400, 'description' => '付费类型不能为空'],
+ ['code' => 'InvalidParams', 'message' => 'Zone id should not be null.', 'http_code' => 400, 'description' => '可用区ID不能为空'],
+ ['code' => 'InvalidParams', 'message' => 'Invalid params: The specified ResourceIds are not found in our records.', 'http_code' => 400, 'description' => '无效参数：资源ID不存在'],
+ ['code' => 'InvalidParams', 'message' => 'Invalid params: Node number in default node group can not be 0.', 'http_code' => 400, 'description' => '无效参数：默认节点组中的节点数量不能为0。'],
+ ['code' => 'InvalidParams', 'message' => 'Invalid params: Invalid configuration change.', 'http_code' => 400, 'description' => '无效参数：无效的配置变更。'],
+ ['code' => 'InvalidParams', 'message' => 'Invalid params: modify reason is empty.', 'http_code' => 400, 'description' => '无效参数：修改原因为空。'],
+ ['code' => 'InvalidParams', 'message' => 'Invalid params: Invalid param autoUpgrade.', 'http_code' => 400, 'description' => '无效参数：autoUpgrade'],
+ ['code' => 'InvalidParams', 'message' => 'Invalid params: Billing instanceId not match with instanceId.', 'http_code' => 400, 'description' => '无效参数：计费实例ID与实例ID不匹配'],
+ ['code' => 'InvalidParams', 'message' => 'Invalid params: Billing instanceId can not be empty.', 'http_code' => 400, 'description' => '无效参数：计费实例ID不能为空'],
+ ['code' => 'InvalidParams', 'message' => 'Only post paid instance can be actively released.', 'http_code' => 400, 'description' => '只有按量付费实例支持主动释放'],
+ ['code' => 'InvalidParams', 'message' => 'Access oss role name should not be null.', 'http_code' => 400, 'description' => 'ossAccessingRoleName不能为空'],
+ ['code' => 'InvalidParams', 'message' => 'VPC can not found.', 'http_code' => 400, 'description' => 'VPC不存在'],
+ ['code' => 'InvalidParams', 'message' => 'Auto renew should not be null.', 'http_code' => 400, 'description' => '自动续费不能为空'],
+ ['code' => 'InvalidParams', 'message' => 'VSwitch id should not be null.', 'http_code' => 400, 'description' => '交换机ID不能为空'],
+ ['code' => 'InvalidParams', 'message' => 'Admin password should not be null.', 'http_code' => 400, 'description' => '管理员密码不能为空'],
+ ['code' => 'InvalidParams', 'message' => 'Fe resource should not be null.', 'http_code' => 400, 'description' => 'FE资源规格不能为空'],
+ ['code' => 'InvalidParams', 'message' => 'Be resource should not be null.', 'http_code' => 400, 'description' => 'BE节点资源规格不能为空'],
+ ['code' => 'InvalidParams', 'message' => 'Duration should not be null.', 'http_code' => 400, 'description' => '购买时长不能为空'],
+ ['code' => 'InvalidParams', 'message' => 'Pricing cycle should be select from set [Year, Month].', 'http_code' => 400, 'description' => '计费周期必须是[Year, Month]之一'],
+ ['code' => 'InvalidParams', 'message' => 'Pricing cycle should not be null.', 'http_code' => 400, 'description' => '计费周期不能为空'],
+ ['code' => 'InvalidParams', 'message' => 'IP address in vSwitch is not enough.', 'http_code' => 400, 'description' => '交换机IP地址不足'],
+ ['code' => 'InvalidParams', 'message' => 'VSwitch can not found.', 'http_code' => 400, 'description' => '交换机不存在'],
+ ['code' => 'InvalidParams', 'message' => 'VSwitch is not belong to current VPC.', 'http_code' => 400, 'description' => '交换机不属于当前VPC'],
+ ['code' => 'InvalidParams', 'message' => 'Invalid network segment of VPC.', 'http_code' => 400, 'description' => '无效的VPC网段'],
+ ['code' => 'InvalidStatus', 'message' => 'Invalid instance status: exist down backend nodes.', 'http_code' => 400, 'description' => '无效的实例状态：存在处于离线状态的BE'],
+ ['code' => 'InvalidStatus', 'message' => 'Invalid instance status: frontend is not available.', 'http_code' => 400, 'description' => '无效的实例状态：FE不可用'],
+ ['code' => 'InvalidStatus', 'message' => 'Invalid instance status: cluster must be in running status.', 'http_code' => 400, 'description' => '无效的实例状态：集群必须处于运行状态。'],
+ ['code' => 'InvalidStatus', 'message' => 'Invalid instance status: cannot upgrade when instance is not running.', 'http_code' => 400, 'description' => '无效的实例状态：非运行状态的实例无法升级。'],
+ ['code' => 'InvalidStatus.ExistUnpaidRenewOrder', 'message' => 'There is an unpaid renewal order.', 'http_code' => 400, 'description' => '存在未支付续费订单'],
+ ['code' => 'InvalidStatus.ExistUnpaidResourceChangeOrder', 'message' => 'There is an unpaid configuration change order.', 'http_code' => 400, 'description' => '存在未支付的变配订单'],
+ ['code' => 'InvalidStatus.InsufficientStorage', 'message' => 'Invalid status: insufficient storage.', 'http_code' => 400, 'description' => '无效状态：存储空间不足'],
+ ['code' => 'MissingParameter.RegionId', 'message' => 'The RegionId parameters that are required for processing this request are missing.', 'http_code' => 400, 'description' => 'RegionId参数缺失。'],
+ ['code' => 'MissingParameter.ResourceGroupId', 'message' => 'The ResourceGroupId parameters that are required for processing this request are missing.', 'http_code' => 400, 'description' => 'ResourceGroupId参数缺失。'],
+ ['code' => 'MissingParameter.ResourceId', 'message' => 'The ResourceId parameters that are required for processing this request are missing.', 'http_code' => 400, 'description' => 'ResourceId参数缺失。'],
+ ['code' => 'MissingParameter.ResourceIds', 'message' => 'You must specify ResourceId.N.', 'http_code' => 400, 'description' => '资源ID不能为空'],
+ ['code' => 'MissingParameter.ResourceType', 'message' => 'You must specify ResourceType.', 'http_code' => 400, 'description' => '资源类型不能为空'],
+ ['code' => 'MissingParameter.TagKey', 'message' => 'You must specify Tag.N.Key.', 'http_code' => 400, 'description' => '标签键不能为空'],
+ ['code' => 'MissingParameter.Tags', 'message' => 'You must specify Tags.', 'http_code' => 400, 'description' => '必须指定标签'],
+ ['code' => 'MissingParameter.TagValue', 'message' => 'You must specify Tag.N.Value.', 'http_code' => 400, 'description' => '标签的值不能为空'],
+ ['code' => 'NoPermission.ChangeResourceGroup', 'message' => 'You are not authorized to change resourcegroup.', 'http_code' => 403, 'description' => '没有更改资源组的权限。'."\n"],
+ ['code' => 'NumberExceed.ResourceIds', 'message' => 'The maximum number of ResourceIds is exceeded.', 'http_code' => 400, 'description' => '资源ID数量超出上限'],
+ ['code' => 'NumberExceed.Tags', 'message' => 'The maximum number of Tags is exceeded.', 'http_code' => 400, 'description' => '超出标签的最大数量限制'],
+ ['code' => 'ResourceNotFound', 'message' => 'The specified resource is not found.', 'http_code' => 400, 'description' => '您的账号下不存在该资源。'],
+ ['code' => 'SystemError', 'message' => 'A system error occurred while processing your request.', 'http_code' => 400, 'description' => '系统异常。'],
+ ],
+ 'changeSet' => [
[
- 'regionId' => 'cn-wulanchabu',
- 'endpoint' => 'starrocks.cn-wulanchabu.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'ModifyNodeNumber'],
+ ],
+ 'createdAt' => '2025-11-25T07:23:42.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'starrocks.cn-shanghai.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateInstanceV1'],
+ ],
+ 'createdAt' => '2025-09-12T07:46:52.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'starrocks.cn-shenzhen.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'ModifyDiskSize'],
+ ],
+ 'createdAt' => '2025-09-12T07:45:07.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'starrocks.cn-hongkong.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'ModifyDiskPerformanceLevel'],
+ ],
+ 'createdAt' => '2025-09-10T11:41:18.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'us-east-1',
- 'endpoint' => 'starrocks.us-east-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateInstanceV1'],
+ ],
+ 'createdAt' => '2025-07-30T11:08:24.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'us-west-1',
- 'endpoint' => 'starrocks.us-west-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'ModifyCu'],
+ ['description' => '请求参数发生变更', 'api' => 'ModifyDiskNumber'],
+ ['description' => '请求参数发生变更', 'api' => 'ModifyDiskPerformanceLevel'],
+ ['description' => '请求参数发生变更', 'api' => 'ModifyDiskSize'],
+ ['description' => '请求参数发生变更', 'api' => 'ModifyNodeNumber'],
+ ],
+ 'createdAt' => '2025-07-01T02:05:41.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'starrocks.eu-central-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'ModifyCu'],
+ ['description' => '请求参数发生变更', 'api' => 'ModifyDiskNumber'],
+ ['description' => '请求参数发生变更', 'api' => 'UpgradeVersion'],
+ ],
+ 'createdAt' => '2025-02-20T08:18:35.000Z',
+ 'description' => '',
],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'starrocks.ap-southeast-1.aliyuncs.com',
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
],
- [
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'starrocks.ap-southeast-5.aliyuncs.com',
+ ],
+ 'ram' => [
+ 'productCode' => 'StarRocks',
+ 'productName' => '开源大数据平台 E-MapReduce',
+ 'ramCodes' => ['starrocks', 'sr'],
+ 'ramLevel' => '操作级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'GetInstanceFeatureGate',
+ 'description' => 'StarRocks集群实例的特性开关',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:GetInstanceFeatureGate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateBackupPolicy',
+ 'description' => '更新备份策略',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:UpdateBackupPolicy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeInstanceConfigs',
+ 'description' => '查询实例配置',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeInstanceConfigs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryModifyDiskTypePrice',
+ 'description' => '修改计算组节点磁盘类型询价',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryModifyDiskTypePrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpgradeVersion',
+ 'description' => '升级版本',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:UpgradeVersion',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DisableSSLConnection',
+ 'description' => 'StarRocks连接关闭SSL',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:DisableSSLConnection',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResumeInstance',
+ 'description' => '恢复已停机实例',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:ResumeInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RollbackConfigModification',
+ 'description' => '回滚之前的配置修改',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:RollbackConfigModification',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifySpecTypePreCheck',
+ 'description' => '修改计算组中节点规格类型预检查',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ModifySpecTypePreCheck',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateBackup',
+ 'description' => '更新备份任务信息',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:UpdateBackup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddGateway',
+ 'description' => '新增网关',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sr:AddGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteBackupPolicy',
+ 'description' => '删除备份策略',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:DeleteBackupPolicy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryModifySpecTypePrice',
+ 'description' => '修改计算组规格类型询价',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryModifySpecTypePrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EnableMultiAz',
+ 'description' => '实例开启多可用区',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:EnableMultiAz',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryModifyDiskPerformanceLevelPrice',
+ 'description' => '修改计算组节点磁盘性能级别询价',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryModifyDiskPerformanceLevelPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetNodeGroupFeatureGate',
+ 'description' => '获取计算组实例的特性开关',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:GetNodeGroupFeatureGate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateNodeGroupDescription',
+ 'description' => '更新计算组描述',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:UpdateNodeGroupDescription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyDiskType',
+ 'description' => '修改计算组的节点磁盘类型',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyDiskType',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteGateway',
+ 'description' => '删除网关',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'sr:DeleteGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeSystemTimezone',
+ 'description' => '获取实例的系统时区',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeSystemTimezone',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyMaintainableTime',
+ 'description' => '修改实例可维护时间',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyMaintainableTime',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateServiceLinkedRole',
+ 'description' => '创建服务角色',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:CreateServiceLinkedRole',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeBackupPolicies',
+ 'description' => '获取备份策略详情',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeBackupPolicies',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RenewInstance',
+ 'description' => '续费实例',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:RenewInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateInnerIpWhitelistGroup',
+ 'description' => '更新内网白名单',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:UpdateInnerIpWhitelistGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteInnerIpWhitelistGroup',
+ 'description' => '删除内网白名单分组',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:DeleteInnerIpWhitelistGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'TogglePublicSlb',
+ 'description' => '开启公网slb开关',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sr:TogglePublicSlb',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RestartInstance',
+ 'description' => '重启实例',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:RestartInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryEnableMultiAzPrice',
+ 'description' => '查询开启多可用区的价格',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryEnableMultiAzPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyInstanceConfig',
+ 'description' => '修改实例配置',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyInstanceConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EnableInternalSlb',
+ 'description' => '开启内网SLB',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:EnableInternalSlb',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyInstanceConfigPreCheck',
+ 'description' => '修改实例配置前的预检查',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyInstanceConfigPreCheck',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryMinorVersion',
+ 'description' => '查询小版本号',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryMinorVersion',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteScalingRule',
+ 'description' => '删除弹性规则',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:DeleteScalingRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifySpecType',
+ 'description' => '修改计算组的节点规格类型',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ModifySpecType',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyChargeType',
+ 'description' => '修改实例的付费类型',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyChargeType',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryUpgradableVersions',
+ 'description' => '查询可升级的版本列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryUpgradableVersions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryModifyNodeNumberPrice',
+ 'description' => '修改计算组节点数量询价',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryModifyNodeNumberPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryPriceV1',
+ 'description' => '新购询价',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:QueryPriceV1',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyScalingRule',
+ 'description' => '修改弹性伸缩规则',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyScalingRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyCu',
+ 'description' => '修改CU数量',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyCu',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyNodeNumberPreCheck',
+ 'description' => '计算组节点数量修改前的预检查',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyNodeNumberPreCheck',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryRefundPrice',
+ 'description' => '退订包年包月计费实例询价',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:QueryRefundPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListOperationActivity',
+ 'description' => '查询操作详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ListOperationActivity',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateScalingRule',
+ 'description' => '新建弹性规则',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:CreateScalingRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RebootECS',
+ 'description' => '重启集群ECS实例',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:RebootECS',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EnableSSLConnection',
+ 'description' => 'StarRocks连接开启SSL',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:EnableSSLConnection',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyDiskSize',
+ 'description' => '磁盘扩容',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyDiskSize',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateInstanceName',
+ 'description' => '修改实例名称',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:UpdateInstanceName',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyCuPreCheck',
+ 'description' => '计算组节点CU修改前的预检查',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyCuPreCheck',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RestartNodeGroup',
+ 'description' => '重启计算组',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:RestartNodeGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ChangeResourceGroup',
+ 'description' => '修改资源组',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sr:ChangeResourceGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeEventNames',
+ 'description' => '获取集群事件名称',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeEventNames',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListOperationHistory',
+ 'description' => '查询集群操作历史',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ListOperationHistory',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryRenewPrice',
+ 'description' => '查询实例的续费价格',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryRenewPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'TagResources',
+ 'description' => '绑定标签',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sr:TagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListGateway',
+ 'description' => '网关列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ListGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteBackup',
+ 'description' => '删除数据备份',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:DeleteBackup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddBackupPolicy',
+ 'description' => '新增备份策略',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:AddBackupPolicy',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeInstanceMetaToken',
+ 'description' => '获取实例迁移的Meta Token',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeInstanceMetaToken',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ReleaseInstance',
+ 'description' => '释放实例',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'sr:ReleaseInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryModifyCuPrice',
+ 'description' => '修改计算组组节点Cu询价',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryModifyCuPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeConfigHistory',
+ 'description' => '查询配置修改历史',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeConfigHistory',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeTimeTriggerScalingRules',
+ 'description' => '查询基于时间触发的弹性规则',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeTimeTriggerScalingRules',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListSSLDetails',
+ 'description' => 'SSL证书详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ListSSLDetails',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryModifyDiskSizePrice',
+ 'description' => '修改计算组节点单盘存储大小询价',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryModifyDiskSizePrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RestoreInstance',
+ 'description' => '从备份中恢复实例',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sr:RestoreInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeInstances',
+ 'description' => '查询实例',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeInstances',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyHostAlias',
+ 'description' => '修改主机别名',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyHostAlias',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeBackups',
+ 'description' => '获取备份详情',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeBackups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryModifyChargeTypePrice',
+ 'description' => '修改付费类型询价',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:QueryModifyChargeTypePrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CheckInventory',
+ 'description' => '校验资源库存',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:CheckInventory',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeNodeGroups',
+ 'description' => '查询计算组',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeNodeGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UnTagResources',
+ 'description' => '解绑标签',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sr:UnTagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeInstanceDiagnosisResult',
+ 'description' => '获取实例的健康诊断结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeInstanceDiagnosisResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdatePublicNetworkStatus',
+ 'description' => '开通/关闭 FE/BE的公网SLB',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:UpdatePublicNetworkStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyUserPassword',
+ 'description' => '修改 starrocks 用户的密码',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyUserPassword',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateInstanceV1',
+ 'description' => '创建实例',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sr:CreateInstanceV1',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateAgentResource',
+ 'description' => '创建Agent计算组',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:CreateAgentResource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyDiskPerformanceLevel',
+ 'description' => '修改磁盘性能级别',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyDiskPerformanceLevel',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'IsolateLeader',
+ 'description' => '开启读写分离',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:IsolateLeader',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ToggleAutoMinorVersionUpgrade',
+ 'description' => '开启/关闭小版本自动升级',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sr:ToggleAutoMinorVersionUpgrade',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryModifyDiskNumberPrice',
+ 'description' => '修改计算组节点磁盘数量询价',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryModifyDiskNumberPrice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SwitchActiveStandbyZones',
+ 'description' => '切换主备可用区',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:SwitchActiveStandbyZones',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyDiskNumber',
+ 'description' => '增加磁盘数量',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyDiskNumber',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateGateway',
+ 'description' => '更新节点数量',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:UpdateGateway',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RestartNodes',
+ 'description' => '重启集群节点',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:RestartNodes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyNodeNumber',
+ 'description' => '修改节点数量',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:ModifyNodeNumber',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeInnerIpWhitelistGroups',
+ 'description' => '查询内网白名单分组',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sr:DescribeInnerIpWhitelistGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryUnpaidOrder',
+ 'description' => '查询计算组/集群的未支付订单',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sr:QueryUnpaidOrder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'StarRocks', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:sr:{#regionId}:{#accountId}:*'],
],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 20:24:19 +0000