1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. vefaas
  5. getSandbox
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.vefaas.getSandbox

bytepluscc logo
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::VEFAAS::Sandbox

    Using getSandbox

    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 getSandbox(args: GetSandboxArgs, opts?: InvokeOptions): Promise<GetSandboxResult>
function getSandboxOutput(args: GetSandboxOutputArgs, opts?: InvokeOptions): Output<GetSandboxResult>
    def get_sandbox(id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetSandboxResult
def get_sandbox_output(id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetSandboxResult]
    func LookupSandbox(ctx *Context, args *LookupSandboxArgs, opts ...InvokeOption) (*LookupSandboxResult, error)
func LookupSandboxOutput(ctx *Context, args *LookupSandboxOutputArgs, opts ...InvokeOption) LookupSandboxResultOutput

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

    public static class GetSandbox 
{
    public static Task<GetSandboxResult> InvokeAsync(GetSandboxArgs args, InvokeOptions? opts = null)
    public static Output<GetSandboxResult> Invoke(GetSandboxInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSandboxResult> getSandbox(GetSandboxArgs args, InvokeOptions options)
public static Output<GetSandboxResult> getSandbox(GetSandboxArgs args, InvokeOptions options)

    fn::invoke:
  function: bytepluscc:vefaas/getSandbox:getSandbox
  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.

    getSandbox Result

    The following output properties are available:

    AvailabilityZone string
    沙箱实例所在可用区 ID。
    CpuMilli int
    沙箱实例 CPU 规格：单位：milli cpu取值范围：250~16000,默认值：1000。
    CreatedTime string
    沙箱实例创建时间。
    Envs List<Byteplus.GetSandboxEnv>
    沙箱实例环境变量。
    ErrorCode string
    沙箱实例启动失败错误码。参数值说明：internalloadrequesterror：系统内部错误，functioninitializefailed：业务进程初始化错误，functionhealthcheckfailed：健康检查错误，route_terminating：路由删除中，正常启动沙箱实例时，该字段为空。
    ErrorMessage string
    沙箱实例启动失败的错误码详情。正常启动沙箱实例时，该字段为空。
    ExpireAt string
    沙箱实例存活时长。
    FunctionId string
    沙箱实例所属的沙箱应用 ID。
    Id string
    Uniquely identifies the resource.
    InstanceImageInfo Byteplus.GetSandboxInstanceImageInfo
    沙箱实例镜像信息，包括镜像地址、启动命令、监听端口。
    InstanceTosMountConfig Byteplus.GetSandboxInstanceTosMountConfig
    沙箱实例级别对象存储（TOS）存储挂载配置。
    InstanceType string
    沙箱实例类型 。参数值说明：elastic：弹性实例，frozen：冻结实例，activated：激活实例，reserved：预留实例。
    MaxConcurrency int
    单实例请求最大并发数：取值范围：10~1000,默认值：100。
    MemoryMb int
    沙箱实例内存规格：单位：MiB，取值范围：512~131072，默认值：2048
    Metadatas List<Byteplus.GetSandboxMetadata>
    沙箱实例标签（Label）元信息，用于标记、筛选实例。格式为<"key":"value">。
    Pending bool
    沙箱实例是否处于 Pending 状态。参数值说明：true：是，false：否。
    RequestTimeout int
    请求超时时间：单位：秒，取值范围：1~900，正整数。默认值：30。
    RevisionNumber int
    函数实例版本编号。
    SandboxId string
    沙箱实例 ID。
    Status string
    沙箱实例状态。 参数值说明：Starting：开始启动，Ready：启动完成，Failed：启动失败，Terminating：终止中。
    Timeout int
    沙箱实例存活时长：单位：分钟，取值范围：3～1440，默认值：60。
    AvailabilityZone string
    沙箱实例所在可用区 ID。
    CpuMilli int
    沙箱实例 CPU 规格：单位：milli cpu取值范围：250~16000,默认值：1000。
    CreatedTime string
    沙箱实例创建时间。
    Envs []GetSandboxEnv
    沙箱实例环境变量。
    ErrorCode string
    沙箱实例启动失败错误码。参数值说明：internalloadrequesterror：系统内部错误，functioninitializefailed：业务进程初始化错误，functionhealthcheckfailed：健康检查错误，route_terminating：路由删除中，正常启动沙箱实例时，该字段为空。
    ErrorMessage string
    沙箱实例启动失败的错误码详情。正常启动沙箱实例时，该字段为空。
    ExpireAt string
    沙箱实例存活时长。
    FunctionId string
    沙箱实例所属的沙箱应用 ID。
    Id string
    Uniquely identifies the resource.
    InstanceImageInfo GetSandboxInstanceImageInfo
    沙箱实例镜像信息，包括镜像地址、启动命令、监听端口。
    InstanceTosMountConfig GetSandboxInstanceTosMountConfig
    沙箱实例级别对象存储（TOS）存储挂载配置。
    InstanceType string
    沙箱实例类型 。参数值说明：elastic：弹性实例，frozen：冻结实例，activated：激活实例，reserved：预留实例。
    MaxConcurrency int
    单实例请求最大并发数：取值范围：10~1000,默认值：100。
    MemoryMb int
    沙箱实例内存规格：单位：MiB，取值范围：512~131072，默认值：2048
    Metadatas []GetSandboxMetadata
    沙箱实例标签（Label）元信息，用于标记、筛选实例。格式为<"key":"value">。
    Pending bool
    沙箱实例是否处于 Pending 状态。参数值说明：true：是，false：否。
    RequestTimeout int
    请求超时时间：单位：秒，取值范围：1~900，正整数。默认值：30。
    RevisionNumber int
    函数实例版本编号。
    SandboxId string
    沙箱实例 ID。
    Status string
    沙箱实例状态。 参数值说明：Starting：开始启动，Ready：启动完成，Failed：启动失败，Terminating：终止中。
    Timeout int
    沙箱实例存活时长：单位：分钟，取值范围：3～1440，默认值：60。
    availabilityZone String
    沙箱实例所在可用区 ID。
    cpuMilli Integer
    沙箱实例 CPU 规格：单位：milli cpu取值范围：250~16000,默认值：1000。
    createdTime String
    沙箱实例创建时间。
    envs List<GetSandboxEnv>
    沙箱实例环境变量。
    errorCode String
    沙箱实例启动失败错误码。参数值说明：internalloadrequesterror：系统内部错误，functioninitializefailed：业务进程初始化错误，functionhealthcheckfailed：健康检查错误，route_terminating：路由删除中，正常启动沙箱实例时，该字段为空。
    errorMessage String
    沙箱实例启动失败的错误码详情。正常启动沙箱实例时，该字段为空。
    expireAt String
    沙箱实例存活时长。
    functionId String
    沙箱实例所属的沙箱应用 ID。
    id String
    Uniquely identifies the resource.
    instanceImageInfo GetSandboxInstanceImageInfo
    沙箱实例镜像信息，包括镜像地址、启动命令、监听端口。
    instanceTosMountConfig GetSandboxInstanceTosMountConfig
    沙箱实例级别对象存储（TOS）存储挂载配置。
    instanceType String
    沙箱实例类型 。参数值说明：elastic：弹性实例，frozen：冻结实例，activated：激活实例，reserved：预留实例。
    maxConcurrency Integer
    单实例请求最大并发数：取值范围：10~1000,默认值：100。
    memoryMb Integer
    沙箱实例内存规格：单位：MiB，取值范围：512~131072，默认值：2048
    metadatas List<GetSandboxMetadata>
    沙箱实例标签（Label）元信息，用于标记、筛选实例。格式为<"key":"value">。
    pending Boolean
    沙箱实例是否处于 Pending 状态。参数值说明：true：是，false：否。
    requestTimeout Integer
    请求超时时间：单位：秒，取值范围：1~900，正整数。默认值：30。
    revisionNumber Integer
    函数实例版本编号。
    sandboxId String
    沙箱实例 ID。
    status String
    沙箱实例状态。 参数值说明：Starting：开始启动，Ready：启动完成，Failed：启动失败，Terminating：终止中。
    timeout Integer
    沙箱实例存活时长：单位：分钟，取值范围：3～1440，默认值：60。
    availabilityZone string
    沙箱实例所在可用区 ID。
    cpuMilli number
    沙箱实例 CPU 规格：单位：milli cpu取值范围：250~16000,默认值：1000。
    createdTime string
    沙箱实例创建时间。
    envs GetSandboxEnv[]
    沙箱实例环境变量。
    errorCode string
    沙箱实例启动失败错误码。参数值说明：internalloadrequesterror：系统内部错误，functioninitializefailed：业务进程初始化错误，functionhealthcheckfailed：健康检查错误，route_terminating：路由删除中，正常启动沙箱实例时，该字段为空。
    errorMessage string
    沙箱实例启动失败的错误码详情。正常启动沙箱实例时，该字段为空。
    expireAt string
    沙箱实例存活时长。
    functionId string
    沙箱实例所属的沙箱应用 ID。
    id string
    Uniquely identifies the resource.
    instanceImageInfo GetSandboxInstanceImageInfo
    沙箱实例镜像信息，包括镜像地址、启动命令、监听端口。
    instanceTosMountConfig GetSandboxInstanceTosMountConfig
    沙箱实例级别对象存储（TOS）存储挂载配置。
    instanceType string
    沙箱实例类型 。参数值说明：elastic：弹性实例，frozen：冻结实例，activated：激活实例，reserved：预留实例。
    maxConcurrency number
    单实例请求最大并发数：取值范围：10~1000,默认值：100。
    memoryMb number
    沙箱实例内存规格：单位：MiB，取值范围：512~131072，默认值：2048
    metadatas GetSandboxMetadata[]
    沙箱实例标签（Label）元信息，用于标记、筛选实例。格式为<"key":"value">。
    pending boolean
    沙箱实例是否处于 Pending 状态。参数值说明：true：是，false：否。
    requestTimeout number
    请求超时时间：单位：秒，取值范围：1~900，正整数。默认值：30。
    revisionNumber number
    函数实例版本编号。
    sandboxId string
    沙箱实例 ID。
    status string
    沙箱实例状态。 参数值说明：Starting：开始启动，Ready：启动完成，Failed：启动失败，Terminating：终止中。
    timeout number
    沙箱实例存活时长：单位：分钟，取值范围：3～1440，默认值：60。
    availability_zone str
    沙箱实例所在可用区 ID。
    cpu_milli int
    沙箱实例 CPU 规格：单位：milli cpu取值范围：250~16000,默认值：1000。
    created_time str
    沙箱实例创建时间。
    envs Sequence[GetSandboxEnv]
    沙箱实例环境变量。
    error_code str
    沙箱实例启动失败错误码。参数值说明：internalloadrequesterror：系统内部错误，functioninitializefailed：业务进程初始化错误，functionhealthcheckfailed：健康检查错误，route_terminating：路由删除中，正常启动沙箱实例时，该字段为空。
    error_message str
    沙箱实例启动失败的错误码详情。正常启动沙箱实例时，该字段为空。
    expire_at str
    沙箱实例存活时长。
    function_id str
    沙箱实例所属的沙箱应用 ID。
    id str
    Uniquely identifies the resource.
    instance_image_info GetSandboxInstanceImageInfo
    沙箱实例镜像信息，包括镜像地址、启动命令、监听端口。
    instance_tos_mount_config GetSandboxInstanceTosMountConfig
    沙箱实例级别对象存储（TOS）存储挂载配置。
    instance_type str
    沙箱实例类型 。参数值说明：elastic：弹性实例，frozen：冻结实例，activated：激活实例，reserved：预留实例。
    max_concurrency int
    单实例请求最大并发数：取值范围：10~1000,默认值：100。
    memory_mb int
    沙箱实例内存规格：单位：MiB，取值范围：512~131072，默认值：2048
    metadatas Sequence[GetSandboxMetadata]
    沙箱实例标签（Label）元信息，用于标记、筛选实例。格式为<"key":"value">。
    pending bool
    沙箱实例是否处于 Pending 状态。参数值说明：true：是，false：否。
    request_timeout int
    请求超时时间：单位：秒，取值范围：1~900，正整数。默认值：30。
    revision_number int
    函数实例版本编号。
    sandbox_id str
    沙箱实例 ID。
    status str
    沙箱实例状态。 参数值说明：Starting：开始启动，Ready：启动完成，Failed：启动失败，Terminating：终止中。
    timeout int
    沙箱实例存活时长：单位：分钟，取值范围：3～1440，默认值：60。
    availabilityZone String
    沙箱实例所在可用区 ID。
    cpuMilli Number
    沙箱实例 CPU 规格：单位：milli cpu取值范围：250~16000,默认值：1000。
    createdTime String
    沙箱实例创建时间。
    envs List<Property Map>
    沙箱实例环境变量。
    errorCode String
    沙箱实例启动失败错误码。参数值说明：internalloadrequesterror：系统内部错误，functioninitializefailed：业务进程初始化错误，functionhealthcheckfailed：健康检查错误，route_terminating：路由删除中，正常启动沙箱实例时，该字段为空。
    errorMessage String
    沙箱实例启动失败的错误码详情。正常启动沙箱实例时，该字段为空。
    expireAt String
    沙箱实例存活时长。
    functionId String
    沙箱实例所属的沙箱应用 ID。
    id String
    Uniquely identifies the resource.
    instanceImageInfo Property Map
    沙箱实例镜像信息，包括镜像地址、启动命令、监听端口。
    instanceTosMountConfig Property Map
    沙箱实例级别对象存储（TOS）存储挂载配置。
    instanceType String
    沙箱实例类型 。参数值说明：elastic：弹性实例，frozen：冻结实例，activated：激活实例，reserved：预留实例。
    maxConcurrency Number
    单实例请求最大并发数：取值范围：10~1000,默认值：100。
    memoryMb Number
    沙箱实例内存规格：单位：MiB，取值范围：512~131072，默认值：2048
    metadatas List<Property Map>
    沙箱实例标签（Label）元信息，用于标记、筛选实例。格式为<"key":"value">。
    pending Boolean
    沙箱实例是否处于 Pending 状态。参数值说明：true：是，false：否。
    requestTimeout Number
    请求超时时间：单位：秒，取值范围：1~900，正整数。默认值：30。
    revisionNumber Number
    函数实例版本编号。
    sandboxId String
    沙箱实例 ID。
    status String
    沙箱实例状态。 参数值说明：Starting：开始启动，Ready：启动完成，Failed：启动失败，Terminating：终止中。
    timeout Number
    沙箱实例存活时长：单位：分钟，取值范围：3～1440，默认值：60。

    Supporting Types

    GetSandboxEnv

    Key string
    环境变量键。
    Value string
    环境变量值。
    Key string
    环境变量键。
    Value string
    环境变量值。
    key String
    环境变量键。
    value String
    环境变量值。
    key string
    环境变量键。
    value string
    环境变量值。
    key str
    环境变量键。
    value str
    环境变量值。
    key String
    环境变量键。
    value String
    环境变量值。

    GetSandboxInstanceImageInfo

    Command string
    沙箱实例程序的启动命令。如需指定脚本文件，请使用绝对路径，并确保脚本具有相应的可执行权限。
    Image string
    沙箱实例使用的已预热镜像地址。
    ImageId string
    沙箱实例使用的已预热镜像 ID。
    Port int
    沙箱实例镜像监听端口。
    Command string
    沙箱实例程序的启动命令。如需指定脚本文件，请使用绝对路径，并确保脚本具有相应的可执行权限。
    Image string
    沙箱实例使用的已预热镜像地址。
    ImageId string
    沙箱实例使用的已预热镜像 ID。
    Port int
    沙箱实例镜像监听端口。
    command String
    沙箱实例程序的启动命令。如需指定脚本文件，请使用绝对路径，并确保脚本具有相应的可执行权限。
    image String
    沙箱实例使用的已预热镜像地址。
    imageId String
    沙箱实例使用的已预热镜像 ID。
    port Integer
    沙箱实例镜像监听端口。
    command string
    沙箱实例程序的启动命令。如需指定脚本文件，请使用绝对路径，并确保脚本具有相应的可执行权限。
    image string
    沙箱实例使用的已预热镜像地址。
    imageId string
    沙箱实例使用的已预热镜像 ID。
    port number
    沙箱实例镜像监听端口。
    command str
    沙箱实例程序的启动命令。如需指定脚本文件，请使用绝对路径，并确保脚本具有相应的可执行权限。
    image str
    沙箱实例使用的已预热镜像地址。
    image_id str
    沙箱实例使用的已预热镜像 ID。
    port int
    沙箱实例镜像监听端口。
    command String
    沙箱实例程序的启动命令。如需指定脚本文件，请使用绝对路径，并确保脚本具有相应的可执行权限。
    image String
    沙箱实例使用的已预热镜像地址。
    imageId String
    沙箱实例使用的已预热镜像 ID。
    port Number
    沙箱实例镜像监听端口。

    GetSandboxInstanceTosMountConfig

    Enable bool
    沙箱实例是否启用了实例级别的 TOS 挂载，参数值说明：true：是，false：否。
    TosMountPoints List<Byteplus.GetSandboxInstanceTosMountConfigTosMountPoint>
    启用了实例级别 TOS 挂载的沙箱实例具体 TOS 挂载目录信息。
    Enable bool
    沙箱实例是否启用了实例级别的 TOS 挂载，参数值说明：true：是，false：否。
    TosMountPoints []GetSandboxInstanceTosMountConfigTosMountPoint
    启用了实例级别 TOS 挂载的沙箱实例具体 TOS 挂载目录信息。
    enable Boolean
    沙箱实例是否启用了实例级别的 TOS 挂载，参数值说明：true：是，false：否。
    tosMountPoints List<GetSandboxInstanceTosMountConfigTosMountPoint>
    启用了实例级别 TOS 挂载的沙箱实例具体 TOS 挂载目录信息。
    enable boolean
    沙箱实例是否启用了实例级别的 TOS 挂载，参数值说明：true：是，false：否。
    tosMountPoints GetSandboxInstanceTosMountConfigTosMountPoint[]
    启用了实例级别 TOS 挂载的沙箱实例具体 TOS 挂载目录信息。
    enable bool
    沙箱实例是否启用了实例级别的 TOS 挂载，参数值说明：true：是，false：否。
    tos_mount_points Sequence[GetSandboxInstanceTosMountConfigTosMountPoint]
    启用了实例级别 TOS 挂载的沙箱实例具体 TOS 挂载目录信息。
    enable Boolean
    沙箱实例是否启用了实例级别的 TOS 挂载，参数值说明：true：是，false：否。
    tosMountPoints List<Property Map>
    启用了实例级别 TOS 挂载的沙箱实例具体 TOS 挂载目录信息。

    GetSandboxInstanceTosMountConfigTosMountPoint

    BucketPath string
    沙箱实例挂载的 TOS 远端目录。
    LocalMountPath string
    沙箱实例挂载的 TOS 存储桶本地目录。该目录为沙箱应用已配置的 TOS 存储挂载的本地目录时，系统根据指定的本地目录，修改与之对应的 TOS BucketPath。
    BucketPath string
    沙箱实例挂载的 TOS 远端目录。
    LocalMountPath string
    沙箱实例挂载的 TOS 存储桶本地目录。该目录为沙箱应用已配置的 TOS 存储挂载的本地目录时，系统根据指定的本地目录，修改与之对应的 TOS BucketPath。
    bucketPath String
    沙箱实例挂载的 TOS 远端目录。
    localMountPath String
    沙箱实例挂载的 TOS 存储桶本地目录。该目录为沙箱应用已配置的 TOS 存储挂载的本地目录时，系统根据指定的本地目录，修改与之对应的 TOS BucketPath。
    bucketPath string
    沙箱实例挂载的 TOS 远端目录。
    localMountPath string
    沙箱实例挂载的 TOS 存储桶本地目录。该目录为沙箱应用已配置的 TOS 存储挂载的本地目录时，系统根据指定的本地目录，修改与之对应的 TOS BucketPath。
    bucket_path str
    沙箱实例挂载的 TOS 远端目录。
    local_mount_path str
    沙箱实例挂载的 TOS 存储桶本地目录。该目录为沙箱应用已配置的 TOS 存储挂载的本地目录时，系统根据指定的本地目录，修改与之对应的 TOS BucketPath。
    bucketPath String
    沙箱实例挂载的 TOS 远端目录。
    localMountPath String
    沙箱实例挂载的 TOS 存储桶本地目录。该目录为沙箱应用已配置的 TOS 存储挂载的本地目录时，系统根据指定的本地目录，修改与之对应的 TOS BucketPath。

    GetSandboxMetadata

    Key string
    标签键。
    Value string
    标签值。
    Key string
    标签键。
    Value string
    标签值。
    key String
    标签键。
    value String
    标签值。
    key string
    标签键。
    value string
    标签值。
    key str
    标签键。
    value str
    标签值。
    key String
    标签键。
    value String
    标签值。

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.16
    published on Monday, Mar 9, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.