DescribeWorkgroups API 概要：パラメータ、フィルター、応答 - SMC

作業グループが作成された後、作業グループ名、説明、アラート情報などの情報を表示できます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

smc:DescribeWorkgroups

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
WorkgroupId	array	任意	作業グループ ID のリスト。最大 50 個の作業グループ ID を指定できます。
	string	任意	作業グループ ID。	w-***
Name	string	任意	作業グループの名前。	test
Status	string	任意	作業グループのステータス。有効な値： NotStarted：作業グループは開始されていません。 InProgress：作業グループは進行中です。 Cutover：作業グループはカットオーバー中です。 Completed：作業グループは完了しています。	InProgress
PageNumber	integer	任意	作業グループリストのページ番号。値は 1 から始まります。デフォルト値：1。	1
PageSize	integer	任意	ページングクエリで各ページに返すエントリの数。最大値：50。デフォルト値：10。	10
Tag	array<object>	任意	タグの配列。配列には 1 ～ 20 個のタグを含めることができます。配列に複数のタグオブジェクトが含まれている場合、タグキーは同じにすることはできません。
	object	任意	タグオブジェクト。
Key	string	任意	作業グループのタグキー。キーは最大 128 文字までです。このパラメータを指定する場合、値を空の文字列にすることはできません。キーは `aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。	TestKey
Value	string	任意	作業グループのタグ値。値は最大 128 文字までです。このパラメータを指定する場合、値を空の文字列にすることができます。値には `http://` または `https://` を含めることはできません。	TestValue

レスポンスフィールド

フィールド	型	説明	例
	object	返されたパラメータ。
RequestId	string	リクエスト ID。	2D69A58F-345C-4FDE-88E4-BF518948****
TotalCount	integer	作業グループの総数。	1
PageSize	integer	各ページに返されるエントリの数。最大値：50。デフォルト値：10。	10
PageNumber	integer	作業グループリストのページ番号。	1
Workgroups	object
Workgroup	array<object>	作業グループの詳細。
	object	作業グループオブジェクト。
WorkgroupId	string	作業グループ ID。	w-***
Name	string	作業グループの名前。	testWorkgroupName
Description	string	作業グループの説明。	test
Status	string	作業グループのステータス。有効な値： NotStarted：作業グループは開始されていません。 InProgress：作業グループは進行中です。 Cutover：作業グループはカットオーバー中です。 Completed：作業グループは完了しています。	InProgress
Warnings	object
Warning	array<object>	作業グループのアラート情報のリスト。リストには複数のアラートタイプが含まれている場合があります。
	object	アラート情報。
WarningType	string	アラートタイプ。有効な値： InError：1 つ以上の移行タスクが失敗しました。 UnRelated：1 つ以上の移行元が移行タスクに関連付けられていません。 NotPassed：1 つ以上の移行タスク訓練が失敗しました。	InError
SourceIds	object
SourceId	array	問題のある移行元のリスト。
	string	問題のある移行元の ID。	s-bp1h7ymebl7swbt4****
Tags	object
Tag	array<object>	作業グループのタグ情報。
	object	作業グループのタグ情報。
Key	string	作業グループのタグキー。	TestKey
Value	string	作業グループのタグ値。	TestValue

例

成功レスポンス

JSONJSON

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "TotalCount": 1,
  "PageSize": 10,
  "PageNumber": 1,
  "Workgroups": {
    "Workgroup": [
      {
        "WorkgroupId": "w-***",
        "Name": "testWorkgroupName",
        "Description": "test",
        "Status": "InProgress",
        "Warnings": {
          "Warning": [
            {
              "WarningType": "InError",
              "SourceIds": {
                "SourceId": [
                  "s-bp1h7ymebl7swbt4****"
                ]
              }
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "Key": "\t\nTestKey",
              "Value": "TestValue"
            }
          ]
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	InternalError	An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.	リクエストの処理中にエラーが発生しました。もう一度お試しください。それでも問題が解決しない場合、チケットを起票してください。
403	Forbidden.Unauthorized	A required authorization for the specified action is not supplied.

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

変更履歴

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