Help Center/ IAM Identity Center/ API Reference/ API/ Instance Management/ Querying Service Instance Status
Updated on 2025-08-21 GMT+08:00

Querying Service Instance Status

Function

This API is used to query the status of an IAM Identity Center service instance. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

GET /v1/identity-center-service/status

Request Parameters

Table 1 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Response Parameters

Status code: 200

Table 2 Parameters in the response body

Parameter

Type

Description

serviceStatus

String

IAM Identity Center service instance status.

serviceStatusReasons

Array of strings

Reason why the IAM Identity Center service instance is in a state.

Status code: 400

Table 3 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

Status code: 403

Table 4 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

encoded_authorization_message

String

Encrypted error message.

Status code: 404

Table 5 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

Example Request

Querying service instance status

GET https://{hostname}/v1/identity-center-service/status

Example Response

Status code: 200

Successful

{
  "serviceStatus" : "enable",
  "serviceStatusReasons" : "success"
}

Status Codes

Status Code

Description

200

Successful.

400

Bad request.

403

Forbidden.

404

Not found.

Error Codes

For details, see Error Codes.