CreatePrivateAccessApplication-阿里云帮助中心

Creates a private access application for the current Alibaba Cloud account.

Operation description

You can create up to 500 private access applications by default.

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

csas:CreatePrivateAccessApplication

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the private access application. The name must be 1 to 128 characters in length. It can contain Chinese characters, letters, digits, periods (.), underscores (_), and hyphens (-).	private_access_application_name
Description	string	No	The description of the private access application. The description must be 1 to 128 characters in length. It can contain Chinese characters, letters, digits, periods (.), underscores (_), hyphens (-), and spaces.	这是一条内网访问应用
Addresses	array	Yes	A collection of addresses for the private access application. You can enter up to 1,000 addresses.
	string	Yes	The address of the private access application. The address must be 1 to 128 characters in length. It can be an IPv4 address, a CIDR block, a domain name, or a wildcard domain name.	192.168.0.0/16
PortRanges	array<object>	Yes	A collection of port ranges for the private access application. You can enter up to 65,535 port ranges. The port ranges cannot be repeated or overlap.
	object	Yes	The port range for the private access application. Valid values: 1 to 65535.
Begin	integer	Yes	The start port. The value must be less than or equal to the end port.	80
End	integer	Yes	The end port. The value must be greater than or equal to the start port.	81
Protocol	string	Yes	The protocol for the private access application. Valid values: All: All protocols. TCP UDP	All
Status	string	Yes	The status of the private access application. Valid values: Enabled: The application is enabled. Disabled: The application is disabled. Valid values: Enabled : enabled Disabled : shutdown	Enabled
TagIds	array	No	A collection of private access tag IDs. A private access application can be associated with up to six custom private access tags.
	string	No	The private access tag ID. You can call the following operations to obtain the tag ID: ListPrivateAccessTags: Queries a list of private access tags. CreatePrivateAccessTag: Creates a private access tag.	tag-d3f64e8bdd4a****
BrowserAccessStatus	string	No	The status of browser-based access. If you enable this feature, you can access the application through a browser without a client. The default value is Disabled. Valid values: Enabled: Enables browser-based access. Disabled: Disables browser-based access.	Disabled
L7ProxyDomainAutomaticPrefix	string	No	A parameter for browser-based access: the prefix of the mapped proxy domain name. The prefix must be 3 to 20 characters in length and can contain lowercase letters, digits, and hyphens (-).	app-sample
L7ProxyDomainCustom	string	No	A parameter for browser-based access: the custom proxy domain name. The domain name must be a valid domain name.	app1.example.com
L7Config	PAL7Config	No	A parameter for browser-based access: the application configuration.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	BE4FB974-11BC-5453-9BE1-1606A73EACA6
ApplicationId	string	The ID of the private access application.	pa-application-e12860ef6c48****

Examples

Success response

JSON format

{
  "RequestId": "BE4FB974-11BC-5453-9BE1-1606A73EACA6",
  "ApplicationId": "pa-application-e12860ef6c48****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.