调用GetWhitelistTemplate查询白名单模板详情-云数据库ClickHouse-阿里云-云数据库 ClickHouse-阿里云帮助中心

查询白名单模板详情

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

clickhouse:GetWhitelistTemplate

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
TemplateId	string	是	白名单模板 ID。	98a6d3db05984dca

返回参数

名称	类型	描述	示例值
	object	Schema of Response。
RequestId	string	Request ID。	1234567890
Data	object	白名单模板详情。
Templates	array<object>	白名单模板列表。
	array<object>	模板详情。
TemplateId	string	白名单模板 ID。	g-asdfwem
TemplateName	string	白名单模板名称。	demo_template
SecurityIPList	string	IP 白名单列表。	192.168.1.1,10.0.0.1
DbInstances	array<object>	关联的实例列表。
	object	实例详情。
DBInstanceId	string	实例 ID。	cc-asdfwef

示例

正常返回示例

JSON格式

{
  "RequestId": "1234567890",
  "Data": {
    "Templates": [
      {
        "TemplateId": "g-asdfwem",
        "TemplateName": "demo_template",
        "SecurityIPList": "192.168.1.1,10.0.0.1",
        "DbInstances": [
          {
            "DBInstanceId": "cc-asdfwef"
          }
        ]
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息
400	InvalidParameter	Invalid parameter.
400	InvalidWhitelistTemplateId	Invalid Whitelist templateId.
400	InvalidWhitelistTemplate.IllegalPermission	No permission to operate the whitelist template.

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

变更历史

更多信息，参考变更详情。