AttachWhitelistTemplateToInstance - ApsaraDB RDS - Alibaba Cloud Documentation Center

Associates a whitelist template with an instance.

Operation description

Supported database engines

MySQL
PostgreSQL
SQL Server

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rds:AttachWhitelistTemplateToInstance		acs:rds:{#regionId}:{#accountId}:*	none	none

Request parameters

Parameter	Type	Required	Description	Example
TemplateId	integer	Yes	The ID of the whitelist template. You can call the DescribeAllWhitelistTemplate operation to obtain the ID of the whitelist template.	412
InsName	string	Yes	The name of the instance.	rm-bp191w771kd3****
ResourceGroupId	string	No	The ID of the resource group. For more information about resource groups, see Resource groups.	rg-acfmy*****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Data	object	The data returned.
Status	string	The status code returned. Valid values: ok: The request is successful. error: The request fails.	ok
RequestId	string	The request ID.	08A3B71B-FE08-4B03-974F-CC7EA6DB1828
Success	boolean	Indicates whether the request is successful. Valid values: true false	true
Code	string	The response code returned. Valid values: 200: success 400: client error 401: identity authentication failed 404: request page not found 500: server error	200
Message	string	The message returned.	success
HttpStatusCode	integer	The HTTP status code returned. Valid values: 200: success 400: client error 500: server error	200

Examples

Sample success responses

JSONformat

{
  "Data": {
    "Status": "ok"
  },
  "RequestId": "08A3B71B-FE08-4B03-974F-CC7EA6DB1828",
  "Success": true,
  "Code": "200",
  "Message": "success",
  "HttpStatusCode": 200
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidSecurityIPList.QuotaExceeded	Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.	The number of IP addresses and CIDR blocks in the IP address whitelist that is specified by the SecurityIPList parameter exceeds the upper limit. The IP address whitelist can contain a maximum of 1,000 IP addresses and CIDR blocks.
400	InvalidParameterTemplateId	The parameter templateId is invalid.	The templateId parameter is invalid.
400	InvalidDBInstanceName.TooMuchItems	The number of DB instance Names should be no more than 20.	The number of instance names passed in at a time cannot be greater than 20.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Your account available limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedIndia	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.	-
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	-
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Your account is abnormal, please contact customer service for details.
401	WhitelistTemplateRelationToCustinsId.EXISTS	Whitelist Template relation to CustinsId exists.	-
401	WhitelistIPLength.Forbidden	Whitelist ip length exceeeds the limit.	-
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
404	WhitelistTemplateId.NotFound	Whitelist Template id not found.	-
404	InvalidDBInstanceName.NotFound	Invalid DBInstanceId NotFound.	The instance ID cannot be found.
404	InsName.NotFound	InsName not found.	-

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2024-04-22

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 401
	delete Error Codes: 404
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: RegionId

2024-03-15

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 400 change
	delete Error Codes: 401
	delete Error Codes: 404

2023-11-07

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 404 change
	delete Error Codes: 400
	delete Error Codes: 401

2023-09-08

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 400 change
	delete Error Codes: 401
	delete Error Codes: 404

2023-08-17

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 401
	delete Error Codes: 404
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: ResourceGroupId