ListPolicyGroups - Cloud Phone - Alibaba Cloud Documentation Center

Queries policies.

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
PolicyGroupIds	array	No	The IDs of the policies.
	string	No	The ID of the policy.	pg-jc31jdxfdcsclk****
PolicyGroupName	string	No	The name of the policy.	默认策略
MaxResults	integer	No	The maximum number of entries per page. Value range: 1 to 100. Default value: 20.	20
NextToken	string	No	The pagination token that is used in the request to retrieve a new page of results. If the parameter is left empty, the data is queried from the first entry.	AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****
PolicyType	string	No	The policy type. Valid values: Instance : Instance Node : Node	Instance

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	7B9EFA4F-4305-5968-BAEE-BD8B8DE5****
TotalCount	integer	The total number of entries returned.	31
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.	AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****
PolicyGroupModel	array<object>	The policies.
	array<object>
PolicyGroupId	string	The ID of the policy.	pg-9q6o8qpiy8opkj****
PolicyGroupName	string	The name of the policy.	默认策略。
GmtCreate	string	The time when the policy was created.	2024-06-04 10:28:54
Clipboard	string	The read/write permissions on the clipboard. Valid values: read : Read-only. readwrite : Read and write. off : Read/write disabled.	readwrite
Html5FileTransfer	string	The file transfer policy of the HTML5 client. Valid values: all : File upload and download are supported. download : Only file download is supported. upload : Only file upload is supported. off : File upload or download is forbidden.	download
CameraRedirect	string	Specifies whether to enable the webcam redirection feature. Valid values: off : Disables the feature. on : Enables the feature.	on
LocalDrive	string	The read/write permissions on the on-premises drive. Valid values: read : Read-only. readwrite : Read and write. off : Read/write denied.	off
LockResolution	string	Identifies whether the resolution is locked. Valid values: off : Does not lock the resolution. on : Locks the resolution.	off
NetRedirectPolicy	object	The network redirection policy.
NetRedirect	string	Indicates whether the network redirection feature is enabled. When this feature is enabled, network traffic is automatically redirected to the on-premises network by default. Valid values: off : Disables the feature. on : Enables the feature.	off
CustomProxy	string	Indicates whether to manually configure a custom proxy. Valid values: off : No on : Yes	off
ProxyType	string	The type of the proxy protocol. Valid values: socks5 : socks5	socks5
HostAddr	string	The IPv4 address of the custom proxy.	47.100.XX.XX
Port	string	The port of the custom proxy. Valid values: 1 to 65535.	1145
ProxyUserName	string	The username of the proxy. The name must be 1 to 256 in length and cannot contain Chinese character or space characters.	username
ProxyPassword	string	The password of the proxy. The password must be 1 to 256 in length and cannot contain Chinese character or space characters.	password
Rules	array<object>	The proxy rules.
	object	The proxy rule.
Target	string	The name of the application package or domain name.	*.baidu.com
RuleType	string	The type of the rule. Valid values: prc : An application package name. domain : A domain name.	domain
SessionResolutionHeight	integer	The height of the resolution.	1080
SessionResolutionWidth	integer	The width of the resolution.	1920
PolicyRelatedResources	object	The resources associated with the policy.
AndroidInstanceGroupIds	array	The instance group IDs.
	string	The instance group ID.	ag-2dzpub83srxt*****
CloudPhoneMatrixIds	array	The matrix IDs.
	string	The matrix ID.	cpn-3dskdfjj245s*****
Watermark	object	The screen watermark.
WatermarkSwitch	string	Specifies whether to enable the screen watermark. Valid values: off : Disable on : Enable	off
WatermarkTypes	array	The content of the screen watermark.
	string	The content of the screen watermark. Valid values: Username : Username CustomText : Custom text ClientIpAddress : Client IP address IpAddress : IP address ClientTime : Current time	Username
WatermarkCustomText	string	The custom text for the watermark. The text can be up to 10 characters in length and cannot contain emoji characters.	custom text
WatermarkFontSize	integer	The font size of the watermark. Valid values: 10 to 20.	12
WatermarkColor	integer	The font color of the watermark. Valid values: 0 to 16777215.	0
WatermarkTransparencyValue	integer	The opacity of the watermark. A larger value makes the watermark more opaque. Valid values: 10 to 100.	25

Examples

Success response

JSON format

{
  "RequestId": "7B9EFA4F-4305-5968-BAEE-BD8B8DE5****",
  "TotalCount": 31,
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****",
  "PolicyGroupModel": [
    {
      "PolicyGroupId": "pg-9q6o8qpiy8opkj****",
      "PolicyGroupName": "默认策略。",
      "GmtCreate": "2024-06-04 10:28:54",
      "Clipboard": "readwrite",
      "Html5FileTransfer": "download",
      "CameraRedirect": "on",
      "LocalDrive": "off",
      "LockResolution": "off",
      "NetRedirectPolicy": {
        "NetRedirect": "off",
        "CustomProxy": "off",
        "ProxyType": "socks5",
        "HostAddr": "47.100.XX.XX",
        "Port": "1145",
        "ProxyUserName": "username",
        "ProxyPassword": "password",
        "Rules": [
          {
            "Target": "*.baidu.com",
            "RuleType": "domain"
          }
        ]
      },
      "SessionResolutionHeight": 1080,
      "SessionResolutionWidth": 1920,
      "PolicyRelatedResources": {
        "AndroidInstanceGroupIds": [
          "ag-2dzpub83srxt*****"
        ],
        "CloudPhoneMatrixIds": [
          "cpn-3dskdfjj245s*****"
        ]
      },
      "Watermark": {
        "WatermarkSwitch": "off",
        "WatermarkTypes": [
          "Username"
        ],
        "WatermarkCustomText": "custom text",
        "WatermarkFontSize": 12,
        "WatermarkColor": 0,
        "WatermarkTransparencyValue": 25
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.