All Products
Search

This Product

    Cloud Backup:GetTrialInfo

    Document Center

    Cloud Backup:GetTrialInfo

    Last Updated:Sep 03, 2026

    Queries the free trial information of a specified OSS bucket or NAS file system.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    SourceType

    string

    Yes

    The data source type. Only free trial information of OSS backup and NAS backup can be queried.

    Valid values:

    • NAS :

      Back up Alibaba Cloud NAS.

    • OSS :

      Back up Alibaba Cloud OSS.

    OSS
    Bucket

    string

    No

    This parameter is required only when SourceType is set to OSS. The name of the OSS bucket.

    hbr-backup-oss
    FileSystemId

    string

    No

    This parameter is required only when SourceType is set to NAS. The ID of the file system.

    005494
    CreateTime

    integer

    No

    This parameter is required only when SourceType is set to NAS. The time when the file system was created. UNIX timestamp, in seconds.

    1607436917

    Response elements

    Element

    Type

    Description

    Example

    object

    Code

    string

    The return code. A value of 200 indicates success.

    200
    Message

    string

    The returned message. The value "successful" is returned on success. An error message is returned on failure.

    successful
    RequestId

    string

    The request ID.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    Success

    boolean

    Indicates whether the request was successful.

    • true: The request was successful.

    • false: The request failed.

    TrialInfo

    object

    The free trial properties. This parameter is returned only when a free trial record exists for the data source.

    TrialExpireTime

    integer

    The expiration time of the free trial. UNIX timestamp, in seconds.

    1584597600
    TrialStartTime

    integer

    The start time of the free trial. UNIX timestamp, in seconds.

    1579413159
    TrialVaultReleaseTime

    integer

    The release time of the free trial backup vault. UNIX timestamp, in seconds.

    1594965600
    KeepAfterTrialExpiration

    boolean

    Indicates whether the service is converted to pay-as-you-go after the free trial expires.

    TrialVaultQuota

    integer

    The remaining number of free trial backup vaults that can be created. The value 1 is returned if the free trial has not expired and no free trial backup vault has been created. Otherwise, the value 0 is returned.

    1
    TrialBackupPlanQuota

    integer

    The remaining number of free trial backup plans that can be created. The value 1 is returned if the free trial has not expired and no free trial backup plan has been created. Otherwise, the value 0 is returned.

    1

    Examples

    Success response

    JSON format

    {
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": false,
  "TrialInfo": {
    "TrialExpireTime": 1584597600,
    "TrialStartTime": 1579413159,
    "TrialVaultReleaseTime": 1594965600,
    "KeepAfterTrialExpiration": false,
    "TrialVaultQuota": 1,
    "TrialBackupPlanQuota": 1
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.