UpdateProperty - Elastic Desktop Service - Alibaba Cloud Documentation Center

Modifies a user property.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
ecd:UpdateProperty	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
PropertyId	long	Yes	The ID of the property that you want to modify. You can call the ListProperty operation to query the property ID.	390
PropertyKey	string	Yes	The new property name.	testkey
PropertyValues	array<object>	No	The values of property.
	object	No
PropertyValueId	long	No	The ID of property value that you want to modify. You can call the ListProperty operation to query the property value ID.	978
PropertyValue	string	No	The new property value.	testvalue

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
UpdateResult	object	The result of the modification.
PropertyId	long	The ID of the property.	390
PropertyKey	string	The name of the property.	testkey2
SavePropertyValueModel	object	The result of the property value modification.
SavePropertyValues	array<object>	The property values that were modified.
savePropertyValues	object
PropertyValueId	long	The ID of the property value.	978
PropertyValue	string	The value of the property.	testvalue2
FailedPropertyValues	array<object>	The property values that failed to be modified.
failedPropertyValues	object
PropertyId	long	The ID of the property.	390
PropertyValue	string	The value of the property.	testvalue
ErrorCode	string	The error code.	ExistedPropertyValue
ErrorMessage	string	The error message.	The property value is used by another property.

Examples

Sample success responses

JSONformat

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "UpdateResult": {
    "PropertyId": 390,
    "PropertyKey": "testkey2",
    "SavePropertyValueModel": {
      "SavePropertyValues": [
        {
          "PropertyValueId": 978,
          "PropertyValue": "testvalue2"
        }
      ],
      "FailedPropertyValues": [
        {
          "PropertyId": 390,
          "PropertyValue": "testvalue",
          "ErrorCode": "ExistedPropertyValue",
          "ErrorMessage": "The property value is used by another property."
        }
      ]
    }
  }
}

Error codes

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