Use DescribePricingModule to query product pricing modules - Expenses and Costs - Alibaba Cloud - Expenses and Costs

Queries the module information of a specific 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 product code. You can call the QueryProductList operation to query product codes.	rds
ProductType	string	No	The product type. You can 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 subscription type. Valid values: Subscription: subscription. PayAsYouGo: pay-as-you-go.	Subscription

Response elements

Element	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 is successful.	true
Data	object	The returned data.
ModuleList	object
Module	array<object>	The module and pricing attribute information.
	array<object>
ModuleName	string	The name of the billing module.	Instance
PriceType	string	The price type. Valid values: Usage: usage. Hour: hourly price. Day: daily price. Week: weekly price. Month: monthly price. Year: yearly price.	Month
Currency	string	The currency. CNY: Chinese yuan.	CNY
ModuleCode	string	The identifier of the billing module.	InstanceType
ConfigList	object
ConfigList	array	The collection of pricing attribute codes that the module depends on.
	string	The collection of pricing attribute codes that the module depends on.	[ "Region","InstanceType" ]
AttributeList	object
Attribute	array<object>	The pricing attribute values of the module.
	array<object>
Code	string	The attribute code.	DBInstanceStorage
Name	string	The attribute name.	Storage space
Unit	string	The attribute unit.	GB
Values	object
AttributeValue	array<object>	The attribute.
	object
Type	string	The type of the attribute value corresponding to the module code. Valid values: single_float: single numeric type. single_string: single string type. range_float: range value type.	single_string
Value	string	The attribute value corresponding to the module code. Note When Type is set to range_float, the format 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: 4000. IOPS depends on the storage capacity
Name	string	The attribute value corresponding to the module code.	2 vCPUs, 4 GB (single-node 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": "实例",
          "PriceType": "Month",
          "Currency": "CNY",
          "ModuleCode": "InstanceType",
          "ConfigList": {
            "ConfigList": [
              "[ \"Region\",\"InstanceType\" ]"
            ]
          }
        }
      ]
    },
    "AttributeList": {
      "Attribute": [
        {
          "Code": "DBInstanceStorage",
          "Name": "存储空间",
          "Unit": "GB",
          "Values": {
            "AttributeValue": [
              {
                "Type": "single_string",
                "Value": "mysql.n2.medium.1",
                "Remark": "连接数：4000 IOPS与存储空间大小有关",
                "Name": "2 核 4GB（单机基础版）"
              }
            ]
          }
        }
      ]
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.