文档

DescribeAllWhitelistTemplate - 批量查询白名单模板信息

更新时间:

该接口用于批量获取白名单模板,支持模糊查询。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeAllWhitelistTemplateRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
MaxRecordsPerPageinteger

每页记录数。合法的枚举值为:10、30、50。

10
PageNumbersinteger

当前页码。

1
RegionIdstring

地域 ID,您可以通过 DescribeRegions 接口查询。

cn-hangzhou
TemplateNamestring

白名单模板名称。模糊查询时传入,支持模糊查询模板名称。可通过 DescribeWhitelistTemplate 获取。

template
FuzzySearchboolean

是否开启模糊查询,各取值含义如下:

  • true:开启
  • false:不开启
true
ResourceGroupIdstring

资源组 ID。 关于资源组的更多信息,请参见什么是资源组。

rg-acfmyhigx******

返回参数

名称类型描述示例值
object

返回参数详情。

Dataobject

返回数据列表。

Templatesobject []

分页返回的白名单模板信息。

Idinteger

数据表主键。

123
UserIdinteger

用户 ID。

168****
TemplateIdinteger

白名单模板 ID。

412
TemplateNamestring

白名单模板名称。

template_123
Ipsstring

IP 列表。

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

总记录数。

402
MaxRecordsPerPageinteger

每页记录数。

10
CurrPageNumbersinteger

当前页码。

1
TotalPageNumbersinteger

总页数。

3
HasNextboolean

表示符合条件的数据是否有下一页,各取值含义如下:

  • true:是
  • false:否
true
HasPrevboolean

表示符合条件的数据是否有上一页,各取值含义如下:

  • true:是
  • false:否
false
RequestIdstring

请求 ID。

16C62438-491B-5C02-9B49-BA924A1372A2
Successboolean

表示请求是否成功,各取值含义如下:

  • true:成功
  • false:失败
true
Codestring

响应码。各取值含义如下:

  • 200:正常
  • 400:客户端错误
  • 401:身份验证失败
  • 404:找不到请求页面
  • 500:服务端错误
200
Messagestring

返回信息。

success
HttpStatusCodeinteger

Http 状态码。各取值含义如下:

  • 200:正常
  • 400:客户端错误
  • 500:服务端错误
200

示例

正常返回示例

JSON格式

{
  "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
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterPagingThe parameter maxRecordsPerPage or PageNumbers is invalid.非法的分页参数。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing 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.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
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.客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。
400Commodity.InvalidComponentThe 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.客户您好,印度地域裁撤,购买的服务效期不能超过2024.07.15。
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好,澳洲地域裁撤,购买的服务效期不能超过2024.09.30
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere 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.您选购的服务存在未支付订单,请支付或作废后再下单。
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.您的基本信息未完善,请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour 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.销售表达式校验系统错误。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-04-22OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:RegionId
2023-08-17OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
  • 本页导读 (1)
文档反馈