All Products
Search
Document Center

Hologres:RestartInstance

Last Updated:Feb 21, 2024

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
hologram:RestartInstanceWrite
  • All Resources
    *
    none
none

Request syntax

POST /api/v1/instances/{instanceId}/restart

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringNo

The instance ID.

hgprecn-cn-i7m2ucpyu005

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

36291497-CDB0-53DC-8CD7-762E054F57A6
Databoolean

Indicates whether the operation was successful.

Valid values:

  • true

  • false

true
Successboolean

The request result, which indicates whether the request was successful.

true
ErrorCodestring

The error code returned if the request failed.

404
ErrorMessagestring

The error message returned if the request failed.

Internal server error.
HttpStatusCodestring

The HTTP status code.

200

Examples

Sample success responses

JSONformat

{
  "RequestId": "36291497-CDB0-53DC-8CD7-762E054F57A6",
  "Data": true,
  "Success": true,
  "ErrorCode": "404",
  "ErrorMessage": "Internal server error.",
  "HttpStatusCode": "200"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-04-26The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: RegionId