All Products
Search
Document Center

CloudSSO:GetServiceStatus

Last Updated:Jun 14, 2024

Queries the status of CloudSSO.

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
cloudsso:GetServiceStatusRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

ADADC31D-90EE-5459-99B0-D83DF07769A3
ServiceStatusobject

The status information of CloudSSO.

Statusstring

Indicates whether CloudSSO is enabled. Valid values:

  • Enabled
  • Disabled
Enabled
AccountIdstring

The ID of your Alibaba Cloud account.

151266687691****
PrerequisiteCheckResultstring

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.
Success
RegionsInUsearray

The ID of the region.

string

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.
cn-shanghai

Examples

Sample success responses

JSONformat

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

Error codes

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