ListRamUsers-阿里云帮助中心

Lists RAM users that have not been imported into a specified instance.

Operation description

A Resource Access Management (RAM) user can be imported as an agent into multiple Cloud Contact Center (CCC) instances. However, an agent can be associated with only one RAM account. When you create an agent in a CCC instance, a corresponding RAM account is also created. To avoid creating redundant RAM accounts when you set up a new instance, you can call the ListRamUsers operation to list RAM users that have not been imported into the instance. You can then call the operation that imports RAM users to add them to the new instance. This prevents creating unnecessary RAM accounts and conserves resources.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	ccc-test
SearchPattern	string	No	The keyword to use for a fuzzy search based on the RAM user's logon name or display name. This parameter is optional. If you leave this parameter empty, no filtering is applied.	agent
PageNumber	integer	Yes	The page number of the results to return. Valid values: 1 to 1,000.	1
PageSize	integer	Yes	The number of entries to return on each page. Valid values: 1 to 100.	10

Response elements

Element	Type	Description	Example
	object
Code	string	The response code.	OK
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The response message.	无
RequestId	string	The ID of the request.	24753D71-C91D-1A38-A8AD-372BF12453F6
Data	object	The data returned.
PageNumber	integer	The returned page number.	1
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of entries.	100
List	array<object>	A list of RAM users.
	object	The details of a RAM user.
DisplayName	string	The display name of the RAM user.	测试账号
Email	string	The email address of the RAM user.	username@example.com
LoginName	string	The logon name of the RAM user.	agent
Mobile	string	The mobile number of the RAM user.	1382114****
AliyunUid	integer	The UID of the Alibaba Cloud account to which the RAM user belongs.	15772400000****
Primary	boolean	Indicates whether the user is a primary account. A value of `false` indicates that the user is a RAM user.	false
RamId	string	The ID of the RAM user.	28036411123456****
Params	array	The response parameters.
	string	A response parameter.	无

Examples

Success response

JSON format

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "24753D71-C91D-1A38-A8AD-372BF12453F6",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "List": [
      {
        "DisplayName": "测试账号",
        "Email": "username@example.com",
        "LoginName": "agent",
        "Mobile": "1382114****",
        "AliyunUid": 0,
        "Primary": false,
        "RamId": "28036411123456****"
      }
    ]
  },
  "Params": [
    "无"
  ]
}

Error codes

HTTP status code	Error code	Error message
400	Parameter.Maximum	The parameter %s must be less than or equal to %s.
400	Parameter.Minimum	The parameter %s must be greater than or equal to %s.
404	NotExists.InstanceId	The specified instance %s does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.