Queries the status of CloudSSO.

Limits

You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetServiceStatus

The operation that you want to perform. Set the value to GetServiceStatus.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String ADADC31D-90EE-5459-99B0-D83DF07769A3

The ID of the request.

ServiceStatus Object

The status information of CloudSSO.

Status String Enabled

Indicates whether CloudSSO is enabled. Valid values:

  • Enabled
  • Disabled
AccountId String 151266687691****

The ID of your Alibaba Cloud account.

PrerequisiteCheckResult String Success

Indicates whether you have permissions to enable CloudSSO. Valid values:

  • Success: You have permissions to enable CloudSSO.
  • Failed: You do not have permissions to enable CloudSSO.
Note The value of this parameter is returned only if the value of Status is Disabled.
RegionsInUse Array of String cn-shanghai

The ID of the region. Valid values:

  • If a directory is created, the value of this parameter is the region ID of the directory.
  • If no directory is created, this parameter is empty.
Note The value of this parameter is returned only if the value of Status is Enabled.

Examples

Sample requests

https://[Endpoint]/?Action=GetServiceStatus
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetServiceStatusResponse>
    <RequestId>ADADC31D-90EE-5459-99B0-D83DF07769A3</RequestId>
    <ServiceStatus>
        <Status>Enabled</Status>
        <AccountId>151266687691****</AccountId>
        <RegionsInUse>cn-shanghai</RegionsInUse>
    </ServiceStatus>
</GetServiceStatusResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.