All Products
Search

This Product

    Cloud Architect Design Tools:QueryInstancePrice4Modify

    Document Center

    Cloud Architect Design Tools:QueryInstancePrice4Modify

    Last Updated:Mar 30, 2026

    Queries the price for an upgrade or downgrade.

    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

    bpstudio:QueryInstancePrice4Modify

    get

    *Application

    acs:bpstudio::{#accountId}:application/{#ApplicationId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ApplicationId

    string

    Yes

    The application ID.

    002XWH7MXB8MJRU0
    InstanceId

    string

    Yes

    The ID of the resource to upgrade or downgrade.

    rm-uf66k9143r2ch*****
    Configuration

    object

    No

    The list of target configurations.

    any

    No

    The target configuration parameters.

    Note

    • For subscription instances, set this parameter to `UPGRADE` for upgrades and `DOWNGRADE` for downgrades. For pay-as-you-go instances, set this parameter to `UPGRADE` for both upgrades and downgrades because the configuration is simply changed.

    • Optional parameters for subscription instances. `period_unit`: The unit of the subscription duration. Valid values: `Month`, `Week`, and `Year`. `period`: The subscription duration. If you set this to `1`, the price for one unit of time is returned.

    ecs

    • orderType:UPGRADE

    • instance_type:xxx (Instance type)

    rds (You can change the instance type and capacity at the same time.)

    • orderType:UPGRADE

    • instance_type:xxx (Instance type)

    • instance_storage:xxx (Capacity)

    kvstore

    • orderType:UPGRADE

    • number:1 (Number of shards)

    • instance_class:xxx (Instance type)

    kvstore_prepaid_public_cn

    • orderType:UPGRADE

    • shard_quantity:4 (Number of shards)

    • shard_class: xxx (Shard specifications)

    • storage: 10 (Disk capacity)

    tair

    • orderType:UPGRADE

    • shard_quantity:4 (Number of shards)

    • shard_class: xxxx (Shard specifications)

    kafka

    • orderType:UPGRADE

    • eip_max (Internet traffic):

    • IO_max (Internet traffic):

    • partition_num: Number of partitions

    • disk_size (Disk capacity):

    polardb

    • orderType:UPGRADE

    • master_spec (Node specifications):

    elasticsearch

    • orderType:UPGRADE

    • node_spec (Data node specifications):

    • kibana_node_spec (Kibana node specifications):

    • master_spec (Dedicated master node specifications)

    • warm_node_spec (Cold data node specifications):

    • client_node_spec (Coordinator node specifications):

    • elastic_node_spec (Elastic data node):

    hitsdb_lindormnext

    Note

    • You can add engines. The parameters required to enable each type of engine are listed below.

    • To change specifications, enter the node specifications for the corresponding engine.

    • To change the number of nodes, enter the number of nodes.

    • To change the disk storage capacity, enter the disk storage capacity.

    • You can perform only one type of change at a time. After a change is successful, you can perform the next one.

    • orderType:UPGRADE

    Production instance changes

    Add a search engine

    • basic_search_engine (Add a search engine):true

    • basic_search_type (Node type):

    • basic_search_node_spec (Node specifications):

    • basic_search_core_num (Number of nodes):

    • basic_search_cloud_disk (Attach a disk):true

    • basic_search_disk_type (Attached disk type):

    • basic_search_disk_size (Attached disk storage capacity):

    Add a vector engine

    • basic_vector_engine (Add a vector engine):true

    • basic_vector_type (Node type):

    • basic_vector_node_spec (Node specifications):

    • basic_vector_core_num (Number of nodes):

    • basic_vector_cloud_disk (Attach a disk):true

    • basic_vector_disk_type (Attached disk type):

    • basic_vector_disk_size (Attached disk storage capacity):

    Add a wide table engine

    • basic_wide_table_engine (Add a wide table engine):

    • basic_wide_table_type (Node type):

    • basic_wide_table_node_spec (Node specifications):

    • basic_wide_table_core_num (Number of nodes):

    • basic_wide_table_cloud_disk (Attach a disk):

    • basic_wide_table_disk_type (Attached disk type):

    • basic_wide_table_disk_size (Attached disk storage capacity):


    Test instance changes

    Add a time series engine - timing_engine (Add a time series engine):true - timing_node_spec (Node specifications): - timing_core_num (Number of nodes): - timing_cloud_disk (Attach a disk): - timing_disk_type (Attached disk type): - timing_disk_size (Attached disk storage capacity):

    Add a search engine

    • search_engine (Add a search engine):

    • search_node_spec (Node specifications):

    • search_core_num (Number of nodes):

    • search_cloud_disk (Attach a disk):

    • search_disk_type (Attached disk type):

    • search_disk_size (Attached disk storage capacity):

    Add an LTL engine

    • lts_engine (Add an LTL engine):true

    • lts_node_spec (Node specifications):

    • lts_core_num (Number of nodes):

    • lts_cloud_disk (Attach a disk):true

    • lts_disk_type (Attached disk type):

    • lts_disk_size (Attached disk storage capacity):

    Add a vector engine

    • vector_engine (Add a vector engine):

    • vector_node_spec (Node specifications):

    • vector_core_num (Number of nodes):

    • vector_cloud_disk (Attach a disk):

    • vector_disk_type (Attached disk type):

    • vector_disk_size (Attached disk storage capacity):

    slb

    Note

    The billing method of the instance (`InstanceChargeType`): `PayBySpec` (pay-by-specification) or `PayByCLCU` (pay-by-usage).
    The billing method for Internet traffic (`internet_charge_type`): `0` (pay-by-bandwidth) or `1` (pay-by-traffic).
    If `InstanceChargeType` is `PayBySpec`, `specification` is required.
    If `internet_charge_type` is `0`, `bandwidth` is required.



    • orderType:UPGRADE

    • specification (Instance type):

    • InstanceChargeType (Instance billing method):

    • internet_charge_type (Internet traffic fee):

    • bandwidth (Bandwidth):

    hbase

    • orderType:UPGRADE

    • core_instance_type (Core specifications):

    dds

    • orderType:UPGRADE

    • db_instance_class (Specifications):

    onspre

    Upgrade or downgrade an Enterprise Platinum Edition instance

    • orderType:UPGRADE

    • tps_max (Peak TPS):

    • topic_capacity (Maximum number of topics):

    • message_capacity (Message storage space):

    Upgrade a Standard Edition instance to an Enterprise Platinum Edition instance

    • orderType:BUY

    • tps_max (Peak TPS):

    • topic_capacity (Maximum number of topics):

    • message_capacity (Message storage space):

    • period_unit (Subscription unit):Month, Year

    • period (Subscription duration):

    hitsdb_lindorm

    • orderType:UPGRADE

    • lindorm_core_spec (Wide table node specifications):

    drds

    • orderType:UPGRADE

    • drds_instance_spec (Instance type):

    clickhouse
    Enterprise Edition instance changes:

    • max_ccu (Maximum CCUs):

    • mini_ccu (Minimum CCUs):

    Community Edition instance:
    Horizontal scaling:

    • node_count (Number of nodes):

    Vertical scaling:

    • zkSize (Zookeeper specifications):

    • instance_class (Specifications):

    • storage_type (Storage class):

    • storage_size (Storage space):

    drds_polarx
    Standard Edition:

    • node_spec (Node specifications):

    Enterprise Edition:

    • cn_node_spec (Compute node specifications):

    • dn_node_spec (Data node specifications):

    • dn_storage_space (Data node disk):

    opensearch

    • buytype (Cluster preference):

    • storage (Storage capacity):

    • compute (Computing resource):

    orderType:UPGRADE

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The ID of the application.

    9656C816-1E9A-58D2-86D5-710678D61AF1
    Success

    string

    Indicates whether the request was successful.

    true
    Code

    string

    The return code.

    200
    Message

    string

    The error message.

    Success
    Data

    string

    The task ID. You can use this ID to call the GetResult4QueryInstancePrice4Modify operation to query the price inquiry result. The task ID is valid for one hour.

    price4modify/19862074****/rm-uf69xr871l***fj39/WQ9ULO4SLD**PQY5/FL1IZLW**3H78OC
    AccessDeniedDetail

    string

    The detailed reason why the access was denied.

    { "PolicyType": "", "AuthPrincipalOwnerId": "", "EncodedDiagnosticMessage": "", "AuthPrincipalType": "", "AuthPrincipalDisplayName": "", "NoPermissionType": "", "AuthAction": "" }

    Examples

    Success response

    JSON format

    {
  "RequestId": "9656C816-1E9A-58D2-86D5-710678D61AF1",
  "Success": "true",
  "Code": "200",
  "Message": "Success",
  "Data": "price4modify/19862074****/rm-uf69xr871l***fj39/WQ9ULO4SLD**PQY5/FL1IZLW**3H78OC",
  "AccessDeniedDetail": "{\n    \"PolicyType\": \"\",\n    \"AuthPrincipalOwnerId\": \"\",\n    \"EncodedDiagnosticMessage\": \"\",\n    \"AuthPrincipalType\": \"\",\n    \"AuthPrincipalDisplayName\": \"\",\n    \"NoPermissionType\": \"\",\n    \"AuthAction\": \"\"\n  }"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.