获取资源约束配置
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /webapi/starrocks/describeResourceConstraints HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PackageType |
string |
否 |
实例系列。取值范围:
|
trial |
| RunMode |
string |
否 |
集群的运行模式:
|
shared_data |
| Architecture |
string |
否 |
实例架构。包含以下取值:
|
onEcs |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| HttpStatusCode |
integer |
HTTP 请求状态码。 |
200 |
| RequestId |
string |
请求 ID。 |
B67D142D-D54E-184F-A306-22BDC01B2XXX |
| Success |
boolean |
请求是否成功。 |
true |
| ErrorCode |
string |
错误码。200 标识查询任务成功。 |
Success |
| ErrMessage |
string |
错误信息。 |
Invalid params: [instance not exists]. |
| Data |
object |
返回数据。 |
|
| BeCu |
array |
BE 节点 CU 大小。 |
|
|
integer |
CU 大小 |
8 |
|
| BeNumber |
object |
be 节点配置 |
|
| Min |
integer |
最小值。 |
1 |
| Max |
integer |
最大值。 |
10 |
| Step |
integer |
步长。 |
1 |
| Default |
integer |
默认值。 |
1 |
| FeCu |
array |
FE 节点 CU 大小。 |
|
|
integer |
CU 大小。 |
8 |
|
| FeStorage |
object |
FE 节点存储大小。 |
|
| Min |
integer |
最小值。 |
200 |
| Max |
integer |
最大值。 |
5000 |
| Step |
integer |
步长。 |
100 |
| Default |
integer |
默认值。 |
500 |
| FeNumber |
object |
FE 节点数量 |
|
| Min |
integer |
最小值。 |
1 |
| Max |
integer |
最大值 |
11 |
| Step |
integer |
步长。 |
2 |
| Default |
integer |
默认值。 |
3 |
| HaFeResourceSpec |
object |
高可用 FE 节点配置 |
|
| Cu |
integer |
CU 大小 |
16 |
| StorageSize |
integer |
存储大小。单位为 GiB。 |
100 |
| NodeNumber |
integer |
节点总数 |
5 |
| NormalFeResourceSpec |
object |
常规 FE 资源配置。 |
|
| Cu |
integer |
CU 大小。 |
64 |
| StorageSize |
integer |
存储大小。单位为 GiB。 |
500 |
| NodeNumber |
integer |
节点总数 |
5 |
| VersionConstraint |
object |
版本约束。 |
|
| Versions |
array |
版本定义。 |
|
|
string |
版本列表。 |
["3.2","3.3","3.5"] |
|
| DefaultVersion |
string |
默认版本。 |
3.3 |
| BetaVersions |
array |
Beta 版本。 |
|
|
string |
Beta 版本列表。 |
3.5 |
|
| BeStorageConstraints |
array<object> |
BE 存储约束 |
|
|
array<object> |
|||
| Level |
string |
磁盘等级。 |
PL1 |
| Desc |
string |
描述信息。 |
BE 存储约束描述 |
| ValueConstraint |
object |
取值约束。 |
|
| Min |
integer |
最小值 |
1 |
| Max |
integer |
最大值。 |
5 |
| Step |
integer |
步长。 |
1 |
| Default |
integer |
默认值。 |
1 |
| IsDefault |
boolean |
是否默认。 |
true |
| DiskNumberConstraint |
object |
磁盘块数约束。 |
|
| Min |
integer |
磁盘块数。 |
1 |
| Max |
integer |
最大值。 |
10 |
| Step |
integer |
步长。 |
1 |
| Default |
integer |
默认值。 |
1 |
| SpecType |
array<object> |
计算组规格类型。包括以下类型:
|
standard |
|
object |
|||
| Name |
string |
名称。 |
standard |
| Display |
string |
展示名称。 |
标准版 |
| FeSpecType |
array<object> |
FE 规格类型 |
|
|
object |
|||
| Name |
string |
名称。 |
standard |
| Display |
string |
展示名称。 |
标准版 |
| BigDataInstanceTypeConstraints |
array<object> |
大数据实例类型规格约束。 |
|
|
object |
|||
| InstanceType |
string |
实例类型。 |
local_hdd_2s_5xlarge |
| EcsInstanceType |
string |
对应的 ECS 实例规格族。 |
ecs.d2s.5xlarge |
| DiskNumber |
string |
磁盘数量。 |
8 |
| StorageSize |
string |
存储大小。单位为 GiB。 |
7300 |
| Display |
string |
展示名称。 |
20核 88GiB 8*7300GiB 本地HDD盘 |
| IsDefault |
string |
是否为默认资源,目前该参数只支持传入 true,暂不支持 false。 |
false |
| Cpu |
integer |
CPU 核数。 |
20 |
| Memory |
integer |
内存大小,单位 GiB。 |
88 |
| LocalSSDInstanceTypeConstraints |
array<object> |
本地 SSD 实例类型约束。 |
|
|
object |
|||
| InstanceType |
string |
实例类型 |
local_ssd_2g_4xlarge |
| EcsInstanceType |
string |
对应的 ECS 实例规格族。 |
ecs.i2g.4xlarge |
| DiskNumber |
string |
磁盘数量。 |
1 |
| StorageSize |
string |
存储大小。单位为 GiB。 |
1788 |
| Display |
string |
展示名称 |
[i2g]16核 64GiB 1*1788GiB 本地SSD盘 |
| IsDefault |
string |
是否默认。 |
true |
| Cpu |
integer |
CPU 核数。 |
16 |
| Memory |
integer |
内存大小,单位 GiB。 |
64 |
| ZoneSupportedSpecTypes |
object |
可用区支持的类型。 |
|
|
array |
可用区。 |
cn-beijing-h |
|
|
string |
可用区支持类型规格列表。 |
standard |
|
| ZoneSupportedEedTypes |
object |
可用区支持 EED 类型 |
|
|
array |
可用区。 |
cn-beijing-h |
|
|
string |
可用区支持 EED 类型列表。 |
eed_standard |
|
| SplitDiskThresholdMap |
object |
已废弃。 |
已废弃。 |
|
object |
已废弃。 |
已废弃。 |
|
|
array |
已废弃。 |
已废弃。 |
|
|
string |
已废弃。 |
已废弃。 |
|
| FeCuOnEcs |
array |
ON ECS FeCu 大小 |
|
|
integer |
CU 大小 |
8 |
|
| BeCuOnEcs |
array |
ON ECS BeCu 大小 |
|
|
integer |
CU 大小 |
8 |
|
| AgentCu |
array |
Agent Cu 大小 |
|
|
integer |
CU 大小 |
8 |
|
| compactionServiceCuConstraint |
object |
Compaction 服务 CU 约束。 |
|
| min |
integer |
最小值。 |
8 |
| max |
integer |
最大值。 |
256 |
| def |
integer |
默认值。 |
16 |
| step |
integer |
步长。 |
8 |
| zoneSupportCompactionService |
object |
||
|
array<object> |
|||
|
object |
|||
| zoneId |
string |
||
| resourceLevel |
string |
||
| recommended |
boolean |
||
| AccessDeniedDetail |
string |
AccessDeniedDetail |
{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" } |
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 200,
"RequestId": "B67D142D-D54E-184F-A306-22BDC01B2XXX",
"Success": true,
"ErrorCode": "Success",
"ErrMessage": "Invalid params: [instance not exists].",
"Data": {
"BeCu": [
8
],
"BeNumber": {
"Min": 1,
"Max": 10,
"Step": 1,
"Default": 1
},
"FeCu": [
8
],
"FeStorage": {
"Min": 200,
"Max": 5000,
"Step": 100,
"Default": 500
},
"FeNumber": {
"Min": 1,
"Max": 11,
"Step": 2,
"Default": 3
},
"HaFeResourceSpec": {
"Cu": 16,
"StorageSize": 100,
"NodeNumber": 5
},
"NormalFeResourceSpec": {
"Cu": 64,
"StorageSize": 500,
"NodeNumber": 5
},
"VersionConstraint": {
"Versions": [
"[\"3.2\",\"3.3\",\"3.5\"]"
],
"DefaultVersion": "3.3",
"BetaVersions": [
"3.5"
]
},
"BeStorageConstraints": [
{
"Level": "PL1",
"Desc": "BE 存储约束描述",
"ValueConstraint": {
"Min": 1,
"Max": 5,
"Step": 1,
"Default": 1
},
"IsDefault": true,
"DiskNumberConstraint": {
"Min": 1,
"Max": 10,
"Step": 1,
"Default": 1
}
}
],
"SpecType": [
{
"Name": "standard",
"Display": "标准版"
}
],
"FeSpecType": [
{
"Name": "standard",
"Display": "标准版"
}
],
"BigDataInstanceTypeConstraints": [
{
"InstanceType": "local_hdd_2s_5xlarge",
"EcsInstanceType": "ecs.d2s.5xlarge",
"DiskNumber": "8",
"StorageSize": "7300",
"Display": "20核 88GiB 8*7300GiB 本地HDD盘",
"IsDefault": "false",
"Cpu": 20,
"Memory": 88
}
],
"LocalSSDInstanceTypeConstraints": [
{
"InstanceType": "local_ssd_2g_4xlarge",
"EcsInstanceType": "ecs.i2g.4xlarge",
"DiskNumber": "1",
"StorageSize": "1788",
"Display": "[i2g]16核 64GiB 1*1788GiB 本地SSD盘",
"IsDefault": "true",
"Cpu": 16,
"Memory": 64
}
],
"ZoneSupportedSpecTypes": {
"key": [
"standard"
]
},
"ZoneSupportedEedTypes": {
"key": [
"eed_standard"
]
},
"SplitDiskThresholdMap": {
"key": {
"key": [
"已废弃。"
]
}
},
"FeCuOnEcs": [
8
],
"BeCuOnEcs": [
8
],
"AgentCu": [
8
],
"compactionServiceCuConstraint": {
"min": 8,
"max": 256,
"def": 16,
"step": 8
},
"zoneSupportCompactionService": {
"key": [
{
"zoneId": "",
"resourceLevel": "",
"recommended": true
}
]
}
},
"AccessDeniedDetail": "{ \"PolicyType\": \"AccountLevelIdentityBasedPolicy\", \"AuthPrincipalOwnerId\": \"xxx\", \"EncodedDiagnosticMessage\": \"xxx\", \"AuthPrincipalType\": \"xxx\", \"AuthPrincipalDisplayName\": \"xxx\", \"NoPermissionType\": \"ImplicitDeny\", \"AuthAction\": \"sr:xxx\" }"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。