GetDirectoryStatistics で CloudSSO ディレクトリ指標を監視 - CloudSSO

ディレクトリの統計情報をクエリします。

操作説明

このトピックでは、ID が d-00fc2p61**** のディレクトリの統計情報をクエリする方法の例を示します。統計情報には、ユーザー数、ユーザーのクォータ、グループ数、グループのクォータ、アクセス構成数、アクセス構成のクォータ、割り当てられたアクセス権限の数、アクセス構成に設定可能なシステムポリシーの数、System for Cross-domain Identity Management (SCIM) 認証情報の数、非同期タスクの数、シングルサインオン (SSO) ログインのステータス、SCIM 同期のステータスが含まれます。

今すぐお試しください

この 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:GetDirectoryStatistics

get

*Directory

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DirectoryId	string	必須	ディレクトリの ID。	d-00fc2p61****

共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	7B7228B0-A435-5D27-A6B2-ED3571F0654B
DirectoryStatistics	object	ディレクトリの統計情報。
UserCount	integer	ユーザー数。	16
GroupCount	integer	ユーザーグループ数。	4
UserQuota	integer	ユーザーのクォータ。	1000
GroupQuota	integer	ユーザーグループのクォータ。	500
AccessConfigurationQuota	integer	アクセス構成のクォータ。	1000
AccessAssignmentCount	integer	割り当てられているアクセス権限の数。	5
SCIMServerCredentialCount	integer	SCIM 認証情報の数。	2
DirectoryId	string	ディレクトリの ID。	d-00fc2p61****
SSOEnabled	boolean	シングルサインオン (SSO) が有効かどうかを示します。有効な値： true false	false
Region	string	ディレクトリのリージョン ID。	cn-shanghai
AccessConfigurationCount	integer	アクセス構成の数。	6
DirectoryName	string	ディレクトリの名前。	new-example
InProgressTaskCount	integer	実行中のタスクの数。	0
SCIMSyncEnabled	boolean	SCIM 同期が有効かどうかを示します。有効な値： true false	true
SystemPolicyPerAccessConfigurationQuota	integer	アクセス構成に設定できるシステムポリシーのクォータ。	20
InlinePolicyPerAccessConfigurationQuota	integer	アクセス構成に設定できるインラインポリシーの数。	1

例

成功レスポンス

JSONJSON

{
  "RequestId": "7B7228B0-A435-5D27-A6B2-ED3571F0654B",
  "DirectoryStatistics": {
    "UserCount": 16,
    "GroupCount": 4,
    "UserQuota": 1000,
    "GroupQuota": 500,
    "AccessConfigurationQuota": 1000,
    "AccessAssignmentCount": 5,
    "SCIMServerCredentialCount": 2,
    "DirectoryId": "d-00fc2p61****",
    "SSOEnabled": false,
    "Region": "cn-shanghai",
    "AccessConfigurationCount": 6,
    "DirectoryName": "new-example",
    "InProgressTaskCount": 0,
    "SCIMSyncEnabled": true,
    "SystemPolicyPerAccessConfigurationQuota": 20,
    "InlinePolicyPerAccessConfigurationQuota": 1
  }
}

エラーコード

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

変更履歴

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