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

Updated on 2025-07-14 GMT+08:00

View PDF

Querying NAT Mapping Configuration Items of a Tenant

Queries NAT mapping configuration items of a tenant.

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

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

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
site_id	No	String	Site ID.

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	Yes	String	MIME type of the request body.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
site_id	String	Site ID.
nat_on	Boolean	Whether to enable NAT mapping.
vag_ips	Array of strings	vAG IP addresses.
nat_vag_maps	Array of NatMappingConfig objects	NAT mapping configurations.

**Table 5** NatMappingConfig
Parameter	Type	Description
nat_map_type	String	NAT mapping type. PORT: port mapping HOST: address mapping
nat_map_value	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	String	NAT IP address.
nat_port	String	NAT port.
vag_ip	String	vAG IP address.
vag_port	String	vAG port.
access_filter_type	Integer	Whether the management of tags and enterprise projects is supported. 0: disabled; 1: enabled
enterprise_project_id	String	Enterprise project ID.
tags	Array of Tag objects	Tag object.

**Table 6** Tag
Parameter	Type	Description
key	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	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.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
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 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
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 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
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 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
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 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

GET /v2/fb2e5ec048384c8f9469d22db0037908/nat-mapping-configs

Status code: 200

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

{
  "site_id" : "0e2dae94-23ff-449a-bb9c-1b808cf2106d"
}

Status Code	Description
200	Response to the request for querying 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, see the error code description.