All Products
Search
Document Center

Data Management:DescribeCostInfoByDbsInstance

Last Updated:Mar 30, 2026

Queries the cost details for a Database Backup Service (DBS) instance.

Operation description

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

Try it now

Test Test

RAM authorization

ActionAccess levelResource typeCondition keyDependent action
dbs:DescribeCostInfoByDbsInstanceget*All Resource *NoneNone

To grant permissions using a Resource Access Management (RAM) policy, set the Action element to dbs:DescribeCostInfoByDbsInstance. This action supports no resource-level permissions. Use an asterisk (*) in the Resource element of the policy.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionCodestringNoThe ID of the region where the instance is located. You can find this information in your bill.cn-hangzhou
BackupPlanIdstringNoThe ID of the backup billing instance.dbsr1l3ro21****

Response elements

ElementTypeDescriptionExample
(root)object
DatastringThe cost details of the DBS instance, returned as a JSON string. Fields in the JSON string: commodity (the commodity), product (the product), moduleCode (the billing item), instanceName (the sandbox instance ID or the name of the engine instance), backupSetId (the backup set ID), 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"}
RequestIdstringThe request ID.9C397502-B4F2-4E22-AD97-C81F0049F3F3
ErrCodestringThe error code.Param.NotFound
SuccessstringIndicates whether the request was successful.true
ErrMessagestringThe error message.The specified parameter %s value is not valid.
CodestringThe status code.Success
MessagestringThe error message.The specified parameter %s value is not valid.

Examples

Sample success response in 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 codeError codeError messageDescription
403Request.ForbiddenHave no Permissions

For a complete list of error codes, see Error codes.

Release notes

For a complete list of release notes, see Release notes.