SubmitHotExpandTask - PolarDB - Alibaba Cloud Documentation Center

Calls the SubmitHotExpandTask operation to submit a hotspot scale-out task.

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

drds:SubmitHotExpandTask

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DrdsInstanceId	string	Yes	The instance ID.	drdshbga1138****
DbName	string	Yes	The database name.	test
TaskName	string	No	The task name.	test
TaskDesc	string	No	The task description.	test
InstanceDbMapping	array<object>	Yes	The list of target instance data.
	object	No
DbList	string	Yes	The target hotspot sharded databases.	hot_test_**_**
InstanceName	string	No	The name of the ApsaraDB RDS instance where the target hotspot database resides.	rm-bp1t1mk5a5bdj****
Mapping	array<object>	Yes	The list of target database data.
	object	No
HotDbName	string	No	The name of the hotspot database.	hot_test_**_**
ShardTbValue	string	No	The table-level shard key value.	test
HotTableName	string	No	The name of the hotspot sharded table. The name must use the logical table name as a prefix.	test_table_*****
ShardDbValue	string	No	The database-level shard key value.	test
TbShardColumn	string	No	The table shard key of the associated table.	platform
DbShardColumn	string	No	The database shard key of the associated table.	platform
LogicTable	string	No	The name of the logical table for hotspot scale-out.	test_table
SupperAccountMapping	array<object>	No	The list of privileged account data.
	object	No
InstanceName	string	No	The instance ID of the ApsaraDB RDS instance that has a privileged account.	rm-bp1t1mk5a5bdj****
SupperAccount	string	No	The name of the privileged account for the ApsaraDB RDS instance.	test
SupperPassword	string	No	The password of the privileged account for the ApsaraDB RDS instance.	11111111
ExtendedMapping	array<object>	Yes	The list of scale-out data.
	object	No
SrcDb	string	No	The name of the source physical sharded database.	test
SrcInstanceId	string	No	The instance ID of the ApsaraDB RDS instance where the source physical database sharding resides.	rm-bp1t1mk5a5bdj****

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful.	true
RequestId	string	The request ID.	0B6B7BDC-575D-4A77-A4F8-24B7EFERV45Y

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "0B6B7BDC-575D-4A77-A4F8-24B7EFERV45Y"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.