Queries the details of a policy.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| PolicyGroupIds |
array |
No |
The list of policy IDs. |
|
|
string |
No |
The policy ID. |
pg-jc31jdxfdcsclk**** |
|
| PolicyGroupName |
string |
No |
The policy name. |
Default policy |
| MaxResults |
integer |
No |
The maximum number of entries per page for a paged query. Valid values: 1 to 100. Default value: 20. |
20 |
| NextToken |
string |
No |
The pagination token that marks the position from which to start reading. Leave this parameter empty to read from the beginning. |
AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc**** |
| PolicyType |
string |
No |
The policy type. Valid values:
|
Instance |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID. |
7B9EFA4F-4305-5968-BAEE-BD8B8DE5**** |
| TotalCount |
integer |
The total number of entries. |
31 |
| NextToken |
string |
The pagination token that indicates the position up to which data has been read in the current call. An empty value indicates that all data has been read. |
AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON**** |
| PolicyGroupModel |
array<object> |
The policy information. |
|
|
array<object> |
The policy information. |
||
| PolicyGroupId |
string |
The policy ID. |
pg-9q6o8qpiy8opkj**** |
| PolicyGroupName |
string |
The policy name. |
Default policy. |
| GmtCreate |
string |
The creation time. |
2024-06-04 10:28:54 |
| Clipboard |
string |
The clipboard permission. Valid values:
|
readwrite |
| Html5FileTransfer |
string |
The file transfer policy for the HTML5 client. Valid values:
|
download |
| CameraRedirect |
string |
Indicates whether local camera redirection is enabled. Valid values:
|
on |
| LocalDrive |
string |
The local disk mapping permission. Valid values:
|
off |
| LockResolution |
string |
The locked resolution. Valid values:
|
off |
| NetRedirectPolicy |
object |
The network redirection settings. |
|
| 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 |
| CustomProxy |
string |
Indicates whether to manually configure a custom proxy. Valid values:
|
off |
| ProxyType |
string |
The type of the proxy protocol. Valid values:
|
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:
|
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 settings. |
|
| WatermarkSwitch |
string |
Specifies whether to enable the screen watermark. Valid values:
|
off |
| WatermarkTypes |
array |
The content of the screen watermark. |
|
|
string |
The content of the screen watermark. Valid values:
|
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 |
| AccessPolicies |
array<object> |
||
|
object |
|||
| AccessPolicyRuleId |
integer |
||
| CidrIp |
string |
||
| Policy |
string |
||
| Priority |
integer |
||
| Description |
string |
Examples
Success response
JSON format
{
"RequestId": "7B9EFA4F-4305-5968-BAEE-BD8B8DE5****",
"TotalCount": 31,
"NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****",
"PolicyGroupModel": [
{
"PolicyGroupId": "pg-9q6o8qpiy8opkj****",
"PolicyGroupName": "Default policy.",
"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
},
"AccessPolicies": [
{
"AccessPolicyRuleId": 0,
"CidrIp": "",
"Policy": "",
"Priority": 0,
"Description": ""
}
]
}
]
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.