跳转到主要内容
API Explorer|API Explorer
运营管理/租户管理(Plus)/组织架构相关接口
POSTOrganization Operations起始版本 2.4.0同步需要认证

添加组织

添加组织

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • nameString必填

      资源名称

    • descriptionString

      资源的详细描述

    • typeOrganizationType必填

      组织类型

    • parentUuidString

      可选。

    • attributesList

      可选。

    • quotaList

      配额

    • resourceUuidString

      可选。

  • systemTagsList

    系统标签。

  • userTagsList

    用户标签。

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventoryIAM2OrganizationInventory必填

    详情参考inventory

    • uuidString必填

      资源的UUID，唯一标示该资源

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • parentUuidString必填

      父级资源UUID。

    • stateState必填

      详情参考state

      • nameString必填

        资源名称

      • ordinalint必填

        暂无描述。

    • typeOrganizationType必填

      详情参考type

      • nameString必填

        资源名称

      • ordinalint必填

        暂无描述。

    • attributesList必填

      详情参考attributes

      • organizationUuidString必填

        组织UUID。

      • uuidString必填

        资源的UUID，唯一标示该资源

      • nameString必填

        资源名称

      • valueString必填

        字段值。

      • typeAttributeType必填

        详情参考type

        • nameString必填

          资源名称

        • ordinalint必填

          暂无描述。

请求地址

POST/v1/iam2/organizations

/v1/iam2/organizations

操作 ID

CreateIAM2Organization

永久链接

请求示例

curl -X POST 'http://{host}/v1/iam2/organizations' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"name":"<name>","description":"<description>","type":"<type>","parentUuid":"<parentUuid>","attributes":["<attributes>"],"quota":["<quota>"],"resourceUuid":"<resourceUuid>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "d8880014345347e1ab945d8ef750fac7", "name": "org1", "state": "Enabled", "type": "Company", "srcType": "ZStack", "parentUuid": "1dffd2c40215412d8ab4b811ce6888f0", "rootOrganizationUuid": "a531128bc8724f0ba55a85c425f22c32", "attributes": [ { "uuid": "053353cf77d6493daef4de70c9ff8d24", "name": "attribute-name", "value": "attribute-value", "type": "Customized" } ] } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史