Query Instance Price After Config Changes via API - Cloud Architect Design Tools - Alibaba Cloud - Cloud Architect Design Tools

Retrieves the result of a price inquiry.

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:GetResult4QueryInstancePrice4Modify

get

*BPStudioVirtual

acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}

None

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	Yes	The ID of the price inquiry task for the instance configuration change. The ID is valid for one hour. If the task times out, you cannot query the result and the Data parameter is not returned.	price4modify/19862074**/rm-uf69xr871lfj39/WQ9ULO4SLDPQY5/FL1IZLW*3H78OC
ApplicationId	string	No	The application ID.	02S7UU41WKJL7ERR

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	A07FFDF2-78FA-1B48-9E38-88E833A93187
Message	string	The error message.	Success
Code	string	The response code.	200
Data	object	The result of the price inquiry for the instance configuration change.
TaskId	string	The task ID.	d9a3e99b-6954-4a16-ad51-954db4a528b7
Status	string	The application status.	SUCCESS
PriceList	array<object>	The list of billing results. If the instance is a pay-as-you-go instance, three prices are returned. If the instance is a subscription instance and you specify the period_unit and period parameters when you query the price for the configuration change, three prices are returned. If you do not specify the period_unit and period parameters, only the amount that you must pay after the configuration change is returned. The three prices are returned in the following order: The amount that you must pay after the configuration change. For a pay-as-you-go instance, this is the price of the new instance type. For a subscription instance, this is the amount that you must pay for the remaining subscription duration after an upgrade. For example, if you upgrade a one-month instance after half a month, this is the amount that you must pay for the remaining half a month. For a subscription instance, this amount changes as the remaining subscription duration decreases. The amount also varies based on the time when you call the QueryInstancePrice4Modify operation. The price of the original instance type. The price of the new instance type. For a subscription instance, this is the price for a full subscription period, such as one month.
	object	The list of billing results.
NodeType	string	The product code.	vpc
TradeAmount	number	The final price. This is the original price minus the discount.	1
DiscountAmount	number	The discount.	2
OriginalAmount	number	The original price.	3
PriceUnit	string	The unit: Amount/Hour.	200/hour
PromotionName	string	The discount information.	Offer Information
Error	string	The cause of the failure.	Get information on price failures
AccessDeniedDetail	string	The details about the failed permission verification.	{ "PolicyType": "", "AuthPrincipalOwnerId": "", "EncodedDiagnosticMessage": "", "AuthPrincipalType": "", "AuthPrincipalDisplayName": "", "NoPermissionType": "", "AuthAction": "" }

Examples

Success response

JSON format

{
  "RequestId": "A07FFDF2-78FA-1B48-9E38-88E833A93187",
  "Message": "Success",
  "Code": "200",
  "Data": {
    "TaskId": "d9a3e99b-6954-4a16-ad51-954db4a528b7",
    "Status": "SUCCESS",
    "PriceList": [
      {
        "NodeType": "vpc",
        "TradeAmount": 1,
        "DiscountAmount": 2,
        "OriginalAmount": 3,
        "PriceUnit": "200/hour",
        "PromotionName": "Offer Information",
        "Error": "Get information on price failures"
      }
    ]
  },
  "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.