Help Center/ Workspace/ API Reference/ Workspace APIs/ Tenant Configuration/ Modifying NAT Mapping Configuration Items of a Tenant

Updated on 2026-02-10 GMT+08:00

View PDF

Modifying NAT Mapping Configuration Items of a Tenant

Function

Modifies NAT mapping configuration items of a tenant.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:natMappings:updateConfig	Write	-	-	-	-

URI

PUT /v2/{project_id}/nat-mapping-configs

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
site_id	No	String	Site ID.
nat_on	No	Boolean	Whether to enable NAT mapping.
nat_vag_maps	No	Array of UpdateNatMappingConfig objects	NAT mapping configurations.

**Table 3** UpdateNatMappingConfig
Parameter	Mandatory	Type	Description
nat_map_type	No	String	NAT mapping type. PORT: port mapping HOST: address mapping, allowing for a maximum of 10 addresses
nat_map_value	No	String	If nat_map_type is set to PORT, the value is 9443 or 9445. If nat_map_type is set to HOST, the value is the access address.
nat_ip	No	String	NAT IP address.
nat_port	No	String	NAT port. The value ranges from 0 to 65535.
vag_ip	No	String	vAG IP address.
access_filter_type	No	Integer	Whether the management of tags and enterprise projects is supported. 0: disabled; 1: enabled
enterprise_project_id	No	String	Enterprise project ID.
tags	No	Array of Tag objects	Tag object.

**Table 4** Tag
Parameter	Mandatory	Type	Description
key	Yes	String	Key of a tag, which cannot be empty and can contain a maximum of 128 Unicode characters. A key can contain letters, digits, spaces, and special characters (_.:=+-@), but cannot start or end with a space or start with *sys*.
value	No	String	Value of a tag, which can contain a maximum of 43 Unicode characters. A value can contain letters, digits, spaces, and special characters (_.:=+-@), but cannot start or end with a space.

Response Parameters

Status code: 204

Response to the request for modifying NAT mapping configuration items of a tenant.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

PUT /v2/fb2e5ec048384c8f9469d22db0037908/nat-mapping-configs

{
  "nat_on" : true,
  "nat_vag_maps" : [ {
    "nat_ip" : "0.0.0.0",
    "nat_port" : 0,
    "vag_ip" : "10.0.0.9"
  } ]
}

Example Responses

None

Status Codes

Status Code	Description
204	Response to the request for modifying NAT mapping configuration items of a tenant.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
500	An internal service error occurred. For details about the error code, see the error code description.