You need to enable JavaScript to run this app.
导航
托管 Prometheus
  • 文档首页
    • /
  • 托管 Prometheus

ListWorkspaceInstanceTypes

最近更新时间：2024.04.19 11:53:52

首次发布时间：2023.06.30 15:23:33

我的收藏

获取工作区实例规格列表。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com/?Action=ListWorkspaceInstanceTypes&Version=2021-03-03

请求参数

参数名称类型是否必选示例值描述
ActionString是ListWorkspaceInstanceTypes公共参数，本接口值：ListWorkspaceInstanceTypes。
VersionString是2021-03-03公共参数，本接口值：2021-03-03。
PageNumberInteger否1当前页数，最小值或默认值均为 1。

PageSize

Integer

否

10

单页数量：

  • 取值范围为 0～100。
  • 默认值为 10。
FiltersObject WorkspaceInstanceTypeFilters否-工作区规格过滤条件。

WorkspaceInstanceTypeFilters

参数名称类型是否必选示例值描述
IdsArray of String否["vmp.standard.15d"]按工作区规格过滤，精确查询。

请求示例

POST /?Action=ListWorkspaceInstanceTypes&Version=2021-03-03
Content-Type:application/json
{
    "PageNumber": 1,
    "PageSize": 10,
    "Filters": {
        "Ids": ["vmp.standard.15d"]
    }
}

返回参数

参数名称类型示例值描述
TotalInteger100工作区规格总数。
ItemsArray of WorkspaceInstanceType-工作区规格列表。

WorkspaceInstanceType

参数名称类型示例值描述
IdStringvmp.standard.15d工作区实例规格 ID，可选值参见 工作区规格 实例规格列。
ActiveSeriesInteger10000000最大活跃时序数。
IngestSamplesPerSecondInteger1000000最大每秒写入样本数。
QueryPerSecondInteger100最大查询 QPS。
RetentionPeriodString360h最长数据保留时间。

Dedicated

Boolean

false

是否为企业版工作区，取值：

  • true：企业版工作区。
  • false：标准版工作区。
AvailabilityZoneReplicasInteger2可用区（az）数。
ReplicasPerZoneInteger2每个可用区（az）的数据副本数。
QueryConcurrencyInteger10最大查询并发数。
ScanSeriesPerSecondInteger20000最大每秒扫描时序数。
ScanSamplesPerSecondInteger200000000最大每秒扫描样本数。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208xxxx",
        "Action": "ListWorkspaceInstanceTypes",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-beijing"
    },
    "Result": {
        "Total": 100,
        "Items": [
            {
                "Id": " vmp.standard.15d",
                "ActiveSeries":  10000000,
                "IngestSamplesPerSecond":  1000000,
                "QueryPerSecond":  100,
                "RetentionPeriod": " 360h",
                "Dedicated":  false,
                "AvailabilityZoneReplicas":  2,
                "ReplicasPerZone":  2,
                "QueryConcurrency":  10,
                "ScanSeriesPerSecond":  20000,
                "ScanSamplesPerSecond":  200000000
            }
        ]
    }
}

错误码

本接口错误码如下表所示，公共错误码请参见 公共错误码。

HTTP 状态码错误码错误信息描述
403ProductUnsubscribedYou are not subscribed to the Volcengine Managed Service for Prometheus (VMP). Please go to the VMP console web page to subscribe to the service当前账号未订阅 VMP 服务。