DescribeOrgs - Cloud Phone - Alibaba Cloud Documentation Center

Queries organizations.

Operation description

An organization is in a tree structure. The root organization ID is in the following format: org-aliyun-wy-org-id.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ecd:DescribeOrgs	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
MaxResults	long	No	The maximum number of entries to return. Valid values: 1 to 100. Default value: 100.	20
NextToken	string	No	The token that determines the start point of the query. The return value is the value of the NextToken response parameter that was returned last time the DescribeOrgs operation was called.	AAAAAV3MpHK****
OrgName	string	No	The name of the organization.	org****
ParentOrgId	string	No	The parent organization ID.	org-****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0B4BB****
NextToken	string	The token that determines the start point of the query. The return value is the value of the NextToken response parameter that was returned last time the DescribeOrgs operation was called.	AAAAAV3MpHK****
Orgs	array<object>	The organizations.
data	object
OrgName	string	The name of the organizational unit.	org****
OrgId	string	The organization ID.	org-****
ParentOrgId	string	The parent organization ID.	org-****

Examples

Sample success responses

JSONformat

{
  "RequestId": "0B4BB****",
  "NextToken": "AAAAAV3MpHK****",
  "Orgs": [
    {
      "OrgName": "org****",
      "OrgId": "org-****",
      "ParentOrgId": "org-****"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.