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

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

View PDF

Enabling Network Access

Function

Enables 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:createNat	Write	-	-	-	vpc:ports:delete vpc:ports:get vpc:networks:get eip:publicIps:create eip:publicIps:update eip:publicIps:delete nat:snatRules:list nat:snatRules:create nat:natGateways:list nat:natGateways:create

URI

POST /v2/{project_id}/internet

**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
nat_spec	Yes	String	Public NAT gateway specifications. 1: small; 2: medium; 3: large; 4: extra-large.
eip_charge_mode	Yes	String	Billed by traffic or bandwidth.
bandwidth_size	Yes	Integer	Bandwidth size.
eip_type	No	String	EIP type. Options: 5_bgp (default, dynamic BGP) and 5_sbgp (static BGP)(tag:HWS).
vpc_id	Yes	String	VPC ID.
subnet_id	Yes	String	Subnet ID.
enterprise_project_id	No	String	Enterprise project ID, which is 0 by default.
nat_id	No	String	NAT gateway ID. If the ID is specified, the corresponding NAT gateway is used. If not, create one.
nat_name	No	String	NAT gateway name, which defaults to nat-workspace.
eip_name	No	String	EIP name, which defaults to eip-workspace.

Response Parameters

Status code: 200

Response to the request for enabling network access.

Status code: default

**Table 3** 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

/v2/0e69423d4400f4a82f67c0059a1e4cc8/internet

{
  "nat_spec" : "string",
  "eip_charge_mode" : "string",
  "bandwidth_size" : 1,
  "eip_type" : "string",
  "vpc_id" : "string",
  "subnet_id" : "string",
  "enterprise_project_id" : "string",
  "nat_name" : "string",
  "eip_name" : "string"
}