DescribeOrgs API Overview for Cloud Phone Organizations - Cloud Phone - Alibaba Cloud - Cloud Phone

Queries a list of organizations.

Operation description

Organizations are arranged in a tree-like structure. The root organization ID is org-aliyun-wy-org-id.

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

ecd:DescribeOrgs

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MaxResults	integer	No	The maximum number of entries to return. Valid values: 1 to 100. Default value: 100.	20
NextToken	string	No	The pagination token. To retrieve the next page of results, set this parameter to the `NextToken` value that was returned from a previous request.	AAAAAV3MpHK****
OrgName	string	No	The organization name.	产品部
ParentOrgId	string	No	The parent organization ID.	org-11fs****
ShowExtras	object	No
	any	No
BusinessChannel	string	No	The channel.	ENTERPRISE

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	0B4BB****
NextToken	string	The token used to retrieve the next page of results. If this parameter is not empty, more results are available. To retrieve the next page, pass this value in the `NextToken` parameter of a subsequent request.	AAAAAV3MpHK****
Orgs	array<object>	The organization list.
	array<object>	The organization details.
OrgName	string	The organization name.	设计部****
OrgId	string	The organization ID.	org-1mox****
ParentOrgId	string	The parent organization ID.	org-ezqr****
OrgNamePath	string
ResourcePolicyList	array<object>
	object
PolicyId	string
PolicyName	string

Examples

Success response

JSON format

{
  "RequestId": "0B4BB****",
  "NextToken": "AAAAAV3MpHK****",
  "Orgs": [
    {
      "OrgName": "设计部****",
      "OrgId": "org-1mox****",
      "ParentOrgId": "org-ezqr****",
      "OrgNamePath": "",
      "ResourcePolicyList": [
        {
          "PolicyId": "",
          "PolicyName": ""
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.