All Products
Search
Document Center

ApsaraDB RDS:DescribeWhitelistTemplate

Last Updated:May 11, 2024

Queries information about the specified IP whitelist.

Operation description

Supported database engines

  • RDS MySQL
  • RDS PostgreSQL
  • RDS 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

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TemplateIdintegerYes

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

1012
ResourceGroupIdstringNo

The resource group ID.

rg-acfmy****
RegionIdstringNo

The region ID.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Dataobject

The data returned.

Templateobject

The information about the IP whitelist template.

Idinteger

The primary key of the data table.

1013
UserIdinteger

The user ID.

16****
TemplateIdinteger

The ID of the whitelist template.

424
TemplateNamestring

The name of the IP whitelist template.

template_123
Ipsstring

The IP addresses.

10.1.X.X,2.3.X.X
RequestIdstring

The request ID.

ED169A3E-1657-4104-82AB-24EA8CD0DB75
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": {
    "Template": {
      "Id": 1013,
      "UserId": 0,
      "TemplateId": 424,
      "TemplateName": "template_123",
      "Ips": "10.1.X.X,2.3.X.X"
    }
  },
  "RequestId": "ED169A3E-1657-4104-82AB-24EA8CD0DB75",
  "Success": true,
  "Code": "200",
  "Message": "success",
  "HttpStatusCode": 200
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterTemplateIdThe parameter templateId is invalid.The templateId parameter is invalid.
400WhitelistTemplateId.NotFoundWhitelist Template id not found.-
400InvalidUserId.NotSupportThe user ID has no permission.-
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 user center 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.Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.
400RegionEndTimeDissolvedAustraliaCloud 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.
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 changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: RegionId
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
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceGroupId