调用GetServiceStatus查询云SSO状态_云SSO(CloudSSO)-阿里云帮助中心

调用GetServiceStatus查询云SSO状态。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cloudsso:GetServiceStatus	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	ADADC31D-90EE-5459-99B0-D83DF07769A3
ServiceStatus	object	云 SSO 状态。
Status	string	云 SSO 开通状态。取值： Enabled：开通。 Disabled：关闭。	Enabled
AccountId	string	阿里云账号 ID。	151266687691****
PrerequisiteCheckResult	string	检查是否满足云 SSO 的开通条件。取值： Success：满足。 Failed：不满足。说明当`Status`为`Disabled`时，返回该参数。	Success
RegionsInUse	array	地域 ID。
	string	地域 ID。取值：如果已创建目录，该参数为目录所在的地域 ID。如果未创建目录，该参数为空。说明当`Status`为`Enabled`时，返回该参数。	cn-shanghai

示例

正常返回示例

JSON格式

{
  "RequestId": "ADADC31D-90EE-5459-99B0-D83DF07769A3",
  "ServiceStatus": {
    "Status": "Enabled",
    "AccountId": "151266687691****",
    "PrerequisiteCheckResult": "Success",
    "RegionsInUse": [
      "cn-shanghai"
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史