文档

CreateProperty - 创建用户自定义属性

更新时间:

创建一个用户属性。

接口说明

  • 一个阿里云账号下最多可以创建 10 个不同的属性。每个属性包括一个属性名(PropertyKey)和多个属性值(PropertyValue)。
  • 一个属性下最多可以添加 50 个不同的属性值。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
PropertyKeystring

属性名。

department
PropertyValuesarray

属性值。一个属性下最多可以添加 50 个不同的属性值。

string

属性值。

HR

返回参数

名称类型描述示例值
object

返回信息集合。

RequestIdstring

请求 ID。

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

创建结果。

PropertyIdlong

属性 ID。

390
PropertyKeystring

属性名。

department
SavePropertyValueModelobject

属性值创建结果。

SavePropertyValuesobject []

创建成功的属性值。

PropertyValueIdlong

属性值 ID。

978
PropertyValuestring

属性值。

HR
FailedPropertyValuesobject []

创建失败的属性值。

PropertyIdlong

属性值 ID。

390
PropertyValuestring

属性值。

HR
ErrorCodestring

错误码。

ExistedPropertyValue
ErrorMessagestring

错误信息。

The property value is used by another property.

示例

正常返回示例

JSON格式

{
  "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."
        }
      ]
    }
  }
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (0)
文档反馈