All Products
Search
Document Center

ApsaraDB RDS:AttachWhitelistTemplateToInstance

Last Updated:Mar 05, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
rds:AttachWhitelistTemplateToInstance
  • acs:rds:{#regionId}:{#accountId}:*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TemplateIdintegerYes

The ID of the whitelist template. You can call the DescribeAllWhitelistTemplate operation to obtain the ID of the whitelist template.

412
InsNamestringYes

The name of the instance.

rm-bp191w771kd3****
ResourceGroupIdstringNo

The ID of the resource group. For more information about resource groups, see Resource groups.

rg-acfmy*****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Dataobject

The data returned.

Statusstring

The status code returned. Valid values:

  • ok: The request is successful.
  • error: The request fails.
ok
RequestIdstring

The request ID.

08A3B71B-FE08-4B03-974F-CC7EA6DB1828
Successboolean

Indicates whether the request is successful. Valid values:

  • true
  • false
true
Codestring

The response code returned. Valid values:

  • 200: success
  • 400: client error
  • 401: identity authentication failed
  • 404: request page not found
  • 500: server error
200
Messagestring

The message returned.

success
HttpStatusCodeinteger

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 codeError codeError messageDescription
400InvalidSecurityIPList.QuotaExceededSpecified 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.
400InvalidParameterTemplateIdThe parameter templateId is invalid.The templateId parameter is invalid.
401WhitelistTemplateRelationToCustinsId.EXISTSWhitelist Template relation to CustinsId exists.-
401WhitelistIPLength.ForbiddenWhitelist ip length exceeeds the limit.-
404WhitelistTemplateId.NotFoundWhitelist Template id not found.-
404InvalidDBInstanceName.NotFoundInvalid DBInstanceId NotFound.The instance ID cannot be found.
404InsName.NotFoundInsName not found.-

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

Change history

Change timeSummary of changesOperation
2023-11-07The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 404 change
    delete Error Codes: 400
    delete Error Codes: 401
2023-09-08The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 401
    delete Error Codes: 404
2023-08-17The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 401
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceGroupId