ModifyClientUserDNS - Smart Access Gateway - Alibaba Cloud Documentation Center

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 support 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

smartag:ModifyClientUserDNS

update

*SmartAccessGateway

acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Smart Access Gateway app instance.	cn-shanghai
SmartAGId	string	Yes	The ID of the Smart Access Gateway app instance.	sag-9uyg53s6juhpxv****
AppDNS	array	No	The IP addresses of the primary and secondary DNS servers that the client uses when it connects to a private network. Note If the client uses PrivateZone to access Alibaba Cloud, the DNS server IP addresses are 100.100.2.136 and 100.100.2.138. DNS configuration is supported only on Android and macOS clients, version 2.1.1 or later. This parameter is optional. If you do not specify this parameter, the system deletes the existing DNS configuration.	100.XX.XX.100
	string	No	The IP address of a DNS server.	100.100.2.136
RecoveredDNS	array	No	The IP addresses of the primary and secondary DNS servers to use after the client disconnects from the private network. Note This feature is not yet available.	100.XX.XX.110
	string	No	The IP address of a DNS server.	100.100.2.138

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	BFE2D0C0-B69F-422D-A8A3-928AD511B471

Examples

Success response

JSON format

{
  "RequestId": "BFE2D0C0-B69F-422D-A8A3-928AD511B471"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam.Ip	The specified IP address is invalid.	The specified IP address is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.