すべてのプロダクト
Search
ドキュメントセンター

:GetServiceStatus

最終更新日:Dec 20, 2025

CloudSSO のステータスを照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cloudsso:GetServiceStatus

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド

説明

object

レスポンスパラメーター。

RequestId

string

リクエスト ID。

ADADC31D-90EE-5459-99B0-D83DF07769A3

ServiceStatus

object

CloudSSO のステータス情報。

Status

string

CloudSSO が有効化されているかどうかを示します。有効な値:

  • Enabled

  • Disabled

Enabled

AccountId

string

ご利用の Alibaba Cloud アカウントの ID。

151266687691****

PrerequisiteCheckResult

string

CloudSSO を有効化する権限があるかどうかを示します。有効な値:

  • Success:CloudSSO を有効化する権限があります。

  • Failed:CloudSSO を有効化する権限がありません。

説明

このパラメーターは、Status の値が Disabled の場合にのみ返されます。

Success

RegionsInUse

array

リージョン ID。

string

リージョン ID。有効な値:

  • ディレクトリが作成されている場合、このパラメーターの値はディレクトリのリージョン ID です。

  • ディレクトリが作成されていない場合、このパラメーターは空です。

説明

このパラメーターは、Status の値が Enabled の場合にのみ返されます。

cn-shanghai

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。