Updated on 2025-03-05 GMT+08:00

Binding an EIP

Function

This API enables you to access GES by binding an elastic IP (EIP).

URI

POST /v1.0/{project_id}/graphs/{graph_id}/action

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

graph_id

Yes

String

Graph ID

Table 2 Query parameters

Parameter

Mandatory

Type

Description

action_id

Yes

String

Graph action ID

Set this parameter to bindEip, which means that an EIP will be bound to the target graph.

Request Parameters

Table 3 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Used to obtain the permission to use APIs. For details about how to obtain the token, see Authentication of Management Plane APIs. The value of X-Subject-Token in the response header is the token.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

eipId

Yes

String

ID of the elastic IP address

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

errorMessage

String

System prompt.

  • If execution succeeds, this parameter may be left blank.
  • If execution fails, this parameter is used to display the error message.

errorCode

String

System prompt code.

  • If execution succeeds, this parameter may be left blank.
  • If execution fails, this parameter is used to display the error code.

Example Request

POST http://Endpoint/v1.0/{project_id}/graphs/{graph_id}/action?action_id=bindEip

{
  "eipId" : "02bd6dc1-5be8-430e-a4cd-2b0f6d0bb042"
}

Example Response

Status code: 200

OK

{ }

Status code: 400

Bad Request

{
  "errorMessage" : "graph [demo] is not found",
  "errorCode" : "GES.8011"
}

Status Code

Status Code

Description

200

Request sent.

400

Request error.

401

Authentication failed.

403

No operation permission.

404

No resources found.

500

Internal service error.

503

Service unavailable.