CreateWhitelistTemplate-阿里云帮助中心

Creates a whitelist template.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

clickhouse:CreateWhitelistTemplate

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
TemplateName	string	Yes	The name of the whitelist template.	InvoiceTemplate
SecurityIPList	string	Yes	The IP addresses in the whitelist. Separate multiple IP addresses with commas (,). You can add up to 100 IP addresses.	192.168.1.1,10.0.0.1

Response elements

Element	Type	Description	Example
	object	Schema of response.
RequestId	string	The request ID.	1234567890
Data	object	The returned data.
Templates	array<object>	The list of whitelist templates.
	object	The details of the template.
TemplateId	string	The ID of the whitelist template.	g-asdfwem
TemplateName	string	The name of the whitelist template.	demo_template
SecurityIPList	string	The list of IP addresses in the whitelist.	192.168.1.1,10.0.0.1

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
400	InvalidSecurityIPs.Malformed	Specified IPList is not valid.
400	InvalidParameter	Invalid parameter.
400	InvalidWhitelistTemplateName.Duplicated	Whitelist template name duplicated.
400	InvalidSecurityIPList.QuotaExceeded	Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.
400	InvalidSecurityIPList.Format	Specified security IP list format is not valid.
400	InvalidWhitelistTemplateName.CreateLimit	Created Whitelist template name exceeded limit.
400	InvalidIpWhitelistTemplateName.Malformed	The templateName is not valid.
400	InvalidSecurityIPList.Duplicate	Specified security IP list is not valid: Duplicate IP address in the list
400	InvalidUser.NotFound	Specified user does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.