1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. tos
  6. getObject
Viewing docs for volcenginecc v0.0.54
published on Thursday, Aug 6, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.54
published on Thursday, Aug 6, 2026 by Volcengine

    Data Source schema for Volcengine::TOS::Object

    Using getObject

    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 getObject(args: GetObjectArgs, opts?: InvokeOptions): Promise<GetObjectResult>
    function getObjectOutput(args: GetObjectOutputArgs, opts?: InvokeOptions): Output<GetObjectResult>
    def get_object(id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetObjectResult
    def get_object_output(id: pulumi.Input[Optional[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetObjectResult]
    func GetObject(ctx *Context, args *GetObjectArgs, opts ...InvokeOption) (*GetObjectResult, error)
    func GetObjectOutput(ctx *Context, args *GetObjectOutputArgs, opts ...InvokeOption) GetObjectResultOutput

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

    public static class GetObject 
    {
        public static Task<GetObjectResult> InvokeAsync(GetObjectArgs args, InvokeOptions? opts = null)
        public static Output<GetObjectResult> Invoke(GetObjectInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetObjectResult> getObject(GetObjectArgs args, InvokeOptions options)
    public static Output<GetObjectResult> getObject(GetObjectArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcenginecc:tos/getObject:getObject
      arguments:
        # arguments dictionary
    data "volcenginecc_tos_get_object" "name" {
        # arguments
    }

    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 string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getObject Result

    The following output properties are available:

    AccountAcls List<Volcengine.GetObjectAccountAcl>
    Object account-level ACL authorization, aligned with Terraform account*acl.
    Bucket string
    Name of the bucket to which the object belongs.
    Content string
    Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
    ContentLength int
    Object content length, in bytes.
    ContentType string
    Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
    ETag string
    Object ETag.
    HashCrc32C string
    Object CRC32C checksum value.
    HashCrc64Ecma string
    Object CRC64 checksum.
    Id string
    Uniquely identifies the resource.
    IsDefault bool
    Whether the object inherits the bucket ACL by default.
    Key string
    Full key name of the object in the bucket.
    LastModified string
    Object last modified time.
    Metadatas List<Volcengine.GetObjectMetadata>
    User-defined object metadata. Both key and value are strings.
    ObjectType string
    Object type.
    PublicAcl string
    Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
    ServerSideEncryption string
    Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
    StorageClass string
    Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
    Tags List<Volcengine.GetObjectTag>
    Object tag information.
    Url string
    Presigned URL for downloading the object.
    VersionIDs List<string>
    List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
    VersionId string
    Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
    AccountAcls []GetObjectAccountAcl
    Object account-level ACL authorization, aligned with Terraform account*acl.
    Bucket string
    Name of the bucket to which the object belongs.
    Content string
    Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
    ContentLength int
    Object content length, in bytes.
    ContentType string
    Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
    ETag string
    Object ETag.
    HashCrc32C string
    Object CRC32C checksum value.
    HashCrc64Ecma string
    Object CRC64 checksum.
    Id string
    Uniquely identifies the resource.
    IsDefault bool
    Whether the object inherits the bucket ACL by default.
    Key string
    Full key name of the object in the bucket.
    LastModified string
    Object last modified time.
    Metadatas []GetObjectMetadata
    User-defined object metadata. Both key and value are strings.
    ObjectType string
    Object type.
    PublicAcl string
    Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
    ServerSideEncryption string
    Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
    StorageClass string
    Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
    Tags []GetObjectTag
    Object tag information.
    Url string
    Presigned URL for downloading the object.
    VersionIDs []string
    List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
    VersionId string
    Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
    account_acls list(object)
    Object account-level ACL authorization, aligned with Terraform account*acl.
    bucket string
    Name of the bucket to which the object belongs.
    content string
    Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
    content_length number
    Object content length, in bytes.
    content_type string
    Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
    e_tag string
    Object ETag.
    hash_crc32_c string
    Object CRC32C checksum value.
    hash_crc64_ecma string
    Object CRC64 checksum.
    id string
    Uniquely identifies the resource.
    is_default bool
    Whether the object inherits the bucket ACL by default.
    key string
    Full key name of the object in the bucket.
    last_modified string
    Object last modified time.
    metadatas list(object)
    User-defined object metadata. Both key and value are strings.
    object_type string
    Object type.
    public_acl string
    Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
    server_side_encryption string
    Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
    storage_class string
    Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
    tags list(object)
    Object tag information.
    url string
    Presigned URL for downloading the object.
    version_i_ds list(string)
    List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
    version_id string
    Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
    accountAcls List<GetObjectAccountAcl>
    Object account-level ACL authorization, aligned with Terraform account*acl.
    bucket String
    Name of the bucket to which the object belongs.
    content String
    Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
    contentLength Integer
    Object content length, in bytes.
    contentType String
    Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
    eTag String
    Object ETag.
    hashCrc32C String
    Object CRC32C checksum value.
    hashCrc64Ecma String
    Object CRC64 checksum.
    id String
    Uniquely identifies the resource.
    isDefault Boolean
    Whether the object inherits the bucket ACL by default.
    key String
    Full key name of the object in the bucket.
    lastModified String
    Object last modified time.
    metadatas List<GetObjectMetadata>
    User-defined object metadata. Both key and value are strings.
    objectType String
    Object type.
    publicAcl String
    Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
    serverSideEncryption String
    Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
    storageClass String
    Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
    tags List<GetObjectTag>
    Object tag information.
    url String
    Presigned URL for downloading the object.
    versionIDs List<String>
    List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
    versionId String
    Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
    accountAcls GetObjectAccountAcl[]
    Object account-level ACL authorization, aligned with Terraform account*acl.
    bucket string
    Name of the bucket to which the object belongs.
    content string
    Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
    contentLength number
    Object content length, in bytes.
    contentType string
    Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
    eTag string
    Object ETag.
    hashCrc32C string
    Object CRC32C checksum value.
    hashCrc64Ecma string
    Object CRC64 checksum.
    id string
    Uniquely identifies the resource.
    isDefault boolean
    Whether the object inherits the bucket ACL by default.
    key string
    Full key name of the object in the bucket.
    lastModified string
    Object last modified time.
    metadatas GetObjectMetadata[]
    User-defined object metadata. Both key and value are strings.
    objectType string
    Object type.
    publicAcl string
    Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
    serverSideEncryption string
    Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
    storageClass string
    Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
    tags GetObjectTag[]
    Object tag information.
    url string
    Presigned URL for downloading the object.
    versionIDs string[]
    List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
    versionId string
    Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
    account_acls Sequence[GetObjectAccountAcl]
    Object account-level ACL authorization, aligned with Terraform account*acl.
    bucket str
    Name of the bucket to which the object belongs.
    content str
    Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
    content_length int
    Object content length, in bytes.
    content_type str
    Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
    e_tag str
    Object ETag.
    hash_crc32_c str
    Object CRC32C checksum value.
    hash_crc64_ecma str
    Object CRC64 checksum.
    id str
    Uniquely identifies the resource.
    is_default bool
    Whether the object inherits the bucket ACL by default.
    key str
    Full key name of the object in the bucket.
    last_modified str
    Object last modified time.
    metadatas Sequence[GetObjectMetadata]
    User-defined object metadata. Both key and value are strings.
    object_type str
    Object type.
    public_acl str
    Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
    server_side_encryption str
    Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
    storage_class str
    Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
    tags Sequence[GetObjectTag]
    Object tag information.
    url str
    Presigned URL for downloading the object.
    version_id str
    Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
    version_ids Sequence[str]
    List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
    accountAcls List<Property Map>
    Object account-level ACL authorization, aligned with Terraform account*acl.
    bucket String
    Name of the bucket to which the object belongs.
    content String
    Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
    contentLength Number
    Object content length, in bytes.
    contentType String
    Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
    eTag String
    Object ETag.
    hashCrc32C String
    Object CRC32C checksum value.
    hashCrc64Ecma String
    Object CRC64 checksum.
    id String
    Uniquely identifies the resource.
    isDefault Boolean
    Whether the object inherits the bucket ACL by default.
    key String
    Full key name of the object in the bucket.
    lastModified String
    Object last modified time.
    metadatas List<Property Map>
    User-defined object metadata. Both key and value are strings.
    objectType String
    Object type.
    publicAcl String
    Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
    serverSideEncryption String
    Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
    storageClass String
    Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
    tags List<Property Map>
    Object tag information.
    url String
    Presigned URL for downloading the object.
    versionIDs List<String>
    List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
    versionId String
    Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.

    Supporting Types

    GetObjectAccountAcl

    AccountId string
    Authorized account ID.
    AclType string
    Authorized principal type. Currently, only CanonicalUser is supported.
    Permission string
    Authorization permission type. Includes FULLCONTROL, READ, READACP, WRITE, WRITE_ACP.
    AccountId string
    Authorized account ID.
    AclType string
    Authorized principal type. Currently, only CanonicalUser is supported.
    Permission string
    Authorization permission type. Includes FULLCONTROL, READ, READACP, WRITE, WRITE_ACP.
    account_id string
    Authorized account ID.
    acl_type string
    Authorized principal type. Currently, only CanonicalUser is supported.
    permission string
    Authorization permission type. Includes FULLCONTROL, READ, READACP, WRITE, WRITE_ACP.
    accountId String
    Authorized account ID.
    aclType String
    Authorized principal type. Currently, only CanonicalUser is supported.
    permission String
    Authorization permission type. Includes FULLCONTROL, READ, READACP, WRITE, WRITE_ACP.
    accountId string
    Authorized account ID.
    aclType string
    Authorized principal type. Currently, only CanonicalUser is supported.
    permission string
    Authorization permission type. Includes FULLCONTROL, READ, READACP, WRITE, WRITE_ACP.
    account_id str
    Authorized account ID.
    acl_type str
    Authorized principal type. Currently, only CanonicalUser is supported.
    permission str
    Authorization permission type. Includes FULLCONTROL, READ, READACP, WRITE, WRITE_ACP.
    accountId String
    Authorized account ID.
    aclType String
    Authorized principal type. Currently, only CanonicalUser is supported.
    permission String
    Authorization permission type. Includes FULLCONTROL, READ, READACP, WRITE, WRITE_ACP.

    GetObjectMetadata

    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 string
    Tag key.
    value string
    Tag value.
    key str
    Tag key.
    value str
    Tag value.
    key String
    Tag key.
    value String
    Tag value.

    GetObjectTag

    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 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.54
    published on Thursday, Aug 6, 2026 by Volcengine

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial