1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. vefaas
  6. getSandbox
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.vefaas.getSandbox

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::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: volcenginecc: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
    Availability zone ID of the sandbox instance
    CpuMilli int
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    CreatedTime string
    Sandbox instance creation time.
    Envs List<Volcengine.GetSandboxEnv>
    Sandbox instance environment variables
    ErrorCode string
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    ErrorMessage string
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    ExpireAt string
    Sandbox instance uptime.
    FunctionId string
    Sandbox application ID to which the sandbox instance belongs
    Id string
    Uniquely identifies the resource.
    InstanceImageInfo Volcengine.GetSandboxInstanceImageInfo
    Sandbox instance image information, including image address, startup command, and listening port.
    InstanceTosMountConfig Volcengine.GetSandboxInstanceTosMountConfig
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    InstanceType string
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    MaxConcurrency int
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    MemoryMb int
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    Metadatas List<Volcengine.GetSandboxMetadata>
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value">
    Pending bool
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    RequestTimeout int
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    RevisionNumber int
    Function instance version number
    SandboxId string
    Sandbox instance ID
    Status string
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating
    Timeout int
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60
    AvailabilityZone string
    Availability zone ID of the sandbox instance
    CpuMilli int
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    CreatedTime string
    Sandbox instance creation time.
    Envs []GetSandboxEnv
    Sandbox instance environment variables
    ErrorCode string
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    ErrorMessage string
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    ExpireAt string
    Sandbox instance uptime.
    FunctionId string
    Sandbox application ID to which the sandbox instance belongs
    Id string
    Uniquely identifies the resource.
    InstanceImageInfo GetSandboxInstanceImageInfo
    Sandbox instance image information, including image address, startup command, and listening port.
    InstanceTosMountConfig GetSandboxInstanceTosMountConfig
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    InstanceType string
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    MaxConcurrency int
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    MemoryMb int
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    Metadatas []GetSandboxMetadata
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value">
    Pending bool
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    RequestTimeout int
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    RevisionNumber int
    Function instance version number
    SandboxId string
    Sandbox instance ID
    Status string
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating
    Timeout int
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60
    availabilityZone String
    Availability zone ID of the sandbox instance
    cpuMilli Integer
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    createdTime String
    Sandbox instance creation time.
    envs List<GetSandboxEnv>
    Sandbox instance environment variables
    errorCode String
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    errorMessage String
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    expireAt String
    Sandbox instance uptime.
    functionId String
    Sandbox application ID to which the sandbox instance belongs
    id String
    Uniquely identifies the resource.
    instanceImageInfo GetSandboxInstanceImageInfo
    Sandbox instance image information, including image address, startup command, and listening port.
    instanceTosMountConfig GetSandboxInstanceTosMountConfig
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    instanceType String
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    maxConcurrency Integer
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    memoryMb Integer
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    metadatas List<GetSandboxMetadata>
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value">
    pending Boolean
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    requestTimeout Integer
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    revisionNumber Integer
    Function instance version number
    sandboxId String
    Sandbox instance ID
    status String
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating
    timeout Integer
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60
    availabilityZone string
    Availability zone ID of the sandbox instance
    cpuMilli number
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    createdTime string
    Sandbox instance creation time.
    envs GetSandboxEnv[]
    Sandbox instance environment variables
    errorCode string
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    errorMessage string
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    expireAt string
    Sandbox instance uptime.
    functionId string
    Sandbox application ID to which the sandbox instance belongs
    id string
    Uniquely identifies the resource.
    instanceImageInfo GetSandboxInstanceImageInfo
    Sandbox instance image information, including image address, startup command, and listening port.
    instanceTosMountConfig GetSandboxInstanceTosMountConfig
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    instanceType string
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    maxConcurrency number
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    memoryMb number
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    metadatas GetSandboxMetadata[]
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value">
    pending boolean
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    requestTimeout number
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    revisionNumber number
    Function instance version number
    sandboxId string
    Sandbox instance ID
    status string
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating
    timeout number
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60
    availability_zone str
    Availability zone ID of the sandbox instance
    cpu_milli int
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    created_time str
    Sandbox instance creation time.
    envs Sequence[GetSandboxEnv]
    Sandbox instance environment variables
    error_code str
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    error_message str
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    expire_at str
    Sandbox instance uptime.
    function_id str
    Sandbox application ID to which the sandbox instance belongs
    id str
    Uniquely identifies the resource.
    instance_image_info GetSandboxInstanceImageInfo
    Sandbox instance image information, including image address, startup command, and listening port.
    instance_tos_mount_config GetSandboxInstanceTosMountConfig
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    instance_type str
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    max_concurrency int
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    memory_mb int
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    metadatas Sequence[GetSandboxMetadata]
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value">
    pending bool
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    request_timeout int
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    revision_number int
    Function instance version number
    sandbox_id str
    Sandbox instance ID
    status str
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating
    timeout int
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60
    availabilityZone String
    Availability zone ID of the sandbox instance
    cpuMilli Number
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    createdTime String
    Sandbox instance creation time.
    envs List<Property Map>
    Sandbox instance environment variables
    errorCode String
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    errorMessage String
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    expireAt String
    Sandbox instance uptime.
    functionId String
    Sandbox application ID to which the sandbox instance belongs
    id String
    Uniquely identifies the resource.
    instanceImageInfo Property Map
    Sandbox instance image information, including image address, startup command, and listening port.
    instanceTosMountConfig Property Map
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    instanceType String
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    maxConcurrency Number
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    memoryMb Number
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    metadatas List<Property Map>
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value">
    pending Boolean
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    requestTimeout Number
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    revisionNumber Number
    Function instance version number
    sandboxId String
    Sandbox instance ID
    status String
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating
    timeout Number
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60

    Supporting Types

    GetSandboxEnv

    Key string
    Environment variable key
    Value string
    Environment variable value
    Key string
    Environment variable key
    Value string
    Environment variable value
    key String
    Environment variable key
    value String
    Environment variable value
    key string
    Environment variable key
    value string
    Environment variable value
    key str
    Environment variable key
    value str
    Environment variable value
    key String
    Environment variable key
    value String
    Environment variable value

    GetSandboxInstanceImageInfo

    Command string
    Startup command for the sandbox instance program. To specify a script file, use an absolute path and ensure the script has executable permissions
    Image string
    Preheated image address used by the sandbox instance
    ImageId string
    Pre-warmed image ID used by the sandbox instance.
    Port int
    Listening port of the sandbox instance image.
    Command string
    Startup command for the sandbox instance program. To specify a script file, use an absolute path and ensure the script has executable permissions
    Image string
    Preheated image address used by the sandbox instance
    ImageId string
    Pre-warmed image ID used by the sandbox instance.
    Port int
    Listening port of the sandbox instance image.
    command String
    Startup command for the sandbox instance program. To specify a script file, use an absolute path and ensure the script has executable permissions
    image String
    Preheated image address used by the sandbox instance
    imageId String
    Pre-warmed image ID used by the sandbox instance.
    port Integer
    Listening port of the sandbox instance image.
    command string
    Startup command for the sandbox instance program. To specify a script file, use an absolute path and ensure the script has executable permissions
    image string
    Preheated image address used by the sandbox instance
    imageId string
    Pre-warmed image ID used by the sandbox instance.
    port number
    Listening port of the sandbox instance image.
    command str
    Startup command for the sandbox instance program. To specify a script file, use an absolute path and ensure the script has executable permissions
    image str
    Preheated image address used by the sandbox instance
    image_id str
    Pre-warmed image ID used by the sandbox instance.
    port int
    Listening port of the sandbox instance image.
    command String
    Startup command for the sandbox instance program. To specify a script file, use an absolute path and ensure the script has executable permissions
    image String
    Preheated image address used by the sandbox instance
    imageId String
    Pre-warmed image ID used by the sandbox instance.
    port Number
    Listening port of the sandbox instance image.

    GetSandboxInstanceTosMountConfig

    Enable bool
    Whether instance-level TOS mount is enabled for the sandbox instance. Parameter description: true: yes, false: no
    TosMountPoints List<Volcengine.GetSandboxInstanceTosMountConfigTosMountPoint>
    Detailed TOS mount directory information for sandbox instances with instance-level TOS mount enabled
    Enable bool
    Whether instance-level TOS mount is enabled for the sandbox instance. Parameter description: true: yes, false: no
    TosMountPoints []GetSandboxInstanceTosMountConfigTosMountPoint
    Detailed TOS mount directory information for sandbox instances with instance-level TOS mount enabled
    enable Boolean
    Whether instance-level TOS mount is enabled for the sandbox instance. Parameter description: true: yes, false: no
    tosMountPoints List<GetSandboxInstanceTosMountConfigTosMountPoint>
    Detailed TOS mount directory information for sandbox instances with instance-level TOS mount enabled
    enable boolean
    Whether instance-level TOS mount is enabled for the sandbox instance. Parameter description: true: yes, false: no
    tosMountPoints GetSandboxInstanceTosMountConfigTosMountPoint[]
    Detailed TOS mount directory information for sandbox instances with instance-level TOS mount enabled
    enable bool
    Whether instance-level TOS mount is enabled for the sandbox instance. Parameter description: true: yes, false: no
    tos_mount_points Sequence[GetSandboxInstanceTosMountConfigTosMountPoint]
    Detailed TOS mount directory information for sandbox instances with instance-level TOS mount enabled
    enable Boolean
    Whether instance-level TOS mount is enabled for the sandbox instance. Parameter description: true: yes, false: no
    tosMountPoints List<Property Map>
    Detailed TOS mount directory information for sandbox instances with instance-level TOS mount enabled

    GetSandboxInstanceTosMountConfigTosMountPoint

    BucketPath string
    TOS remote directory mounted by the sandbox instance
    LocalMountPath string
    Local directory of the TOS bucket mounted by the sandbox instance. If this directory is the local directory configured for TOS storage mount in the sandbox application, the system modifies the corresponding TOS BucketPath based on the specified local directory
    BucketPath string
    TOS remote directory mounted by the sandbox instance
    LocalMountPath string
    Local directory of the TOS bucket mounted by the sandbox instance. If this directory is the local directory configured for TOS storage mount in the sandbox application, the system modifies the corresponding TOS BucketPath based on the specified local directory
    bucketPath String
    TOS remote directory mounted by the sandbox instance
    localMountPath String
    Local directory of the TOS bucket mounted by the sandbox instance. If this directory is the local directory configured for TOS storage mount in the sandbox application, the system modifies the corresponding TOS BucketPath based on the specified local directory
    bucketPath string
    TOS remote directory mounted by the sandbox instance
    localMountPath string
    Local directory of the TOS bucket mounted by the sandbox instance. If this directory is the local directory configured for TOS storage mount in the sandbox application, the system modifies the corresponding TOS BucketPath based on the specified local directory
    bucket_path str
    TOS remote directory mounted by the sandbox instance
    local_mount_path str
    Local directory of the TOS bucket mounted by the sandbox instance. If this directory is the local directory configured for TOS storage mount in the sandbox application, the system modifies the corresponding TOS BucketPath based on the specified local directory
    bucketPath String
    TOS remote directory mounted by the sandbox instance
    localMountPath String
    Local directory of the TOS bucket mounted by the sandbox instance. If this directory is the local directory configured for TOS storage mount in the sandbox application, the system modifies the corresponding TOS BucketPath based on the specified local directory

    GetSandboxMetadata

    Key string
    Tag key
    Value string
    Tag value
    Key string
    Tag key
    Value string
    Tag value
    key String
    Tag key
    value String
    Tag value
    key string
    Tag key
    value string
    Tag value
    key str
    Tag key
    value str
    Tag value
    key String
    Tag key
    value String
    Tag value

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.