All Products
Search
Document Center

ApsaraDB RDS:DescribeAllWhitelistTemplate

Last Updated:Dec 05, 2024

Queries whitelist templates at a time by using fuzzy search.

Operation description

Supported database engines

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:DescribeAllWhitelistTemplateget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
MaxRecordsPerPageintegerYes

The number of entries to return on each page. Enumerated valid values: 10, 30, and 50.

10
PageNumbersintegerYes

The page number.

1
RegionIdstringNo

The region ID.

cn-hangzhou
TemplateNamestringNo

The name of the IP whitelist template. If you specify this parameter when you perform a fuzzy search, you can call the DescribeWhitelistTemplate operation to query the name of the whitelist template during the fuzzy search.

template
FuzzySearchbooleanNo

Specifies whether to enable fuzzy search. Valid values:

  • true
  • false
true
ResourceGroupIdstringNo

The resource group ID. For more information about resource groups, see related documentation.

rg-acfmyhigxskzysy

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Dataobject

The data returned.

Templatesarray<object>

The information about whitelist templates that are returned by page.

Templateobject
Idinteger

The primary key of the data table.

123
UserIdinteger

The user ID.

168****
TemplateIdinteger

The ID of the whitelist template.

412
TemplateNamestring

The name of the whitelist template.

template_123
Ipsstring

The IP addresses.

12.2.X.X,10.0.X.X
TotalRecordsinteger

The total number of entries returned.

402
MaxRecordsPerPageinteger

The number of entries to return on each page.

10
CurrPageNumbersinteger

The page number.

1
TotalPageNumbersinteger

The total number of pages returned.

3
HasNextboolean

Indicates whether the data that meets the conditions is displayed on the next page. Valid values:

  • true
  • false
true
HasPrevboolean

Indicates whether the data that meets the conditions is displayed on the previous page. Valid values:

  • true
  • false
false
RequestIdstring

The request ID.

16C62438-491B-5C02-9B49-BA924A1372A2
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 response parameters.

success
HttpStatusCodeinteger

The HTTP status code returned. Valid values:

  • 200: success
  • 400: client error
  • 500: server error
200

Examples

Sample success responses

JSONformat

{
  "Data": {
    "Templates": [
      {
        "Id": 123,
        "UserId": 0,
        "TemplateId": 412,
        "TemplateName": "template_123",
        "Ips": "12.2.X.X,10.0.X.X"
      }
    ],
    "TotalRecords": 402,
    "MaxRecordsPerPage": 10,
    "CurrPageNumbers": 1,
    "TotalPageNumbers": 3,
    "HasNext": true,
    "HasPrev": false
  },
  "RequestId": "16C62438-491B-5C02-9B49-BA924A1372A2",
  "Success": true,
  "Code": "200",
  "Message": "success",
  "HttpStatusCode": 200
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterPagingThe parameter maxRecordsPerPage or PageNumbers is invalid.-
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
400Order.NoRealNameAuthenticationYou 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 cost and cost for real-name authentication.
400InsufficientAvailableQuotaYour 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.
400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
400RegionDissolvedEOMDear 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.
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.The module you purchased is not legal, please buy it again.
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.Hello customer, this area has been abolished.
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.Hello customer, this area has been abolished.
400Price.CommoditySysCommodity system call exception.Commodity system call exception.
400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There is a problem with the period you selected, please choose again.
400pay.noCreditCardAccount not bound to credit card.-
400Order.InstHasUnpaidOrderThere 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.
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.-
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your basic information is not complete, please complete your basic information before operation.
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your account is abnormal, please contact customer service for details.
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.-
400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.

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

Change history

Change timeSummary of changesOperation
2024-04-22The Error code has changed. The request parameters of the API has changedView Change Details
2023-08-17The Error code has changed. The request parameters of the API has changedView Change Details