通过AttachWhitelistTemplateToInstance为实例关联白名单模板-云数据库ClickHouse-阿里云-云数据库 ClickHouse-阿里云帮助中心

白名单模板关联实例。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	RegionId	cn-hangzhou
TemplateId	string	是	白名单模板 Id	98a6d3db05984dca
DBInstanceId	string	是	数据库实例。逗号分隔，一次关联变更不超过 20 个	cc-nkhdbf1d,cc-nkhdbf1s

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	1234567890
Data	object	返回数据。
Status	string	操作状态。ok	ok
AttachFailList	array<object>	解绑失败实例
	object	实例解绑失败详情
DBInstanceId	string	实例名称	my-database
Reason	string	解绑失败原因	处理异常
AttachSuccessedList	array<object>	绑定成功模板
	array<object>	实例绑定成功详情
DBInstanceId	string	实例名称	my-database
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	asdfwef

示例

正常返回示例

JSON格式

{
  "RequestId": "1234567890",
  "Data": {
    "Status": "ok",
    "AttachFailList": [
      {
        "DBInstanceId": "my-database",
        "Reason": "处理异常"
      }
    ],
    "AttachSuccessedList": [
      {
        "DBInstanceId": "my-database",
        "Templates": [
          {
            "TemplateId": "g-asdfwem",
            "TemplateName": "demo_template",
            "SecurityIPList": "192.168.1.1,10.0.0.1",
            "DbInstances": [
              {
                "DBInstanceId": "asdfwef"
              }
            ]
          }
        ]
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息
400	InvalidParameter	Invalid parameter.
400	InvalidWhitelistTemplateId	Invalid Whitelist templateId.
400	InvalidWhitelistTemplate.IllegalPermission	No permission to operate the whitelist template.
400	InvalidDBInstanceId.TooManyItems	The number of DBInstanceId should be no more than 20.
400	InvalidParameter.DBInstanceId	The specified parameter DBInstanceId is not valid.
400	InvalidAttachTemplate.QuotaExceeded	Exceed the upper limit of the template that the instance can bind.

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

变更历史

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