You need to enable JavaScript to run this app.
导航
CreateResource - 通过此接口创建云资源
最近更新时间:2025.09.25 17:18:07首次发布时间:2025.09.25 16:37:12
复制全文
我的收藏
有用
有用
无用
无用

通过此接口创建云资源

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

CreateResource

要执行的操作,取值:CreateResource。

Version
String

2025-06-01

API的版本,取值:2025-06-01。

TypeName
String

Volcengine::IAM::User

资源类型的抽象描述,格式为“Volcengine::服务名称::资源名称”,可以通过 ListResourceTypes 查询支持的资源类型

TargetState
Object

{
"UserName": "user-cccc",
"DisplayName": "demo",
"Description": "this is a iam user created by ccapi",
"SecurityConfig": {
"SafeAuthType": "vmfa"
},
"Policies": [
{
"PolicyName": "IAMReadOnlyAccess",
"PolicyType": "System"
}
],
"LoginProfile": {
"Password": "123456ccNN",
"PasswordResetRequired": true
},
"Tags": [
{
"Key": "usage",
"Value": "ccapi"
}
]
}

资源预期状态的结构化数据,由资源属性及其值组成,以 Json 的形式传入。支持传入的资源属性及相关约束可以通过 DescribeResourceType 获取。

ClientToken
String

1e810dfe1468721d0664a49b9d9f74f4

幂等标识,指定此令牌以确保资源操作的幂等性,以区分重试请求和新请求,token有效期为24小时。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
TypeName
String

Volcengine::IAM::User

资源类型的抽象描述,格式为“Volcengine::服务名称::资源名称”,可以通过 ListResourceTypes 查询支持的资源类型

Identifier
String

user-cc

资源实例的唯一标识符,标识符可以由单个或多个资源属性组成,可以通过 GetResource 使用该标识唯一定位资源

Operation
String

CREATE

资源操作类型

OperationStatus
String

SUCCESS

资源操作请求的状态,包括“SUCCESS”、“IN_PROGRESS”、“FAILED”、“PENDING”

TaskID
String

task-3e4ec995-6956-4907-b925-f92dd964636f

资源操作的任务ID,可以通过 GetTask 获取任务详情

ResourceModel
String

{"AccountId":2000000191,"CreateDate":"20250919T084713Z","Description":"this is a iam user created by ccapi","DisplayName":"demo","Email":"","EmailIsVerify":false,"LoginProfile":{"CreateDate":"20250919T084721Z","LastLoginDate":"00010101T000000Z","LastLoginIp":"","LastResetPasswordTime":1758271641,"LoginAllowed":false,"LoginLocked":false,"PasswordExpireAt":0,"PasswordResetRequired":true,"SafeAuthExemptDuration":10,"SafeAuthExemptRequired":1,"SafeAuthExemptUnit":0,"SafeAuthFlag":false,"SafeAuthType":"","UpdateDate":"20250919T084721Z"},"MobilePhone":"","MobilePhoneIsVerify":false,"Policies":[{"PolicyName":"IAMReadOnlyAccess","PolicyType":"System"}],"SecurityConfig":{"SafeAuthClose":0,"SafeAuthExemptDuration":10,"SafeAuthType":"phone,email,vmfa"},"Tags":[{"Key":"usage","Value":"ccapi"}],"Trn":"trn:iam::2000000191:user/user-cccccc","UpdateDate":"20250919T084713Z","UserId":1819738,"UserName":"user-cc"}

资源属性模型,展示资源属性和当前值,用Json方式表达

EventTime
String

2025-09-19T16:15:50.273+08:00

资源操作执行的时间

ErrorCode
String

UserAlreadyExists

错误码信息

StatusMessage
String

UserAlreadyExists: User 'user-cc' already exists.

状态描述信息

请求示例

{
    "TypeName": "Volcengine::IAM::User",
    "TargetState": {
      "UserName": "user-cc",
      "DisplayName": "demo",
      "Description": "this is a iam user created by ccapi",
      "SecurityConfig": {
        "SafeAuthType": "vmfa"
      },
      "Policies": [
        {
          "PolicyName": "IAMReadOnlyAccess",
          "PolicyType": "System"
        }
      ],
      "LoginProfile": {
        "Password": "123456ccNN",
        "PasswordResetRequired": true
      },
      "Tags": [
        {
          "Key": "usage",
          "Value": "ccapi"
        }
      ]
    },
    "ClientToken": "abc"
  }

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250919172405E7ED3D8E42B5E47B97DE",
    "Region": "cn-beijing"
  },
  "Result": {
    "EventTime": "2025-09-19T16:47:22+08:00",
    "TypeName": "Volcengine::IAM::User",
    "Identifier": "user-cccccc",
    "Operation": "CREATE",
    "OperationStatus": "SUCCESS",
    "TaskID": "task-3e4ec995-6956-4907-b925-f92dd964636f",
    "ResourceModel": "{\"AccountId\":2000000191,\"CreateDate\":\"20250919T084713Z\",\"Description\":\"this is a iam user created by ccapi\",\"DisplayName\":\"demo\",\"Email\":\"\",\"EmailIsVerify\":false,\"LoginProfile\":{\"CreateDate\":\"20250919T084721Z\",\"LastLoginDate\":\"00010101T000000Z\",\"LastLoginIp\":\"\",\"LastResetPasswordTime\":1758271641,\"LoginAllowed\":false,\"LoginLocked\":false,\"PasswordExpireAt\":0,\"PasswordResetRequired\":true,\"SafeAuthExemptDuration\":10,\"SafeAuthExemptRequired\":1,\"SafeAuthExemptUnit\":0,\"SafeAuthFlag\":false,\"SafeAuthType\":\"\",\"UpdateDate\":\"20250919T084721Z\"},\"MobilePhone\":\"\",\"MobilePhoneIsVerify\":false,\"Policies\":[{\"PolicyName\":\"IAMReadOnlyAccess\",\"PolicyType\":\"System\"}],\"SecurityConfig\":{\"SafeAuthClose\":0,\"SafeAuthExemptDuration\":10,\"SafeAuthType\":\"phone,email,vmfa\"},\"Tags\":[{\"Key\":\"usage\",\"Value\":\"ccapi\"}],\"Trn\":\"trn:iam::2000000191:user/user-cccccc\",\"UpdateDate\":\"20250919T084713Z\",\"UserId\":1819738,\"UserName\":\"user-cccccc\"}"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
QuotaLimitExceeded

an error occurred when calling %s operation: %s

400
ServiceNotEnabled

an error occurred when calling %s operation: %s

400
InvalidParameter

Params %s is invalid

参数无效

400
MissingParameter

an error occurred when calling %s operation: %s

400
InvalidRequest

an error occurred when calling %s operation: %s

401
InvalidCredentials

an error occurred when calling %s operation: %s

403
RequestForbidden

an error occurred when calling %s operation: %s

403
AccountInvalid

an error occurred when calling %s operation: %s

404
EntityNotFound

taskID %s was not found

未查询到

404
NotFound

an error occurred when calling %s operation: %s

409
AlreadyExists

an error occurred when calling %s operation: %s

409
ResourceConflict

an error occurred when calling %s operation: %s

409
NotStabilized

an error occurred when calling %s operation: %s

409
ConcurrentModification

The resource has been updated by another process

422
NotUpdatable

an error occurred when calling %s operation: %s

429
Throttling

an error occurred when calling %s operation: %s

500
GeneralServiceException

an error occurred when calling %s operation: %s

500
InternalFailure

an error occurred when calling %s operation: %s

500
ServiceInternalError

an error occurred when calling %s operation: %s

500
ServiceLimitExceeded

an error occurred when calling %s operation: %s

500
NoResource

an error occurred when calling %s operation: %s

500
InternalError

Some internal service error occurred, please wait and try again.

系统错误,请稍后重试

504
NetworkFailure

an error occurred when calling %s operation: %s