diff options
Diffstat (limited to 'data/zh_cn/starrocks/2022-10-19/api-docs.php')
| -rw-r--r-- | data/zh_cn/starrocks/2022-10-19/api-docs.php | 3697 |
1 files changed, 3697 insertions, 0 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 new file mode 100644 index 0000000..83cf4d3 --- /dev/null +++ b/data/zh_cn/starrocks/2022-10-19/api-docs.php @@ -0,0 +1,3697 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'starrocks', + 'version' => '2022-10-19', + ], + 'directories' => [ + [ + 'id' => 306065, + 'title' => '实例管理', + 'type' => 'directory', + 'children' => [ + 'CreateInstanceV1', + 'RestartInstance', + 'ReleaseInstance', + 'UpdateInstanceName', + 'DescribeInstances', + 'DescribeNodeGroups', + 'TagResources', + 'UnTagResources', + 'ChangeResourceGroup', + ], + ], + [ + 'id' => 306075, + 'title' => '版本管理', + 'type' => 'directory', + 'children' => [ + 'UpgradeVersion', + 'QueryUpgradableVersions', + ], + ], + [ + 'id' => 306078, + 'title' => '资源变配', + 'type' => 'directory', + 'children' => [ + 'ModifyNodeNumberPreCheck', + 'ModifyNodeNumber', + 'ModifyCuPreCheck', + 'ModifyDiskPerformanceLevel', + 'ModifyDiskSize', + 'ModifyDiskNumber', + 'ModifyCu', + ], + ], + [ + 'id' => 306086, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'CreateServiceLinkedRole', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'InstanceConfigDto' => [ + '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', + ], + ], + ], + 'ResourceSpec' => [ + 'title' => '资源规格', + 'description' => '资源规格。', + 'type' => 'object', + 'properties' => [ + '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' => [ + 'CreateInstanceV1' => [ + 'summary' => '本接口用于创建 Serverless StarRocks 实例。', + 'path' => '/webapi/cluster/createV1', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240406', + 'abilityTreeNodes' => [ + 'FEATUREemapreduceUHHTB7', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求结构体。', + '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', + ], + 'RunMode' => [ + 'title' => '集群的运行模式：'."\n" + .' - 存算一体（shared_nothing）。'."\n" + .' * 存算分离（shared_data）。'."\n" + .' - 数据湖分析（lakehouse）。', + 'description' => '集群的运行模式：'."\n" + .'<ul>'."\n" + .'<li>存算一体（shared_nothing）。</li>'."\n" + .'<li>存算分离（shared_data）。</li>'."\n" + .'</ul>', + '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', + ], + 'PackageType' => [ + 'title' => '实例系列：'."\n" + .' 入门版（trial）。'."\n" + .' 标准版（official）。', + 'description' => '实例系列：'."\n" + .'<ul>'."\n" + .'<li> 入门版（trial）。</li>'."\n" + .'<li> 标准版（official）。</li>'."\n" + .'</ul>', + 'type' => 'string', + 'required' => true, + 'example' => 'official', + 'enum' => [ + 'official', + 'trial', + ], + ], + 'PayType' => [ + 'title' => '付费类型：'."\n" + .'<ol>'."\n" + .'<li>包年包月（prePaid）。</li>'."\n" + .'<li>按量付费（postPaid）。</li>'."\n" + .'</ol>'."\n" + .' '."\n" + .' ', + 'description' => '付费类型：'."\n" + .'<ol>'."\n" + .'<li>包年包月（prePaid）。</li>'."\n" + .'<li>按量付费（postPaid）。</li>'."\n" + .'</ol>'."\n" + .' '."\n" + .' ', + 'type' => 'string', + 'required' => true, + 'example' => 'prePaid', + 'enum' => [ + 'prePaid', + 'postPaid', + ], + ], + 'VpcId' => [ + 'title' => 'VPC ID。', + 'description' => 'VPC ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-bp1fll2mci6d7pw8m****', + ], + 'PricingCycle' => [ + 'title' => '购买时长单位：'."\n" + .' 月（Month）'."\n" + .' 年（Year）'."\n" + .'仅在 payType 为 PrePaid 时有意义。', + 'description' => '购买时长单位：'."\n" + .'<ul>'."\n" + .'<li> 月（Month）</li>'."\n" + .'<li> 年（Year）</li>'."\n" + .'</ul>'."\n" + .'仅在 payType 为 PrePaid 时有意义。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + 'enum' => [ + 'Month', + 'Year', + ], + ], + 'VSwitches' => [ + 'title' => 'VSwitch 信息和可用区信息。', + 'description' => 'VSwitch 信息和可用区信息。', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + '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', + ], + 'Tags' => [ + 'title' => '实例标签。', + 'description' => '实例标签。', + 'type' => 'array', + 'items' => [ + 'title' => '标签结构体。', + 'description' => '标签结构体。', + 'type' => 'object', + 'properties' => [ + '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', + ], + 'ObserverNodeGroups' => [ + 'description' => 'Observer计算组信息。仅在需要开启多可用区容灾时填写该字段，且 Observer 的配置必须和 FE 节点组的规格保持一致。', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'BackendNodeGroups' => [ + 'description' => 'BE 或者 CN 计算组信息。', + 'type' => 'array', + 'items' => [ + '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', + ], + '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', + '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" + .'- standard，标准版。'."\n" + .'- localSSD ，本地SSD。'."\n" + .'- bigData，大规格存储。'."\n" + .'- ramEnhanced，内存增强型。'."\n" + .'- networkEnhanced，网络增强型。', + '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', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'FrontendNodeGroups' => [ + 'description' => 'FE 节点组信息。', + 'type' => 'array', + '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', + ], + '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', + ], + ], + 'required' => false, + ], + '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, + ], + 'AgentNodeGroup' => [ + 'type' => 'object', + 'properties' => [ + 'cu' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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]]', + ], + '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', + ], + ], + ], + 'AccessDeniedDetail' => [ + 'title' => '权限校验失败详情。', + 'description' => '权限校验失败详情。', + 'type' => 'string', + 'example' => '{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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' => '创建实例', + '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>。', + ], + 'RestartInstance' => [ + 'summary' => '本接口用于重启 Serverless StarRocks 实例。', + '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" }', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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" }', + ], + ], + ], + ], + ], + '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\\": 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>', + ], + '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" }', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + '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', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmygmtrcenXXX', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'k1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + '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', + ], + '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', + 'items' => [ + '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****', + ], + 'Tags' => [ + 'description' => '实例所绑定的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + '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', + ], + 'VSwitches' => [ + 'description' => '交换机列表。', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + ], + ], + '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****', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询实例', + ], + 'DescribeNodeGroups' => [ + 'summary' => '获取节点组信息', + 'path' => '/webapi/nodegroup/describeNodeGroups', + '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' => '219304', + 'abilityTreeNodes' => [ + 'FEATUREemapreduceUHHTB7', + ], + ], + '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' => '20', + 'default' => '10', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c-718fb04c7112****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求参数信息。', + 'type' => 'object', + 'properties' => [ + 'instanceId' => [ + 'description' => '实例 ID。该字段已废弃。', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + 'componentType' => [ + 'description' => '计算组类型。包含以下取值：'."\n" + ."\n" + .'- FE'."\n" + .'- BE'."\n" + .'- CN'."\n" + .'- OBSERVER'."\n" + .'- AGENT', + 'type' => 'string', + 'required' => false, + 'example' => 'FE', + 'enum' => [ + 'FE', + 'BE', + 'CN', + 'AGENT', + 'OBSERVER', + ], + ], + 'nodeGroupIds' => [ + 'description' => '待查询的计算组 ID 列表。', + 'type' => 'array', + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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].', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + '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计算组', + ], + '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', + ], + ], + ], + ], + 'ZoneId' => [ + 'description' => '可用区 ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + ], + 'Value' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + '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" }', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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' => '查询计算组', + ], + 'TagResources' => [ + 'summary' => '为指定资源绑定标签。', + '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, + ], + '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, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '32A44F0D-BFF6-5664-999A-218BBDE74XXX', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\"\\n}","type":"json"}]', + 'title' => '绑定标签', + ], + 'UnTagResources' => [ + 'summary' => '为指定的资源列表统一解绑标签。', + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32A44F0D-BFF6-5664-999A-218BBDE74XXX\\"\\n}","type":"json"}]', + 'title' => '解绑标签', + ], + 'ChangeResourceGroup' => [ + 'summary' => '本接口用于修改 Serverless StarRocks 实例的资源组。', + '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" }', + ], + ], + ], + ], + ], + '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', + ], + '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, + ], + ], + ], + '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" }', + ], + ], + ], + ], + ], + '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', + ], + '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' => '可升级的版本列表。', + '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" }', + ], + ], + ], + ], + ], + '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\\": [\\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' => '查询可升级的版本列表', + ], + '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', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + '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' => [ + '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" }', + ], + ], + ], + ], + ], + '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\\": {\\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' => '计算组节点数量修改前的预检查', + ], + '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, + ], + ], + [ + 'name' => 'Parallelism', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'TerminationGracePeriodSeconds', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + '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: [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" }', + ], + ], + ], + ], + ], + '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' => '修改节点数量', + '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 点到有效期结束）来计算应补缴的费用。', + ], + 'ModifyCuPreCheck' => [ + 'summary' => '本接口用于对修改 Serverless StarRocks 实例的 FE、BE、CN 计算组中节点 CU 数量的操作进行预检查操作，以判断能否执行 CU 的升配或者降配操作。', + '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' => '目标 CU 数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '2', + 'enum' => [ + '2', + '4', + '8', + '16', + '32', + '64', + ], + ], + ], + ], + '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' => 'object', + 'properties' => [ + '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" }', + ], + ], + ], + ], + ], + '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\\": {\\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修改前的预检查', + ], + 'ModifyDiskPerformanceLevel' => [ + 'summary' => '本接口用于修改 Serverless StarRocks 实例的计算组的节点磁盘性能级别。', + 'path' => '/webapi/resourceChange/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' => 'update', + 'abilityTreeCode' => '220690', + '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' => 'string', + 'required' => true, + 'example' => 'pl2', + 'enum' => [ + 'pl0', + 'pl1', + 'pl2', + 'pl3', + 'eed_standard', + 'eed_advanced', + ], + ], + ], + [ + 'name' => 'PromotionOptionNo', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + '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: [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" }', + ], + ], + ], + ], + ], + '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' => '修改磁盘性能级别', + '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 点到有效期结束）来计算应补缴的费用。', + ], + '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' => '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, + ], + ], + [ + 'name' => 'FastMode', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + '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' => '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" }', + ], + ], + ], + ], + ], + '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' => '磁盘扩容', + '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 点到有效期结束）来计算应补缴的费用。', + ], + 'ModifyDiskNumber' => [ + 'summary' => '本接口用于增加 Serverless StarRocks 实例计算组的节点磁盘块数。', + 'path' => '/webapi/resourceChange/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' => '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, + ], + ], + ], + '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" }', + ], + ], + ], + ], + ], + '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' => '增加磁盘数量', + '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 点到有效期结束）来计算应补缴的费用。', + ], + 'ModifyCu' => [ + 'summary' => '本接口用于修改 Serverless StarRocks 实例计算组节点的 CU 数量。', + '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' => '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' => '目标 CU 数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '64', + 'minimum' => '4', + 'example' => '4', + 'enum' => [ + '4', + '8', + '16', + '32', + '64', + ], + ], + ], + [ + '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, + ], + ], + ], + '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' => '订单 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" }', + ], + ], + ], + ], + ], + '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\\",\\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + '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" }', + ], + ], + ], + ], + ], + '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' => '创建服务角色', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'starrocks.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'starrocks.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'starrocks.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'starrocks.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'starrocks.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'starrocks.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'starrocks.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'starrocks.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'starrocks.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'starrocks.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'starrocks.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'starrocks.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'starrocks.ap-southeast-5.aliyuncs.com', + ], + ], +]; |