Help Center/ Workspace/ API Reference/ Workspace APIs/ Network/ Querying Network Access

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

View PDF

Querying Network Access

Function

Queries network access.

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:networks:listNats	List	-	-	-	vpc:subnets:get vpc:vpcs:get nat:snatRules:list nat:natGateways:list

URI

GET /v2/{project_id}/internet

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID.
nat_name	No	String	NAT gateway name.
eip	No	String	EIP.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
internet_infos	Array of InternetInfo objects	Network access information.

**Table 4** InternetInfo
Parameter	Type	Description
vpc_name	String	VPC name.
subnet_id	String	Subnet ID.
subnet_name	String	Subnet name.
nat_id	String	NAT gateway ID.
nat_name	String	NAT gateway name.
eip	String	EIP.
created_at	String	Creation time.
status	String	Status.
enterprise_project_id	String	Enterprise project ID.

Status code: default

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
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

None

Example Responses

Status code: 200

Response to the request for querying network access.

{
  "internet_infos" : [ {
    "vpc_name" : "string",
    "subnet_id" : "string",
    "subnet_name" : "string",
    "nat_id" : "string",
    "nat_name" : "string",
    "eip" : "string",
    "created_at" : "string",
    "status" : "string",
    "enterprise_project_id" : "string"
  } ]
}