All Products
Search
Document Center

Hologres:UpdateInstancePort

Last Updated:May 21, 2026

Updates the port of an instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST /api/v1/instances/{instanceId}/updatePort HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example

instanceId

string

No

The instance ID.

hgprecn-cn-i7m2v08uxxx

Request parameters

Parameter

Type

Required

Description

Example

body

object

No

The request body.

port

integer

No

The port of the instance. Valid values: 1 to 65535.

443

Response elements

Element

Type

Description

Example

object

The data returned.

RequestId

string

The request ID.

D1303CD4-AA70-5998-8025-F55B22C50840

data

boolean

The result of the operation. A value of true indicates that the operation is successful. A value of false indicates that the operation fails.

true

Success

string

Indicates whether the request was successful. This parameter is independent of the result of the operation.

true

ErrorCode

string

The error code.

null

ErrorMessage

string

The error message.

null

HttpStatusCode

string

The HTTP status code.

200

Examples

Success response

JSON format

{
  "RequestId": "D1303CD4-AA70-5998-8025-F55B22C50840",
  "data": true,
  "Success": "true",
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.