查询服务实例状态 - GetIdentityCenterServiceStatus
功能介绍
查询IAM Identity Center服务实例状态信息。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
|
授权项 |
访问级别 |
资源类型（*为必须） |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
IdentityCenter:instance:getIdentityCenterStatus |
Read |
- |
- |
- |
organizations:delegatedAdministrators:list |
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/identity-center-service/status
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Security-Token |
否 |
String |
如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
serviceStatus |
String |
IAM身份中心服务实例状态 |
|
serviceStatusReasons |
Array of strings |
IAM身份中心服务实例状态呈现原因 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
request_id |
String |
请求唯一标识 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
request_id |
String |
请求唯一标识 |
|
encoded_authorization_message |
String |
加密的错误信息 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
request_id |
String |
请求唯一标识 |
请求示例
查询服务实例状态
GET https://{hostname}/v1/identity-center-service/status
响应示例
状态码：200
Successful
{
"serviceStatus" : "enable",
"serviceStatusReasons" : "success"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Successful |
|
400 |
Bad request |
|
403 |
Forbidden |
|
404 |
Not found |
错误码
请参见错误码。
