DescribePricingModule - Expenses and Costs - Alibaba Cloud Documentation Center

Queries the pricing modules of an Alibaba Cloud product.

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

bss:DescribePricingModule

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProductCode	string	Yes	The code of the product. Call the QueryProductList operation to query product codes.	rds
ProductType	string	No	The type of the product. Call the QueryProductList operation to query product types. Important The value must be the same as the product type returned by the QueryProductList operation.	rds
SubscriptionType	string	Yes	The billing method. Valid values: Subscription: subscription. PayAsYouGo: pay-as-you-go.	Subscription

Response elements

Parameter	Type	Description	Example
	object
Code	string	The status code.	Success
Message	string	The error message.	This API is not applicable for caller.
RequestId	string	The request ID.	C40A8EE0-8084-49FE-B66E-5E1C3B6AE025
Success	boolean	Indicates whether the request was successful.	true
Data	object	The data that is returned.
ModuleList	object
Module	array<object>	The information about the modules and their pricing properties.
	object
ModuleName	string	The name of the pricing module.	Instance
PriceType	string	The price type. Valid values: Usage: usage Hour: hourly Day: daily Week: weekly Month: monthly Year: yearly	Month
Currency	string	The currency. CNY indicates Chinese Yuan.	CNY
ModuleCode	string	The code of the pricing module.	InstanceType
ConfigList	object
ConfigList	array
	string	The collection of codes for the pricing properties that the module depends on.	[ "Region","InstanceType" ]
AttributeList	object
Attribute	array<object>	The values of the pricing properties of the module.
	object
Code	string	The property code.	DBInstanceStorage
Name	string	The property name.	Capacity
Unit	string	The unit of the property.	GB
Values	object
AttributeValue	array<object>	The properties.
	object
Type	string	The type of the property value that corresponds to the module code. Valid values: single_float: a single numeric value. single_string: a single string. range_float: a range of numeric values.	single_string
Value	string	The property value that corresponds to the module code. Note If Type is set to range_float, the value is in the start-end:step format. For example, 1024-1024000:1024 indicates a range from 1024 to 1024000 with a step size of 1024.	mysql.n2.medium.1
Remark	string	The description of the module value.	Connections: 4,000 IOPS is related to storage space
Name	string	The name of the property value that corresponds to the module code.	2 Cores and 4 GB Memory (Basic Edition)

Examples

Success response

JSON format

{
  "Code": "Success",
  "Message": "This API is not applicable for caller.",
  "RequestId": "C40A8EE0-8084-49FE-B66E-5E1C3B6AE025",
  "Success": true,
  "Data": {
    "ModuleList": {
      "Module": [
        {
          "ModuleName": "Instance\n",
          "PriceType": "Month",
          "Currency": "CNY",
          "ModuleCode": "InstanceType",
          "ConfigList": {
            "ConfigList": [
              "[ \"Region\",\"InstanceType\" ]"
            ]
          }
        }
      ]
    },
    "AttributeList": {
      "Attribute": [
        {
          "Code": "DBInstanceStorage",
          "Name": "Capacity\n",
          "Unit": "GB",
          "Values": {
            "AttributeValue": [
              {
                "Type": "single_string",
                "Value": "mysql.n2.medium.1",
                "Remark": "Connections: 4,000 IOPS is related to storage space\n",
                "Name": "2 Cores and 4 GB Memory (Basic Edition)\n"
              }
            ]
          }
        }
      ]
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.