CreateProperty - Create a custom user property - Elastic Desktop Service

Operation description

You can create up to 10 properties per Alibaba Cloud account. Each property includes a property name (PropertyKey) and multiple property values (PropertyValue).
Each property supports up to 50 property values.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:CreateProperty

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PropertyKey	string	Yes	The property name.	department
PropertyValues	array	No	The property values. You can specify up to 50 values.
	string	No	The value of the property.	HR
BusinessChannel	string	No	Channel	ENTERPRISE

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
CreateResult	object	The property creation result.
PropertyId	integer	The ID of the property.	390
PropertyKey	string	The name of the property.	department
SavePropertyValueModel	object	The property value creation result.
SavePropertyValues	array<object>	The property values that were created.
	object	The created property value.
PropertyValueId	integer	The ID of the property value.	978
PropertyValue	string	The value of the property.	HR
FailedPropertyValues	array<object>	The property values that failed to be created.
	object	The property value that failed to be created.
PropertyId	integer	The ID of the property value.	390
PropertyValue	string	The value of the property.	HR
ErrorCode	string	The error code.	ExistedPropertyValue
ErrorMessage	string	The error message.	The property value is used by another property.

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.