All Products
Search
Document Center

WUYING Workspace:ModifyDesktopsPolicyGroup

Last Updated:Apr 03, 2024

Modifies the policies that are configured for a cloud desktop.

Operation description

The cloud desktops that you want to restart by calling this operation must be in the Running state.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
ecd:ModifyDesktopsPolicyGroupWRITE
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region.

cn-hangzhou
PolicyGroupIdstringYes

The ID of the policy.

pg-gx2x1dhsmthe9****
DesktopIdarrayYes

The ID of the cloud desktop. You can specify one or more desktop IDs. The value is a JSON array.

stringYes

The ID of the cloud desktop.

ecd-ia2zw38bi6cm7****

Response parameters

ParameterTypeDescriptionExample
object

The object that is returned.

RequestIdstring

The ID of the request.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
ModifyResultsobject []

The modification results.

Codestring

The result of the modification. A value of success indicates that the policy is modified. If the policy failed to be modified, an error message is returned.

success
Messagestring

The error message returned if the request failed. This parameter is not returned if the value of Code is success.``

The specified param DesktopId ecd-ia2zw38bi6cm7**** is not found.
DesktopIdstring

The ID of the cloud desktop.

ecd-7w78ozhjcwa3u****

Examples

Sample success responses

JSONformat

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "ModifyResults": [
    {
      "Code": "success",
      "Message": "The specified param DesktopId ecd-ia2zw38bi6cm7**** is not found.",
      "DesktopId": "ecd-7w78ozhjcwa3u****"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2022-11-24The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: PreCheck
Output ParametersThe response structure of the API has changed.