Help Center/ Workspace/ API Reference/ Workspace APIs/ Network/ Enabling the Desktop Internet Access Function
Updated on 2026-02-10 GMT+08:00
View PDF
Share

Enabling the Desktop Internet Access Function

Function

Enable the desktop Internet access function.

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:createEips

    Write

    -

    -

    -
    • vpc:quotas:list
    • eip:publicIps:create
    • eip:publicIps:associateInstance

URI

POST /v2/{project_id}/eips

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

desktop_ids

No

Array of strings

IDs of desktops for which the Internet access function is to be enabled.

eip_type

Yes

String

For details about the supported types, see types supported by the eip service. You can call the API (https://support.huaweicloud.com/api-eip/ShowPublicIpType.html) for query.

eip_charge_mode

Yes

String

EIP bandwidth billing mode

  • TRAFFIC: billed by traffic

  • BANDWIDTH: billed by bandwidth

bandwidth_size

Yes

Integer

Specifies the bandwidth size in Mbit/s. The value ranges from 1 Mbit/s to 2000 Mbit/s by default. (The specific range may vary by region. You can see the available bandwidth range on the management console.)

enterprise_project_id

No

String

Enterprise project ID, which is 0 by default.

count

No

Integer

Number of EIPs to be purchased. This parameter is mandatory when desktop_ids is empty. This parameter is valid when EIPs are purchased separately.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

Status code: default

Table 4 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/eips

{
  "desktop_ids" : [ "90f05916-bc71-4e26-a534-d036188d96e3" ],
  "eip_charge_mode" : "string",
  "bandwidth_size" : 1,
  "eip_type" : "5_bgp"
}

Example Responses

Status code: 200

Response to the request for enabling the Internet access function.

{
  "job_id" : "fa9e41e1-1221-47c3-a43c-67a1271e2093"
}

Status Codes

Status Code

Description

200

Response to the request for enabling the Internet access function.

default

Default response.

Error Codes

See Error Codes.

Parent topic: Network