QueryInstanceSpec4Modify - Cloud Architect Design Tools - Alibaba Cloud Documentation Center

Queries a list of specifications 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:QueryInstanceSpec4Modify

get

*Application

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

None

Request parameters

Parameter	Type	Required	Description	Example
ApplicationId	string	Yes	The ID of the Cloud Architect Design Tools application.	BE68D71ZY5YYIU9R
InstanceId	string	Yes	The ID of the resource to be upgraded or downgraded.	rm-uf66k9143r2ch*****
MethodName	string	No	The API operation name of the corresponding product. To query the specifications of an ECS instance, enter `describeResourcesModification`. To query the specifications of an ApsaraDB RDS instance, enter `listAvailableClasses`. To query the specifications of an ApsaraDB for Redis instance, enter `getKvstoreInstanceClass`. To query the number of shards of an ApsaraDB for Redis instance, enter `getKvstoreShardNum`. To query the specifications of a subscription ApsaraDB for Redis instance, enter `getShardClass`. To query the disk capacity of a subscription ApsaraDB for Redis instance, enter `getStorage`. To query the number of shards of a subscription ApsaraDB for Redis instance, enter `getShardQuantity`. To query the specifications of a Tair instance, enter `getShardClass`. To query the number of shards of a Tair instance, enter `getShardQuantity`. To query the Internet traffic of a Kafka instance, enter `getEipMax`. To query the traffic specifications of a Kafka instance, enter `getIoMax`. To query the number of partitions of a Kafka instance, enter `getPartitionNum`. To query the disk capacity of a Kafka instance, enter `getDiskSize`. To query the node specifications of a PolarDB cluster, enter `getMasterSpec`. To query the data node specifications of an Elasticsearch cluster, enter `getNodeSpec`. To query the Kibana node specifications of an Elasticsearch cluster, enter `getKibanaNodeSpecList`. To query the dedicated master node specifications of an Elasticsearch cluster, enter `getMasterSpecList`. To query the warm data node specifications of an Elasticsearch cluster, enter `getWarmNodeSpecList`. To query the client node specifications of an Elasticsearch cluster, enter `getClientNodeSpecList`. To query the elastic data node specifications of an Elasticsearch cluster, enter `getElasticNodeSpecList`. To query the specifications of a trial LindormTSDB, search engine, LTL engine, or vector engine for a Lindorm instance, enter `getLightNodeSpec`. To query the specifications of a production search engine for a Lindorm instance, enter `getBasicSearchNodeSpec`. To query the specifications of a production vector engine for a Lindorm instance, enter `getBasicVectorNodeSpec`. To query the specifications of a production LindormTable for a Lindorm instance, enter `getBasicWideTableNodeSpec`. To query the instance type of an SLB instance, enter `getSlbLoadBalancerSpec`. To query the specifications of an Hbase instance, enter `getHbaseCoreSpec`. To query the specifications of an ApsaraDB for MongoDB instance, enter `getDdsClass`. To query the peak TPS of a Message Queue for Apache RocketMQ instance, enter `getOnsPreTpsMax`. To query the maximum number of topics for a Message Queue for Apache RocketMQ instance, enter `getOnsPreTopicCapacity`. To query the log broker capacity of a Message Queue for Apache RocketMQ instance, enter `getOnsPreMessageCapacity`. To query the wide table specifications of a Lindorm instance, enter `getHitsdbLindormCoreSpec`. To query the instance type of a DRDS instance, enter `getDrdsInstanceSpec`. To query the maximum number of ClickHouse Compute Units (CCUs), enter `getClickHouseMaxCcu`. To query the minimum number of CCUs, enter `getClickHouseMinCcu`. To query the Zookeeper specifications, enter `getClickHouseZkSize`. To query the specifications, enter `getClickHouseInstanceClass`. To query the storage class, enter `getClickHouseStorageType`. To query the storage space, enter `getClickHouseStorageSize`. To query the node specifications of a PolarDB-X 1.0 instance, enter `getDrdsPolarxNodeSpec`. To query the compute node specifications of a PolarDB-X 1.0 instance, enter `getDrdsPolarxCnNodeSpec`. To query the data node specifications of a PolarDB-X 1.0 instance, enter `getDrdsPolarxDnNodeSpec`. To query the disk space of data nodes for a PolarDB-X 1.0 instance, enter `getDrdsPolarxDnStorageSpace`. To query the cluster preference of an OpenSearch instance, enter `getOpenSearchBuyType`. To query the storage capacity of an OpenSearch instance, enter `getOpenSearchStorage`. To query the computing resources of an OpenSearch instance, enter `getOpenSearchCompute`.	describeResourcesModification
Parameters	object	No	The constraints on the specifications.
	any	No	The parameters. Note For subscription instances, use `UPGRADE` for upgrades and `DOWNGRADE` for downgrades. For pay-as-you-go instances, use `UPGRADE` for both upgrades and downgrades because it indicates a configuration change. To query the specifications for an ECS instance modification: orderType:UPGRADE To query the specifications for an ApsaraDB RDS instance modification: orderType:UPGRADE To query the specifications for an ApsaraDB for Redis instance modification: orderType:UPGRADE To query the specifications for a subscription ApsaraDB for Redis instance modification: orderType:UPGRADE To query the disk capacity that corresponds to the specifications for a subscription ApsaraDB for Redis instance modification: orderType:UPGRADE shard_class:xxx To query the specifications for a Tair instance modification: orderType:UPGRADE To query the properties for a Lindorm instance modification: orderType:UPGRADE To query the specifications for an SLB instance modification: orderType:UPGRADE To query the core specifications for an Hbase instance modification: orderType:UPGRADE To query the specifications for an ApsaraDB for MongoDB instance modification: orderType:UPGRADE To query the specifications for an upgrade or downgrade of a Message Queue for Apache RocketMQ Platinum Edition instance: orderType:UPGRADE To query the specifications for upgrading a Standard Edition instance of Message Queue for Apache RocketMQ to a Platinum Edition instance: orderType:BUY To query the specifications for a Lindorm instance modification: orderType:UPGRADE To query the specifications for a DRDS instance modification: orderType:UPGRADE	orderType:UPGRADE

Response elements

Element	Type	Description	Example
	object	Schema of Response
Success	boolean	Indicates whether the request was successful.	true
Code	string	The return code.	200
Message	string	The error message.	Success
Data	object	The query results.
OptionalValues	array<object>	The list of available specifications for modification.
	object
Label	string	The name of the specification.	1 GB
Value	string	The value of the specification.	redis.shard.small.2.ce
Min	number	The minimum value. This parameter is valid when you query the number of shards for an ApsaraDB for Redis instance.	1
Max	number	The maximum value. This parameter is valid when you query the number of shards for an ApsaraDB for Redis instance.	1
Step	number	The step size. This parameter is valid when you query the number of shards for an ApsaraDB for Redis instance.	1
RequestId	string	The request ID.	847C9D0A-BABD-589C-8A9C-6464409EDED9
AccessDeniedDetail	string	The details about the access denial.	{ "PolicyType": "", "AuthPrincipalOwnerId": "", "EncodedDiagnosticMessage": "", "AuthPrincipalType": "", "AuthPrincipalDisplayName": "", "NoPermissionType": "", "AuthAction": "" }

Examples

Success response

JSON format

{
  "Success": true,
  "Code": "200",
  "Message": "Success",
  "Data": {
    "OptionalValues": [
      {
        "Label": "1  GB",
        "Value": "redis.shard.small.2.ce",
        "Min": 1,
        "Max": 1,
        "Step": 1
      }
    ]
  },
  "RequestId": "847C9D0A-BABD-589C-8A9C-6464409EDED9",
  "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.