GetModifyBEClusterInquiry - ApsaraDB for SelectDB - Alibaba Cloud Documentation Center

Retrieves the pricing information for creating a new cluster within a specified ApsaraDB for SelectDB instance.

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

selectdb:GetModifyBEClusterInquiry

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	No	The cluster ID.	selectdb-xxx-be
CommodityCode	string	Yes	The commodity code. Valid values: selectdb_pre_public_intl : A subscription commodity for the Alibaba Cloud International website. selectdb_go_public_cn : A pay-as-you-go commodity for the Alibaba Cloud China website. selectdb_go_public_intl : A pay-as-you-go commodity for the Alibaba Cloud International website. selectdb_pre_public_cn : A subscription commodity for the Alibaba Cloud China website.	selectdb_go_public_cn
ChargeType	string	Yes	The billing method. Valid values: PREPAY : subscription POSTPAY : pay-as-you-go	POSTPAY
PricingCycle	string	Yes	The billing cycle. Valid values: Month : month Year : year Minute : minute Hour : hour Day : day	Hour
Quantity	integer	Yes	The quantity.	1
PreCacheSize	integer	No	The reserved cache space.	200
PreComputeSize	integer	No	The reserved computing resources.	4
CacheSize	integer	No	The elastic cache space.	200
ComputeSize	integer	No	The elastic computing resources.	4
DbInstanceId	string	Yes	The instance ID.	selectdb-cn-xxx
RegionId	string	Yes	The region ID.	cn-beijing
ModifyClusterChargeType	boolean	No	Specifies whether to query the price for converting the billing method of the cluster. Valid values: true : Yes false : No	true
PromotionOptionNo	string	No	The coupon number.	123412345

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	06758CAB-1204-5852-A471-29C87D5C1D0F
Data	object	The returned data.
Currency	string	The currency.	CNY
TradeAmount	string	The amount.	1.76
RefundAmount	string	The estimated refund amount for converting a subscription cluster to a pay-as-you-go cluster.	-100
PricingRules	object	The unit prices of billable items.
	string	The unit price of a billable item. The billable items include computing resources, cache resources, and storage resources. This parameter is valid only for serverless clusters.	{"compute_size":{"priceUnit":"元/(CU小时)","payFee":"0.0"},"cache_size":{"priceUnit":"元/(GB小时)","payFee":"0.0"},"storage_size":{"priceUnit":"元/(GB*小时)","payFee":"0.0"}
OptionalPromotions	array<object>	The coupon information.
	object	The coupon information.
OptionCode	string	The description of the promotion rule.	789asdf
PromotionDesc	string	The coupon description.	通用优惠券可抵扣100
PromotionName	string	The coupon name.	通用优惠券
CanPromFee	string	The discount amount. Note This parameter is not used for the Alibaba Cloud China website.	100
PromotionOptionNo	string	The coupon number.	732211480132

Examples

Success response

JSON format

{
  "RequestId": "06758CAB-1204-5852-A471-29C87D5C1D0F\n",
  "Data": {
    "Currency": "CNY",
    "TradeAmount": "1.76",
    "RefundAmount": "-100",
    "PricingRules": {
      "key": "{\"compute_size\":{\"priceUnit\":\"元/(CU*小时)\",\"payFee\":\"0.0\"},\"cache_size\":{\"priceUnit\":\"元/(GB*小时)\",\"payFee\":\"0.0\"},\"storage_size\":{\"priceUnit\":\"元/(GB*小时)\",\"payFee\":\"0.0\"}"
    },
    "OptionalPromotions": [
      {
        "OptionCode": "789asdf",
        "PromotionDesc": "通用优惠券可抵扣100",
        "PromotionName": "通用优惠券",
        "CanPromFee": "100",
        "PromotionOptionNo": "732211480132"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	DocumentConvertFailed.ExceedFileSizeLimit	The conversion has been failed, exceed file size limit.	english description1
400	Forbidden	User not authorized to operate on the specified resource, or this API does not support RAM.	english description1
400	InvalidDBName	The specified database name is not allowed.	english description1
400	CreateOrderFailed	Failed to create order.	Failed to create order.
403	DBClusterNotSupported	The requested operation can not be performed while the cluster is not sale.	The requested operation cannot be performed while the cluster is not running.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	english description1
403	InstanceEngineType.NotSupport	The instance engine and type does not support operations.	english description1
403	InvalidDBInstanceState.NotSupport	The specified instance state does't support this operation.	The instance is in a state that does not support the current operation.
403	MoneyLessThan100	The Account Monet less Than 100.	english description1
403	OperationDenied.DBNameAndAccountPrivilegeCount	The operation is not permitted due to count of database or account privilege.	english description1
403	InsufficientResourceCapacity	The resource is out of usage.	Not enough resources, please try again later.
404	DBInstanceLocked	The current instance lock mode does not support this operation.	english description1
404	IncorrectVswitchId	The specified parameter VSwitchId is not valid.	english description1
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	InvalidDBInstance.NotFound	The specified instance is not found.	english description1
404	InvalidDBInstanceClass.NotFound	The specified instance classic does not exist.	english description1
404	InvalidRegionId.NotFound	The provided RegionId does not exist in our records.	english description1
404	QueryPrice.Failed	The inquiry failed. Contact Alibaba Cloud customer service representatives.	english description1
404	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in our records.	Instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.