文档

CreateProperty - 创建用户自定义属性

更新时间:

创建一个用户属性。

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecd:CreatePropertycreate
  • 全部资源
    *

请求参数

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

属性名。

department
PropertyValuesarray

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

string

属性值。

HR

返回参数

名称类型描述示例值
object

返回信息集合。

RequestIdstring

请求 ID。

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

创建结果。

PropertyIdlong

属性 ID。

390
PropertyKeystring

属性名。

department
SavePropertyValueModelobject

属性值创建结果。

SavePropertyValuesarray<object>

创建成功的属性值。

object

创建成功的属性值。

PropertyValueIdlong

属性值 ID。

978
PropertyValuestring

属性值。

HR
FailedPropertyValuesarray<object>

创建失败的属性值。

object

修改失败的属性值。

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

错误码

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