文档中心

云控制API

云控制API

使用示例

使用示例

本文以 IAM 子用户为例演示如何在 API-Explore 上通过 CloudControlAPI 完成资源的 CRUD-L 操作。

查看 IAM 子用户的资源类型元数据

调用 DescribeResourceType ，接口说明参考：

在 TypeName 传入参数 "Volcengine::IAM::User"

查看返回结果中的 Schema 结构体，相关元数据的含义相见资源元数据结构

在您创建和更新资源时，该元数据信息将起到重要作用

创建 IAM 子用户

调用 CreateResource，接口说明参考：CreateResource

在 TypeName 传入参数 "Volcengine::IAM::User"

在 TargetState 传入以下信息，代表创建一个名为 user-cc 的 IAM 子用户，并完成展示名称、安全配置、权限策略、登陆配置、资源标签的属性赋值。

点击发起调用，会返回异步操作的状态结果，记录 TaskID 信息

使用 GetTask 接口获取状态详情，传入 TaskID，接口说明参考：GetTask

若返回结果的 OperationStatus 为 SUCCESS，代表操作成功

查看 IAM 子用户列表

调用 ListResources，接口说明参考：ListResources

在 TypeName 传入参数 "Volcengine::IAM::User"，按需传入分页参数

在 ResourceDescriptions 中可以查看所有资源的常用属性信息，若希望查看指定 IAM 子用户的属性详情，可以通过 GetResource 查询。

注意，如果在资源类型元数据中存在“filterProperties”，那么在调用ListResources接口时可以在Filter参数中以Json形式传入所需的属性及值信息，其中“required”为必填过滤参数，“filterableProperties”为选填过滤参数。

查看指定 IAM 子用户的属性详情

调用 GetResource，接口说明参考：GetResource

在 TypeName 传入参数 "Volcengine::IAM::User"，Identifier 传入 IAM 子用户的唯一标识

在 Properties 中可以查看该资源的属性信息，在更新资源属性时可以参考此配置。

更新 IAM 子用户属性

调用 UpdateResource，接口说明参考：UpdateResource

在 TypeName 传入参数 "Volcengine::IAM::User"，Identifier 传入 IAM 子用户的唯一标识

在 PatchDocument 传入需要更新的属性及其信息

点击发起调用，会返回异步操作的状态结果，记录 TaskID 信息

使用 GetTask 接口获取状态详情，传入 TaskID，接口说明参考：GetTask

若返回结果的 OperationStatus 为 SUCCESS，代表操作成功

删除 IAM 子用户

调用 DeleteResource，接口说明参考：DeleteResource

在 TypeName 传入参数 "Volcengine::IAM::User"，Identifier 传入 IAM 子用户的唯一标识

使用 GetTask 接口获取状态详情，传入 TaskID，接口说明参考：GetTask

若返回结果的 OperationStatus 为 SUCCESS，代表操作成功

最近更新时间：2025.12.25 21:20:09

这个页面对您有帮助吗？

有用

有用

无用

无用