Application Group Billing API Overview - CloudOps Orchestration Service - Alibaba Cloud - CloudOps Orchestration Service

Queries the resource costs of an application group.

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

oos:DescribeApplicationGroupBill

get

*ApplicationGroup

acs:oos:{#regionId}:{#AccountId}:application/{#ApplicationName}/applicationgroup/{#ApplicationGroupName}

oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-hangzhou
ApplicationName	string	Yes	The application name.	test_application
Name	string	Yes	The application group name.	test_application_group
BillingCycle	string	Yes	The billing cycle, in the YYYY-MM format.	2023-06
ResourceType	string	Yes	The type of the cloud resource.	ALIYUN::ECS::INSTANCE
MaxResults	integer	No	The number of entries per page.	10
NextToken	string	No	The token that is used to retrieve the next page of results.	-

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token that is used to retrieve the next page of results.	""
RequestId	string	The request ID.	E897A1AB-4701-5B71-93AD-38FD703763A3
MaxResults	integer	The number of entries per page.	10
ApplicationGroupConsume	array<object>	The consume of application group.
	object
InstanceId	string	The ID of the instance.	i-0jl781czrhqey0s5zpsj
InstanceName	string	The name of the instance.	test-
InstanceType	string	The instance type.	ALIYUN::ECS::INSTANCE
CreationTime	string	The time when the instance was created.	2023-06-10T06:00Z
Status	string	The status of instance.	Running
Amount	number	The amount consumed by the instance.	18.88
Currency	string	The currency unit. Valid values: JPY : JPY USD : USD CNY : CNY	CNY
Performance	string	The performance of the data synchronization instance.	"{\"mem\":\"6.82\",\"cpu\":\"0.55\"}"
Optimization	string	Optimization suggestions.	1
PeakType	string	The peak type. Valid values: WHITE : WHITE NIGHT : NIGHT AVERAGE : AVERAGE	WHITE

Examples

Success response

JSON format

{
  "NextToken": "\"\"",
  "RequestId": "E897A1AB-4701-5B71-93AD-38FD703763A3",
  "MaxResults": 10,
  "ApplicationGroupConsume": [
    {
      "InstanceId": "i-0jl781czrhqey0s5zpsj",
      "InstanceName": "test-",
      "InstanceType": "ALIYUN::ECS::INSTANCE",
      "CreationTime": "2023-06-10T06:00Z",
      "Status": "Running",
      "Amount": 18.88,
      "Currency": "CNY",
      "Performance": "\"{\\\"mem\\\":\\\"6.82\\\",\\\"cpu\\\":\\\"0.55\\\"}\"",
      "Optimization": "1",
      "PeakType": "WHITE"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.