ListWorkspaceInstanceTypes--托管 Prometheus-火山引擎

文档中心

立即注册

导航

ListWorkspaceInstanceTypes

最近更新时间：2024.09.03 15:42:17首次发布时间：2023.06.30 15:23:33

获取工作区类型列表。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListWorkspaceInstanceTypes	接口名称。当前 API 的名称为 `ListWorkspaceInstanceTypes`。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 `2021-03-03`。
PageNumber	Long	否	1	当前页数，最小值或默认值均为 1。
PageSize	Long	否	10	单页数量：取值范围为 0～100。默认值为 10。
Filters	Object of WorkspaceInstanceTypeFilters	否	-	工作区规格过滤条件。

WorkspaceInstanceTypeFilters

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

请求示例

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

返回参数

参数	类型	示例值	描述
Total	Long	100	工作区规格总数。
Items	Array of WorkspaceInstanceType	-	工作区规格列表。

WorkspaceInstanceType

参数	类型	示例值	描述
Id	String	vmp.standard.15d	工作区实例规格。
ActiveSeries	Integer	10000000	最大活跃时序数。
IngestSamplesPerSecond	Integer	1000000	最大每秒写入样本数。
QueryPerSecond	Integer	100	最大查询 QPS。
RetentionPeriod	String	360h	最长数据保留时间。
Dedicated	Boolean	false	是否为企业版工作区，取值： true：企业版工作区。 false：标准版工作区。
AvailabilityZoneReplicas	Integer	2	可用区（az）数。
ReplicasPerZone	Integer	2	每个可用区（az）的数据副本数。
QueryConcurrency	Integer	10	最大查询并发数。
ScanSeriesPerSecond	Integer	20000	最大每秒扫描时序数。
ScanSamplesPerSecond	Long	200000000	最大每秒扫描样本数。

返回示例

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

错误码

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

HTTP 状态码	错误码	错误信息	说明
403	ProductUnsubscribed	You 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 服务。