ListGroups API 概要 - Security Center - Alibaba Cloud - Security Center

現在のユーザーのサーバーグループリストを取得します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-sas:ListGroups

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Lang	string	任意	リクエストおよび応答メッセージの言語タイプ。デフォルト値: zh。有効な値: zh: 中国語 en: 英語。	zh
CurrentPage	integer	任意	返す現在のページのページ番号。最小値: 1。デフォルト値: 1。	89
PageSize	integer	任意	ページングクエリで各ページに返すエントリの最大数。デフォルト値: 20。最大値: 2000。	10
NextToken	string	任意	次のクエリ用のトークン。NextToken が空の場合、追加の結果は存在しません。NextToken に値がある場合、その値は次のクエリに使用するトークンを示します。	1426C575705AE8545E8360A6EFA3B***
UseNextToken	boolean	任意	NextToken メソッドを使用して脆弱性リストデータを取得するかどうかを指定します。このパラメーターを使用すると、TotalCount は返されなくなります。有効な値: true: NextToken メソッドを使用します。 false: NextToken メソッドを使用しません。	true

レスポンスフィールド

フィールド	型	説明	例
	object	PageResult。
List	array<object>	サーバーグループのリスト。
	object	サーバーグループ。
GroupId	integer	サーバーグループの ID。	11028542
GroupName	string	サーバーグループの名前。	cn-shenzhen+dir-1440978***
GroupFlag	integer	サーバーグループのタイプ。有効な値: 0: デフォルトグループ 1: その他のグループ。	1
PageInfo	object	クエリ結果のページネーション情報。
CurrentPage	integer	ページングクエリにおける現在のページのページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。	10
TotalCount	integer	返されたエントリの総数。	202
Count	integer	現在のページで返されたエントリ数。	4
NextToken	string	NextToken メソッドを使用した場合に返される NextToken の値。	B604532DEF982B875E8360A6EFA3B***
Success	boolean	例外イベントが処理されたかどうかを示します。有効な値: true: 処理済み。 false: 未処理。	true
Code	string	API リクエストによって返された状態コード。	200
Message	string	エラーコードの詳細情報。	successful
RequestId	string	リクエストの ID。Alibaba Cloud は各リクエストに一意の識別子を生成します。これはトラブルシューティングや診断に使用できます。	CB414DB5-F692-5DAB-9F0F-975C060AF***
HttpStatusCode	integer	HTTP 状態コード。	200

例

成功レスポンス

JSONJSON

{
  "List": [
    {
      "GroupId": 11028542,
      "GroupName": "cn-shenzhen+dir-1440978***",
      "GroupFlag": 1
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 10,
    "TotalCount": 202,
    "Count": 4,
    "NextToken": "B604532DEF982B875E8360A6EFA3B***"
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "CB414DB5-F692-5DAB-9F0F-975C060AF***",
  "HttpStatusCode": 200
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	ServerError	ServerError
403	NoPermission	caller has no permission

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

変更履歴

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