DescribeWorkgroups - - Alibaba Cloud Dokümantasyon Merkezi

Bir çalışma grubu oluşturulduktan sonra, çalışma grubu adı, açıklaması ve uyarı bilgileri gibi bilgilerini görüntüleyebilirsiniz.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

smc:DescribeWorkgroups

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
WorkgroupId	array	No	Çalışma grubu kimliklerinin listesi. En fazla 50 çalışma grubu kimliği belirtebilirsiniz.
	string	No	Çalışma grubu kimliği.	w-***
Name	string	No	Çalışma grubunun adı.	test
Status	string	No	Çalışma grubunun durumu. Geçerli değerler: NotStarted: Çalışma grubu başlatılmamış. InProgress: Çalışma grubu devam ediyor. Cutover: Çalışma grubu geçiş aşamasında. Completed: Çalışma grubu tamamlanmış.	InProgress
PageNumber	integer	No	Çalışma grubu listesinin sayfa numarası. Değer 1'den başlar. Varsayılan değer: 1.	1
PageSize	integer	No	Sayfalanmış bir sorgu için her sayfada döndürülecek giriş sayısı. Maksimum değer: 50. Varsayılan değer: 10.	10
Tag	array<object>	No	Etiket dizisi. Dizi 1 ila 20 etiket içerebilir. Dizi birden fazla etiket nesnesi içeriyorsa, etiket anahtarları aynı olamaz.
	object	No	Etiket nesnesi.
Key	string	No	Çalışma grubunun etiket anahtarı. Anahtar en fazla 128 karakter uzunluğunda olabilir. Bu parametreyi belirtirseniz değer boş bir dize olamaz. Anahtar aliyun veya acs: ile başlayamaz ve http:// veya https:// içeremez.	TestKey
Value	string	No	Çalışma grubunun etiket değeri. Değer en fazla 128 karakter uzunluğunda olabilir. Bu parametreyi belirtirseniz değer boş bir dize olabilir. Değer http:// veya https:// içeremez.	TestValue

Response elements

Element	Type	Description	Example
	object	Döndürülen parametreler.
RequestId	string	İstek kimliği.	2D69A58F-345C-4FDE-88E4-BF518948****
TotalCount	integer	Toplam çalışma grubu sayısı.	1
PageSize	integer	Her sayfada döndürülen giriş sayısı. Maksimum değer: 50. Varsayılan değer: 10.	10
PageNumber	integer	Çalışma grubu listesinin sayfa numarası.	1
Workgroups	object
Workgroup	array<object>	Çalışma gruplarının ayrıntıları.
	array<object>	Çalışma grubu nesnesi.
WorkgroupId	string	Çalışma grubu kimliği.	w-***
Name	string	Çalışma grubunun adı.	testWorkgroupName
Description	string	Çalışma grubunun açıklaması.	test
Status	string	Çalışma grubunun durumu. Olası değerler: NotStarted: Çalışma grubu başlatılmamış. InProgress: Çalışma grubu devam ediyor. Cutover: Çalışma grubu geçiş aşamasında. Completed: Çalışma grubu tamamlanmış.	InProgress
Warnings	object
Warning	array<object>	Çalışma grubu için uyarı bilgilerinin listesi. Liste birden fazla uyarı türü içerebilir.
	array<object>	Uyarı bilgileri.
WarningType	string	Uyarı türü. Olası değerler: InError: Bir veya daha fazla geçiş görevi başarısız oldu. UnRelated: Bir veya daha fazla geçiş kaynağı geçiş görevleriyle ilişkilendirilmemiş. NotPassed: Bir veya daha fazla geçiş görevi denemesi başarısız oldu.	InError
SourceIds	object
SourceId	array	Sorunlu geçiş kaynaklarının listesi.
	string	Sorunlu geçiş kaynağının kimliği.	s-bp1h7ymebl7swbt4****
Tags	object
Tag	array<object>	Çalışma grubunun etiket bilgileri.
	object	Çalışma grubunun etiket bilgileri.
Key	string	Çalışma grubunun etiket anahtarı.	TestKey
Value	string	Çalışma grubunun etiket değeri.	TestValue

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.	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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.