DescribePricingModule - BSS OpenAPI - Alibaba Cloud Documentation Center

Queries the pricing information about an Alibaba Cloud service.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
bssapi:DescribePricingModule	READ	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProductCode	string	Yes	The service code. You can query the service code by calling the QueryProductList operation.	rds
ProductType	string	No	The type of the service. You can query the service type by calling the QueryProductList operation.	rds
SubscriptionType	string	Yes	The billing method. Valid values: Subscription: subscription PayAsYouGo: pay-as-you-go	Subscription

Response parameters

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

Examples

Sample success responses

JSONformat

{
  "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

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