All Products
Search
Document Center

BSS OpenAPI:QueryCostUnit

Last Updated:Mar 01, 2024

Queries all cost centers within the current node of the cost center tree. If the ParentUnitId parameter is set to -1, all cost centers are queried.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
bss:QueryCostUnitREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
OwnerUidlongYes

The user ID of the cost center owner.

28394563429587
ParentUnitIdlongYes

The ID of the parent cost center. A value of -1 indicates the root cost center.

-1
PageNumintegerNo

The page number of the page to return.

1
PageSizeintegerNo

The number of entries per page. A maximum of 300 entries can be returned per page.

20

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The status code.

Success
Messagestring

The error message returned.

Successful!
RequestIdstring

The ID of the request.

6000EE23-274B-4E07-A697-FF2E999520A4
Successboolean

Indicates whether the request was successful.

true
Dataobject

The data returned.

PageNuminteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned on each page.

20
TotalCountinteger

The total number of returned entries.

1
CostUnitDtoListobject []

The cost centers.

ParentUnitIdlong

The ID of the parent cost center. A value of -1 indicates the root cost center.

-1
UnitNamestring

The name of the cost center.

test
UnitIdlong

The ID of the cost center.

23534
OwnerUidlong

The user ID of the cost center owner.

2343464

Examples

Sample success responses

JSONformat

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "6000EE23-274B-4E07-A697-FF2E999520A4",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "PageSize": 20,
    "TotalCount": 1,
    "CostUnitDtoList": [
      {
        "ParentUnitId": -1,
        "UnitName": "test",
        "UnitId": 23534,
        "OwnerUid": 2343464
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.