bytepluscc.vmp.getWorkspace

bytepluscc v0.0.16, Mar 9 26

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Using getWorkspace

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getWorkspace(args: GetWorkspaceArgs, opts?: InvokeOptions): Promise<GetWorkspaceResult>
function getWorkspaceOutput(args: GetWorkspaceOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceResult>

def get_workspace(id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetWorkspaceResult
def get_workspace_output(id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceResult]

func LookupWorkspace(ctx *Context, args *LookupWorkspaceArgs, opts ...InvokeOption) (*LookupWorkspaceResult, error)
func LookupWorkspaceOutput(ctx *Context, args *LookupWorkspaceOutputArgs, opts ...InvokeOption) LookupWorkspaceResultOutput

> Note: This function is named LookupWorkspace in the Go SDK.

public static class GetWorkspace 
{
    public static Task<GetWorkspaceResult> InvokeAsync(GetWorkspaceArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceResult> Invoke(GetWorkspaceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
public static Output<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)

fn::invoke:
  function: bytepluscc:vmp/getWorkspace:getWorkspace
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getWorkspace Result

The following output properties are available:

CreateTime string: 工作区创建时间，RFC3339 格式。
DeleteProtectionEnabled bool: 是否开启工作区删除保护,true：开启，false：关闭。
Description string: 工作区描述信息，字符串形式，长度限制为 0～200。
Id string: Uniquely identifies the resource.
InstanceType Byteplus.GetWorkspaceInstanceType: 工作区规格详情。
InstanceTypeId string: 工作区规格,vmp.standard.15d：15 天存储时长工作区。vmp.standard.30d：30 天存储时长工作区。vmp.standard.90d：90 天存储时长工作区。vmp.standard.180d：180 天存储时长工作区。vmp.standard.1y：1 年存储时长工作区。
Name string: 工作区名称，字符串形式，长度限制为 1～100。
OverdueReclaimTime string: 工作区预期欠费回收时间，RFC3339 格式。
Password string: 工作区 BasicAuth 密码。
ProjectName string: 项目名称。
PrometheusPushIntranetEndpoint string: 工作区 Push Gateway URL 地址。
PrometheusQueryIntranetEndpoint string: 工作区 Query URL 地址。
PrometheusWriteIntranetEndpoint string: 工作区 RemoteWrite URL 地址。
Quota Byteplus.GetWorkspaceQuota: 工作区配额详情。
Status string: 工作区状态，取值：Creating：创建中 Active：正常 Updating：更新中 Deleting：删除中 OverdueShutted：欠费关停 Resuming：恢复中 Error：错误。
Tags List<Byteplus.GetWorkspaceTag>: 工作区标签。
Usage Byteplus.GetWorkspaceUsage: 工作区用量。
Username string: 工作区 BasicAuth 用户名。
WorkspaceId string: 工作区Id。

CreateTime string: 工作区创建时间，RFC3339 格式。
DeleteProtectionEnabled bool: 是否开启工作区删除保护,true：开启，false：关闭。
Description string: 工作区描述信息，字符串形式，长度限制为 0～200。
Id string: Uniquely identifies the resource.
InstanceType GetWorkspaceInstanceType: 工作区规格详情。
InstanceTypeId string: 工作区规格,vmp.standard.15d：15 天存储时长工作区。vmp.standard.30d：30 天存储时长工作区。vmp.standard.90d：90 天存储时长工作区。vmp.standard.180d：180 天存储时长工作区。vmp.standard.1y：1 年存储时长工作区。
Name string: 工作区名称，字符串形式，长度限制为 1～100。
OverdueReclaimTime string: 工作区预期欠费回收时间，RFC3339 格式。
Password string: 工作区 BasicAuth 密码。
ProjectName string: 项目名称。
PrometheusPushIntranetEndpoint string: 工作区 Push Gateway URL 地址。
PrometheusQueryIntranetEndpoint string: 工作区 Query URL 地址。
PrometheusWriteIntranetEndpoint string: 工作区 RemoteWrite URL 地址。
Quota GetWorkspaceQuota: 工作区配额详情。
Status string: 工作区状态，取值：Creating：创建中 Active：正常 Updating：更新中 Deleting：删除中 OverdueShutted：欠费关停 Resuming：恢复中 Error：错误。
Tags []GetWorkspaceTag: 工作区标签。
Usage GetWorkspaceUsage: 工作区用量。
Username string: 工作区 BasicAuth 用户名。
WorkspaceId string: 工作区Id。

createTime String: 工作区创建时间，RFC3339 格式。
deleteProtectionEnabled Boolean: 是否开启工作区删除保护,true：开启，false：关闭。
description String: 工作区描述信息，字符串形式，长度限制为 0～200。
id String: Uniquely identifies the resource.
instanceType GetWorkspaceInstanceType: 工作区规格详情。
instanceTypeId String: 工作区规格,vmp.standard.15d：15 天存储时长工作区。vmp.standard.30d：30 天存储时长工作区。vmp.standard.90d：90 天存储时长工作区。vmp.standard.180d：180 天存储时长工作区。vmp.standard.1y：1 年存储时长工作区。
name String: 工作区名称，字符串形式，长度限制为 1～100。
overdueReclaimTime String: 工作区预期欠费回收时间，RFC3339 格式。
password String: 工作区 BasicAuth 密码。
projectName String: 项目名称。
prometheusPushIntranetEndpoint String: 工作区 Push Gateway URL 地址。
prometheusQueryIntranetEndpoint String: 工作区 Query URL 地址。
prometheusWriteIntranetEndpoint String: 工作区 RemoteWrite URL 地址。
quota GetWorkspaceQuota: 工作区配额详情。
status String: 工作区状态，取值：Creating：创建中 Active：正常 Updating：更新中 Deleting：删除中 OverdueShutted：欠费关停 Resuming：恢复中 Error：错误。
tags List<GetWorkspaceTag>: 工作区标签。
usage GetWorkspaceUsage: 工作区用量。
username String: 工作区 BasicAuth 用户名。
workspaceId String: 工作区Id。

createTime string: 工作区创建时间，RFC3339 格式。
deleteProtectionEnabled boolean: 是否开启工作区删除保护,true：开启，false：关闭。
description string: 工作区描述信息，字符串形式，长度限制为 0～200。
id string: Uniquely identifies the resource.
instanceType GetWorkspaceInstanceType: 工作区规格详情。
instanceTypeId string: 工作区规格,vmp.standard.15d：15 天存储时长工作区。vmp.standard.30d：30 天存储时长工作区。vmp.standard.90d：90 天存储时长工作区。vmp.standard.180d：180 天存储时长工作区。vmp.standard.1y：1 年存储时长工作区。
name string: 工作区名称，字符串形式，长度限制为 1～100。
overdueReclaimTime string: 工作区预期欠费回收时间，RFC3339 格式。
password string: 工作区 BasicAuth 密码。
projectName string: 项目名称。
prometheusPushIntranetEndpoint string: 工作区 Push Gateway URL 地址。
prometheusQueryIntranetEndpoint string: 工作区 Query URL 地址。
prometheusWriteIntranetEndpoint string: 工作区 RemoteWrite URL 地址。
quota GetWorkspaceQuota: 工作区配额详情。
status string: 工作区状态，取值：Creating：创建中 Active：正常 Updating：更新中 Deleting：删除中 OverdueShutted：欠费关停 Resuming：恢复中 Error：错误。
tags GetWorkspaceTag[]: 工作区标签。
usage GetWorkspaceUsage: 工作区用量。
username string: 工作区 BasicAuth 用户名。
workspaceId string: 工作区Id。

create_time str: 工作区创建时间，RFC3339 格式。
delete_protection_enabled bool: 是否开启工作区删除保护,true：开启，false：关闭。
description str: 工作区描述信息，字符串形式，长度限制为 0～200。
id str: Uniquely identifies the resource.
instance_type GetWorkspaceInstanceType: 工作区规格详情。
instance_type_id str: 工作区规格,vmp.standard.15d：15 天存储时长工作区。vmp.standard.30d：30 天存储时长工作区。vmp.standard.90d：90 天存储时长工作区。vmp.standard.180d：180 天存储时长工作区。vmp.standard.1y：1 年存储时长工作区。
name str: 工作区名称，字符串形式，长度限制为 1～100。
overdue_reclaim_time str: 工作区预期欠费回收时间，RFC3339 格式。
password str: 工作区 BasicAuth 密码。
project_name str: 项目名称。
prometheus_push_intranet_endpoint str: 工作区 Push Gateway URL 地址。
prometheus_query_intranet_endpoint str: 工作区 Query URL 地址。
prometheus_write_intranet_endpoint str: 工作区 RemoteWrite URL 地址。
quota GetWorkspaceQuota: 工作区配额详情。
status str: 工作区状态，取值：Creating：创建中 Active：正常 Updating：更新中 Deleting：删除中 OverdueShutted：欠费关停 Resuming：恢复中 Error：错误。
tags Sequence[GetWorkspaceTag]: 工作区标签。
usage GetWorkspaceUsage: 工作区用量。
username str: 工作区 BasicAuth 用户名。
workspace_id str: 工作区Id。

createTime String: 工作区创建时间，RFC3339 格式。
deleteProtectionEnabled Boolean: 是否开启工作区删除保护,true：开启，false：关闭。
description String: 工作区描述信息，字符串形式，长度限制为 0～200。
id String: Uniquely identifies the resource.
instanceType Property Map: 工作区规格详情。
instanceTypeId String: 工作区规格,vmp.standard.15d：15 天存储时长工作区。vmp.standard.30d：30 天存储时长工作区。vmp.standard.90d：90 天存储时长工作区。vmp.standard.180d：180 天存储时长工作区。vmp.standard.1y：1 年存储时长工作区。
name String: 工作区名称，字符串形式，长度限制为 1～100。
overdueReclaimTime String: 工作区预期欠费回收时间，RFC3339 格式。
password String: 工作区 BasicAuth 密码。
projectName String: 项目名称。
prometheusPushIntranetEndpoint String: 工作区 Push Gateway URL 地址。
prometheusQueryIntranetEndpoint String: 工作区 Query URL 地址。
prometheusWriteIntranetEndpoint String: 工作区 RemoteWrite URL 地址。
quota Property Map: 工作区配额详情。
status String: 工作区状态，取值：Creating：创建中 Active：正常 Updating：更新中 Deleting：删除中 OverdueShutted：欠费关停 Resuming：恢复中 Error：错误。
tags List<Property Map>: 工作区标签。
usage Property Map: 工作区用量。
username String: 工作区 BasicAuth 用户名。
workspaceId String: 工作区Id。

Supporting Types

GetWorkspaceInstanceType

ActiveSeries int: 最大活跃时序数。
AvailabilityZoneReplicas int: 可用区（az）数。
DownsamplingPeriods List<string>: 降采样策略。
IngestSamplesPerSecond int: 最大每秒写入样本数。
QueryConcurrency int: 最大查询并发数。
QueryPerSecond int: 最大查询 QPS。
ReplicasPerZone int: 每个可用区（az）的数据副本数。
RetentionPeriod string: 最长数据保留时间。
ScanSamplesPerSecond int: 最大每秒扫描样本数。
ScanSeriesPerSecond int: 最大每秒扫描时序数。

ActiveSeries int: 最大活跃时序数。
AvailabilityZoneReplicas int: 可用区（az）数。
DownsamplingPeriods []string: 降采样策略。
IngestSamplesPerSecond int: 最大每秒写入样本数。
QueryConcurrency int: 最大查询并发数。
QueryPerSecond int: 最大查询 QPS。
ReplicasPerZone int: 每个可用区（az）的数据副本数。
RetentionPeriod string: 最长数据保留时间。
ScanSamplesPerSecond int: 最大每秒扫描样本数。
ScanSeriesPerSecond int: 最大每秒扫描时序数。

activeSeries Integer: 最大活跃时序数。
availabilityZoneReplicas Integer: 可用区（az）数。
downsamplingPeriods List<String>: 降采样策略。
ingestSamplesPerSecond Integer: 最大每秒写入样本数。
queryConcurrency Integer: 最大查询并发数。
queryPerSecond Integer: 最大查询 QPS。
replicasPerZone Integer: 每个可用区（az）的数据副本数。
retentionPeriod String: 最长数据保留时间。
scanSamplesPerSecond Integer: 最大每秒扫描样本数。
scanSeriesPerSecond Integer: 最大每秒扫描时序数。

activeSeries number: 最大活跃时序数。
availabilityZoneReplicas number: 可用区（az）数。
downsamplingPeriods string[]: 降采样策略。
ingestSamplesPerSecond number: 最大每秒写入样本数。
queryConcurrency number: 最大查询并发数。
queryPerSecond number: 最大查询 QPS。
replicasPerZone number: 每个可用区（az）的数据副本数。
retentionPeriod string: 最长数据保留时间。
scanSamplesPerSecond number: 最大每秒扫描样本数。
scanSeriesPerSecond number: 最大每秒扫描时序数。

active_series int: 最大活跃时序数。
availability_zone_replicas int: 可用区（az）数。
downsampling_periods Sequence[str]: 降采样策略。
ingest_samples_per_second int: 最大每秒写入样本数。
query_concurrency int: 最大查询并发数。
query_per_second int: 最大查询 QPS。
replicas_per_zone int: 每个可用区（az）的数据副本数。
retention_period str: 最长数据保留时间。
scan_samples_per_second int: 最大每秒扫描样本数。
scan_series_per_second int: 最大每秒扫描时序数。

activeSeries Number: 最大活跃时序数。
availabilityZoneReplicas Number: 可用区（az）数。
downsamplingPeriods List<String>: 降采样策略。
ingestSamplesPerSecond Number: 最大每秒写入样本数。
queryConcurrency Number: 最大查询并发数。
queryPerSecond Number: 最大查询 QPS。
replicasPerZone Number: 每个可用区（az）的数据副本数。
retentionPeriod String: 最长数据保留时间。
scanSamplesPerSecond Number: 最大每秒扫描样本数。
scanSeriesPerSecond Number: 最大每秒扫描时序数。

GetWorkspaceQuota

ActiveSeries int: 最大活跃时序数。整数形式，默认取值范围为 1～50000000。
IngestSamplesPerSecond int: 指标摄入速率，即最大每秒写入样本数。整数形式，默认取值范围为 1～5000000。
QueryPerSecond int: 最大查询 QPS。整数形式，默认取值范围为 1～500。
ScanSamplesPerSecond int: 最大每秒扫描样本数。整数形式，默认取值范围为 1～1000000000。
ScanSeriesPerSecond int: 最大每秒扫描时序数。整数形式，默认取值范围为 1～200000。

ActiveSeries int: 最大活跃时序数。整数形式，默认取值范围为 1～50000000。
IngestSamplesPerSecond int: 指标摄入速率，即最大每秒写入样本数。整数形式，默认取值范围为 1～5000000。
QueryPerSecond int: 最大查询 QPS。整数形式，默认取值范围为 1～500。
ScanSamplesPerSecond int: 最大每秒扫描样本数。整数形式，默认取值范围为 1～1000000000。
ScanSeriesPerSecond int: 最大每秒扫描时序数。整数形式，默认取值范围为 1～200000。

activeSeries Integer: 最大活跃时序数。整数形式，默认取值范围为 1～50000000。
ingestSamplesPerSecond Integer: 指标摄入速率，即最大每秒写入样本数。整数形式，默认取值范围为 1～5000000。
queryPerSecond Integer: 最大查询 QPS。整数形式，默认取值范围为 1～500。
scanSamplesPerSecond Integer: 最大每秒扫描样本数。整数形式，默认取值范围为 1～1000000000。
scanSeriesPerSecond Integer: 最大每秒扫描时序数。整数形式，默认取值范围为 1～200000。

activeSeries number: 最大活跃时序数。整数形式，默认取值范围为 1～50000000。
ingestSamplesPerSecond number: 指标摄入速率，即最大每秒写入样本数。整数形式，默认取值范围为 1～5000000。
queryPerSecond number: 最大查询 QPS。整数形式，默认取值范围为 1～500。
scanSamplesPerSecond number: 最大每秒扫描样本数。整数形式，默认取值范围为 1～1000000000。
scanSeriesPerSecond number: 最大每秒扫描时序数。整数形式，默认取值范围为 1～200000。

active_series int: 最大活跃时序数。整数形式，默认取值范围为 1～50000000。
ingest_samples_per_second int: 指标摄入速率，即最大每秒写入样本数。整数形式，默认取值范围为 1～5000000。
query_per_second int: 最大查询 QPS。整数形式，默认取值范围为 1～500。
scan_samples_per_second int: 最大每秒扫描样本数。整数形式，默认取值范围为 1～1000000000。
scan_series_per_second int: 最大每秒扫描时序数。整数形式，默认取值范围为 1～200000。

activeSeries Number: 最大活跃时序数。整数形式，默认取值范围为 1～50000000。
ingestSamplesPerSecond Number: 指标摄入速率，即最大每秒写入样本数。整数形式，默认取值范围为 1～5000000。
queryPerSecond Number: 最大查询 QPS。整数形式，默认取值范围为 1～500。
scanSamplesPerSecond Number: 最大每秒扫描样本数。整数形式，默认取值范围为 1～1000000000。
scanSeriesPerSecond Number: 最大每秒扫描时序数。整数形式，默认取值范围为 1～200000。

GetWorkspaceTag

Key string: 标签键。
Value string: 标签值。

Key string: 标签键。
Value string: 标签值。

key String: 标签键。
value String: 标签值。

key string: 标签键。
value string: 标签值。

key str: 标签键。
value str: 标签值。

key String: 标签键。
value String: 标签值。

GetWorkspaceUsage

ActiveSeries int: 活跃时序数。
IngestedSamplesPerSecond double: 每秒写入样本数。

ActiveSeries int: 活跃时序数。
IngestedSamplesPerSecond float64: 每秒写入样本数。

activeSeries Integer: 活跃时序数。
ingestedSamplesPerSecond Double: 每秒写入样本数。

activeSeries number: 活跃时序数。
ingestedSamplesPerSecond number: 每秒写入样本数。

active_series int: 活跃时序数。
ingested_samples_per_second float: 每秒写入样本数。

activeSeries Number: 活跃时序数。
ingestedSamplesPerSecond Number: 每秒写入样本数。

Package Details

Repository: bytepluscc byteplus-sdk/pulumi-bytepluscc
License: MPL-2.0
Notes: This Pulumi package is based on the bytepluscc Terraform Provider.

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc.vmp.getWorkspace

On this page

On this page

Using getWorkspace

getWorkspace Result

Supporting Types

GetWorkspaceInstanceType

GetWorkspaceQuota

GetWorkspaceTag

GetWorkspaceUsage

Package Details

On this page

On this page