All Products
Search

This Product

    Data Management:DescribeCostInfoByDbsInstance

    Document Center

    Data Management:DescribeCostInfoByDbsInstance

    Last Updated:Dec 01, 2025

    Queries the costs for a DBS instance.

    Operation description

    This operation is available only in version 2021-01-01 of the DBS API.

    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

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dbs:DescribeCostInfoByDbsInstance

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionCode

    string

    No

    The ID of the region where the instance is located. You can find this information in your bill.

    cn-hangzhou
    BackupPlanId

    string

    No

    The ID of the backup billing instance.

    dbsr1l3ro21****

    Response elements

    Element

    Type

    Description

    Example

    object

    Data

    string

    Parameter descriptions:

    • commodity: The commodity.

    • product: The product.

    • moduleCode: The billing item.

    • instanceName: The sandbox instance ID.

    • backupSetId: The backup set ID.

    • instanceName: The name of the engine instance.

    • backupPlanId: The ID of the backup billing instance.

    { "backupPlanComment": "", "commodity": "cbs_post", "product": "cbs", "moduleCode": "BackupStorageSize", "instanceName": "d-2zefd6337d766294", "backupPlanId": "dbs:d-2zefd6337d766294", "moduleName": "mongodb" }
    RequestId

    string

    The request ID.

    9C397502-B4F2-4E22-AD97-C81F0049F3F3
    ErrCode

    string

    The error code.

    Param.NotFound
    Success

    string

    Indicates whether the request was successful.

    true
    ErrMessage

    string

    The error message.

    The specified parameter %s value is not valid.

    Code

    string

    The status code.

    Success
    Message

    string

    The error message.

    The specified parameter %s value is not valid.

    Examples

    Success response

    JSON format

    {
  "Data": "{\n      \"backupPlanComment\": \"\",\n      \"commodity\": \"cbs_post\",\n      \"product\": \"cbs\",\n      \"moduleCode\": \"BackupStorageSize\",\n      \"instanceName\": \"d-2zefd6337d766294\",\n      \"backupPlanId\": \"dbs:d-2zefd6337d766294\",\n      \"moduleName\": \"mongodb\"\n    }",
  "RequestId": "9C397502-B4F2-4E22-AD97-C81F0049F3F3",
  "ErrCode": "Param.NotFound",
  "Success": "true",
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "Code": "Success",
  "Message": "The specified parameter %s value is not valid."
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    403 Request.Forbidden Have no Permissions

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.