All Products
Search
Document Center

Elastic Desktop Service:CreateProperty

Last Updated:Nov 20, 2024

Creates 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.

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:CreatePropertycreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PropertyKeystringYes

The property name.

department
PropertyValuesarrayNo

The values of the property. You can specify up to 50 values for a property.

stringNo

The value of the property.

HR

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
CreateResultobject

The result of creating the property.

PropertyIdlong

The ID of the property.

390
PropertyKeystring

The name of the property.

department
SavePropertyValueModelobject

The result of creating the property value.

SavePropertyValuesarray<object>

Details of the property values that were created.

savePropertyValuesobject

Details of the property value that was created.

PropertyValueIdlong

The ID of the property value.

978
PropertyValuestring

The value of the property.

HR
FailedPropertyValuesarray<object>

The property values that failed to be created.

failedPropertyValuesobject

The property values that failed to be modified.

PropertyIdlong

The ID of the property value.

390
PropertyValuestring

The value of the property.

HR
ErrorCodestring

The error code.

ExistedPropertyValue
ErrorMessagestring

The error message.

The property value is used by another property.

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change timeSummary of changesOperation
No change history