门户 OpenAPI

生成

application/json

安全

类型	名称	作用域
apiKey	Token	global

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/functions/byJwt

请求 query

{
  "teamId" : 0,
  "jwt" : "string",
  "module" : "string",
  "type" : "string"
}

HTTP响应示例

响应 200

{
  "functions" : [ {
    "businessRole" : "string",
    "code" : "string",
    "description" : "string",
    "module" : "string",
    "name" : "string",
    "path" : "string",
    "roleCode" : "string",
    "sortNumber" : 0,
    "type" : "string"
  } ],
  "requestId" : "string"
}

2.1.2. 获取用户在团队中的权限列表

GET /functions/byUser

参数

类型	名称	说明	架构
Query	userId 必填	用户ID	integer(int64)
Query	teamId 必填	团队ID	integer(int64)
Query	module 可选	模块	string
Query	type 可选	校验类型	enum (FUNCTION_CODE, API_PATH, BUSINESS_ROLE)

类型

名称

说明

架构

Query

userId
必填

用户ID

integer(int64)

Query

teamId
必填

团队ID

integer(int64)

Query

module
可选

模块

string

Query

type
可选

校验类型

enum (FUNCTION_CODE, API_PATH, BUSINESS_ROLE)

响应

HTTP代码	说明	架构
200	OK	GetFunctionResult

HTTP代码

说明

架构

200

生成

application/json

安全

类型	名称	作用域
apiKey	Token	global

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/functions/byUser

请求 query

{
  "userId" : 0,
  "teamId" : 0,
  "module" : "string",
  "type" : "string"
}

HTTP响应示例

响应 200

{
  "functions" : [ {
    "businessRole" : "string",
    "code" : "string",
    "description" : "string",
    "module" : "string",
    "name" : "string",
    "path" : "string",
    "roleCode" : "string",
    "sortNumber" : 0,
    "type" : "string"
  } ],
  "requestId" : "string"
}

2.1.3. 导入用户

POST /user

说明

设置joinTeam或joinTeamCode可以自动加入新建用户到团队；参数roles用逗号连接多个角色id，如果是系统角色，可以用RoleCode。例如：roles='12,TEAM_ADMINER’表示id=12的角色和团队管理员角色。

参数

类型	名称	说明	架构
Body	request 必填	用户列表	ImportUserRequest

类型

名称

说明

架构

Body

request
必填

用户列表

ImportUserRequest

响应

HTTP代码	说明	架构
200	OK	ImportUserResult
201	User created successfully	ImportUserResult
409	account or email conflict	无内容

HTTP代码

说明

架构

200

201

User created successfully

409

account or email conflict

无内容

消耗

application/json

生成

application/json

安全

类型	名称	作用域
apiKey	Token	global

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user

请求 body

{
  "users" : [ {
    "account" : "string",
    "address" : "string",
    "email" : "string",
    "expirationDate" : "string",
    "forceUpdate" : false,
    "gender" : 0,
    "introduce" : "string",
    "joinTeam" : 0,
    "joinTeamCode" : "string",
    "name" : "string",
    "password" : "string",
    "roles" : "string",
    "sendEmail" : false
  } ]
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "userAccounts" : {
    "string" : "string"
  },
  "userIds" : [ 0 ]
}

响应 201

{
  "requestId" : "string",
  "userAccounts" : {
    "string" : "string"
  },
  "userIds" : [ 0 ]
}

2.1.4. 获取用户信息（根据账号）

GET /user/byAccount/{account}

参数

类型	名称	说明	架构
Path	account 必填	用户账号	string

类型

名称

说明

架构

Path

account
必填

用户账号

string

响应

HTTP代码	说明	架构
200	OK	UserVo

HTTP代码

说明

架构

200

生成

application/json

安全

类型	名称	作用域
apiKey	Token	global

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/byAccount/string

HTTP响应示例

响应 200

{
  "account" : "string",
  "address" : "string",
  "authMethod" : "string",
  "blockedTime" : "string",
  "blockingSeconds" : 0,
  "delete" : false,
  "email" : "string",
  "gender" : 0,
  "id" : 0,
  "importTime" : "string",
  "introduce" : "string",
  "lastLoginTime" : "string",
  "ldapAttr" : "string",
  "ldapBaseDn" : "string",
  "loginCount" : 0,
  "name" : "string",
  "nickname" : "string",
  "online" : false,
  "phone" : "string",
  "signature" : "string",
  "status" : "string",
  "tenantId" : 0,
  "uid" : "string",
  "userId" : 0
}

2.1.5. 修改用户信息（根据账号）

PUT /user/byAccount/{account}

说明

修改用户的昵称、签名、性别、地址

参数

类型	名称	说明	架构
Path	account 必填	用户账号	string
Body	userVo 必填	用户信息	UpdateUserVo

类型

名称

说明

架构

Path

account
必填

用户账号

string

Body

userVo
必填

用户信息

UpdateUserVo

响应

HTTP代码	说明	架构
200	OK	无内容

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型	名称	作用域
apiKey	Token	global

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/byAccount/string

请求 body

{
  "address" : "string",
  "gender" : 0,
  "introduce" : "string",
  "name" : "string"
}

2.1.6. 删除一个用户（根据账号）

DELETE /user/byAccount/{account}

说明

注意：无法删除团队创建者

参数

类型	名称	说明	架构
Path	account 必填	用户账号	string

类型

名称

说明

架构

Path

account
必填

用户账号

string

响应

HTTP代码	说明	架构
200	OK	无内容

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型	名称	作用域
apiKey	Token	global

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/byAccount/string

2.1.7. 修改或清理用户登录账号（根据账号)

PUT /user/byAccount/{account}/account

说明

这个方法仅在私有部署环境可以使用。设置成随机账号以后，不能再用原来的账号登陆。但是用户的手机和邮箱（如果设置了）还是可以登录的。

参数

类型	名称	说明	架构
Path	account 必填	用户账号	string
Query	newAccount 可选	账号，不能与现有系统重复。设置为空或者不设置时，系统生成随机账号。	string

类型

名称

说明

架构

Path

account
必填

用户账号

string

Query

newAccount
可选

账号，不能与现有系统重复。设置为空或者不设置时，系统生成随机账号。

string

响应

HTTP代码	说明	架构
200	OK	无内容

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型	名称	作用域
apiKey	Token	global

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/byAccount/string/account

请求 query

{
  "newAccount" : "string"
}

2.1.8. 锁定用户（按账号）

PUT /user/byAccount/{account}/blocked

说明

仅在私有部署版使用。锁定以后，无法登陆

参数

类型名称说明架构默认列

类型	名称	说明	架构	默认列
Path	account 必填	用户账号	string
Query	blockingSeconds 必填	锁定时间，单位秒，为0时永久锁定	integer(int32)	`"0"`
Query	description 可选	锁定原因	string

Path

account
必填

用户账号

string

Query

blockingSeconds
必填

锁定时间，单位秒，为0时永久锁定

integer(int32)

"0"

Query

description
可选

锁定原因

string

响应

HTTP代码	说明	架构
200	OK	无内容

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型	名称	作用域
apiKey	Token	global

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/byAccount/string/blocked

请求 query

{
  "blockingSeconds" : 0,
  "description" : "string"
}

2.1.9. 修改或删除用户邮箱（根据账号)

PUT /user/byAccount/{account}/email

说明

这个方法仅在私有部署环境可以使用。SAAS环境的邮箱必须通过验证码绑定。

参数

类型	名称	说明	架构
Path	account 必填	用户账号	string
Query	email 可选	邮箱，不能跟系统中的已有的邮箱重复。不设置或者为空串时，删除用户的邮箱	string

类型

名称

说明

架构

Path

account
必填

用户账号

string

Query

email
可选

邮箱，不能跟系统中的已有的邮箱重复。不设置或者为空串时，删除用户的邮箱

string

响应

HTTP代码	说明	架构
200	OK	无内容

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型	名称	作用域
apiKey	Token	global

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/byAccount/string/email

请求 query

{
  "email" : "string"
}

2.1.10. 查询用户授予的角色列表（按账户）

GET /user/byAccount/{account}/joinedRoles

参数

类型	名称	说明	架构
Path	account 必填	用户账户	string
Query	teamId 必填	团队ID	integer(int64)

类型

名称

说明

架构

Path

account
必填

用户账户

string

Query

teamId
必填

团队ID

integer(int64)

响应

HTTP代码	说明	架构
200	OK	RoleListResult

HTTP代码

说明

架构

200

生成

application/json

安全

类型	名称	作用域
apiKey	Token	global

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/byAccount/string/joinedRoles

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "roles" : [ {
    "code" : "string",
    "description" : "string",
    "id" : 0,
    "locked" : false,
    "name" : "string",
    "requestId" : "string",
    "roleType" : 0,
    "system" : false,
    "teamId" : 0
  } ]
}

2.1.11. 查询用户加入的团队列表

GET /user/byAccount/{account}/joinedTeams

参数

类型	名称	说明	架构
Path	account 必填	用户账户	string

类型

名称

说明

架构

Path

account
必填

用户账户

string

响应

HTTP代码	说明	架构
200	OK	TeamListResult

HTTP代码

说明

架构

200

TeamListResult

生成

application/json

安全

类型	名称	作用域
apiKey	Token	global

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/byAccount/string/joinedTeams

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "teams" : [ {
    "code" : "string",
    "createTime" : "string",
    "creator" : 0,
    "name" : "string",
    "quotaExceed" : false,
    "serveEndTime" : "string",
    "teamId" : 0,
    "teamType" : "string",
    "tenantId" : 0
  } ]
}

2.1.12. 修改用户登录密码

PUT /user/byAccount/{account}/password

说明

这个操作不校验密码复杂性，不保存改密记录

参数

类型	名称	说明	架构
Path	account 必填	用户账号	string
Query	password 必填	登录密码，长度4~40个字符，不校验复杂性	string
Query	sendEmail 可选	是否发送通知邮件，可选。默认为false，只有用户设置了email才会生效。4.11新增属性。	boolean

类型

名称

说明

架构

Path

account
必填

用户账号

string

Query

password
必填

登录密码，长度4~40个字符，不校验复杂性

string

Query

sendEmail
可选

是否发送通知邮件，可选。默认为false，只有用户设置了email才会生效。4.11新增属性。

boolean

响应

HTTP代码	说明	架构
200	OK	无内容

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型	名称	作用域
apiKey	Token	global

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/byAccount/string/password

请求 query

{
  "password" : "string",
  "sendEmail" : true
}

2.1.13. 解除用户锁定

PUT /user/byAccount/{account}/unblocked

说明

仅在私有部署版使用

参数

类型	名称	说明	架构
Path	account 必填	用户账号	string

类型

名称

说明

架构

Path

account
必填

用户账号

string

响应

HTTP代码	说明	架构
200	OK	无内容

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型	名称	作用域
apiKey	Token	global

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/byAccount/string/unblocked

2.1.14. 获取用户信息（根据邮箱）

GET /user/byEmail/{email}

参数

类型	名称	说明	架构
Path	email 必填	用户账号	string

类型

名称

说明

架构

Path

email
必填

用户账号

string

响应

HTTP代码	说明	架构
200	OK	UserVo

HTTP代码

说明

架构

200

生成

application/json

安全

类型	名称	作用域
apiKey	Token	global

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/byEmail/string

HTTP响应示例

响应 200

{
  "account" : "string",
  "address" : "string",
  "authMethod" : "string",
  "blockedTime" : "string",
  "blockingSeconds" : 0,
  "delete" : false,
  "email" : "string",
  "gender" : 0,
  "id" : 0,
  "importTime" : "string",
  "introduce" : "string",
  "lastLoginTime" : "string",
  "ldapAttr" : "string",
  "ldapBaseDn" : "string",
  "loginCount" : 0,
  "name" : "string",
  "nickname" : "string",
  "online" : false,
  "phone" : "string",
  "signature" : "string",
  "status" : "string",
  "tenantId" : 0,
  "uid" : "string",
  "userId" : 0
}

2.1.15. 获取用户信息（根据昵称）

GET /user/byNickname

参数

类型	名称	说明	架构
Query	nickname 必填	用户昵称	string

类型

名称

说明

架构

Query

nickname
必填

用户昵称

string

响应

HTTP代码	说明	架构
200	OK	UserListResult

HTTP代码

说明

架构

200

生成

application/json

安全

类型	名称	作用域
apiKey	Token	global

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/byNickname

请求 query

{
  "nickname" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "users" : [ {
    "account" : "string",
    "address" : "string",
    "authMethod" : "string",
    "blockedTime" : "string",
    "blockingSeconds" : 0,
    "delete" : false,
    "email" : "string",
    "gender" : 0,
    "id" : 0,
    "importTime" : "string",
    "introduce" : "string",
    "lastLoginTime" : "string",
    "ldapAttr" : "string",
    "ldapBaseDn" : "string",
    "loginCount" : 0,
    "name" : "string",
    "nickname" : "string",
    "online" : false,
    "phone" : "string",
    "signature" : "string",
    "status" : "string",
    "tenantId" : 0,
    "uid" : "string",
    "userId" : 0
  } ]
}

2.1.16. 获取用户信息（根据手机号）

GET /user/byPhone/{phone}

参数

类型	名称	说明	架构
Path	phone 必填	用户账号	string

类型

名称

说明

架构

Path

phone
必填

用户账号

string

响应

HTTP代码	说明	架构
200	OK	UserVo

HTTP代码

说明

架构

200

生成

application/json

安全

类型	名称	作用域
apiKey	Token	global

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/byPhone/string

HTTP响应示例

响应 200

{
  "account" : "string",
  "address" : "string",
  "authMethod" : "string",
  "blockedTime" : "string",
  "blockingSeconds" : 0,
  "delete" : false,
  "email" : "string",
  "gender" : 0,
  "id" : 0,
  "importTime" : "string",
  "introduce" : "string",
  "lastLoginTime" : "string",
  "ldapAttr" : "string",
  "ldapBaseDn" : "string",
  "loginCount" : 0,
  "name" : "string",
  "nickname" : "string",
  "online" : false,
  "phone" : "string",
  "signature" : "string",
  "status" : "string",
  "tenantId" : 0,
  "uid" : "string",
  "userId" : 0
}

2.1.17. 分页获取团队成员

GET /user/byTeam

参数

类型名称说明架构默认列

类型	名称	说明	架构	默认列
Query	teamId 必填	团队ID	integer(int64)
Query	page 可选	页码	integer(int32)	`"1"`
Query	size 可选	条数	integer(int32)	`"20"`

Query

teamId
必填

团队ID

integer(int64)

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

条数

integer(int32)

"20"

响应

HTTP代码	说明	架构
200	OK	PagedUserListResult

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/byTeam

请求 query

{
  "teamId" : 0,
  "page" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "page" : 0,
  "requestId" : "string",
  "size" : 0,
  "total" : 0,
  "users" : [ {
    "account" : "string",
    "address" : "string",
    "authMethod" : "string",
    "blockedTime" : "string",
    "blockingSeconds" : 0,
    "delete" : false,
    "email" : "string",
    "gender" : 0,
    "id" : 0,
    "importTime" : "string",
    "introduce" : "string",
    "lastLoginTime" : "string",
    "ldapAttr" : "string",
    "ldapBaseDn" : "string",
    "loginCount" : 0,
    "name" : "string",
    "nickname" : "string",
    "online" : false,
    "phone" : "string",
    "signature" : "string",
    "status" : "string",
    "tenantId" : 0,
    "uid" : "string",
    "userId" : 0
  } ]
}

2.1.18. 创建用户

POST /user/create

参数

类型

名称

说明

架构

Query

account
必填

登录账号

string

Query

nickname
可选

用户昵称

string

Query

phone
可选

手机号

string

Query

email
可选

邮箱

string

Query

password
可选

密码

string

Query

thirdPartyUserId
可选

第三方用户唯一标识

string

Query

joinTeamCode
可选

加入的团队标识

string

响应

HTTP代码

说明

架构

200

SimpleUserVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/create

请求 query

{
  "account" : "string",
  "nickname" : "string",
  "phone" : "string",
  "email" : "string",
  "password" : "string",
  "thirdPartyUserId" : "string",
  "joinTeamCode" : "string"
}

HTTP响应示例

响应 200

{
  "account" : "string",
  "email" : "string",
  "nickname" : "string",
  "phone" : "string",
  "requestId" : "string",
  "thirdPartyUserId" : "string",
  "userId" : 0
}

2.1.19. 创建或者更新用户扩展属性

POST /user/deleteUserExtendParam

参数

类型

名称

说明

架构

Query

userId
必填

用户ID

integer(int64)

Query

paramName
可选

属性名

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/deleteUserExtendParam

请求 query

{
  "userId" : 0,
  "paramName" : "string"
}

HTTP响应示例

响应 200

{
  "count" : 0,
  "requestId" : "string"
}

2.1.20. 获取所有用户ID

GET /user/findIds

参数

类型

名称

说明

架构

Query

teamId
可选

团队id，teamId未设置时，将获取所有用户ID

integer(int64)

响应

HTTP代码

说明

架构

200

UserBriefResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/findIds

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "userIds" : [ 0 ]
}

2.1.21. 查询用户扩展属性

GET /user/getUserExtendParams

参数

类型

名称

说明

架构

Query

userId
可选

用户ID

integer(int64)

Query

paramName
可选

属性名

string

Query

paramValue
可选

属性值

string

响应

HTTP代码

说明

架构

200

UserExtendParamResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/getUserExtendParams

请求 query

{
  "userId" : 0,
  "paramName" : "string",
  "paramValue" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "userExtendParams" : [ {
    "createTime" : "string",
    "description" : "string",
    "paramName" : "string",
    "paramValue" : "string",
    "requestId" : "string",
    "updateTime" : "string",
    "userId" : 0
  } ]
}

2.1.22. 根据扩展属性查询用户

GET /user/getUserListByExtendParam

参数

类型

名称

说明

架构

Query

paramName
必填

属性名

string

Query

paramValue
必填

属性值

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/getUserListByExtendParam

请求 query

{
  "paramName" : "string",
  "paramValue" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "users" : [ {
    "account" : "string",
    "address" : "string",
    "authMethod" : "string",
    "blockedTime" : "string",
    "blockingSeconds" : 0,
    "delete" : false,
    "email" : "string",
    "gender" : 0,
    "id" : 0,
    "importTime" : "string",
    "introduce" : "string",
    "lastLoginTime" : "string",
    "ldapAttr" : "string",
    "ldapBaseDn" : "string",
    "loginCount" : 0,
    "name" : "string",
    "nickname" : "string",
    "online" : false,
    "phone" : "string",
    "signature" : "string",
    "status" : "string",
    "tenantId" : 0,
    "uid" : "string",
    "userId" : 0
  } ]
}

2.1.23. 获取所有用户ID（根据团队code）

GET /user/ids/byTeamCode/{teamCode}

参数

类型

名称

说明

架构

Path

teamCode
必填

团队code

string

响应

HTTP代码

说明

架构

200

UserBriefResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/ids/byTeamCode/string

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "userIds" : [ 0 ]
}

2.1.24. 判断用户是否加在某个团队中

GET /user/isUserInTeam

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

Query

userId
必填

用户ID

integer(int64)

响应

HTTP代码

说明

架构

200

BooleanResponse

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/isUserInTeam

请求 query

{
  "teamId" : 0,
  "userId" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "value" : false
}

2.1.25. 根据第三方用户标识查询用户

POST /user/queryByThirdPartyUserId

参数

类型

名称

说明

架构

Query

thirdPartyUserId
可选

第三方用户唯一标识

string

响应

HTTP代码

说明

架构

200

SimpleUserVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/queryByThirdPartyUserId

请求 query

{
  "thirdPartyUserId" : "string"
}

HTTP响应示例

响应 200

{
  "account" : "string",
  "email" : "string",
  "nickname" : "string",
  "phone" : "string",
  "requestId" : "string",
  "thirdPartyUserId" : "string",
  "userId" : 0
}

2.1.26. 创建或者更新用户扩展属性

POST /user/saveOrUpdateUserExtendParam

参数

类型

名称

说明

架构

Query

userId
必填

用户ID

integer(int64)

Query

paramName
必填

属性名

string

Query

paramValue
必填

属性值

string

Query

description
可选

描述信息

string

响应

HTTP代码

说明

架构

200

UserExtendParamVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/saveOrUpdateUserExtendParam

请求 query

{
  "userId" : 0,
  "paramName" : "string",
  "paramValue" : "string",
  "description" : "string"
}

HTTP响应示例

响应 200

{
  "createTime" : "string",
  "description" : "string",
  "paramName" : "string",
  "paramValue" : "string",
  "requestId" : "string",
  "updateTime" : "string",
  "userId" : 0
}

2.1.27. 身份证实名认证

GET /user/verifyIdCard/{realName}/{idCard}

参数

类型

名称

说明

架构

Path

realName
必填

用户的真实姓名

string

Path

idCard
必填

身份证号码

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/verifyIdCard/string/string

2.1.28. 批量删除用户

DELETE /user/{ids}

说明

注意：无法删除团队创建者

参数

类型

名称

说明

架构

Path

ids
必填

用户id列表，用','连接

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/string

2.1.29. 获取用户信息

GET /user/{id}

参数

类型

名称

说明

架构

Path

id
必填

用户id或者账号

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/0

HTTP响应示例

响应 200

{
  "account" : "string",
  "address" : "string",
  "authMethod" : "string",
  "blockedTime" : "string",
  "blockingSeconds" : 0,
  "delete" : false,
  "email" : "string",
  "gender" : 0,
  "id" : 0,
  "importTime" : "string",
  "introduce" : "string",
  "lastLoginTime" : "string",
  "ldapAttr" : "string",
  "ldapBaseDn" : "string",
  "loginCount" : 0,
  "name" : "string",
  "nickname" : "string",
  "online" : false,
  "phone" : "string",
  "signature" : "string",
  "status" : "string",
  "tenantId" : 0,
  "uid" : "string",
  "userId" : 0
}

2.1.30. 修改用户信息

PUT /user/{id}

说明

修改用户的昵称、签名、性别、地址

参数

类型

名称

说明

架构

Path

id
必填

用户ID

integer(int64)

Body

userVo
必填

用户信息

UpdateUserVo

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/0

请求 body

{
  "address" : "string",
  "gender" : 0,
  "introduce" : "string",
  "name" : "string"
}

2.1.31. 修改或清理用户登录账号

PUT /user/{id}/account

说明

这个方法仅在私有部署环境可以使用。设置成随机账号以后，不能再用原来的账号登陆。但是用户的手机和邮箱（如果设置了）还是可以登录的。

参数

类型

名称

说明

架构

Path

id
必填

用户ID或者账号

integer(int64)

Query

account
可选

账号，不能与现有系统中的账号重复。设置为空或者不设置时，系统生成随机账号。

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/0/account

请求 query

{
  "account" : "string"
}

2.1.32. 锁定用户

PUT /user/{id}/blocked

说明

仅在私有部署版使用。锁定以后，无法登陆

参数

类型名称说明架构默认列

Path

id
必填

用户ID

integer(int64)

Query

blockingSeconds
可选

锁定时间，单位秒，缺省为0，为0时永久锁定

integer(int32)

"0"

Query

description
可选

锁定原因

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/0/blocked

请求 query

{
  "blockingSeconds" : 0,
  "description" : "string"
}

2.1.33. 修改或删除用户邮箱

PUT /user/{id}/email

说明

这个方法仅在私有部署环境可以使用。SAAS环境的邮箱必须通过验证码绑定。

参数

类型

名称

说明

架构

Path

id
必填

用户ID或者账号

integer(int64)

Query

email
可选

邮箱，不能跟系统中的已有的邮箱重复。不设置或者为空串时，删除用户的邮箱

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/0/email

请求 query

{
  "email" : "string"
}

2.1.34. 查询用户授予的角色列表

GET /user/{id}/joinedRoles

参数

类型

名称

说明

架构

Path

id
必填

用户ID

integer(int64)

Query

teamId
必填

团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/0/joinedRoles

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "roles" : [ {
    "code" : "string",
    "description" : "string",
    "id" : 0,
    "locked" : false,
    "name" : "string",
    "requestId" : "string",
    "roleType" : 0,
    "system" : false,
    "teamId" : 0
  } ]
}

2.1.35. 获取用户加入的团队列表

GET /user/{id}/joinedTeams

参数

类型

名称

说明

架构

Path

id
必填

用户ID

integer(int64)

响应

HTTP代码

说明

架构

200

TeamListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/0/joinedTeams

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "teams" : [ {
    "code" : "string",
    "createTime" : "string",
    "creator" : 0,
    "name" : "string",
    "quotaExceed" : false,
    "serveEndTime" : "string",
    "teamId" : 0,
    "teamType" : "string",
    "tenantId" : 0
  } ]
}

2.1.36. 修改用户登录密码

PUT /user/{id}/password

说明

这个操作不校验密码复杂性，不保存改密记录

参数

类型

名称

说明

架构

Path

id
必填

用户ID

integer(int64)

Query

password
必填

登录密码，长度4~40个字符，不校验复杂性

string

Query

sendEmail
可选

是否发送通知邮件，可选。默认为false，只有用户设置了email才会生效。4.11新增属性。

boolean

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/0/password

请求 query

{
  "password" : "string",
  "sendEmail" : true
}

2.1.37. 解除用户锁定

PUT /user/{id}/unblocked

说明

仅在私有部署版使用

参数

类型

名称

说明

架构

Path

id
必填

用户ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/user/0/unblocked

2.1.38. 导入单个用户

POST /userV2

参数

类型名称说明架构默认列

Query

name
必填

用户昵称，必填。

string

Query

introduce
可选

用户签名，可选。用户自定义描述

string

Query

gender
可选

性别，可选。0:未知；1,：男；2：女。不填时默认值为0。

integer(int32)

"0"

Query

address
可选

地址，可选。

string

Query

forceUpdate
可选

首次登录强制修改密码，可选。默认为false。4.8新增属性。

boolean

"false"

Query

account
可选

登录账户，可选。需保证全局唯一,未设置时，将由系统自动生成。4.8新增属性，只能在私有部署版中设置，SAAS版的Openapi不支持设置登录账户。账号不能包含逗号','。

string

Query

password
可选

登录密码，可选。长度4~40个字符，不校验复杂性。4.8新增属性。

string

Query

joinTeam
可选

默认加入的团队，可选。团队ID。4.8新增属性。

integer(int64)

Query

joinTeamCode
可选

默认加入的团队，可选。团队code，4.10新加字段，与joinTeam不要同时设置，如果设置了joinTeamCode，会忽略joinTeam。

string

Query

roles
可选

在加入团队中默认授权的角色，可选。必须设置joinTeam或者joinTeamCode才可以设置roles。格式：用逗号','连接的角色ID或者code，code可以设定私有部署环境role_templates.json定义的系统角色。

string

Query

expirationDate
可选

用户在团队中的有效期，可选。如果设置，会在到期后自动退出团队，如果不设置，则是永久成员。日期格式：yyyy-MM-dd。4.8新增属性。

string

Query

email
可选

登录邮箱，可选。需保证全局唯一。4.9新增属性，只能在私有部署版中设置，SAAS用户的邮箱需要通过验证码绑定。

string

Query

sendEmail
可选

是否发送通知邮件，可选。默认为false，只有设置了email才会生效。4.11新增属性。

boolean

响应

HTTP代码

说明

架构

200

201

User created successfully

409

account or email conflict

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/userV2

请求 query

{
  "name" : "string",
  "introduce" : "string",
  "gender" : 0,
  "address" : "string",
  "forceUpdate" : true,
  "account" : "string",
  "password" : "string",
  "joinTeam" : 0,
  "joinTeamCode" : "string",
  "roles" : "string",
  "expirationDate" : "string",
  "email" : "string",
  "sendEmail" : true
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "userAccounts" : {
    "string" : "string"
  },
  "userIds" : [ 0 ]
}

响应 201

{
  "requestId" : "string",
  "userAccounts" : {
    "string" : "string"
  },
  "userIds" : [ 0 ]
}

2.1.39. 分页获取用户信息

GET /users

参数

类型名称说明架构默认列

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

条数

integer(int32)

"20"

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/users

请求 query

{
  "page" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "page" : 0,
  "requestId" : "string",
  "size" : 0,
  "total" : 0,
  "users" : [ {
    "account" : "string",
    "address" : "string",
    "authMethod" : "string",
    "blockedTime" : "string",
    "blockingSeconds" : 0,
    "delete" : false,
    "email" : "string",
    "gender" : 0,
    "id" : 0,
    "importTime" : "string",
    "introduce" : "string",
    "lastLoginTime" : "string",
    "ldapAttr" : "string",
    "ldapBaseDn" : "string",
    "loginCount" : 0,
    "name" : "string",
    "nickname" : "string",
    "online" : false,
    "phone" : "string",
    "signature" : "string",
    "status" : "string",
    "tenantId" : 0,
    "uid" : "string",
    "userId" : 0
  } ]
}

2.1.40. 根据创建时间查询用户

GET /users/byCreateTime

说明

按照用户的创建时间为[fromTime,toTime)来查询

参数

类型

名称

说明

架构

Query

fromTime
必填

用户创建时间开始。UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

toTime
必填

用户创建时间截止。UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/users/byCreateTime

请求 query

{
  "fromTime" : "string",
  "toTime" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "users" : [ {
    "account" : "string",
    "address" : "string",
    "authMethod" : "string",
    "blockedTime" : "string",
    "blockingSeconds" : 0,
    "delete" : false,
    "email" : "string",
    "gender" : 0,
    "id" : 0,
    "importTime" : "string",
    "introduce" : "string",
    "lastLoginTime" : "string",
    "ldapAttr" : "string",
    "ldapBaseDn" : "string",
    "loginCount" : 0,
    "name" : "string",
    "nickname" : "string",
    "online" : false,
    "phone" : "string",
    "signature" : "string",
    "status" : "string",
    "tenantId" : 0,
    "uid" : "string",
    "userId" : 0
  } ]
}

2.1.41. 查询用户列表（按游标：用户ID）

GET /users/byCursor

说明

用户ID>cursorId的规则进行查询

参数

类型名称说明架构默认列

Query

cursorId
必填

游标，即用户ID值的下限

integer(int64)

"0"

Query

size
可选

请求记录数，默认20

integer(int32)

"20"

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/users/byCursor

请求 query

{
  "cursorId" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "users" : [ {
    "account" : "string",
    "address" : "string",
    "authMethod" : "string",
    "blockedTime" : "string",
    "blockingSeconds" : 0,
    "delete" : false,
    "email" : "string",
    "gender" : 0,
    "id" : 0,
    "importTime" : "string",
    "introduce" : "string",
    "lastLoginTime" : "string",
    "ldapAttr" : "string",
    "ldapBaseDn" : "string",
    "loginCount" : 0,
    "name" : "string",
    "nickname" : "string",
    "online" : false,
    "phone" : "string",
    "signature" : "string",
    "status" : "string",
    "tenantId" : 0,
    "uid" : "string",
    "userId" : 0
  } ]
}

2.1.42. 根据昵称查询用户

GET /users/byName

说明

根据用户昵称查询精准匹配用户

参数

类型

名称

说明

架构

Query

name
可选

用户昵称

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/users/byName

请求 query

{
  "name" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "users" : [ {
    "account" : "string",
    "address" : "string",
    "authMethod" : "string",
    "blockedTime" : "string",
    "blockingSeconds" : 0,
    "delete" : false,
    "email" : "string",
    "gender" : 0,
    "id" : 0,
    "importTime" : "string",
    "introduce" : "string",
    "lastLoginTime" : "string",
    "ldapAttr" : "string",
    "ldapBaseDn" : "string",
    "loginCount" : 0,
    "name" : "string",
    "nickname" : "string",
    "online" : false,
    "phone" : "string",
    "signature" : "string",
    "status" : "string",
    "tenantId" : 0,
    "uid" : "string",
    "userId" : 0
  } ]
}

2.1.43. 根据昵称查询用户

GET /users/byNameLike

说明

查询用户昵称包含name字符串的用户

参数

类型

名称

说明

架构

Query

name
可选

用户昵称包含的字符串

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/users/byNameLike

请求 query

{
  "name" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "users" : [ {
    "account" : "string",
    "address" : "string",
    "authMethod" : "string",
    "blockedTime" : "string",
    "blockingSeconds" : 0,
    "delete" : false,
    "email" : "string",
    "gender" : 0,
    "id" : 0,
    "importTime" : "string",
    "introduce" : "string",
    "lastLoginTime" : "string",
    "ldapAttr" : "string",
    "ldapBaseDn" : "string",
    "loginCount" : 0,
    "name" : "string",
    "nickname" : "string",
    "online" : false,
    "phone" : "string",
    "signature" : "string",
    "status" : "string",
    "tenantId" : 0,
    "uid" : "string",
    "userId" : 0
  } ]
}

2.1.44. 获取系统在线用户数

GET /users/countOnline

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/users/countOnline

HTTP响应示例

响应 200

{
  "count" : 0,
  "requestId" : "string"
}

2.1.45. 获取团队在线成员数

GET /users/countOnlineMembers

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/users/countOnlineMembers

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "count" : 0,
  "requestId" : "string"
}

2.2. 2 Team Api

团队操作API

2.2.1. 导入团队

POST /team

说明

注意：code字段不能设置为保留字，目前系统的保留字有：wx,mobile,assets,cloud_bootstrap,common,welcome,errorPage,flash,oldjs,pub,thirdparty_libs,downloads,help,cloudAdminer,cloudApiExecutor,cloudCi,cloudPortal,cloudTransit,portal_socketio,protected,rtunnel_srv_ws,imagepreview,api,proxy。

参数

类型

名称

说明

架构

Body

request
必填

团队列表

ImportTeamRequest

响应

HTTP代码

说明

架构

200

ImportTeamResult

201

Team created successfully

ImportTeamResult

409

name or code conflict

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team

请求 body

{
  "teams" : [ {
    "code" : "string",
    "creator" : 0,
    "creatorAccount" : "string",
    "memberAccounts" : [ "string" ],
    "memberQuota" : 0,
    "members" : [ 0 ],
    "name" : "string"
  } ]
}

HTTP响应示例

响应 200

{
  "teamCodes" : {
    "string" : "string"
  }
}

响应 201

{
  "teamCodes" : {
    "string" : "string"
  }
}

2.2.2. 获取团队信息（根据团队code）

GET /team/byCode/{code}

参数

类型名称说明架构默认列

Path

code
必填

团队code

string

Query

includeMembers
可选

是否获取成员列表

boolean

"true"

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/byCode/string

请求 query

{
  "includeMembers" : true
}

HTTP响应示例

响应 200

{
  "code" : "string",
  "createTime" : "string",
  "creator" : 0,
  "departmentEnabled" : false,
  "memberAccounts" : {
    "string" : "string"
  },
  "members" : [ 0 ],
  "name" : "string",
  "quotaExceed" : false,
  "requestId" : "string",
  "serveEndTime" : "string",
  "teamId" : 0,
  "teamType" : "string"
}

2.2.3. 修改团队名称和所有者（根据团队code）

PUT /team/byCode/{code}

说明

name和creator参数不能同时为null

参数

类型

名称

说明

架构

Path

code
必填

团队code

string

Query

name
可选

团队名称，可选。如果设置，不能与当前ISV的其他团队重名。私有部署环境必须全局唯一。

string

Query

creatorAccount
可选

团队创建者账号,可选。如果设置，必须是当前ISV有权限的用户，私有部署环境可以是任何用户。修改团队创建者会进行转移身份操作。

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/byCode/string

请求 query

{
  "name" : "string",
  "creatorAccount" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.2.4. 删除一个团队（根据团队code）

DELETE /team/byCode/{code}

参数

类型

名称

说明

架构

Path

code
必填

团队code

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/byCode/string

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.2.5. 获取团队所有成员信息（根据团队code）

GET /team/byCode/{code}/members

参数

类型名称说明架构默认列

Path

code
必填

团队code

string

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

条数

integer(int32)

"1000"

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/byCode/string/members

请求 query

{
  "page" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "page" : 0,
  "requestId" : "string",
  "size" : 0,
  "total" : 0,
  "users" : [ {
    "account" : "string",
    "address" : "string",
    "authMethod" : "string",
    "blockedTime" : "string",
    "blockingSeconds" : 0,
    "delete" : false,
    "email" : "string",
    "gender" : 0,
    "id" : 0,
    "importTime" : "string",
    "introduce" : "string",
    "lastLoginTime" : "string",
    "ldapAttr" : "string",
    "ldapBaseDn" : "string",
    "loginCount" : 0,
    "name" : "string",
    "nickname" : "string",
    "online" : false,
    "phone" : "string",
    "signature" : "string",
    "status" : "string",
    "tenantId" : 0,
    "uid" : "string",
    "userId" : 0
  } ]
}

2.2.6. 添加一个团队成员（根据团队code和用户账号）

POST /team/byCode/{code}/members/{account}

参数

类型

名称

说明

架构

Path

code
必填

团队code

string

Path

account
必填

用户账号

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/byCode/string/members/string

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.2.7. 删除一个团队成员（根据团队code和用户账号）

DELETE /team/byCode/{code}/members/{account}

参数

类型

名称

说明

架构

Path

code
必填

团队code

string

Path

account
必填

用户账号

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/byCode/string/members/string

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.2.8. 获取团队配额信息（根据团队code）

GET /team/byCode/{code}/quota

Caution

operation.deprecated

参数

类型

名称

说明

架构

Path

code
必填

团队code

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/byCode/string/quota

HTTP响应示例

响应 200

{
  "buckets" : 0,
  "cdns" : 0,
  "clouds" : 0,
  "dbs" : 0,
  "fileKeepDuration" : 0,
  "hosts" : 0,
  "logKeepDuration" : 0,
  "maxCdnResources" : 0,
  "maxClouds" : 0,
  "maxDbResources" : 0,
  "maxHostResources" : 0,
  "maxMembers" : 0,
  "maxOssResources" : 0,
  "maxResources" : 0,
  "maxScriptRuns" : 0,
  "maxSessions" : 0,
  "members" : 0,
  "netDiskMaxCapability" : 0,
  "netDiskMaxFileSize" : 0,
  "requestId" : "string",
  "resources" : 0,
  "teamId" : 0
}

2.2.9. 更新团队配额信息（根据团队code）

PUT /team/byCode/{code}/quota

Caution

operation.deprecated

说明

仅在私有部署环境使用。返回更新后的配额信息。注意：成员配额不能超过License总配额，因为用户可以加入多个团队，所以团队的成员数仅受License用户数限制。而资源数配额必须满足所有团队资源总配额不能超过License资源配额。

参数

类型

名称

说明

架构

Path

code
必填

团队code

string

Query

members
可选

团队成员数配额，不能超过License总配额，不设置时不更新

integer(int32)

Query

hosts
可选

主机资源配额，不设置时不更新

integer(int32)

Query

cdns
可选

CDN资源配额，不设置时不更新

integer(int32)

Query

buckets
可选

Bucket资源配额（包括OSS、COS、S3等），不设置时不更新

integer(int32)

Query

dbs
可选

数据库资源配额，不设置时不更新

integer(int32)

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/byCode/string/quota

请求 query

{
  "members" : 0,
  "hosts" : 0,
  "cdns" : 0,
  "buckets" : 0,
  "dbs" : 0
}

HTTP响应示例

响应 200

{
  "buckets" : 0,
  "cdns" : 0,
  "clouds" : 0,
  "dbs" : 0,
  "fileKeepDuration" : 0,
  "hosts" : 0,
  "logKeepDuration" : 0,
  "maxCdnResources" : 0,
  "maxClouds" : 0,
  "maxDbResources" : 0,
  "maxHostResources" : 0,
  "maxMembers" : 0,
  "maxOssResources" : 0,
  "maxResources" : 0,
  "maxScriptRuns" : 0,
  "maxSessions" : 0,
  "members" : 0,
  "netDiskMaxCapability" : 0,
  "netDiskMaxFileSize" : 0,
  "requestId" : "string",
  "resources" : 0,
  "teamId" : 0
}

2.2.10. 创建团队

POST /team/createTeam

参数

类型

名称

说明

架构

Query

teamName
必填

团队名称

string

Query

teamCode
必填

团队标识

string

Query

creatorId
必填

团队创建者

integer(int64)

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/createTeam

请求 query

{
  "teamName" : "string",
  "teamCode" : "string",
  "creatorId" : 0
}

HTTP响应示例

响应 200

{
  "code" : "string",
  "createTime" : "string",
  "creator" : 0,
  "departmentEnabled" : false,
  "memberAccounts" : {
    "string" : "string"
  },
  "members" : [ 0 ],
  "name" : "string",
  "quotaExceed" : false,
  "requestId" : "string",
  "serveEndTime" : "string",
  "teamId" : 0,
  "teamType" : "string"
}

2.2.11. 获取所有团队ID

GET /team/findIds

响应

HTTP代码

说明

架构

200

TeamBriefResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/findIds

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "teamIds" : [ 0 ]
}

2.2.12. 删除团队

DELETE /team/{ids}

参数

类型

名称

说明

架构

Path

ids
必填

团队ID，用','连接

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/string

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.2.13. 获取团队信息

GET /team/{id}

参数

类型名称说明架构默认列

Path

id
必填

团队ID

integer(int64)

Query

includeMembers
可选

是否获取成员列表

boolean

"true"

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/0

请求 query

{
  "includeMembers" : true
}

HTTP响应示例

响应 200

{
  "code" : "string",
  "createTime" : "string",
  "creator" : 0,
  "departmentEnabled" : false,
  "memberAccounts" : {
    "string" : "string"
  },
  "members" : [ 0 ],
  "name" : "string",
  "quotaExceed" : false,
  "requestId" : "string",
  "serveEndTime" : "string",
  "teamId" : 0,
  "teamType" : "string"
}

2.2.14. 修改团队名称和所有者

PUT /team/{id}

说明

name和creator参数不能同时为null

参数

类型

名称

说明

架构

Path

id
必填

团队ID

integer(int64)

Query

name
可选

团队名称，可选。如果设置，不能与当前ISV的其他团队重名。私有部署环境必须全局唯一。

string

Query

creator
可选

团队创建者用户ID,可选。如果设置，必须是当前ISV有权限的用户，私有部署环境可以是任何用户。修改团队创建者会进行转移身份操作。

integer(int32)

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/0

请求 query

{
  "name" : "string",
  "creator" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.2.15. 修改团队code

PUT /team/{id}/code

说明

name和creator参数不能同时为null

参数

类型

名称

说明

架构

Path

id
必填

团队ID

integer(int64)

Query

code
必填

团队code，必须是字符数字下划线的组合，即[A-Za-z0-9_]，全局唯一，不能与保留字段相同

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/0/code

请求 query

{
  "code" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.2.16. 获取团队在线成员数

GET /team/{id}/countOnlineMembers

参数

类型

名称

说明

架构

Path

id
必填

团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/0/countOnlineMembers

HTTP响应示例

响应 200

{
  "count" : 0,
  "requestId" : "string"
}

2.2.17. 获取团队所有成员信息

GET /team/{id}/members

参数

类型名称说明架构默认列

Path

id
必填

团队ID

integer(int64)

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

条数

integer(int32)

"1000"

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/0/members

请求 query

{
  "page" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "page" : 0,
  "requestId" : "string",
  "size" : 0,
  "total" : 0,
  "users" : [ {
    "account" : "string",
    "address" : "string",
    "authMethod" : "string",
    "blockedTime" : "string",
    "blockingSeconds" : 0,
    "delete" : false,
    "email" : "string",
    "gender" : 0,
    "id" : 0,
    "importTime" : "string",
    "introduce" : "string",
    "lastLoginTime" : "string",
    "ldapAttr" : "string",
    "ldapBaseDn" : "string",
    "loginCount" : 0,
    "name" : "string",
    "nickname" : "string",
    "online" : false,
    "phone" : "string",
    "signature" : "string",
    "status" : "string",
    "tenantId" : 0,
    "uid" : "string",
    "userId" : 0
  } ]
}

2.2.18. 添加团队成员

POST /team/{id}/members/{userIds}

参数

类型

名称

说明

架构

Path

id
必填

团队ID

integer(int64)

Path

userIds
必填

用户id或者账号列表，用','连接

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/0/members/string

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.2.19. 删除团队成员

DELETE /team/{id}/members/{userIds}

参数

类型

名称

说明

架构

Path

id
必填

团队ID

integer(int64)

Path

userIds
必填

用户id列表，用','连接

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/0/members/string

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.2.20. 获取团队配额信息

GET /team/{id}/quota

Caution

operation.deprecated

参数

类型

名称

说明

架构

Path

id
可选

团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/0/quota

HTTP响应示例

响应 200

{
  "buckets" : 0,
  "cdns" : 0,
  "clouds" : 0,
  "dbs" : 0,
  "fileKeepDuration" : 0,
  "hosts" : 0,
  "logKeepDuration" : 0,
  "maxCdnResources" : 0,
  "maxClouds" : 0,
  "maxDbResources" : 0,
  "maxHostResources" : 0,
  "maxMembers" : 0,
  "maxOssResources" : 0,
  "maxResources" : 0,
  "maxScriptRuns" : 0,
  "maxSessions" : 0,
  "members" : 0,
  "netDiskMaxCapability" : 0,
  "netDiskMaxFileSize" : 0,
  "requestId" : "string",
  "resources" : 0,
  "teamId" : 0
}

2.2.21. 更新团队配额信息

PUT /team/{id}/quota

Caution

operation.deprecated

说明

参数

类型

名称

说明

架构

Path

id
必填

团队ID

integer(int64)

Query

members
可选

团队成员数配额，不能超过License总配额，不设置时不更新

integer(int32)

Query

hosts
可选

主机资源配额，不设置时不更新

integer(int32)

Query

cdns
可选

CDN资源配额，不设置时不更新

integer(int32)

Query

buckets
可选

Bucket资源配额（包括OSS、COS、S3等），不设置时不更新

integer(int32)

Query

dbs
可选

数据库资源配额，不设置时不更新

integer(int32)

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/0/quota

请求 query

{
  "members" : 0,
  "hosts" : 0,
  "cdns" : 0,
  "buckets" : 0,
  "dbs" : 0
}

HTTP响应示例

响应 200

{
  "buckets" : 0,
  "cdns" : 0,
  "clouds" : 0,
  "dbs" : 0,
  "fileKeepDuration" : 0,
  "hosts" : 0,
  "logKeepDuration" : 0,
  "maxCdnResources" : 0,
  "maxClouds" : 0,
  "maxDbResources" : 0,
  "maxHostResources" : 0,
  "maxMembers" : 0,
  "maxOssResources" : 0,
  "maxResources" : 0,
  "maxScriptRuns" : 0,
  "maxSessions" : 0,
  "members" : 0,
  "netDiskMaxCapability" : 0,
  "netDiskMaxFileSize" : 0,
  "requestId" : "string",
  "resources" : 0,
  "teamId" : 0
}

2.2.22. 获取所有团队信息

GET /teams

参数

类型名称说明架构默认列

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

条数

integer(int32)

"20"

响应

HTTP代码

说明

架构

200

GetTeamListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/teams

请求 query

{
  "page" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "page" : 0,
  "requestId" : "string",
  "size" : 0,
  "teams" : [ {
    "code" : "string",
    "createTime" : "string",
    "creator" : 0,
    "name" : "string",
    "quotaExceed" : false,
    "serveEndTime" : "string",
    "teamId" : 0,
    "teamType" : "string",
    "tenantId" : 0
  } ],
  "total" : 0
}

2.2.23. 获取团队列表（根据名称）

GET /teams/byName

参数

类型

名称

说明

架构

Query

name
必填

团队名称

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/teams/byName

请求 query

{
  "name" : "string"
}

HTTP响应示例

响应 200

{
  "code" : "string",
  "createTime" : "string",
  "creator" : 0,
  "departmentEnabled" : false,
  "memberAccounts" : {
    "string" : "string"
  },
  "members" : [ 0 ],
  "name" : "string",
  "quotaExceed" : false,
  "requestId" : "string",
  "serveEndTime" : "string",
  "teamId" : 0,
  "teamType" : "string"
}

2.2.24. 获取团队列表（根据名称模糊查询）

GET /teams/byNameLike

参数

类型

名称

说明

架构

Query

name
必填

团队名称

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/teams/byNameLike

请求 query

{
  "name" : "string"
}

HTTP响应示例

响应 200

{
  "code" : "string",
  "createTime" : "string",
  "creator" : 0,
  "departmentEnabled" : false,
  "memberAccounts" : {
    "string" : "string"
  },
  "members" : [ 0 ],
  "name" : "string",
  "quotaExceed" : false,
  "requestId" : "string",
  "serveEndTime" : "string",
  "teamId" : 0,
  "teamType" : "string"
}

2.3. 3 Cloud Api

云账户操作API

2.3.1. 批量创建局域网云账户

POST /cloud

参数

类型

名称

说明

架构

Body

request
必填

云账户列表

CreateCloudRequest

响应

HTTP代码

说明

架构

200

CreateCloudResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud

请求 body

{
  "clouds" : [ {
    "cidrRule" : "string",
    "cidrs" : "string",
    "creatorId" : 0,
    "intranetAccessType" : "string",
    "name" : "string",
    "referencedPolicyId" : 0,
    "roles" : "string",
    "teamId" : 0
  } ]
}

HTTP响应示例

响应 200

{
  "cloudIds" : [ 0 ],
  "requestId" : "string"
}

2.3.2. 获取区域下可售卖的磁盘规格

GET /cloud/availableDiskTypes

参数

类型

名称

说明

架构

Query

cloudId
必填

云账户ID

integer(int64)

Query

regionId
必填

区域ID

string

Query

zoneId
可选

可用区ID

string

Query

instanceType
可选

实例规格

string

响应

HTTP代码

说明

架构

200

InstanceTypeResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud/availableDiskTypes

请求 query

{
  "cloudId" : 0,
  "regionId" : "string",
  "zoneId" : "string",
  "instanceType" : "string"
}

HTTP响应示例

响应 200

{
  "instanceTypes" : [ {
    "instanceTypes" : [ {
      "cpu" : 0,
      "instanceType" : "string",
      "instanceTypeFamily" : "string",
      "memoryInMB" : 0
    } ],
    "regionId" : "string",
    "zoneId" : "string"
  } ],
  "requestId" : "string"
}

2.3.3. 获取区域下可售卖的实例规格

GET /cloud/availableInstanceTypes

参数

类型名称说明架构默认列

Query

cloudId
必填

云账户ID

integer(int64)

Query

regionId
必填

区域ID

string

Query

zoneId
可选

可用区ID

string

Query

instanceChargeType
必填

实例收费类型

enum (PrePaid, PostPaid)

"PostPaid"

响应

HTTP代码

说明

架构

200

InstanceTypeResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud/availableInstanceTypes

请求 query

{
  "cloudId" : 0,
  "regionId" : "string",
  "zoneId" : "string",
  "instanceChargeType" : "string"
}

HTTP响应示例

响应 200

{
  "instanceTypes" : [ {
    "instanceTypes" : [ {
      "cpu" : 0,
      "instanceType" : "string",
      "instanceTypeFamily" : "string",
      "memoryInMB" : 0
    } ],
    "regionId" : "string",
    "zoneId" : "string"
  } ],
  "requestId" : "string"
}

2.3.4. 创建一个Azure云账号

POST /cloud/azure

说明

参数roles用逗号连接多个角色id，如果是系统角色，可以用RoleCode。例如：roles='12,TEAM_ADMINER’表示id=12的角色和团队管理员角色。roles不能设置为TEAM_CREATOR。私有部署版包括通过role_templates.json配置的系统角色

参数

类型名称说明架构默认列

Query

teamId
必填

团队ID

integer(int64)

Query

name
必填

名称

string

Query

creatorId
可选

创建者用户ID，未设置时使用团队拥有者ID

integer(int64)

Query

roles
可选

新建云账户默认授予的角色，如果不设置时，只有团队拥有者能访问云账户

string

Query

subscriptionId
必填

subscriptionId

string

Query

tenantId
必填

tenantId

string

Query

clientId
必填

clientId

string

Query

clientSecret
必填

clientSecret

string

Query

intranetAccessType
必填

内网连接方式，默认proxy

enum (directly, proxy)

"proxy"

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud/azure

请求 query

{
  "teamId" : 0,
  "name" : "string",
  "creatorId" : 0,
  "roles" : "string",
  "subscriptionId" : "string",
  "tenantId" : "string",
  "clientId" : "string",
  "clientSecret" : "string",
  "intranetAccessType" : "string"
}

HTTP响应示例

响应 200

{
  "accountId" : "string",
  "cloudIntranetAccessType" : "string",
  "createTime" : "string",
  "id" : 0,
  "name" : "string",
  "provider" : "string",
  "requestId" : "string",
  "scope" : "string",
  "teamId" : 0
}

2.3.5. 查询团队所有云账户列表

GET /cloud/byTeam/{teamId}

参数

类型

名称

说明

架构

Path

teamId
必填

团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

ListCloudsResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud/byTeam/0

HTTP响应示例

响应 200

{
  "clouds" : [ {
    "accountId" : "string",
    "cloudIntranetAccessType" : "string",
    "createTime" : "string",
    "id" : 0,
    "name" : "string",
    "provider" : "string",
    "requestId" : "string",
    "scope" : "string",
    "teamId" : 0
  } ]
}

2.3.6. 查询团队所有云账户列表（根据teamCode）

GET /cloud/byTeamCode/{teamCode}

参数

类型

名称

说明

架构

Path

teamCode
必填

团队Code

string

响应

HTTP代码

说明

架构

200

ListCloudsResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud/byTeamCode/string

HTTP响应示例

响应 200

{
  "clouds" : [ {
    "accountId" : "string",
    "cloudIntranetAccessType" : "string",
    "createTime" : "string",
    "id" : 0,
    "name" : "string",
    "provider" : "string",
    "requestId" : "string",
    "scope" : "string",
    "teamId" : 0
  } ]
}

2.3.7. 根据ID查询云账户详情

GET /cloud/detail

参数

类型名称说明架构默认列

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
可选

云账户来源

enum (Console, Portal)

"Portal"

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud/detail

请求 query

{
  "cloudId" : 0,
  "scope" : "string"
}

HTTP响应示例

响应 200

{
  "accountId" : "string",
  "cloudIntranetAccessType" : "string",
  "createTime" : "string",
  "id" : 0,
  "name" : "string",
  "provider" : "string",
  "requestId" : "string",
  "scope" : "string",
  "teamId" : 0
}

2.3.8. 创建一个Openstack云账号

POST /cloud/openstack

说明

参数

类型名称说明架构默认列

Query

teamId
必填

团队ID

integer(int64)

Query

name
必填

名称

string

Query

creatorId
可选

创建者用户ID，未设置时使用团队拥有者ID

integer(int64)

Query

roles
可选

新建云账户默认授予的角色，如果不设置时，只有团队拥有者能访问云账户

string

Query

authUrl
必填

authUrl

string

Query

username
必填

username

string

Query

password
必填

password

string

Query

domainName
必填

domainName

string

Query

projectId
必填

projectId

string

Query

intranetAccessType
必填

内网连接方式，默认proxy

enum (directly, proxy)

"proxy"

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud/openstack

请求 query

{
  "teamId" : 0,
  "name" : "string",
  "creatorId" : 0,
  "roles" : "string",
  "authUrl" : "string",
  "username" : "string",
  "password" : "string",
  "domainName" : "string",
  "projectId" : "string",
  "intranetAccessType" : "string"
}

HTTP响应示例

响应 200

{
  "accountId" : "string",
  "cloudIntranetAccessType" : "string",
  "createTime" : "string",
  "id" : 0,
  "name" : "string",
  "provider" : "string",
  "requestId" : "string",
  "scope" : "string",
  "teamId" : 0
}

2.3.9. 获取云账户的项目列表

GET /cloud/projects

参数

类型

名称

说明

架构

Query

cloudId
必填

云账户ID

integer(int64)

Query

regionId
必填

区域ID

string

响应

HTTP代码

说明

架构

200

GetRegionResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud/projects

请求 query

{
  "cloudId" : 0,
  "regionId" : "string"
}

HTTP响应示例

响应 200

{
  "provider" : "string",
  "regions" : [ {
    "regionId" : "string",
    "regionName" : "string",
    "zones" : [ {
      "zoneId" : "string",
      "zoneName" : "string"
    } ]
  } ],
  "requestId" : "string"
}

2.3.10. 创建一个公有云云账户，不包括Azure

POST /cloud/public

说明

参数

类型名称说明架构默认列

Query

teamId
必填

团队ID

integer(int64)

Query

name
必填

名称

string

Query

creatorId
可选

创建者用户ID，未设置时使用团队拥有者ID

integer(int64)

Query

roles
可选

新建云账户默认授予的角色，如果不设置时，只有团队拥有者能访问云账户

string

Query

akId
必填

Access Key Id

string

Query

akSecret
必填

Access Key Secret

string

Query

provider
必填

云厂商

enum (aliyun, huaweicloud, ucloud, qingcloud, qcloud, azure, baidu, openstack, jdcloud, zstack, astack, aws_cn)

Query

intranetAccessType
必填

内网连接方式，默认proxy

enum (directly, proxy)

"proxy"

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud/public

请求 query

{
  "teamId" : 0,
  "name" : "string",
  "creatorId" : 0,
  "roles" : "string",
  "akId" : "string",
  "akSecret" : "string",
  "provider" : "string",
  "intranetAccessType" : "string"
}

HTTP响应示例

响应 200

{
  "accountId" : "string",
  "cloudIntranetAccessType" : "string",
  "createTime" : "string",
  "id" : 0,
  "name" : "string",
  "provider" : "string",
  "requestId" : "string",
  "scope" : "string",
  "teamId" : 0
}

2.3.11. 获取Proxy安装脚本

GET /cloud/{cloudId}/proxyScript

参数

类型

名称

说明

架构

Path

cloudId
必填

云账户ID

integer(int64)

Body

base64
可选

base64

boolean

响应

HTTP代码

说明

架构

200

GetProxyScriptResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud/0/proxyScript

请求 body

{ }

HTTP响应示例

响应 200

{
  "cloudId" : 0,
  "linuxInstallScript" : "string",
  "requestId" : "string",
  "windowsBatScript" : "string",
  "windowsScript" : "string"
}

2.3.12. 删除云账户

DELETE /cloud/{ids}

参数

类型

名称

说明

架构

Path

ids
必填

云账户id列表，用','连接

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud/string

2.3.13. 根据ID查询云账户

GET /cloud/{id}

参数

类型

名称

说明

架构

Path

id
必填

云账户ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud/0

HTTP响应示例

响应 200

{
  "accountId" : "string",
  "cloudIntranetAccessType" : "string",
  "createTime" : "string",
  "id" : 0,
  "name" : "string",
  "provider" : "string",
  "requestId" : "string",
  "scope" : "string",
  "teamId" : 0
}

2.3.14. 修改云账户

PUT /cloud/{id}

说明

包括两部分：修改云账户名称、重新指定授权角色。name和roles两个参数不能同时为空。为空时，不会修改。私有部署版包括通过role_templates.json配置的系统角色

参数

类型

名称

说明

架构

Path

id
必填

云账户id

integer(int64)

Query

name
可选

云账户名称

string

Query

roles
可选

新的角色授权

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud/0

请求 query

{
  "name" : "string",
  "roles" : "string"
}

2.3.15. 修改（局域网）云账户网段划分规则

PUT /cloud/{id}/cidrRule

说明

注意：1，仅局域网云账户支持修改；2，修改之后，主机会按照新的规则重新组织分组；3，耗时操作，后台系统异步完成请求；

参数

类型

名称

说明

架构

Path

id
必填

云账户id

integer(int64)

Query

cidrRule
必填

网段划分方式

enum (auto, manual)

Query

cidrs
必填

cidr串。在cidrRule=manual时必须指定cidr网段

string

响应

HTTP代码

说明

架构

200

JobVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud/0/cidrRule

请求 query

{
  "cidrRule" : "string",
  "cidrs" : "string"
}

HTTP响应示例

响应 200

{
  "id" : 0,
  "requestId" : "string"
}

2.3.16. 授权云账户给组织单元

PUT /cloud/{id}/departments

参数

类型

名称

说明

架构

Path

id
必填

云账户id

integer(int64)

Query

departments
可选

组织单元ID列表，用逗号连接

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud/0/departments

请求 query

{
  "departments" : "string"
}

2.3.17. 修改云账户内网连接方式

PUT /cloud/{id}/intranetAccessType

说明

仅私有部署版支持

参数

类型

名称

说明

架构

Path

id
必填

云账户id

integer(int64)

Query

intranetAccessType
必填

内网连接方式

enum (directly, proxy)

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud/0/intranetAccessType

请求 query

{
  "intranetAccessType" : "string"
}

2.3.18. 授权云账户给用户

PUT /cloud/{id}/members

参数

类型

名称

说明

架构

Path

id
必填

云账户id

integer(int64)

Query

members
可选

用户ID列表，用逗号连接

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud/0/members

请求 query

{
  "members" : "string"
}

2.3.19. 撤销云账户的所有角色授权

PUT /cloud/{id}/revokeAllRoles

说明

清空角色授权以后，只有团队拥有者有权限访问云账户

参数

类型

名称

说明

架构

Path

id
必填

云账户id

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud/0/revokeAllRoles

2.3.20. 授权云账户给角色

PUT /cloud/{id}/roles

参数

类型

名称

说明

架构

Path

id
必填

云账户id

integer(int64)

Query

roles
可选

角色ID列表，用逗号连接

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloud/0/roles

请求 query

{
  "roles" : "string"
}

2.3.21. 创建一个局域网云账户

POST /cloudV2

说明

1，参数roles用逗号连接多个角色id，如果是系统角色，可以用RoleCode。例如：roles='12,TEAM_ADMINER’表示id=12的角色和团队管理员角色。roles不能设置为TEAM_CREATOR。私有部署版包括通过role_templates.json配置的系统角色.。 2,网段划分方式:4.18新增，默认是auto(自动按C网段划分)。manual:按设定的CIDR划分；cidr串：手工（cidrRule=manual）指定cidr网段，4.18新增，用逗号连接。 3,referencedPolicyId指定团队内的一个运维子策略ID，新建的云账户将引用这个策略中的条目设置默认值，4.18新增。

参数

类型名称说明架构默认列

Query

teamId
必填

团队ID

integer(int64)

Query

name
必填

名称

string

Query

creatorId
可选

创建者用户ID，未设置时使用团队拥有者ID

integer(int64)

Query

roles
可选

新建云账户默认授予的角色，如果不设置时，只有团队拥有者能访问云账户

string

Query

intranetAccessType
必填

内网连接方式，默认proxy

enum (directly, proxy)

"proxy"

Query

cidrRule
必填

网段划分方式

enum (auto, manual)

"auto"

Query

cidrs
可选

cidr串

string

Query

referencedPolicyId
可选

参考运维子策略ID

integer(int64)

响应

HTTP代码

说明

架构

200

CreateCloudResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cloudV2

请求 query

{
  "teamId" : 0,
  "name" : "string",
  "creatorId" : 0,
  "roles" : "string",
  "intranetAccessType" : "string",
  "cidrRule" : "string",
  "cidrs" : "string",
  "referencedPolicyId" : 0
}

HTTP响应示例

响应 200

{
  "cloudIds" : [ 0 ],
  "requestId" : "string"
}

2.3.22. 获取云厂商的所有区域

GET /region/byCloud/{cloudId}

参数

类型

名称

说明

架构

Path

cloudId
必填

云账户ID

integer(int64)

响应

HTTP代码

说明

架构

200

GetRegionResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/region/byCloud/0

HTTP响应示例

响应 200

{
  "provider" : "string",
  "regions" : [ {
    "regionId" : "string",
    "regionName" : "string",
    "zones" : [ {
      "zoneId" : "string",
      "zoneName" : "string"
    } ]
  } ],
  "requestId" : "string"
}

2.3.23. 获取云厂商的所有区域

GET /region/byProvider/{provider}

参数

类型

名称

说明

架构

Path

provider
必填

云厂商

string

响应

HTTP代码

说明

架构

200

GetRegionResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/region/byProvider/string

HTTP响应示例

响应 200

{
  "provider" : "string",
  "regions" : [ {
    "regionId" : "string",
    "regionName" : "string",
    "zones" : [ {
      "zoneId" : "string",
      "zoneName" : "string"
    } ]
  } ],
  "requestId" : "string"
}

2.4. 4 Host Api

主机操作API

2.4.1. 获取云账户的物理网络列表

GET /hg/byCloud/{cloudId}

说明

物理网络，也叫主机物理分组。在公有云账户中，按区域进行划分；在局域网账户中，按子网进行划分（比如主机192.168.1.123属于物理分组：192.168.1.*。物理网络也可以进行角色授权

参数

类型

名称

说明

架构

Path

cloudId
必填

云账户ID

integer(int64)

响应

HTTP代码

说明

架构

200

HostGroupVoResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/hg/byCloud/0

HTTP响应示例

响应 200

{
  "hostgroups" : [ {
    "cloudId" : 0,
    "id" : 0,
    "name" : "string",
    "networkType" : "string",
    "regionId" : "string",
    "requestId" : "string",
    "teamId" : 0
  } ]
}

2.4.2. 撤销物理分组的所有角色授权

PUT /hg/{id}/revokeAllRoles

说明

清空角色授权以后，只有团队拥有者有权限

参数

类型

名称

说明

架构

Path

id
必填

物理分组id

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/hg/0/revokeAllRoles

2.4.3. 批量导入局域网主机

POST /host

说明

可以根据vgIds参数选择是否默认把新建主机加入到虚拟分组中,vgIds代表的虚拟分组必须属于当前团队。4.8版本以后，导入主机时创建的物理分组将不再默认授权给所有成员。资源授权请使用虚拟分组API。

参数

类型

名称

说明

架构

Body

request
必填

主机列表

ImportHostRequest

响应

HTTP代码

说明

架构

200

ImportHostResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host

请求 body

{
  "cloudId" : 0,
  "hosts" : [ {
    "defaultVgIds" : [ 0 ],
    "description" : "string",
    "innerIp" : "string",
    "instanceId" : "string",
    "memory" : 0,
    "name" : "string",
    "operatingSystem" : "string",
    "processor" : 0,
    "publicIp" : "string",
    "status" : "string"
  } ],
  "teamId" : 0,
  "vgIds" : [ 0 ]
}

HTTP响应示例

响应 200

{
  "cloudId" : 0,
  "groupId" : 0,
  "hostIds" : [ 0 ],
  "teamId" : 0
}

2.4.4. 获取云账户主机成本优化建议

GET /host/advice/byCloud/{cloudId}

参数

类型

名称

说明

架构

Path

cloudId
必填

所属云账户ID

integer(int64)

响应

HTTP代码

说明

架构

200

OptimizedAdviceResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/advice/byCloud/0

HTTP响应示例

响应 200

{
  "optimizedAdvices" : [ {
    "adviceLevel" : "string",
    "adviceTarget" : "string",
    "description" : "string",
    "hostId" : 0,
    "optimizedAdviceId" : 0,
    "saveMoney" : 0.0
  } ],
  "requestId" : "string"
}

2.4.5. 获取团队主机成本优化建议

GET /host/advice/byTeam/{teamId}

参数

类型

名称

说明

架构

Path

teamId
必填

所属团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

OptimizedAdviceResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/advice/byTeam/0

HTTP响应示例

响应 200

{
  "optimizedAdvices" : [ {
    "adviceLevel" : "string",
    "adviceTarget" : "string",
    "description" : "string",
    "hostId" : 0,
    "optimizedAdviceId" : 0,
    "saveMoney" : 0.0
  } ],
  "requestId" : "string"
}

2.4.6. 获取特定主机成本优化建议

GET /host/advice/{hostId}

参数

类型

名称

说明

架构

Path

hostId
必填

主机ID

integer(int64)

响应

HTTP代码

说明

架构

200

OptimizedAdviceResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/advice/0

HTTP响应示例

响应 200

{
  "optimizedAdvices" : [ {
    "adviceLevel" : "string",
    "adviceTarget" : "string",
    "description" : "string",
    "hostId" : 0,
    "optimizedAdviceId" : 0,
    "saveMoney" : 0.0
  } ],
  "requestId" : "string"
}

2.4.7. 获取云账户中所有主机

GET /host/byCloud/{cloudId}

参数

类型名称说明架构默认列

Path

cloudId
必填

云账户id

integer(int64)

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

条数

integer(int32)

"20"

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/byCloud/0

请求 query

{
  "page" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "hosts" : [ {
    "agentStatus" : "string",
    "cloudId" : 0,
    "cloudName" : "string",
    "dataDisks" : [ {
      "category" : "string",
      "deleteWithInstance" : false,
      "diskId" : "string",
      "diskName" : "string",
      "jobId" : 0,
      "size" : 0
    } ],
    "description" : "string",
    "groupId" : 0,
    "hostId" : 0,
    "hostName" : "string",
    "importTime" : "string",
    "innerIp" : "string",
    "installedAgent" : false,
    "instanceId" : "string",
    "instanceName" : "string",
    "jobId" : 0,
    "macAddr" : "string",
    "memory" : 0,
    "operatingSystem" : "string",
    "platform" : "string",
    "processorCores" : 0,
    "provider" : "string",
    "proxyHostId" : 0,
    "proxyInnerIp" : "string",
    "proxyInstalledAgent" : false,
    "proxyInstanceName" : "string",
    "proxyPublicIp" : "string",
    "publicIp" : "string",
    "regionId" : "string",
    "scope" : "string",
    "status" : "string",
    "systemDisk" : {
      "category" : "string",
      "diskId" : "string",
      "size" : 0
    },
    "teamId" : 0,
    "zoneId" : "string"
  } ],
  "jobId" : 0
}

2.4.8. 获取团队中所有主机

GET /host/byTeam/{teamId}

参数

类型名称说明架构默认列

Path

teamId
必填

团队ID

integer(int64)

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

条数

integer(int32)

"20"

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/byTeam/0

请求 query

{
  "page" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "hosts" : [ {
    "agentStatus" : "string",
    "cloudId" : 0,
    "cloudName" : "string",
    "dataDisks" : [ {
      "category" : "string",
      "deleteWithInstance" : false,
      "diskId" : "string",
      "diskName" : "string",
      "jobId" : 0,
      "size" : 0
    } ],
    "description" : "string",
    "groupId" : 0,
    "hostId" : 0,
    "hostName" : "string",
    "importTime" : "string",
    "innerIp" : "string",
    "installedAgent" : false,
    "instanceId" : "string",
    "instanceName" : "string",
    "jobId" : 0,
    "macAddr" : "string",
    "memory" : 0,
    "operatingSystem" : "string",
    "platform" : "string",
    "processorCores" : 0,
    "provider" : "string",
    "proxyHostId" : 0,
    "proxyInnerIp" : "string",
    "proxyInstalledAgent" : false,
    "proxyInstanceName" : "string",
    "proxyPublicIp" : "string",
    "publicIp" : "string",
    "regionId" : "string",
    "scope" : "string",
    "status" : "string",
    "systemDisk" : {
      "category" : "string",
      "diskId" : "string",
      "size" : 0
    },
    "teamId" : 0,
    "zoneId" : "string"
  } ],
  "jobId" : 0
}

2.4.9. 获取团队中所有主机（根据团队code）

GET /host/byTeamCode/{teamCode}

参数

类型名称说明架构默认列

Path

teamCode
必填

团队code

string

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

条数

integer(int32)

"20"

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/byTeamCode/string

请求 query

{
  "page" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "hosts" : [ {
    "agentStatus" : "string",
    "cloudId" : 0,
    "cloudName" : "string",
    "dataDisks" : [ {
      "category" : "string",
      "deleteWithInstance" : false,
      "diskId" : "string",
      "diskName" : "string",
      "jobId" : 0,
      "size" : 0
    } ],
    "description" : "string",
    "groupId" : 0,
    "hostId" : 0,
    "hostName" : "string",
    "importTime" : "string",
    "innerIp" : "string",
    "installedAgent" : false,
    "instanceId" : "string",
    "instanceName" : "string",
    "jobId" : 0,
    "macAddr" : "string",
    "memory" : 0,
    "operatingSystem" : "string",
    "platform" : "string",
    "processorCores" : 0,
    "provider" : "string",
    "proxyHostId" : 0,
    "proxyInnerIp" : "string",
    "proxyInstalledAgent" : false,
    "proxyInstanceName" : "string",
    "proxyPublicIp" : "string",
    "publicIp" : "string",
    "regionId" : "string",
    "scope" : "string",
    "status" : "string",
    "systemDisk" : {
      "category" : "string",
      "diskId" : "string",
      "size" : 0
    },
    "teamId" : 0,
    "zoneId" : "string"
  } ],
  "jobId" : 0
}

2.4.10. 获取用户在团队中的可见主机列表

GET /host/byUser/{userId}

说明

如果传递cloudId或groupId，则会按照云账户或物理分组再过滤一次。（groupId优先级比cloudId高）

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

Path

userId
必填

用户ID

integer(int64)

Query

cloudId
可选

云账户ID

integer(int64)

Query

groupId
可选

物理分组ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/byUser/0

请求 query

{
  "teamId" : 0,
  "cloudId" : 0,
  "groupId" : 0
}

HTTP响应示例

响应 200

{
  "hosts" : [ {
    "agentStatus" : "string",
    "cloudId" : 0,
    "cloudName" : "string",
    "dataDisks" : [ {
      "category" : "string",
      "deleteWithInstance" : false,
      "diskId" : "string",
      "diskName" : "string",
      "jobId" : 0,
      "size" : 0
    } ],
    "description" : "string",
    "groupId" : 0,
    "hostId" : 0,
    "hostName" : "string",
    "importTime" : "string",
    "innerIp" : "string",
    "installedAgent" : false,
    "instanceId" : "string",
    "instanceName" : "string",
    "jobId" : 0,
    "macAddr" : "string",
    "memory" : 0,
    "operatingSystem" : "string",
    "platform" : "string",
    "processorCores" : 0,
    "provider" : "string",
    "proxyHostId" : 0,
    "proxyInnerIp" : "string",
    "proxyInstalledAgent" : false,
    "proxyInstanceName" : "string",
    "proxyPublicIp" : "string",
    "publicIp" : "string",
    "regionId" : "string",
    "scope" : "string",
    "status" : "string",
    "systemDisk" : {
      "category" : "string",
      "diskId" : "string",
      "size" : 0
    },
    "teamId" : 0,
    "zoneId" : "string"
  } ],
  "jobId" : 0
}

2.4.11. 查询云账户主机成品评估明细

GET /host/cost/byCloud/{cloudId}

参数

类型

名称

说明

架构

Path

cloudId
必填

所属云账户ID

integer(int64)

响应

HTTP代码

说明

架构

200

HostCostResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/cost/byCloud/0

HTTP响应示例

响应 200

{
  "bandwidthCost" : 0.0,
  "diskCost" : 0.0,
  "hostCosts" : [ {
    "bandwidthCost" : 0.0,
    "chargeType" : "string",
    "diskCost" : 0.0,
    "id" : 0,
    "instanceCost" : 0.0,
    "instanceId" : "string",
    "instanceName" : "string",
    "platform" : "string",
    "snapshotCost" : 0.0,
    "totalCost" : 0.0
  } ],
  "instanceCost" : 0.0,
  "requestId" : "string",
  "snapshotCost" : 0.0,
  "totalCost" : 0.0
}

2.4.12. 查询团队主机成品评估明细

GET /host/cost/byTeam/{teamId}

参数

类型

名称

说明

架构

Path

teamId
必填

所属团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

HostCostResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/cost/byTeam/0

HTTP响应示例

响应 200

{
  "bandwidthCost" : 0.0,
  "diskCost" : 0.0,
  "hostCosts" : [ {
    "bandwidthCost" : 0.0,
    "chargeType" : "string",
    "diskCost" : 0.0,
    "id" : 0,
    "instanceCost" : 0.0,
    "instanceId" : "string",
    "instanceName" : "string",
    "platform" : "string",
    "snapshotCost" : 0.0,
    "totalCost" : 0.0
  } ],
  "instanceCost" : 0.0,
  "requestId" : "string",
  "snapshotCost" : 0.0,
  "totalCost" : 0.0
}

2.4.13. 查询云账户主机成品评估明细（csv文件下载）

GET /host/costCsv/byCloud/{cloudId}

说明

直接返回流式数据。

参数

类型名称说明架构默认列

Path

cloudId
必填

所属云账户ID

integer(int64)

Query

lang
可选

表格语言，目前支持：zh,en

string

"zh"

响应

HTTP代码

说明

架构

200

流式数据

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/costCsv/byCloud/0

请求 query

{
  "lang" : "string"
}

2.4.14. 查询团队主机成品评估明细（csv文件下载）

GET /host/costCsv/byTeam/{teamId}

说明

直接返回流式数据。

参数

类型名称说明架构默认列

Path

teamId
必填

所属团队ID

integer(int64)

Query

lang
可选

表格语言，目前支持：zh,en

string

"zh"

响应

HTTP代码

说明

架构

200

流式数据

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/costCsv/byTeam/0

请求 query

{
  "lang" : "string"
}

2.4.15. 查询云账户主机成品评估明细（csv文件下载URL）

GET /host/costCsvUrl/byCloud/{cloudId}

参数

类型名称说明架构默认列

Path

cloudId
必填

所属云账户ID

integer(int64)

Query

lang
可选

表格语言，目前支持：zh,en

string

"zh"

Query

oneoff
必填

是否一次有效

boolean

"true"

Query

expireSeconds
必填

链接超时时间，单位：秒，取值范围[5min,24hr]

integer(int64)

"600"

响应

HTTP代码

说明

架构

200

流式数据

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/costCsvUrl/byCloud/0

请求 query

{
  "lang" : "string",
  "oneoff" : true,
  "expireSeconds" : 0
}

HTTP响应示例

响应 200

{
  "expiredSeconds" : 0,
  "url" : "string"
}

2.4.16. 查询团队主机成品评估明细（csv文件下载URL）

GET /host/costCsvUrl/byTeam/{teamId}

参数

类型名称说明架构默认列

Path

teamId
必填

所属团队ID

integer(int64)

Query

lang
可选

表格语言，目前支持：zh,en

string

"zh"

Query

oneoff
必填

是否一次有效

boolean

"true"

Query

expireSeconds
必填

链接超时时间，单位：秒，取值范围[5min,24hr]

integer(int64)

"600"

响应

HTTP代码

说明

架构

200

流式数据

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/costCsvUrl/byTeam/0

请求 query

{
  "lang" : "string",
  "oneoff" : true,
  "expireSeconds" : 0
}

HTTP响应示例

响应 200

{
  "expiredSeconds" : 0,
  "url" : "string"
}

2.4.17. 根据内网和公网IP获取主机信息

GET /host/findByInnerIpAndPublicIp

说明

包括API导入和行云管家页面导入的主机。匹配规则：内网IP=innerIp（如果设置）且公网IP=publicIp（如果设置）。innerIp和publicIp两个参数必须至少指定一个

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

Query

cloudId
可选

云账户id

integer(int64)

Query

innerIp
可选

内网IP

string

Query

publicIp
可选

公网IP

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/findByInnerIpAndPublicIp

请求 query

{
  "teamId" : 0,
  "cloudId" : 0,
  "innerIp" : "string",
  "publicIp" : "string"
}

HTTP响应示例

响应 200

{
  "hosts" : [ {
    "agentStatus" : "string",
    "cloudId" : 0,
    "cloudName" : "string",
    "dataDisks" : [ {
      "category" : "string",
      "deleteWithInstance" : false,
      "diskId" : "string",
      "diskName" : "string",
      "jobId" : 0,
      "size" : 0
    } ],
    "description" : "string",
    "groupId" : 0,
    "hostId" : 0,
    "hostName" : "string",
    "importTime" : "string",
    "innerIp" : "string",
    "installedAgent" : false,
    "instanceId" : "string",
    "instanceName" : "string",
    "jobId" : 0,
    "macAddr" : "string",
    "memory" : 0,
    "operatingSystem" : "string",
    "platform" : "string",
    "processorCores" : 0,
    "provider" : "string",
    "proxyHostId" : 0,
    "proxyInnerIp" : "string",
    "proxyInstalledAgent" : false,
    "proxyInstanceName" : "string",
    "proxyPublicIp" : "string",
    "publicIp" : "string",
    "regionId" : "string",
    "scope" : "string",
    "status" : "string",
    "systemDisk" : {
      "category" : "string",
      "diskId" : "string",
      "size" : 0
    },
    "teamId" : 0,
    "zoneId" : "string"
  } ],
  "jobId" : 0
}

2.4.18. 根据instanceId获取主机信息

GET /host/findByInstanceId

说明

包括云主机和局域网主机。instanceId可以是云主机的实例ID或者Openapi导入主机时用户指定的instanceId，或者由系统自动生成的instanceId

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

Query

cloudId
可选

云账户id

integer(int64)

Query

instanceId
必填

instanceId

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/findByInstanceId

请求 query

{
  "teamId" : 0,
  "cloudId" : 0,
  "instanceId" : "string"
}

HTTP响应示例

响应 200

{
  "hosts" : [ {
    "agentStatus" : "string",
    "cloudId" : 0,
    "cloudName" : "string",
    "dataDisks" : [ {
      "category" : "string",
      "deleteWithInstance" : false,
      "diskId" : "string",
      "diskName" : "string",
      "jobId" : 0,
      "size" : 0
    } ],
    "description" : "string",
    "groupId" : 0,
    "hostId" : 0,
    "hostName" : "string",
    "importTime" : "string",
    "innerIp" : "string",
    "installedAgent" : false,
    "instanceId" : "string",
    "instanceName" : "string",
    "jobId" : 0,
    "macAddr" : "string",
    "memory" : 0,
    "operatingSystem" : "string",
    "platform" : "string",
    "processorCores" : 0,
    "provider" : "string",
    "proxyHostId" : 0,
    "proxyInnerIp" : "string",
    "proxyInstalledAgent" : false,
    "proxyInstanceName" : "string",
    "proxyPublicIp" : "string",
    "publicIp" : "string",
    "regionId" : "string",
    "scope" : "string",
    "status" : "string",
    "systemDisk" : {
      "category" : "string",
      "diskId" : "string",
      "size" : 0
    },
    "teamId" : 0,
    "zoneId" : "string"
  } ],
  "jobId" : 0
}

2.4.19. 根据IP地址获取主机信息

GET /host/findByIp

说明

包括API导入和行云管家页面导入的主机。匹配规则：内网IP或公网IP匹配给定IP

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

Query

cloudId
可选

云账户id

integer(int64)

Query

ip
必填

IP地址

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/findByIp

请求 query

{
  "teamId" : 0,
  "cloudId" : 0,
  "ip" : "string"
}

HTTP响应示例

响应 200

{
  "hosts" : [ {
    "agentStatus" : "string",
    "cloudId" : 0,
    "cloudName" : "string",
    "dataDisks" : [ {
      "category" : "string",
      "deleteWithInstance" : false,
      "diskId" : "string",
      "diskName" : "string",
      "jobId" : 0,
      "size" : 0
    } ],
    "description" : "string",
    "groupId" : 0,
    "hostId" : 0,
    "hostName" : "string",
    "importTime" : "string",
    "innerIp" : "string",
    "installedAgent" : false,
    "instanceId" : "string",
    "instanceName" : "string",
    "jobId" : 0,
    "macAddr" : "string",
    "memory" : 0,
    "operatingSystem" : "string",
    "platform" : "string",
    "processorCores" : 0,
    "provider" : "string",
    "proxyHostId" : 0,
    "proxyInnerIp" : "string",
    "proxyInstalledAgent" : false,
    "proxyInstanceName" : "string",
    "proxyPublicIp" : "string",
    "publicIp" : "string",
    "regionId" : "string",
    "scope" : "string",
    "status" : "string",
    "systemDisk" : {
      "category" : "string",
      "diskId" : "string",
      "size" : 0
    },
    "teamId" : 0,
    "zoneId" : "string"
  } ],
  "jobId" : 0
}

2.4.20. 查询团队内安装了Agent的主机

GET /host/findHostsWithAgent

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/findHostsWithAgent

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "hosts" : [ {
    "agentStatus" : "string",
    "cloudId" : 0,
    "cloudName" : "string",
    "dataDisks" : [ {
      "category" : "string",
      "deleteWithInstance" : false,
      "diskId" : "string",
      "diskName" : "string",
      "jobId" : 0,
      "size" : 0
    } ],
    "description" : "string",
    "groupId" : 0,
    "hostId" : 0,
    "hostName" : "string",
    "importTime" : "string",
    "innerIp" : "string",
    "installedAgent" : false,
    "instanceId" : "string",
    "instanceName" : "string",
    "jobId" : 0,
    "macAddr" : "string",
    "memory" : 0,
    "operatingSystem" : "string",
    "platform" : "string",
    "processorCores" : 0,
    "provider" : "string",
    "proxyHostId" : 0,
    "proxyInnerIp" : "string",
    "proxyInstalledAgent" : false,
    "proxyInstanceName" : "string",
    "proxyPublicIp" : "string",
    "publicIp" : "string",
    "regionId" : "string",
    "scope" : "string",
    "status" : "string",
    "systemDisk" : {
      "category" : "string",
      "diskId" : "string",
      "size" : 0
    },
    "teamId" : 0,
    "zoneId" : "string"
  } ],
  "jobId" : 0
}

2.4.21. 查询团队内安装了Proxy的主机

GET /host/findHostsWithProxy

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/findHostsWithProxy

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "hosts" : [ {
    "agentStatus" : "string",
    "cloudId" : 0,
    "cloudName" : "string",
    "dataDisks" : [ {
      "category" : "string",
      "deleteWithInstance" : false,
      "diskId" : "string",
      "diskName" : "string",
      "jobId" : 0,
      "size" : 0
    } ],
    "description" : "string",
    "groupId" : 0,
    "hostId" : 0,
    "hostName" : "string",
    "importTime" : "string",
    "innerIp" : "string",
    "installedAgent" : false,
    "instanceId" : "string",
    "instanceName" : "string",
    "jobId" : 0,
    "macAddr" : "string",
    "memory" : 0,
    "operatingSystem" : "string",
    "platform" : "string",
    "processorCores" : 0,
    "provider" : "string",
    "proxyHostId" : 0,
    "proxyInnerIp" : "string",
    "proxyInstalledAgent" : false,
    "proxyInstanceName" : "string",
    "proxyPublicIp" : "string",
    "publicIp" : "string",
    "regionId" : "string",
    "scope" : "string",
    "status" : "string",
    "systemDisk" : {
      "category" : "string",
      "diskId" : "string",
      "size" : 0
    },
    "teamId" : 0,
    "zoneId" : "string"
  } ],
  "jobId" : 0
}

2.4.22. 获取主机ID列表

GET /host/findIds

说明

包括API导入和行云管家页面导入的主机ID

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

GetHostBriefResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/findIds

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "hostIds" : [ 0 ]
}

2.4.23. 获取主机状态

GET /host/findStatus

说明

包括API导入和行云管家页面导入的主机ID

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

Query

hostIds
可选

主机ID列表

string

响应

HTTP代码

说明

架构

200

GetHostsStatusResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/findStatus

请求 query

{
  "teamId" : 0,
  "hostIds" : "string"
}

HTTP响应示例

响应 200

{
  "statusMap" : {
    "string" : "string"
  }
}

2.4.24. 导入一台公有云主机，不支持Azure

POST /host/public

说明

导入过程创建的物理分组不会设置任何角色，即只有团队拥有者可见。如果物理分组已经存在则不会改变已有授权结构

参数

类型

名称

说明

架构

Query

cloudId
必填

云账户ID

integer(int64)

Query

regionId
必填

云厂商区域ID

string

Query

instanceId
必填

云主机instanceId

string

Query

creatorId
可选

导入主机的用户ID，不设置时，是团队所有者

integer(int64)

响应

HTTP代码

说明

架构

200

JobVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/public

请求 query

{
  "cloudId" : 0,
  "regionId" : "string",
  "instanceId" : "string",
  "creatorId" : 0
}

HTTP响应示例

响应 200

{
  "id" : 0,
  "requestId" : "string"
}

2.4.25. 获取团队中所有公网主机列表

GET /host/publicHostByTeam/{teamId}

参数

类型

名称

说明

架构

Path

teamId
必填

团队id

integer(int64)

Query

createTimeFrom
可选

创建时间起[yyyy-MM-dd’T’HH:mm:ss’Z]

string

Query

createTimeTo
可选

创建时间止[yyyy-MM-dd’T’HH:mm:ss’Z]

string

响应

HTTP代码

说明

架构

200

PublicIpHostsResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/publicHostByTeam/0

请求 query

{
  "createTimeFrom" : "string",
  "createTimeTo" : "string"
}

HTTP响应示例

响应 200

{
  "hosts" : [ {
    "creationTime" : "string",
    "innerIp" : "string",
    "instanceId" : "string",
    "instanceName" : "string",
    "provider" : "string",
    "publicIp" : "string",
    "requestId" : "string",
    "teamId" : 0
  } ],
  "requestId" : "string"
}

2.4.26. 重启虚拟机

POST /host/{hostId}/restart

参数

类型名称说明架构默认列

Path

hostId
必填

主机ID

integer(int64)

Query

force
可选

是否强制重启

boolean

"false"

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/0/restart

请求 query

{
  "force" : true
}

2.4.27. 启动虚拟机

POST /host/{hostId}/start

参数

类型

名称

说明

架构

Path

hostId
必填

主机ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/0/start

2.4.28. 关闭虚拟机

POST /host/{hostId}/stop

参数

类型

名称

说明

架构

Path

hostId
必填

主机ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/0/stop

2.4.29. 删除主机

DELETE /host/{ids}

说明

删除的主机，可以来自API导入和行云管家页面导入

参数

类型

名称

说明

架构

Path

ids
必填

主机id列表，用','连接

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/string

2.4.30. 获取主机详情

GET /host/{id}

参数

类型

名称

说明

架构

Path

id
必填

主机id

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/0

HTTP响应示例

响应 200

{
  "agentStatus" : "string",
  "cloudId" : 0,
  "cloudName" : "string",
  "dataDisks" : [ {
    "category" : "string",
    "deleteWithInstance" : false,
    "diskId" : "string",
    "diskName" : "string",
    "jobId" : 0,
    "size" : 0
  } ],
  "description" : "string",
  "groupId" : 0,
  "hostId" : 0,
  "hostName" : "string",
  "importTime" : "string",
  "innerIp" : "string",
  "installedAgent" : false,
  "instanceId" : "string",
  "instanceName" : "string",
  "jobId" : 0,
  "macAddr" : "string",
  "memory" : 0,
  "operatingSystem" : "string",
  "platform" : "string",
  "processorCores" : 0,
  "provider" : "string",
  "proxyHostId" : 0,
  "proxyInnerIp" : "string",
  "proxyInstalledAgent" : false,
  "proxyInstanceName" : "string",
  "proxyPublicIp" : "string",
  "publicIp" : "string",
  "regionId" : "string",
  "scope" : "string",
  "status" : "string",
  "systemDisk" : {
    "category" : "string",
    "diskId" : "string",
    "size" : 0
  },
  "teamId" : 0,
  "zoneId" : "string"
}

2.4.31. 更新主机信息

PUT /host/{id}

说明

不需要更新的属性，请保持默认值

参数

类型

名称

说明

架构

Path

id
必填

主机id

integer(int64)

Body

hostVo
必填

主机信息

ImportHostVo

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/0

请求 body

{
  "defaultVgIds" : [ 0 ],
  "description" : "string",
  "innerIp" : "string",
  "instanceId" : "string",
  "memory" : 0,
  "name" : "string",
  "operatingSystem" : "string",
  "processor" : 0,
  "publicIp" : "string",
  "status" : "string"
}

2.4.32. 获取主机Agent安装脚本

GET /host/{id}/agentScript

参数

类型

名称

说明

架构

Path

id
必填

主机id

integer(int64)

响应

HTTP代码

说明

架构

200

GetAgentScriptResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/0/agentScript

HTTP响应示例

响应 200

{
  "cloudId" : 0,
  "hostId" : 0,
  "linuxInstallScript" : "string",
  "requestId" : "string",
  "windowsBatScript" : "string",
  "windowsScript" : "string"
}

2.4.33. 更新主机所有登录凭证密码

PUT /host/{id}/credentials

说明

同时满足下面条件的登录凭证都会被修改：1，认证类型是密码而不是密钥文件；2，登录凭证关联到当前主机。风险提示：不会校验被修改的登录凭证原来密码是否正确，都会被修改成指定的密码，可能使原本错误的登录凭证可以登录成功。返回被修改的登录凭证列表。

参数

类型

名称

说明

架构

Path

id
必填

主机id

integer(int64)

Query

user
必填

用户名

string

Query

password
必填

登录密码，长度>=4，不校验复杂性

string

Query

encryptSensitive
可选

密码是否是加密字串，可选。默认为false

boolean

响应

HTTP代码

说明

架构

200

ListCredentialsResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/0/credentials

请求 query

{
  "user" : "string",
  "password" : "string",
  "encryptSensitive" : true
}

HTTP响应示例

响应 200

{
  "credentials" : [ {
    "authType" : "string",
    "createTime" : "string",
    "creatorId" : 0,
    "desktopType" : "string",
    "id" : 0,
    "name" : "string",
    "suCommand" : "string",
    "suUser" : "string",
    "user" : "string"
  } ],
  "requestId" : "string"
}

2.4.34. 获取主机所有快捷方式

GET /host/{id}/shortcuts

参数

类型

名称

说明

架构

Path

id
必填

主机id

integer(int64)

响应

HTTP代码

说明

架构

200

GetShortcutsResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/0/shortcuts

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "shortcuts" : [ {
    "createTime" : "string",
    "creatorId" : 0,
    "creatorName" : "string",
    "desktopType" : "string",
    "hostId" : 0,
    "id" : 0,
    "loginAccount" : "string",
    "name" : "string",
    "passwordOrKeySet" : false,
    "requestId" : "string",
    "updateTime" : "string"
  } ]
}

2.4.35. 删除主机所有快捷方式

DELETE /host/{id}/shortcuts

参数

类型

名称

说明

架构

Path

id
必填

主机id

integer(int64)

响应

HTTP代码

说明

架构

200

DeleteEntitiesResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/host/0/shortcuts

HTTP响应示例

响应 200

{
  "count" : 0,
  "requestId" : "string"
}

2.4.36. 获取主机一个用户的访问串信息

GET /hostAccessAuth/byHost/{hostId}

参数

类型

名称

说明

架构

Path

hostId
必填

主机ID

integer(int64)

Query

userId
必填

用户ID

integer(int64)

响应

HTTP代码

说明

架构

200

HostAccessAuthResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/hostAccessAuth/byHost/0

请求 query

{
  "userId" : 0
}

HTTP响应示例

响应 200

{
  "accessAuthResults" : [ {
    "account" : "string",
    "credentialId" : 0,
    "hostId" : 0,
    "id" : 0,
    "password" : "string",
    "port" : 0,
    "requestId" : "string",
    "serverAddr" : "string",
    "userId" : 0
  } ],
  "count" : 0,
  "requestId" : "string"
}

2.4.37. 删除主机一个用户的访问串

DELETE /hostAccessAuth/byHost/{hostId}

参数

类型

名称

说明

架构

Path

hostId
必填

主机ID

integer(int64)

Query

userId
必填

用户ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/hostAccessAuth/byHost/0

请求 query

{
  "userId" : 0
}

HTTP响应示例

响应 200

{
  "msg" : "string",
  "success" : true
}

2.4.38. 给指定用户生成指定主机的访问串

POST /hostAccessAuth/{hostId}/{userId}/{credentialId}

说明

基于已有的登陆凭证

参数

类型

名称

说明

架构

Path

hostId
必填

主机ID

integer(int64)

Path

userId
必填

用户ID

integer(int64)

Path

credentialId
必填

登陆凭证ID

integer(int64)

响应

HTTP代码

说明

架构

200

AccessAuthResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/hostAccessAuth/0/0/0

HTTP响应示例

响应 200

{
  "account" : "string",
  "credentialId" : 0,
  "hostId" : 0,
  "id" : 0,
  "password" : "string",
  "port" : 0,
  "requestId" : "string",
  "serverAddr" : "string",
  "userId" : 0
}

2.4.39. 获取访问串信息

GET /hostAccessAuth/{id}

参数

类型

名称

说明

架构

Path

id
必填

访问串ID

integer(int64)

响应

HTTP代码

说明

架构

200

AccessAuthResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/hostAccessAuth/0

HTTP响应示例

响应 200

{
  "account" : "string",
  "credentialId" : 0,
  "hostId" : 0,
  "id" : 0,
  "password" : "string",
  "port" : 0,
  "requestId" : "string",
  "serverAddr" : "string",
  "userId" : 0
}

2.4.40. 删除访问串

DELETE /hostAccessAuth/{id}

参数

类型

名称

说明

架构

Path

id
必填

访问串ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/hostAccessAuth/0

HTTP响应示例

响应 200

{
  "msg" : "string",
  "success" : true
}

2.4.41. 添加主机的部门授权

POST /hostDepartmentAuth/{hostId}

参数

类型

名称

说明

架构

Path

hostId
必填

主机ID

integer(int64)

Query

departmentId
必填

部门ID

integer(int64)

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/hostDepartmentAuth/0

请求 query

{
  "departmentId" : 0
}

HTTP响应示例

响应 200

{
  "msg" : "string",
  "success" : true
}

2.4.42. 添加主机的角色授权

POST /hostRoleAuth/{hostId}

参数

类型

名称

说明

架构

Path

hostId
必填

主机ID

integer(int64)

Query

roleId
必填

角色ID

integer(int64)

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/hostRoleAuth/0

请求 query

{
  "roleId" : 0
}

HTTP响应示例

响应 200

{
  "msg" : "string",
  "success" : true
}

2.4.43. 添加主机的单用户授权

POST /hostUserAuth/{hostId}

参数

类型

名称

说明

架构

Path

hostId
必填

主机ID

integer(int64)

Query

userId
必填

用户ID

integer(int64)

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/hostUserAuth/0

请求 query

{
  "userId" : 0
}

HTTP响应示例

响应 200

{
  "msg" : "string",
  "success" : true
}

2.4.44. 导入一台局域网主机

POST /hostV2

参数

类型名称说明架构默认列

Query

cloudId
必填

局域网云账户ID

integer(int64)

Query

innerIp
必填

内网IP

string

Query

publicIp
可选

公网IP

string

Query

instanceId
可选

厂商提供的ID，在云账户中唯一，不设置时系统自动生成

string

Query

name
必填

主机名称

string

Query

description
可选

描述信息

string

Query

operatingSystem
必填

操作系统：

string

Query

processor
可选

CPU核数

integer(int32)

"0"

Query

memory
可选

内存，单位MB

integer(int32)

"0"

Query

status
可选

主机状态

enum (Unknown, Stopped, Running, Expired, Pending, Starting)

"Unknown"

Query

vgIds
可选

默认加入的虚拟分组

string

响应

HTTP代码

说明

架构

200

ImportHostResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/hostV2

请求 query

{
  "cloudId" : 0,
  "innerIp" : "string",
  "publicIp" : "string",
  "instanceId" : "string",
  "name" : "string",
  "description" : "string",
  "operatingSystem" : "string",
  "processor" : 0,
  "memory" : 0,
  "status" : "string",
  "vgIds" : "string"
}

HTTP响应示例

响应 200

{
  "cloudId" : 0,
  "groupId" : 0,
  "hostIds" : [ 0 ],
  "teamId" : 0
}

2.4.45. 批量导入公有云主机，不支持Azure

POST /hosts/public

说明

导入过程创建的物理分组不会设置任何角色，即只有团队拥有者可见。如果物理分组已经存在则不会改变已有授权结构

参数

类型

名称

说明

架构

Body

request
必填

实例ID和RegionId信息

ImportPublicHostRequest

响应

HTTP代码

说明

架构

200

JobVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/hosts/public

请求 body

{
  "cloudId" : 0,
  "creatorId" : 0,
  "instanceRegionMap" : {
    "string" : "string"
  }
}

HTTP响应示例

响应 200

{
  "id" : 0,
  "requestId" : "string"
}

2.4.46. 获取快捷方式

GET /shortcut/{id}

参数

类型

名称

说明

架构

Path

id
必填

快捷方式id

integer(int64)

响应

HTTP代码

说明

架构

200

ShortcutVo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/shortcut/0

HTTP响应示例

响应 200

{
  "createTime" : "string",
  "creatorId" : 0,
  "creatorName" : "string",
  "desktopType" : "string",
  "hostId" : 0,
  "id" : 0,
  "loginAccount" : "string",
  "name" : "string",
  "passwordOrKeySet" : false,
  "requestId" : "string",
  "updateTime" : "string"
}

2.4.47. 删除快捷方式

DELETE /shortcut/{id}

参数

类型

名称

说明

架构

Path

id
必填

快捷方式id

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/shortcut/0

2.5. 5 Log Api

日志API

2.5.1. 插入一条日志记录

POST /log

说明

AK需要有LogWrite权限才可以调用当前端口。日志的cluster必须以EXT_开头

参数

类型

名称

说明

架构

Body

request
必填

日志信息

AddLogRequest

响应

HTTP代码

说明

架构

200

AddLogResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/log

请求 body

{
  "action" : "string",
  "actionSource" : "string",
  "actorId" : 0,
  "cluster" : "string",
  "createTime" : "string",
  "errorCode" : "string",
  "errorMsg" : "string",
  "extraInfo" : "object",
  "remoteIp" : "string",
  "status" : "string",
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "id" : "string",
  "requestId" : "string"
}

2.5.2. 查询日志

GET /log

说明

创建时间（如果有传入）查询范围是[startTime,endTime)。teamId和cluster两个参数是必填参数

参数

类型名称说明架构默认列

Query

teamId
必填

所属团队ID

integer(int64)

Query

cluster
必填

日志分类

string

Query

action
可选

操作

string

Query

actorId
可选

操作者ID

integer(int64)

Query

status
可选

状态

string

Query

startTime
可选

开始时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

endTime
可选

结束时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

order
必填

排序规则，按创建时间排序

enum (DESC, ASC)

"DESC"

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

条数，不超过1000

integer(int32)

"20"

响应

HTTP代码

说明

架构

200

LogResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/log

请求 query

{
  "teamId" : 0,
  "cluster" : "string",
  "action" : "string",
  "actorId" : 0,
  "status" : "string",
  "startTime" : "string",
  "endTime" : "string",
  "order" : "string",
  "page" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "logs" : [ {
    "action" : "string",
    "actionSource" : "string",
    "actor" : {
      "avatar" : "string",
      "id" : 0,
      "name" : "string",
      "nickname" : "string",
      "teamNickname" : "string",
      "uid" : "string"
    },
    "cluster" : "string",
    "createTime" : "string",
    "errorCode" : "string",
    "errorMsg" : "string",
    "extendMap" : "object",
    "extraInfo" : "object",
    "id" : "string",
    "remoteIp" : "string",
    "status" : "string",
    "teamId" : 0,
    "teamName" : "string"
  } ],
  "page" : 0,
  "requestId" : "string",
  "size" : 0,
  "total" : 0
}

2.5.3. 获取数据库SQL日志

GET /log/db/sql

参数

类型名称说明架构默认列

Query

teamId
必填

所属团队ID

integer(int64)

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

条数

integer(int32)

"20"

Query

actorId
可选

操作者ID

integer(int64)

Query

dbId
可选

数据库ID

integer(int64)

Query

sessionId
可选

数据库会话ID

integer(int64)

Query

success
可选

过滤成功或失败记录

boolean

Query

startTime
可选

开始时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

endTime
可选

结束时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

order
必填

排序规则，按创建时间排序

enum (DESC, ASC)

"DESC"

响应

HTTP代码

说明

架构

200

DbSqlLogResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/log/db/sql

请求 query

{
  "teamId" : 0,
  "page" : 0,
  "size" : 0,
  "actorId" : 0,
  "dbId" : 0,
  "sessionId" : 0,
  "success" : true,
  "startTime" : "string",
  "endTime" : "string",
  "order" : "string"
}

HTTP响应示例

响应 200

{
  "logs" : [ {
    "actorId" : 0,
    "actorName" : "string",
    "dbId" : 0,
    "dbType" : "string",
    "errorCode" : "string",
    "errorMessage" : "string",
    "query" : "string",
    "queryEnd" : 0,
    "queryStart" : 0,
    "rowCount" : 0,
    "sessionId" : 0,
    "sqlState" : "string",
    "success" : false,
    "teamId" : 0
  } ],
  "page" : 0,
  "requestId" : "string",
  "size" : 0,
  "total" : 0
}

2.5.4. 获取主机日志

GET /log/host

参数

类型名称说明架构默认列

Query

teamId
必填

所属团队ID

integer(int64)

Query

actionType
可选

操作类型，未指定时查询所有操作

enum (ACCESS, ADD, REMOVE, START, STOP, RESTART, RESET_PWD, MODIFY, RESET_MCONSOLE_PWD, CHANGE_SNAPSHOT_POLICY, ALLOCATE)

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

条数

integer(int32)

"20"

Query

cloudId
可选

所属云账户，未指定时查询所有云账户

integer(int64)

Query

status
可选

状态：成功或失败

enum (FAIL, SUCCESS, RUNNING, UNKNOWN)

Query

actorId
可选

操作者ID

integer(int64)

Query

hostId
可选

主机ID

integer(int64)

Query

startTime
可选

开始时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

endTime
可选

结束时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

filterRunningSession
可选

过滤正在进行的会话,设置为true时必须指定hostId

boolean

"false"

Query

order
必填

排序规则，按创建时间排序

enum (DESC, ASC)

"DESC"

响应

HTTP代码

说明

架构

200

HostLogResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/log/host

请求 query

{
  "teamId" : 0,
  "actionType" : "string",
  "page" : 0,
  "size" : 0,
  "cloudId" : 0,
  "status" : "string",
  "actorId" : 0,
  "hostId" : 0,
  "startTime" : "string",
  "endTime" : "string",
  "filterRunningSession" : true,
  "order" : "string"
}

HTTP响应示例

响应 200

{
  "logs" : [ {
    "accessIp" : "string",
    "accessUserAgent" : "string",
    "action" : "string",
    "actionSource" : "string",
    "actorId" : 0,
    "actorName" : "string",
    "cloudId" : 0,
    "cloudName" : "string",
    "cloudProvider" : "string",
    "createTime" : "string",
    "extraInfo" : "object",
    "hostDeleted" : false,
    "hostGroupId" : 0,
    "hostId" : 0,
    "hostInnerIp" : "string",
    "hostInstanceId" : "string",
    "hostName" : "string",
    "hostPlatform" : "string",
    "hostPublicIp" : "string",
    "id" : "string",
    "status" : "string",
    "teamId" : 0
  } ],
  "page" : 0,
  "requestId" : "string",
  "size" : 0,
  "total" : 0
}

2.6. 6 Role Api

角色管理API

2.6.1. 获取系统功能权限列表

GET /function

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/function

HTTP响应示例

响应 200

{
  "functions" : [ {
    "businessRole" : "string",
    "code" : "string",
    "description" : "string",
    "module" : "string",
    "name" : "string",
    "path" : "string",
    "roleCode" : "string",
    "sortNumber" : 0,
    "type" : "string"
  } ],
  "requestId" : "string"
}

2.6.2. 创建角色

POST /role

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

Query

name
必填

角色名称

string

Query

description
可选

角色描述

string

Query

functionCodes
可选

权限code列表，可选，用逗号连接

string

响应

HTTP代码

说明

架构

200

CreateRoleResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role

请求 query

{
  "teamId" : 0,
  "name" : "string",
  "description" : "string",
  "functionCodes" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "roleId" : 0
}

2.6.3. 获取团队所有角色

GET /role

说明

可以用 GET /roles代替

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "page" : 0,
  "requestId" : "string",
  "roles" : [ {
    "code" : "string",
    "description" : "string",
    "id" : 0,
    "locked" : false,
    "name" : "string",
    "requestId" : "string",
    "roleType" : 0,
    "system" : false,
    "teamId" : 0
  } ],
  "size" : 0,
  "total" : 0
}

2.6.4. 获取团队中系统角色

GET /role/byCode/{code}

说明

只有系统内置角色才有code,而且同一个code的角色有且只有一个，目前系统内置三个角色：TEAM_CREATOR(团队创建者）、TEAM_ADMINER（管理员）、TEAM_MEMBER（所有成员）。私有部署版可以通过role_templates.json定义系统角色。

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

Path

code
必填

角色Code

string

响应

HTTP代码

说明

架构

200

RoleVo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/byCode/string

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "code" : "string",
  "description" : "string",
  "id" : 0,
  "locked" : false,
  "name" : "string",
  "requestId" : "string",
  "roleType" : 0,
  "system" : false,
  "teamId" : 0
}

2.6.5. 获取团队中系统角色（根据团队code）

GET /role/byRoleAndTeamCode

说明

参数

类型

名称

说明

架构

Query

teamCode
必填

所属团队code

string

Query

roleCode
必填

角色Code

string

响应

HTTP代码

说明

架构

200

RoleVo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/byRoleAndTeamCode

请求 query

{
  "teamCode" : "string",
  "roleCode" : "string"
}

HTTP响应示例

响应 200

{
  "code" : "string",
  "description" : "string",
  "id" : 0,
  "locked" : false,
  "name" : "string",
  "requestId" : "string",
  "roleType" : 0,
  "system" : false,
  "teamId" : 0
}

2.6.6. 获取团队所有角色（根据团队code）

GET /role/byTeamCode/{teamCode}

参数

类型

名称

说明

架构

Path

teamCode
必填

所属团队code

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/byTeamCode/string

HTTP响应示例

响应 200

{
  "page" : 0,
  "requestId" : "string",
  "roles" : [ {
    "code" : "string",
    "description" : "string",
    "id" : 0,
    "locked" : false,
    "name" : "string",
    "requestId" : "string",
    "roleType" : 0,
    "system" : false,
    "teamId" : 0
  } ],
  "size" : 0,
  "total" : 0
}

2.6.7. 获取用户在团队中加入的角色列表

GET /role/byTeamCodeAndUserAccount

参数

类型

名称

说明

架构

Query

teamCode
必填

所属团队code

string

Query

userAccount
必填

用户账号

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/byTeamCodeAndUserAccount

请求 query

{
  "teamCode" : "string",
  "userAccount" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "roles" : [ {
    "code" : "string",
    "description" : "string",
    "id" : 0,
    "locked" : false,
    "name" : "string",
    "requestId" : "string",
    "roleType" : 0,
    "system" : false,
    "teamId" : 0
  } ]
}

2.6.8. 获取用户在团队中加入的角色列表

GET /role/byUser/{userId}

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

Path

userId
必填

用户ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/byUser/0

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "roles" : [ {
    "code" : "string",
    "description" : "string",
    "id" : 0,
    "locked" : false,
    "name" : "string",
    "requestId" : "string",
    "roleType" : 0,
    "system" : false,
    "teamId" : 0
  } ]
}

2.6.9. 更新角色的名称和描述

PUT /role/{id}

参数

类型

名称

说明

架构

Path

id
必填

角色ID

integer(int64)

Query

name
必填

角色名称

string

Query

description
可选

角色描述

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0

请求 query

{
  "name" : "string",
  "description" : "string"
}

2.6.10. 获取角色详情

GET /role/{roleId}

参数

类型

名称

说明

架构

Path

roleId
必填

角色ID

integer(int64)

Query

includeMembers
可选

是否获取成员列表

boolean

Query

includeFunctionCodes
可选

是否获取权限代码列表

boolean

响应

HTTP代码

说明

架构

200

RoleDetailResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0

请求 query

{
  "includeMembers" : true,
  "includeFunctionCodes" : true
}

HTTP响应示例

响应 200

{
  "functionCodes" : [ "string" ],
  "members" : [ 0 ],
  "requestId" : "string",
  "role" : {
    "code" : "string",
    "description" : "string",
    "id" : 0,
    "locked" : false,
    "name" : "string",
    "requestId" : "string",
    "roleType" : 0,
    "system" : false,
    "teamId" : 0
  }
}

2.6.11. 删除角色

DELETE /role/{roleId}

参数

类型

名称

说明

架构

Path

roleId
必填

角色ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0

2.6.12. 授权角色给云账户

POST /role/{roleId}/cloud/{cloudId}

参数

类型

名称

说明

架构

Path

roleId
必填

角色ID

integer(int64)

Path

cloudId
必填

云账户ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0/cloud/0

2.6.13. 撤销角色给物理网络分组的授权

DELETE /role/{roleId}/cloud/{cloudId}

说明

如果不存在授权，不会出错

参数

类型

名称

说明

架构

Path

roleId
必填

角色ID

integer(int64)

Path

cloudId
必填

云账户ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0/cloud/0

2.6.14. 获取角色的权限列表

GET /role/{roleId}/functions

参数

类型

名称

说明

架构

Path

roleId
必填

角色ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0/functions

HTTP响应示例

响应 200

{
  "functions" : [ {
    "businessRole" : "string",
    "code" : "string",
    "description" : "string",
    "module" : "string",
    "name" : "string",
    "path" : "string",
    "roleCode" : "string",
    "sortNumber" : 0,
    "type" : "string"
  } ],
  "requestId" : "string"
}

2.6.15. 角色添加权限

POST /role/{roleId}/functions/{functionCodes}

参数

类型

名称

说明

架构

Path

roleId
必填

角色ID

integer(int64)

Path

functionCodes
必填

功能权限代码列表，用','连接

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0/functions/string

2.6.16. 角色删除权限

DELETE /role/{roleId}/functions/{functionCodes}

参数

类型

名称

说明

架构

Path

roleId
必填

角色ID

integer(int64)

Path

functionCodes
必填

功能权限代码列表，用','连接

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0/functions/string

2.6.17. 角色添加权限V2

POST /role/{roleId}/functionsV2

参数

类型

名称

说明

架构

Path

roleId
必填

角色ID

integer(int64)

Query

functionCodes
必填

功能权限代码列表，用','连接

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0/functionsV2

请求 query

{
  "functionCodes" : "string"
}

2.6.18. 角色删除权限V2

DELETE /role/{roleId}/functionsV2

参数

类型

名称

说明

架构

Path

roleId
必填

角色ID

integer(int64)

Query

functionCodes
必填

功能权限代码列表，用','连接

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0/functionsV2

请求 query

{
  "functionCodes" : "string"
}

2.6.19. 授权角色给物理网络分组

POST /role/{roleId}/hg/{hgId}

参数

类型

名称

说明

架构

Path

roleId
必填

角色ID

integer(int64)

Path

hgId
必填

物理网络分组ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0/hg/0

2.6.20. 撤销角色给物理网络分组的授权

DELETE /role/{roleId}/hg/{hgId}

说明

如果不存在授权，不会出错

参数

类型

名称

说明

架构

Path

roleId
必填

角色ID

integer(int64)

Path

hgId
必填

物理网络分组ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0/hg/0

2.6.21. 获取授权角色的用户列表

GET /role/{roleId}/members

参数

类型

名称

说明

架构

Path

roleId
必填

角色ID

integer(int64)

响应

HTTP代码

说明

架构

200

UserBriefResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0/members

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "userIds" : [ 0 ]
}

2.6.22. 授权角色给一个团队成员

POST /role/{roleId}/members/byAccount/{account}

参数

类型

名称

说明

架构

Path

roleId
必填

角色ID

integer(int64)

Path

account
必填

用户账号

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0/members/byAccount/string

2.6.23. 撤销用户的角色

DELETE /role/{roleId}/members/byAccount/{account}

参数

类型

名称

说明

架构

Path

roleId
必填

角色ID

integer(int64)

Path

account
必填

用户账号

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0/members/byAccount/string

2.6.24. 授权角色给团队成员

POST /role/{roleId}/members/{userIds}

参数

类型

名称

说明

架构

Path

roleId
必填

角色ID

integer(int64)

Path

userIds
必填

用户ID，用','连接

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0/members/string

2.6.25. 撤销用户的角色

DELETE /role/{roleId}/members/{userIds}

参数

类型

名称

说明

架构

Path

roleId
必填

角色ID

integer(int64)

Path

userIds
必填

用户ID列表，用','连接

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0/members/string

2.6.26. 获取角色可见的资源列表

GET /role/{roleId}/resources

Caution

operation.deprecated

说明

目前只包含主机、cdn、bucket。后续版本就添加通用接口

参数

类型

名称

说明

架构

Path

roleId
必填

角色ID

integer(int64)

响应

HTTP代码

说明

架构

200

GetRoleResourcesResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0/resources

HTTP响应示例

响应 200

{
  "bucketIds" : [ 0 ],
  "cdnIds" : [ 0 ],
  "hostIds" : [ 0 ],
  "requestId" : "string",
  "roleId" : 0
}

2.6.27. 授权角色给虚拟分组

POST /role/{roleId}/vg/{vgId}

参数

类型

名称

说明

架构

Path

roleId
必填

角色ID

integer(int64)

Path

vgId
必填

虚拟分组ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0/vg/0

2.6.28. 撤销角色给虚拟分组的授权

DELETE /role/{roleId}/vg/{vgId}

说明

如果不存在授权，不会出错

参数

类型

名称

说明

架构

Path

roleId
必填

角色ID

integer(int64)

Path

vgId
必填

虚拟分组ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/role/0/vg/0

2.6.29. 获取当前系统自定义的系统角色模版

GET /roleTemplates

说明

系统自定义角色模版在文件/opt/cloudbility/conf/role_templates.json中

响应

HTTP代码

说明

架构

200

GetRoleTemplatesResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/roleTemplates

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "roleTemplates" : {
    "string" : "<<_roletemplatevo>>"
  }
}

2.6.30. 分页获取团队角色列表

GET /roles

参数

类型名称说明架构默认列

Query

teamId
必填

所属团队ID

integer(int64)

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

条数

integer(int32)

"20"

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/roles

请求 query

{
  "teamId" : 0,
  "page" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "page" : 0,
  "requestId" : "string",
  "roles" : [ {
    "code" : "string",
    "description" : "string",
    "id" : 0,
    "locked" : false,
    "name" : "string",
    "requestId" : "string",
    "roleType" : 0,
    "system" : false,
    "teamId" : 0
  } ],
  "size" : 0,
  "total" : 0
}

2.6.31. 获取云账户的角色列表

GET /roles/byCloud/{cloudId}

参数

类型

名称

说明

架构

Path

cloudId
必填

云账户ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/roles/byCloud/0

HTTP响应示例

响应 200

{
  "page" : 0,
  "requestId" : "string",
  "roles" : [ {
    "code" : "string",
    "description" : "string",
    "id" : 0,
    "locked" : false,
    "name" : "string",
    "requestId" : "string",
    "roleType" : 0,
    "system" : false,
    "teamId" : 0
  } ],
  "size" : 0,
  "total" : 0
}

2.6.32. 获取物理分组的角色列表

GET /roles/byHg/{hgId}

参数

类型

名称

说明

架构

Path

hgId
必填

物理分组ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/roles/byHg/0

HTTP响应示例

响应 200

{
  "page" : 0,
  "requestId" : "string",
  "roles" : [ {
    "code" : "string",
    "description" : "string",
    "id" : 0,
    "locked" : false,
    "name" : "string",
    "requestId" : "string",
    "roleType" : 0,
    "system" : false,
    "teamId" : 0
  } ],
  "size" : 0,
  "total" : 0
}

2.6.33. 根据名称查询团队内的角色

GET /roles/byName

说明

因为角色名称唯一，所以最多返回一条记录

参数

类型

名称

说明

架构

Query

name
必填

角色名称

string

Query

teamId
必填

所属团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/roles/byName

请求 query

{
  "name" : "string",
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "roles" : [ {
    "code" : "string",
    "description" : "string",
    "id" : 0,
    "locked" : false,
    "name" : "string",
    "requestId" : "string",
    "roleType" : 0,
    "system" : false,
    "teamId" : 0
  } ]
}

2.6.34. 根据名称模糊查询团队内的角色

GET /roles/byNameLike

参数

类型

名称

说明

架构

Query

name
必填

角色名称包含的字符串

string

Query

teamId
必填

所属团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/roles/byNameLike

请求 query

{
  "name" : "string",
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "roles" : [ {
    "code" : "string",
    "description" : "string",
    "id" : 0,
    "locked" : false,
    "name" : "string",
    "requestId" : "string",
    "roleType" : 0,
    "system" : false,
    "teamId" : 0
  } ]
}

2.6.35. 分页获取团队角色列表（根据团队code）

GET /roles/byTeamCode/{teamCode}

参数

类型名称说明架构默认列

Path

teamCode
必填

所属团队code

string

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

条数

integer(int32)

"20"

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/roles/byTeamCode/string

请求 query

{
  "page" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "page" : 0,
  "requestId" : "string",
  "roles" : [ {
    "code" : "string",
    "description" : "string",
    "id" : 0,
    "locked" : false,
    "name" : "string",
    "requestId" : "string",
    "roleType" : 0,
    "system" : false,
    "teamId" : 0
  } ],
  "size" : 0,
  "total" : 0
}

2.6.36. 获取虚拟分组的角色列表

GET /roles/byVg/{vgId}

参数

类型

名称

说明

架构

Path

vgId
必填

虚拟分组ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/roles/byVg/0

HTTP响应示例

响应 200

{
  "page" : 0,
  "requestId" : "string",
  "roles" : [ {
    "code" : "string",
    "description" : "string",
    "id" : 0,
    "locked" : false,
    "name" : "string",
    "requestId" : "string",
    "roleType" : 0,
    "system" : false,
    "teamId" : 0
  } ],
  "size" : 0,
  "total" : 0
}

2.7. 7 Tag Api

标签操作API

2.7.1. 新增标签

POST /tag

说明

创建标签,返回创建的标签（如果已经存在，则返回已有标签）

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

Query

name
必填

标签名，如果包含':'字符，则会解析成’标签名称:标签值’的映射；如果没有包含':'字符，则会认为值为null

string

响应

HTTP代码

说明

架构

200

TagDetailResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/tag

请求 query

{
  "teamId" : 0,
  "name" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "tag" : {
    "id" : 0,
    "name" : "string",
    "tagValueList" : [ {
      "id" : 0,
      "tagId" : 0,
      "value" : "string"
    } ],
    "teamId" : 0
  }
}

2.7.2. 按照标签名给主机打标签

POST /tag/attachToHostByName/{hostIds}

说明

按照标签名给主机打标签，返回操作的标签详情。如果标签不存在会自动创建

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

Path

hostIds
必填

主机id列表，用','连接

string

Query

name
必填

标签名称

string

响应

HTTP代码

说明

架构

200

TagDetailResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/tag/attachToHostByName/string

请求 query

{
  "teamId" : 0,
  "name" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "tag" : {
    "id" : 0,
    "name" : "string",
    "tagValueList" : [ {
      "id" : 0,
      "tagId" : 0,
      "value" : "string"
    } ],
    "teamId" : 0
  }
}

2.7.3. 根据标签名称删除主机的某个标签

DELETE /tag/detachFromHostByName/{hostIds}

说明

根据标签名称删除主机的某个标签

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

Path

hostIds
必填

主机id列表，用','连接

string

Query

name
必填

标签名称，如果包含值，则用':'连接

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/tag/detachFromHostByName/string

请求 query

{
  "teamId" : 0,
  "name" : "string"
}

2.7.4. 查询团队标签列表

GET /tag/list

说明

获取团队的所有标签

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

ListTagResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/tag/list

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "tags" : [ {
    "id" : 0,
    "name" : "string",
    "tagValueList" : [ {
      "id" : 0,
      "tagId" : 0,
      "value" : "string"
    } ],
    "teamId" : 0
  } ],
  "teamId" : 0
}

2.7.5. 查询主机的标签列表

GET /tag/listByHost

说明

查询主机的标签列表

参数

类型

名称

说明

架构

Query

hostId
必填

主机ID

integer(int64)

响应

HTTP代码

说明

架构

200

ListTagResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/tag/listByHost

请求 query

{
  "hostId" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "tags" : [ {
    "id" : 0,
    "name" : "string",
    "tagValueList" : [ {
      "id" : 0,
      "tagId" : 0,
      "value" : "string"
    } ],
    "teamId" : 0
  } ],
  "teamId" : 0
}

2.7.6. 查询特定标签

GET /tag/{tagId}

说明

获取特定标签

参数

类型

名称

说明

架构

Path

tagId
必填

标签名称ID

integer(int64)

响应

HTTP代码

说明

架构

200

TagDetailResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/tag/0

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "tag" : {
    "id" : 0,
    "name" : "string",
    "tagValueList" : [ {
      "id" : 0,
      "tagId" : 0,
      "value" : "string"
    } ],
    "teamId" : 0
  }
}

2.7.7. 删除标签

DELETE /tag/{tagId}

说明

删除标签

参数

类型

名称

说明

架构

Path

tagId
必填

标签名称ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/tag/0

2.7.8. 查询标签下的主机详情列表

GET /tag/{tagId}/hostDetailList

说明

查询特定标签下的主机详情列表

参数

类型

名称

说明

架构

Path

tagId
必填

标签名称ID

integer(int64)

响应

HTTP代码

说明

架构

200

HostDetailListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/tag/0/hostDetailList

HTTP响应示例

响应 200

{
  "hosts" : [ {
    "agentStatus" : "string",
    "cloudId" : 0,
    "groupId" : 0,
    "hostId" : 0,
    "hostName" : "string",
    "importTime" : "string",
    "innerIp" : "string",
    "installedAgent" : false,
    "instanceId" : "string",
    "instanceName" : "string",
    "memory" : 0,
    "operatingSystem" : "string",
    "platform" : "string",
    "processorCores" : 0,
    "publicIp" : "string",
    "requestId" : "string",
    "scope" : "string",
    "status" : "string",
    "teamId" : 0
  } ],
  "requestId" : "string"
}

2.7.9. 查询标签下的主机ID列表

GET /tag/{tagId}/hostIdList

说明

查询特定标签下主机ID列表

参数

类型

名称

说明

架构

Path

tagId
必填

标签名称ID

integer(int64)

响应

HTTP代码

说明

架构

200

GetHostBriefResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/tag/0/hostIdList

HTTP响应示例

响应 200

{
  "hostIds" : [ 0 ]
}

2.7.10. 修改标签名称

PUT /tag/{tagId}/tagName

说明

修改标签名称，不会修改标签的值

参数

类型

名称

说明

架构

Path

tagId
必填

标签ID

integer(int64)

Query

newName
必填

新名称

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/tag/0/tagName

请求 query

{
  "newName" : "string"
}

2.7.11. 修改标签名称和标签值

PUT /tag/{tagValueId}

说明

同时修改标签名称和值

参数

类型

名称

说明

架构

Path

tagValueId
必填

标签值ID

integer(int64)

Query

newName
必填

新名称

string

Query

newValue
可选

新值，如果不设置，则设置为null

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/tag/0

请求 query

{
  "newName" : "string",
  "newValue" : "string"
}

2.7.12. 修改标签值

PUT /tag/{tagValueId}/tagValue

说明

修改标签值，不会修改标签的名称

参数

类型

名称

说明

架构

Path

tagValueId
必填

标签值ID

integer(int64)

Query

newValue
可选

新值，如果不设置，则设置为null

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/tag/0/tagValue

请求 query

{
  "newValue" : "string"
}

2.8. 8 Virtual Group Api

虚拟分组API

2.8.1. 新增虚拟分组

POST /vg

说明

参数roles用逗号连接多个角色id，如果是系统角色，可以用RoleCode。例如：roles='12,TEAM_ADMINER’表示将创建的虚拟分组授权给id=12的角色和团队管理员角色。如果参数不设置，则新建的虚拟分组不会添加到任何角色。注意：角色的id必须与云账户属于同一个团队。roles不能设置为TEAM_CREATOR。私有部署版包括通过role_templates.json配置的系统角色。默认团队成员授权，支持用户id或者用户账户，用逗号连接

参数

类型

名称

说明

架构

Query

parentVgId
可选

父级分组ID，未设置时创建顶级分组

integer(int64)

Query

teamId
必填

团队ID

integer(int64)

Query

name
必填

分组名称

string

Query

roles
可选

默认角色授权

string

Query

members
可选

默认团队成员授权

string

响应

HTTP代码

说明

架构

200

VirtualGroupVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg

请求 query

{
  "parentVgId" : 0,
  "teamId" : 0,
  "name" : "string",
  "roles" : "string",
  "members" : "string"
}

HTTP响应示例

响应 200

{
  "createTime" : "string",
  "id" : 0,
  "name" : "string",
  "parentVgId" : 0,
  "requestId" : "string",
  "teamId" : 0
}

2.8.2. 根据虚拟分组名称查询

GET /vg/byName

说明

按照团队查询特定名称的虚拟分组

参数

类型

名称

说明

架构

Query

teamId
可选

团队ID，如果设置，按照团队过滤

integer(int64)

Query

name
必填

虚拟分组名称，精确匹配

string

响应

HTTP代码

说明

架构

200

VirtualGroupResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/byName

请求 query

{
  "teamId" : 0,
  "name" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "vgs" : [ {
    "createTime" : "string",
    "id" : 0,
    "name" : "string",
    "parentVgId" : 0,
    "requestId" : "string",
    "teamId" : 0
  } ]
}

2.8.3. 获取团队虚拟分组

GET /vg/byTeam/{teamId}

参数

类型

名称

说明

架构

Path

teamId
必填

团队ID

integer(int64)

Query

parentVgId
可选

父级分组ID，未设置时查询所有分组

integer(int64)

响应

HTTP代码

说明

架构

200

VirtualGroupResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/byTeam/0

请求 query

{
  "parentVgId" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "vgs" : [ {
    "createTime" : "string",
    "id" : 0,
    "name" : "string",
    "parentVgId" : 0,
    "requestId" : "string",
    "teamId" : 0
  } ]
}

2.8.4. 获取团队虚拟分组（根据团队code）

GET /vg/byTeamCode/{teamCode}

参数

类型

名称

说明

架构

Path

teamCode
必填

团队ID

string

Query

parentVgId
可选

父级分组ID，未设置时查询所有分组

integer(int64)

响应

HTTP代码

说明

架构

200

VirtualGroupResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/byTeamCode/string

请求 query

{
  "parentVgId" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "vgs" : [ {
    "createTime" : "string",
    "id" : 0,
    "name" : "string",
    "parentVgId" : 0,
    "requestId" : "string",
    "teamId" : 0
  } ]
}

2.8.5. 删除虚拟分组

DELETE /vg/{ids}

参数

类型

名称

说明

架构

Path

ids
必填

虚拟分组id列表，用','连接

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/string

2.8.6. 获取虚拟分组详情

GET /vg/{id}

参数

类型

名称

说明

架构

Path

id
必填

虚拟分组id

integer(int64)

响应

HTTP代码

说明

架构

200

VirtualGroupDetailVo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/0

HTTP响应示例

响应 200

{
  "buckets" : [ {
    "bucketId" : 0,
    "cloudId" : 0,
    "createTime" : "string",
    "importTime" : "string",
    "provider" : "string",
    "regionId" : "string",
    "requestId" : "string",
    "teamId" : 0
  } ],
  "cnds" : [ {
    "cdnId" : 0,
    "cloudId" : 0,
    "createTime" : "string",
    "domainName" : "string",
    "importTime" : "string",
    "provider" : "string",
    "requestId" : "string",
    "sourceType" : "string",
    "sources" : "string",
    "sslProtocol" : false,
    "status" : "string",
    "teamId" : 0
  } ],
  "createTime" : "string",
  "hosts" : [ {
    "cloudId" : 0,
    "groupId" : 0,
    "hostId" : 0,
    "hostName" : "string",
    "importTime" : "string",
    "innerIp" : "string",
    "instanceId" : "string",
    "instanceName" : "string",
    "memory" : 0,
    "operatingSystem" : "string",
    "platform" : "string",
    "processorCores" : 0,
    "publicIp" : "string",
    "requestId" : "string",
    "scope" : "string",
    "status" : "string",
    "teamId" : 0
  } ],
  "id" : 0,
  "name" : "string",
  "parentVgId" : 0,
  "requestId" : "string",
  "teamId" : 0
}

2.8.7. 修改虚拟分组(不推荐）

PUT /vg/{id}

说明

包括两部分：修改虚拟分组名称、重新指定授权角色。name和roles两个参数不能同时为空。为空时，不会修改。roles不能设置为TEAM_CREATOR。私有部署版包括通过role_templates.json配置的系统角色

参数

类型

名称

说明

架构

Path

id
必填

虚拟分组id

integer(int64)

Query

name
可选

虚拟分组名称

string

Query

roles
可选

新的角色授权

string

Query

members
可选

默认团队成员授权

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/0

请求 query

{
  "name" : "string",
  "roles" : "string",
  "members" : "string"
}

2.8.8. 从虚拟分组中移除所有主机、bucket、CDN资源

DELETE /vg/{id}/allResources

参数

类型

名称

说明

架构

Path

id
必填

虚拟分组id

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/0/allResources

2.8.9. 从虚拟分组中移除所有对象存储

DELETE /vg/{id}/buckets

参数

类型

名称

说明

架构

Path

id
必填

虚拟分组id

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/0/buckets

2.8.10. 添加对象存储(Bucket)到虚拟分组

POST /vg/{id}/buckets/{bucketIds}

说明

虚拟分组中如果已经包含对象存储，不会报错

参数

类型

名称

说明

架构

Path

id
必填

虚拟分组id

integer(int64)

Path

bucketIds
必填

对象存储id列表，用逗号连接

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/0/buckets/string

2.8.11. 从虚拟分组中移除对象存储

DELETE /vg/{id}/buckets/{bucketIds}

参数

类型

名称

说明

架构

Path

id
必填

虚拟分组id

integer(int64)

Path

bucketIds
必填

对象存储id列表，用逗号连接

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/0/buckets/string

2.8.12. 从虚拟分组中移除所有CDN

DELETE /vg/{id}/cdns

参数

类型

名称

说明

架构

Path

id
必填

虚拟分组id

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/0/cdns

2.8.13. 添加CDN到虚拟分组

POST /vg/{id}/cdns/{cdnIds}

参数

类型

名称

说明

架构

Path

id
必填

虚拟分组id

integer(int64)

Path

cdnIds
必填

CDN id列表，用逗号连接

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/0/cdns/string

2.8.14. 从虚拟分组中移除CDN

DELETE /vg/{id}/cdns/{cdnIds}

说明

CDN中如果不包含对象，不会报错

参数

类型

名称

说明

架构

Path

id
必填

虚拟分组id

integer(int64)

Path

cdnIds
必填

CDN id列表，用逗号连接

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/0/cdns/string

2.8.15. 授权分组给组织单元

PUT /vg/{id}/departments

说明

团队必须先开启组织视图

参数

类型

名称

说明

架构

Path

id
必填

虚拟分组id

integer(int64)

Query

departments
必填

新的组织单元ID列表，用逗号连接，使用空串时删除所有组织单元授权

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/0/departments

请求 query

{
  "departments" : "string"
}

2.8.16. 从虚拟分组中移除所有主机

DELETE /vg/{id}/hosts

参数

类型

名称

说明

架构

Path

id
必填

虚拟分组id

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/0/hosts

2.8.17. 添加主机到虚拟分组

POST /vg/{id}/hosts/{hostIds}

说明

虚拟分组中如果已经包含主机，不会报错

参数

类型

名称

说明

架构

Path

id
必填

虚拟分组id

integer(int64)

Path

hostIds
可选

主机id列表，用逗号连接

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/0/hosts/string

2.8.18. 从虚拟分组中移除主机

DELETE /vg/{id}/hosts/{hostIds}

说明

虚拟分组中如果不包含主机，不会报错

参数

类型

名称

说明

架构

Path

id
必填

虚拟分组id

integer(int64)

Path

hostIds
必填

主机id列表，用逗号连接

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/0/hosts/string

2.8.19. 授权分组给团队成员

PUT /vg/{id}/members

参数

类型

名称

说明

架构

Path

id
必填

虚拟分组id

integer(int64)

Query

members
必填

默认团队成员授权。使用空串时删除所有用户授权

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/0/members

请求 query

{
  "members" : "string"
}

2.8.20. 修改虚拟分组名称

PUT /vg/{id}/name

说明

name不能重复

参数

类型

名称

说明

架构

Path

id
必填

虚拟分组id

integer(int64)

Query

name
可选

虚拟分组名称

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/0/name

请求 query

{
  "name" : "string"
}

2.8.21. 撤销虚拟分组的所有角色授权

PUT /vg/{id}/revokeAllRoles

说明

清空角色授权以后，只有团队拥有者有权限

参数

类型

名称

说明

架构

Path

id
必填

虚拟分组id

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/0/revokeAllRoles

2.8.22. 授权分组给角色

PUT /vg/{id}/roles

说明

roles不能设置为TEAM_CREATOR。私有部署版包括通过role_templates.json配置的系统角色

参数

类型

名称

说明

架构

Path

id
必填

虚拟分组id

integer(int64)

Query

roles
必填

新的角色授权，使用空串时删除所有角色授权

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/vg/0/roles

请求 query

{
  "roles" : "string"
}

2.9. 9 Job Api

异步任务API

2.9.1. 获取任务详情

GET /job/{id}

参数

类型名称说明架构默认列

Path

id
必填

任务id

integer(int64)

Query

includeMeta
可选

是否包含扩展属性

boolean

"false"

响应

HTTP代码

说明

架构

200

JobInfoVo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/job/0

请求 query

{
  "includeMeta" : true
}

HTTP响应示例

响应 200

{
  "completed" : 0,
  "createTime" : "string",
  "description" : "string",
  "done" : true,
  "finishTime" : "string",
  "id" : 0,
  "meta" : "object",
  "requestId" : "string",
  "startTime" : "string",
  "status" : "string",
  "success" : true,
  "targetId" : 0,
  "teamId" : 0,
  "total" : 0,
  "type" : "string"
}

2.10. 11 Script Api

脚本API

2.10.1. 获取预设脚本库的子库

GET /preInstalledLibrary/{libraryId}/subLibrary

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

Path

libraryId
必填

脚本库ID

integer(int64)

响应

HTTP代码

说明

架构

200

ScriptLibraryListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/preInstalledLibrary/0/subLibrary

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "scriptLibraries" : [ {
    "createTime" : "string",
    "creator" : 0,
    "description" : "string",
    "id" : 0,
    "name" : "string",
    "requestId" : "string"
  } ]
}

2.10.2. 获取预设脚本库

GET /preInstalledScriptLibraries

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

ScriptLibraryListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/preInstalledScriptLibraries

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "scriptLibraries" : [ {
    "createTime" : "string",
    "creator" : 0,
    "description" : "string",
    "id" : 0,
    "name" : "string",
    "requestId" : "string"
  } ]
}

2.10.3. 添加脚本

POST /script

参数

类型名称说明架构默认列

Query

libraryId
必填

脚本库ID

integer(int64)

Query

name
必填

脚本名称

string

Query

content
必填

脚本内容

string

Query

language
必填

脚本类型

enum (shell, python, powershell, perl, node, cmd)

Query

parameter
可选

脚本参数

string

Query

description
可选

脚本说明

string

Query

timeout
必填

脚本超时

integer(int32)

"300"

Query

creator
可选

创建人ID，不设置时是团队拥有者

integer(int64)

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script

请求 query

{
  "libraryId" : 0,
  "name" : "string",
  "content" : "string",
  "language" : "string",
  "parameter" : "string",
  "description" : "string",
  "timeout" : 0,
  "creator" : 0
}

HTTP响应示例

响应 200

{
  "content" : "string",
  "createTime" : "string",
  "creator" : 0,
  "description" : "string",
  "id" : 0,
  "language" : "string",
  "libraryId" : 0,
  "modifyTime" : "string",
  "name" : "string",
  "parameter" : "string",
  "requestId" : "string",
  "timeout" : 0
}

2.10.4. 获取脚本库中的脚本

GET /script/byLibrary/{id}

说明

返回的结果按照创建时间正序排列

参数

类型名称说明架构默认列

Path

id
必填

脚本库ID

integer(int64)

Query

includeContent
可选

是否包含脚本内容

boolean

"false"

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

条数

integer(int32)

"20"

响应

HTTP代码

说明

架构

200

ScriptListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/byLibrary/0

请求 query

{
  "includeContent" : true,
  "page" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "scripts" : [ {
    "content" : "string",
    "createTime" : "string",
    "creator" : 0,
    "description" : "string",
    "id" : 0,
    "language" : "string",
    "libraryId" : 0,
    "modifyTime" : "string",
    "name" : "string",
    "parameter" : "string",
    "requestId" : "string",
    "timeout" : 0
  } ]
}

2.10.5. 删除脚本库中所有脚本

DELETE /script/byLibrary/{id}

参数

类型

名称

说明

架构

Path

id
必填

脚本库ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/byLibrary/0

HTTP响应示例

响应 200

{
  "count" : 0,
  "requestId" : "string"
}

2.10.6. 根据脚本名称查询脚本信息

GET /script/byName

参数

类型名称说明架构默认列

Query

libraryId
必填

脚本库ID

integer(int64)

Query

name
必填

脚本名称

string

Query

includeContent
可选

是否包含脚本内容

boolean

"false"

响应

HTTP代码

说明

架构

200

特定脚本

404

未找到脚本

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/byName

请求 query

{
  "libraryId" : 0,
  "name" : "string",
  "includeContent" : true
}

HTTP响应示例

响应 200

{
  "content" : "string",
  "createTime" : "string",
  "creator" : 0,
  "description" : "string",
  "id" : 0,
  "language" : "string",
  "libraryId" : 0,
  "modifyTime" : "string",
  "name" : "string",
  "parameter" : "string",
  "requestId" : "string",
  "timeout" : 0
}

2.10.7. 获取预设脚本库的脚本

GET /script/byPreInstalledLibrary/{libraryId}

参数

类型名称说明架构默认列

Path

libraryId
必填

脚本库ID

integer(int64)

Query

includeContent
可选

是否包含脚本内容

boolean

"false"

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

条数

integer(int32)

"20"

响应

HTTP代码

说明

架构

200

ScriptListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/byPreInstalledLibrary/0

请求 query

{
  "includeContent" : true,
  "page" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "scripts" : [ {
    "content" : "string",
    "createTime" : "string",
    "creator" : 0,
    "description" : "string",
    "id" : 0,
    "language" : "string",
    "libraryId" : 0,
    "modifyTime" : "string",
    "name" : "string",
    "parameter" : "string",
    "requestId" : "string",
    "timeout" : 0
  } ]
}

2.10.8. 通过Agent执行脚本命令

POST /script/executeCommandWithAgent

参数

类型名称说明架构默认列

Query

hostIds
必填

主机ID列表

string

Query

platform
必填

平台,linux或者windows

string

"linux"

Query

command
必填

脚本内容

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/executeCommandWithAgent

请求 query

{
  "hostIds" : "string",
  "platform" : "string",
  "command" : "string"
}

HTTP响应示例

响应 200

{
  "content" : "string",
  "createTime" : "string",
  "creator" : 0,
  "description" : "string",
  "id" : 0,
  "language" : "string",
  "libraryId" : 0,
  "modifyTime" : "string",
  "name" : "string",
  "parameter" : "string",
  "requestId" : "string",
  "timeout" : 0
}

2.10.9. 获取脚本任务执行信息

GET /script/job/{jobId}

说明

注意，读取的脚本输出不会超过10KB。超过10KB的输出流，请使用另外接口获取

参数

类型名称说明架构默认列

Path

jobId
必填

jobId

integer(int64)

Query

includeOutput
必填

是否包含脚本输出

boolean

"false"

响应

HTTP代码

说明

架构

200

ScriptRunResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/job/0

请求 query

{
  "includeOutput" : true
}

HTTP响应示例

响应 200

{
  "cancelled" : 0,
  "completed" : 0,
  "done" : true,
  "fails" : 0,
  "id" : 0,
  "lastCompleteTime" : "string",
  "operatorId" : 0,
  "pending" : 0,
  "requestId" : "string",
  "running" : 0,
  "scriptId" : 0,
  "scriptRuns" : [ {
    "completeTime" : "string",
    "exitCode" : 0,
    "hostId" : 0,
    "id" : 0,
    "outputLength" : 0,
    "outputLines" : [ {
      "line" : "string",
      "type" : "string"
    } ],
    "outputSize" : 0,
    "result" : "string",
    "startTime" : "string",
    "status" : "string"
  } ],
  "total" : 0
}

2.10.10. 获取脚本在主机上的输出

GET /script/jobOutput/{jobId}/{hostId}

说明

直接返回流式数据。支持断点下载。

参数

类型

名称

说明

架构

Path

jobId
必填

任务ID

integer(int64)

Path

hostId
必填

主机ID

integer(int64)

响应

HTTP代码

说明

架构

200

流式数据

InputStreamResource

404

script-run has no output on current host

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/jobOutput/0/0

HTTP响应示例

响应 200

{
  "description" : "string",
  "file" : {
    "absolute" : true,
    "absoluteFile" : {
      "absolute" : true,
      "absoluteFile" : "...",
      "absolutePath" : "string",
      "canonicalFile" : "...",
      "canonicalPath" : "string",
      "directory" : true,
      "file" : true,
      "freeSpace" : 0,
      "hidden" : true,
      "name" : "string",
      "parent" : "string",
      "parentFile" : "...",
      "path" : "string",
      "totalSpace" : 0,
      "usableSpace" : 0
    },
    "absolutePath" : "string",
    "canonicalFile" : "...",
    "canonicalPath" : "string",
    "directory" : true,
    "file" : true,
    "freeSpace" : 0,
    "hidden" : true,
    "name" : "string",
    "parent" : "string",
    "parentFile" : "...",
    "path" : "string",
    "totalSpace" : 0,
    "usableSpace" : 0
  },
  "filename" : "string",
  "inputStream" : { },
  "open" : true,
  "readable" : true,
  "uri" : {
    "absolute" : true,
    "authority" : "string",
    "fragment" : "string",
    "host" : "string",
    "opaque" : true,
    "path" : "string",
    "port" : 0,
    "query" : "string",
    "rawAuthority" : "string",
    "rawFragment" : "string",
    "rawPath" : "string",
    "rawQuery" : "string",
    "rawSchemeSpecificPart" : "string",
    "rawUserInfo" : "string",
    "scheme" : "string",
    "schemeSpecificPart" : "string",
    "userInfo" : "string"
  },
  "url" : {
    "authority" : "string",
    "content" : "object",
    "defaultPort" : 0,
    "file" : "string",
    "host" : "string",
    "path" : "string",
    "port" : 0,
    "protocol" : "string",
    "query" : "string",
    "ref" : "string",
    "userInfo" : "string"
  }
}

2.10.11. 获取脚本在主机上的输出长度

HEAD /script/jobOutput/{jobId}/{hostId}

说明

-1表示不存在

参数

类型

名称

说明

架构

Path

jobId
必填

任务ID

integer(int64)

Path

hostId
必填

主机ID

integer(int64)

响应

HTTP代码

说明

架构

200

integer(int64)

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/jobOutput/0/0

HTTP响应示例

响应 200

"0"

2.10.12. 创建脚本库

POST /script/library

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

Query

name
必填

脚本库名称

string

Query

description
可选

脚本库说明

string

Query

creator
可选

创建人ID，不设置时是团队拥有者

integer(int64)

响应

HTTP代码

说明

架构

200

ScriptLibraryVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/library

请求 query

{
  "teamId" : 0,
  "name" : "string",
  "description" : "string",
  "creator" : 0
}

HTTP响应示例

响应 200

{
  "createTime" : "string",
  "creator" : 0,
  "description" : "string",
  "id" : 0,
  "name" : "string",
  "requestId" : "string"
}

2.10.13. 获取脚本库

GET /script/library

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

ScriptLibraryListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/library

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "scriptLibraries" : [ {
    "createTime" : "string",
    "creator" : 0,
    "description" : "string",
    "id" : 0,
    "name" : "string",
    "requestId" : "string"
  } ]
}

2.10.14. 根据名称获取脚本库

GET /script/library/byName

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

Query

name
必填

脚本库名称

string

响应

HTTP代码

说明

架构

200

特定脚本库

ScriptLibraryVo

404

未找到脚本库

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/library/byName

请求 query

{
  "teamId" : 0,
  "name" : "string"
}

HTTP响应示例

响应 200

{
  "createTime" : "string",
  "creator" : 0,
  "description" : "string",
  "id" : 0,
  "name" : "string",
  "requestId" : "string"
}

2.10.15. 获取脚本库

GET /script/library/{id}

参数

类型

名称

说明

架构

Path

id
必填

脚本库ID

integer(int64)

响应

HTTP代码

说明

架构

200

ScriptLibraryVo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/library/0

HTTP响应示例

响应 200

{
  "createTime" : "string",
  "creator" : 0,
  "description" : "string",
  "id" : 0,
  "name" : "string",
  "requestId" : "string"
}

2.10.16. 修改脚本库名称

PUT /script/library/{id}

参数

类型

名称

说明

架构

Path

id
必填

脚本库ID

integer(int64)

Query

name
必填

脚本库名称

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/library/0

请求 query

{
  "name" : "string"
}

2.10.17. 删除脚本库

DELETE /script/library/{id}

说明

脚本库如果还有脚本，则无法删除

参数

类型

名称

说明

架构

Path

id
必填

脚本库ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/library/0

2.10.18. 获取脚本信息

GET /script/{id}

参数

类型名称说明架构默认列

Path

id
必填

脚本ID

integer(int64)

Query

includeContent
可选

是否包含脚本内容

boolean

"true"

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/0

请求 query

{
  "includeContent" : true
}

HTTP响应示例

响应 200

{
  "content" : "string",
  "createTime" : "string",
  "creator" : 0,
  "description" : "string",
  "id" : 0,
  "language" : "string",
  "libraryId" : 0,
  "modifyTime" : "string",
  "name" : "string",
  "parameter" : "string",
  "requestId" : "string",
  "timeout" : 0
}

2.10.19. 修改脚本信息

PUT /script/{id}

参数

类型

名称

说明

架构

Path

id
必填

脚本ID

integer(int64)

Query

name
必填

脚本名称

string

Query

timeout
必填

脚本超时

integer(int32)

Query

description
必填

脚本描述

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/0

请求 query

{
  "name" : "string",
  "timeout" : 0,
  "description" : "string"
}

2.10.20. 删除脚本

DELETE /script/{id}

参数

类型

名称

说明

架构

Path

id
必填

脚本ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/0

2.10.21. 修改脚本内容

PUT /script/{id}/content

参数

类型

名称

说明

架构

Path

id
必填

脚本ID

integer(int64)

Query

content
必填

脚本内容

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/0/content

请求 query

{
  "content" : "string"
}

2.10.22. 修改脚本内容

PUT /script/{id}/contentWithPayload

说明

脚本内容以payload方式提交

参数

类型

名称

说明

架构

Path

id
必填

脚本ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

消耗

application/octet-stream
application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/0/contentWithPayload

2.10.23. 执行脚本

POST /script/{id}/execute

参数

类型

名称

说明

架构

Path

id
必填

脚本ID

integer(int64)

Body

executingHostsInfo
必填

executingHostsInfo

ScriptExecutingHostsInfo

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/script/0/execute

请求 body

{
  "executingHosts" : [ {
    "credentialId" : 0,
    "hostId" : 0
  } ],
  "operatorId" : 0,
  "parameter" : "string",
  "timeout" : 0
}

HTTP响应示例

响应 200

{
  "content" : "string",
  "createTime" : "string",
  "creator" : 0,
  "description" : "string",
  "id" : 0,
  "language" : "string",
  "libraryId" : 0,
  "modifyTime" : "string",
  "name" : "string",
  "parameter" : "string",
  "requestId" : "string",
  "timeout" : 0
}

2.11. 12 Monitor Api

监控API

2.11.1. 获取主机监控数据在时间段内统计值

GET /monitor/hostAggregation/{hostId}

说明

如果不指定开始时间，相当于取监控数据存储最早的时间；如果不指定结束时间，相当于取最后一个监控数据的的时间。注意：必须使用聚合函数，即函数的结果是一个数据点。

参数

类型

名称

说明

架构

Path

hostId
必填

主机ID

integer(int64)

Query

metric
必填

主机监控项

enum (CpuUsage, MemoryUsed, DiskUsed, InternetInRate, InternetOutRate, IntranetInRate, IntranetOutRate)

Query

functions
必填

集合函数列表，多个函数用逗号连接

string

Query

startTime
可选

开始时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

endTime
可选

结束时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

响应

HTTP代码

说明

架构

200

SingletonResultList

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/monitor/hostAggregation/0

请求 query

{
  "metric" : "string",
  "functions" : "string",
  "startTime" : "string",
  "endTime" : "string"
}

HTTP响应示例

响应 200

{
  "dataPoints" : [ {
    "dimensionName" : "string",
    "func" : {
      "name" : "string"
    },
    "measurement" : "string",
    "tags" : "object",
    "time" : "string",
    "unit" : "string",
    "unitEn" : "string",
    "value" : 0.0
  } ]
}

2.11.2. 获取主机特定监控项的最后一个数据点

GET /monitor/hostLast/{hostId}

说明

如果监控项包括不同的dimension，返回的数据会包含所有dimension

参数

类型

名称

说明

架构

Path

hostId
必填

主机ID

integer(int64)

Query

metrics
必填

主机监控项(MonitorMetric)，用逗号连接

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/monitor/hostLast/0

请求 query

{
  "metrics" : "string"
}

HTTP响应示例

响应 200

{
  "dataPoints" : {
    "string" : 0.0
  }
}

2.11.3. 获取云账户下所有主机监控数据在时间段内统计值

GET /monitor/hostsAggregation/byCloud/{cloudId}

说明

参数

类型

名称

说明

架构

Path

cloudId
必填

云账户ID

integer(int64)

Query

metric
必填

主机监控项

enum (CpuUsage, MemoryUsed, DiskUsed, InternetInRate, InternetOutRate, IntranetInRate, IntranetOutRate)

Query

functions
必填

集合函数列表，多个函数用逗号连接

string

Query

startTime
可选

开始时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

endTime
可选

结束时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/monitor/hostsAggregation/byCloud/0

请求 query

{
  "metric" : "string",
  "functions" : "string",
  "startTime" : "string",
  "endTime" : "string"
}

HTTP响应示例

响应 200

{
  "batchDataPoints" : {
    "string" : "<<_aggregationdata>>"
  },
  "requestId" : "string"
}

2.11.4. 获取物理网络分组获取主机监控数据在时间段内统计值

GET /monitor/hostsAggregation/byHg/{hgId}

说明

参数

类型

名称

说明

架构

Path

hgId
必填

物理网络分组ID

integer(int64)

Query

metric
必填

主机监控项

enum (CpuUsage, MemoryUsed, DiskUsed, InternetInRate, InternetOutRate, IntranetInRate, IntranetOutRate)

Query

functions
必填

集合函数列表，多个函数用逗号连接

string

Query

startTime
可选

开始时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

endTime
可选

结束时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/monitor/hostsAggregation/byHg/0

请求 query

{
  "metric" : "string",
  "functions" : "string",
  "startTime" : "string",
  "endTime" : "string"
}

HTTP响应示例

响应 200

{
  "batchDataPoints" : {
    "string" : "<<_aggregationdata>>"
  },
  "requestId" : "string"
}

2.11.5. 获取标签获取主机监控数据在时间段内统计值

GET /monitor/hostsAggregation/byTag/{tagId}

说明

参数

类型

名称

说明

架构

Path

tagId
必填

标签ID

integer(int64)

Query

metric
必填

主机监控项

enum (CpuUsage, MemoryUsed, DiskUsed, InternetInRate, InternetOutRate, IntranetInRate, IntranetOutRate)

Query

functions
必填

集合函数列表，多个函数用逗号连接

string

Query

startTime
可选

开始时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

endTime
可选

结束时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/monitor/hostsAggregation/byTag/0

请求 query

{
  "metric" : "string",
  "functions" : "string",
  "startTime" : "string",
  "endTime" : "string"
}

HTTP响应示例

响应 200

{
  "batchDataPoints" : {
    "string" : "<<_aggregationdata>>"
  },
  "requestId" : "string"
}

2.11.6. 获取虚拟分组获取主机监控数据在时间段内统计值

GET /monitor/hostsAggregation/byVg/{vgId}

说明

参数

类型

名称

说明

架构

Path

vgId
必填

虚拟分组ID

integer(int64)

Query

metric
必填

主机监控项

enum (CpuUsage, MemoryUsed, DiskUsed, InternetInRate, InternetOutRate, IntranetInRate, IntranetOutRate)

Query

functions
必填

集合函数列表，多个函数用逗号连接

string

Query

startTime
可选

开始时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

endTime
可选

结束时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/monitor/hostsAggregation/byVg/0

请求 query

{
  "metric" : "string",
  "functions" : "string",
  "startTime" : "string",
  "endTime" : "string"
}

HTTP响应示例

响应 200

{
  "batchDataPoints" : {
    "string" : "<<_aggregationdata>>"
  },
  "requestId" : "string"
}

2.11.7. 获取多台主机监控数据在时间段内统计值

GET /monitor/hostsAggregation/{hostIds}

说明

参数

类型

名称

说明

架构

Path

hostIds
必填

主机ID列表，用逗号分隔

string

Query

metric
必填

主机监控项

enum (CpuUsage, MemoryUsed, DiskUsed, InternetInRate, InternetOutRate, IntranetInRate, IntranetOutRate)

Query

functions
必填

集合函数列表，多个函数用逗号连接

string

Query

startTime
可选

开始时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

endTime
可选

结束时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/monitor/hostsAggregation/string

请求 query

{
  "metric" : "string",
  "functions" : "string",
  "startTime" : "string",
  "endTime" : "string"
}

HTTP响应示例

响应 200

{
  "batchDataPoints" : {
    "string" : "<<_aggregationdata>>"
  },
  "requestId" : "string"
}

2.11.8. 获取云账户下所有主机监控数据在时间段内统计值的平均值

GET /monitor/hostsAvgAggregation/byCloud/{cloudId}

说明

参数

类型

名称

说明

架构

Path

cloudId
必填

云账户ID

integer(int64)

Query

metric
必填

主机监控项

enum (CpuUsage, MemoryUsed, DiskUsed, InternetInRate, InternetOutRate, IntranetInRate, IntranetOutRate)

Query

functions
必填

集合函数列表，多个函数用逗号连接

string

Query

startTime
可选

开始时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

endTime
可选

结束时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/monitor/hostsAvgAggregation/byCloud/0

请求 query

{
  "metric" : "string",
  "functions" : "string",
  "startTime" : "string",
  "endTime" : "string"
}

HTTP响应示例

响应 200

{
  "dataPoints" : {
    "string" : 0.0
  }
}

2.11.9. 获取物理网络分组下主机监控数据在时间段内统计值的平均值

GET /monitor/hostsAvgAggregation/byHg/{hgId}

说明

参数

类型

名称

说明

架构

Path

hgId
必填

物理网络分组ID

integer(int64)

Query

metric
必填

主机监控项

enum (CpuUsage, MemoryUsed, DiskUsed, InternetInRate, InternetOutRate, IntranetInRate, IntranetOutRate)

Query

functions
必填

集合函数列表，多个函数用逗号连接

string

Query

startTime
可选

开始时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

endTime
可选

结束时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/monitor/hostsAvgAggregation/byHg/0

请求 query

{
  "metric" : "string",
  "functions" : "string",
  "startTime" : "string",
  "endTime" : "string"
}

HTTP响应示例

响应 200

{
  "dataPoints" : {
    "string" : 0.0
  }
}

2.11.10. 获取标签下主机监控数据在时间段内统计值的平均值

GET /monitor/hostsAvgAggregation/byTag/{tagId}

说明

参数

类型

名称

说明

架构

Path

tagId
必填

标签ID

integer(int64)

Query

metric
必填

主机监控项

enum (CpuUsage, MemoryUsed, DiskUsed, InternetInRate, InternetOutRate, IntranetInRate, IntranetOutRate)

Query

functions
必填

集合函数列表，多个函数用逗号连接

string

Query

startTime
可选

开始时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

endTime
可选

结束时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/monitor/hostsAvgAggregation/byTag/0

请求 query

{
  "metric" : "string",
  "functions" : "string",
  "startTime" : "string",
  "endTime" : "string"
}

HTTP响应示例

响应 200

{
  "dataPoints" : {
    "string" : 0.0
  }
}

2.11.11. 获取虚拟分组中主机监控数据在时间段内统计值的平均值

GET /monitor/hostsAvgAggregation/byVg/{vgId}

说明

参数

类型

名称

说明

架构

Path

vgId
必填

虚拟分组ID

integer(int64)

Query

metric
必填

主机监控项

enum (CpuUsage, MemoryUsed, DiskUsed, InternetInRate, InternetOutRate, IntranetInRate, IntranetOutRate)

Query

functions
必填

集合函数列表，多个函数用逗号连接

string

Query

startTime
可选

开始时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

endTime
可选

结束时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/monitor/hostsAvgAggregation/byVg/0

请求 query

{
  "metric" : "string",
  "functions" : "string",
  "startTime" : "string",
  "endTime" : "string"
}

HTTP响应示例

响应 200

{
  "dataPoints" : {
    "string" : 0.0
  }
}

2.11.12. 获取多台主机监控数据在时间段内统计值的平均值

GET /monitor/hostsAvgAggregation/{hostIds}

说明

参数

类型

名称

说明

架构

Path

hostIds
必填

主机ID列表，用逗号分隔

string

Query

metric
必填

主机监控项

enum (CpuUsage, MemoryUsed, DiskUsed, InternetInRate, InternetOutRate, IntranetInRate, IntranetOutRate)

Query

functions
必填

集合函数列表，多个函数用逗号连接

string

Query

startTime
可选

开始时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

endTime
可选

结束时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/monitor/hostsAvgAggregation/string

请求 query

{
  "metric" : "string",
  "functions" : "string",
  "startTime" : "string",
  "endTime" : "string"
}

HTTP响应示例

响应 200

{
  "dataPoints" : {
    "string" : 0.0
  }
}

2.11.13. 获取ZStack主机特定监控项的最后一个数据点

GET /monitor/zstackHostLast/{hostId}

说明

如果监控项包括不同的dimension，返回的数据会包含所有dimension

参数

类型名称说明架构默认列

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Path

hostId
必填

主机ID

integer(int64)

Query

metrics
必填

主机监控项(MonitorMetric)，用逗号连接

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/monitor/zstackHostLast/0

请求 query

{
  "scope" : "string",
  "metrics" : "string"
}

HTTP响应示例

响应 200

{
  "dataPoints" : {
    "string" : 0.0
  }
}

2.12. 13 Database Api

数据库API

2.12.1. 创建一个DB

POST /db

参数

类型

名称

说明

架构

Query

teamId
可选

团队ID

integer(int64)

Query

name
可选

DB名称

string

Query

dbType
可选

DB类型

enum (RDS, MYSQL, SQLSERVER, ORACLE, POSTGRESQL, HIVE, VERTICA, REDIS, REDSHIFT, MONGODB, GAUSSDB)

Query

ip
可选

DB连接IP

string

Query

port
可选

DB连接端口

integer(int32)

Query

jumpServerId
可选

跳板机ID

integer(int64)

Query

jumpServerType
可选

跳板机类型

enum (Proxy, Transit)

Query

creatorId
可选

创建者ID（未设置时，默认团队创建者）

integer(int64)

Query

location
可选

DB位置：主机、RDS

enum (Host, RDS)

Query

jumpServerPort
可选

跳板机端口，不设置或设置为0时，自动寻找可用端口

integer(int32)

Query

hostId
可选

DB宿主机ID，RDS时为null

integer(int64)

Query

dbGroupId
可选

DB分组ID

integer(int64)

Query

clusterUri
可选

DB集群连接串

string

Query

isCluster
可选

DB是否集群模式

boolean

Query

autoStart
可选

创建后启动代理

boolean

响应

HTTP代码

说明

架构

200

DbVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/db

请求 query

{
  "teamId" : 0,
  "name" : "string",
  "dbType" : "string",
  "ip" : "string",
  "port" : 0,
  "jumpServerId" : 0,
  "jumpServerType" : "string",
  "creatorId" : 0,
  "location" : "string",
  "jumpServerPort" : 0,
  "hostId" : 0,
  "dbGroupId" : 0,
  "clusterUri" : "string",
  "isCluster" : true,
  "autoStart" : true
}

HTTP响应示例

响应 200

{
  "cluseterUri" : "string",
  "cluster" : true,
  "creatorId" : 0,
  "dbGroupId" : 0,
  "dbInstance" : "string",
  "dbPassword" : "string",
  "dbType" : "string",
  "dbUser" : "string",
  "description" : "string",
  "hostId" : 0,
  "id" : 0,
  "inner" : true,
  "ip" : "string",
  "jumpServerId" : 0,
  "jumpServerPort" : 0,
  "jumpServerType" : "string",
  "location" : "string",
  "name" : "string",
  "port" : 0,
  "teamId" : 0
}

2.12.2. 分页查询团队DB实例

GET /db

参数

类型名称说明架构默认列

Query

teamId
可选

团队ID

integer(int64)

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

数量

integer(int32)

"10"

响应

HTTP代码

说明

架构

200

ListDbResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/db

请求 query

{
  "teamId" : 0,
  "page" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "dbs" : [ {
    "cluseterUri" : "string",
    "cluster" : true,
    "creatorId" : 0,
    "dbGroupId" : 0,
    "dbInstance" : "string",
    "dbPassword" : "string",
    "dbType" : "string",
    "dbUser" : "string",
    "description" : "string",
    "hostId" : 0,
    "id" : 0,
    "inner" : true,
    "ip" : "string",
    "jumpServerId" : 0,
    "jumpServerPort" : 0,
    "jumpServerType" : "string",
    "location" : "string",
    "name" : "string",
    "port" : 0,
    "teamId" : 0
  } ],
  "requestId" : "string",
  "teamId" : 0
}

2.12.3. 查询DB分组内的DB实例

GET /db/byGroup/{dbGroupId}

参数

类型

名称

说明

架构

Path

dbGroupId
可选

DB分组ID

integer(int64)

响应

HTTP代码

说明

架构

200

ListDbResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/db/byGroup/0

HTTP响应示例

响应 200

{
  "dbs" : [ {
    "cluseterUri" : "string",
    "cluster" : true,
    "creatorId" : 0,
    "dbGroupId" : 0,
    "dbInstance" : "string",
    "dbPassword" : "string",
    "dbType" : "string",
    "dbUser" : "string",
    "description" : "string",
    "hostId" : 0,
    "id" : 0,
    "inner" : true,
    "ip" : "string",
    "jumpServerId" : 0,
    "jumpServerPort" : 0,
    "jumpServerType" : "string",
    "location" : "string",
    "name" : "string",
    "port" : 0,
    "teamId" : 0
  } ],
  "requestId" : "string",
  "teamId" : 0
}

2.12.4. 查询用户有权限的DB实例

GET /db/byUser

参数

类型

名称

说明

架构

Query

teamId
可选

团队ID

integer(int64)

Query

userId
可选

用户ID

integer(int64)

响应

HTTP代码

说明

架构

200

ListDbResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/db/byUser

请求 query

{
  "teamId" : 0,
  "userId" : 0
}

HTTP响应示例

响应 200

{
  "dbs" : [ {
    "cluseterUri" : "string",
    "cluster" : true,
    "creatorId" : 0,
    "dbGroupId" : 0,
    "dbInstance" : "string",
    "dbPassword" : "string",
    "dbType" : "string",
    "dbUser" : "string",
    "description" : "string",
    "hostId" : 0,
    "id" : 0,
    "inner" : true,
    "ip" : "string",
    "jumpServerId" : 0,
    "jumpServerPort" : 0,
    "jumpServerType" : "string",
    "location" : "string",
    "name" : "string",
    "port" : 0,
    "teamId" : 0
  } ],
  "requestId" : "string",
  "teamId" : 0
}

2.12.5. 创建DB分组

POST /db/group

参数

类型

名称

说明

架构

Query

teamId
可选

团队ID

integer(int64)

Query

name
可选

DB分组名称

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/db/group

请求 query

{
  "teamId" : 0,
  "name" : "string"
}

2.12.6. 查询团队DB分组

GET /db/group

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

ListDbGroupResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/db/group

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "dbGroups" : [ {
    "createTime" : "string",
    "id" : 0,
    "name" : "string"
  } ],
  "requestId" : "string",
  "teamId" : 0
}

2.12.7. 删除DB分组

DELETE /db/group/{dbGroupId}

参数

类型

名称

说明

架构

Path

dbGroupId
可选

DB分组ID

integer(int64)

Query

userId
可选

执行删除操作的用户Id

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/db/group/0

请求 query

{
  "userId" : 0
}

2.12.8. 修改DB分组名称

PUT /db/group/{dbGroupId}/name

说明

DB分组名称不能重复

参数

类型

名称

说明

架构

Path

dbGroupId
可选

DB分组ID

integer(int64)

Query

name
可选

DB分组名称

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/db/group/0/name

请求 query

{
  "name" : "string"
}

2.12.9. 创建一个DBPlan

POST /db/plan

参数

类型

名称

说明

架构

Query

dbId
可选

DBID

integer(int64)

Query

name
可选

DB名称

string

Query

dbUser
可选

DB账号

string

Query

dbPassword
可选

DB密码

string

Query

teamId
可选

团队ID

integer(int64)

Query

creatorId
可选

创建者ID（未设置时，默认团队创建者）

integer(int64)

Query

dbInstance
可选

DB实例

string

Query

description
可选

DB描述

string

Query

roleIds
可选

DBPlan关联角色

string

Query

userIds
可选

DBPlan关联用户

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/db/plan

请求 query

{
  "dbId" : 0,
  "name" : "string",
  "dbUser" : "string",
  "dbPassword" : "string",
  "teamId" : 0,
  "creatorId" : 0,
  "dbInstance" : "string",
  "description" : "string",
  "roleIds" : "string",
  "userIds" : "string"
}

2.12.10. 删除DBPlan

DELETE /db/plan/{planId}

参数

类型

名称

说明

架构

Path

planId
可选

planId

integer(int64)

Query

userId
可选

执行删除操作的用户Id

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/db/plan/0

请求 query

{
  "userId" : 0
}

2.12.11. 修改DB

PUT /db/{dbId}

参数

类型名称说明架构默认列

Path

dbId
可选

DBID

integer(int64)

Path

userId
可选

执行删除操作的用户Id

integer(int64)

Query

name
可选

DB名称

string

Query

port
可选

DB连接端口

integer(int32)

Query

jumpServerId
可选

跳板机ID

integer(int64)

Query

dbGroupId
可选

DB分组ID

integer(int64)

Query

dbType
可选

DB类型

enum (RDS, MYSQL, SQLSERVER, ORACLE, POSTGRESQL, HIVE, VERTICA, REDIS, REDSHIFT, MONGODB, GAUSSDB)

Query

jumpServerType
可选

跳板机类型

enum (Proxy, Transit)

Query

ip
可选

DB连接IP

string

Query

clusterUri
可选

DB集群连接串

string

Query

isCluster
可选

DB是否集群模式

boolean

Query

isInner
可选

DB连接IP是否是内网IP

string

"false"

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/db/0

请求 query

{
  "name" : "string",
  "port" : 0,
  "jumpServerId" : 0,
  "dbGroupId" : 0,
  "dbType" : "string",
  "jumpServerType" : "string",
  "ip" : "string",
  "clusterUri" : "string",
  "isCluster" : true,
  "isInner" : "string"
}

2.12.12. 删除DB

DELETE /db/{dbId}

参数

类型

名称

说明

架构

Path

dbId
可选

dbId

integer(int64)

Query

userId
可选

执行删除操作的用户Id

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/db/0

请求 query

{
  "userId" : 0
}

2.13. 14 Notice Api

公告栏API

2.13.1. 创建公告

POST /notice

参数

类型

名称

说明

架构

Query

title
可选

标题

string

Query

content
可选

内容，富文本格式

string

Query

tagId
可选

标签ID

integer(int64)

Query

sourceUrl
可选

原文地址

string

响应

HTTP代码

说明

架构

200

NoticeVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/notice

请求 query

{
  "title" : "string",
  "content" : "string",
  "tagId" : 0,
  "sourceUrl" : "string"
}

HTTP响应示例

响应 200

{
  "content" : "string",
  "createTime" : "string",
  "id" : 0,
  "publishTime" : "string",
  "sourceUrl" : "string",
  "status" : "string",
  "tagId" : 0,
  "title" : "string"
}

2.13.2. 查询公告列表

GET /notice

参数

类型名称说明架构默认列

Query

tagId
可选

按标签过滤

integer(int64)

Query

status
可选

状态

enum (Unpublished, Published)

Query

title
可选

标题

string

Query

sortField
可选

排序字段：publishTime,createTime,title

string

"createTime"

Query

sortOrder
可选

顺序顺序

enum (desc, asc)

"desc"

Query

page
可选

页码:从1开始

integer(int32)

"1"

Query

size
可选

条数

integer(int32)

"20"

Query

includeAttachments
可选

是否包含附件

boolean

"false"

响应

HTTP代码

说明

架构

200

NoticeListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/notice

请求 query

{
  "tagId" : 0,
  "status" : "string",
  "title" : "string",
  "sortField" : "string",
  "sortOrder" : "string",
  "page" : 0,
  "size" : 0,
  "includeAttachments" : true
}

HTTP响应示例

响应 200

{
  "notices" : [ {
    "attachments" : [ {
      "contentType" : "string",
      "cover" : false,
      "createTime" : "string",
      "downloadUrl" : "string",
      "id" : 0,
      "name" : "string",
      "noticeId" : 0,
      "size" : 0
    } ],
    "content" : "string",
    "cover" : {
      "contentType" : "string",
      "cover" : false,
      "createTime" : "string",
      "downloadUrl" : "string",
      "id" : 0,
      "name" : "string",
      "noticeId" : 0,
      "size" : 0
    },
    "createTime" : "string",
    "id" : 0,
    "publishTime" : "string",
    "sourceUrl" : "string",
    "status" : "string",
    "tag" : {
      "color" : "string",
      "createTime" : "string",
      "id" : 0,
      "name" : "string"
    },
    "tagId" : 0,
    "title" : "string"
  } ],
  "page" : 0,
  "requestId" : "string",
  "size" : 0,
  "total" : 0
}

2.13.3. 删除附件（或封面）

DELETE /notice/attachment/{attachmentId}

参数

类型

名称

说明

架构

Path

attachmentId
可选

attachmentId

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/notice/attachment/0

2.13.4. 开启/关闭公告栏

PUT /notice/config

参数

类型

名称

说明

架构

Query

enabled
可选

是否开启

boolean

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/notice/config

请求 query

{
  "enabled" : true
}

2.13.5. 查询公告栏基本信息

GET /notice/info

响应

HTTP代码

说明

架构

200

NoticeInfo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/notice/info

HTTP响应示例

响应 200

{
  "enabled" : false,
  "notices" : 0,
  "requestId" : "string"
}

2.13.6. 创建标签

POST /notice/tag

参数

类型名称说明架构默认列

Query

name
可选

名称

string

Query

color
必填

颜色,形如#39c6ee

string

"#39c6ee"

响应

HTTP代码

说明

架构

200

NoticeTagVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/notice/tag

请求 query

{
  "name" : "string",
  "color" : "string"
}

HTTP响应示例

响应 200

{
  "color" : "string",
  "createTime" : "string",
  "id" : 0,
  "name" : "string"
}

2.13.7. 删除标签

DELETE /notice/tag/byName/{name}

参数

类型

名称

说明

架构

Path

name
可选

名称

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/notice/tag/byName/string

2.13.8. 删除标签

DELETE /notice/tag/{id}

参数

类型

名称

说明

架构

Path

id
可选

标签id

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/notice/tag/0

2.13.9. 查询标签列表

GET /notice/tags

响应

HTTP代码

说明

架构

200

NoticeTagResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/notice/tags

HTTP响应示例

响应 200

{
  "noticeTags" : [ {
    "color" : "string",
    "createTime" : "string",
    "id" : 0,
    "name" : "string"
  } ],
  "requestId" : "string"
}

2.13.10. 查询公告详情

GET /notice/{id}

参数

类型

名称

说明

架构

Path

id
可选

公告ID

integer(int64)

响应

HTTP代码

说明

架构

200

NoticeDetailVo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/notice/0

HTTP响应示例

响应 200

{
  "attachments" : [ {
    "contentType" : "string",
    "cover" : false,
    "createTime" : "string",
    "downloadUrl" : "string",
    "id" : 0,
    "name" : "string",
    "noticeId" : 0,
    "size" : 0
  } ],
  "content" : "string",
  "cover" : {
    "contentType" : "string",
    "cover" : false,
    "createTime" : "string",
    "downloadUrl" : "string",
    "id" : 0,
    "name" : "string",
    "noticeId" : 0,
    "size" : 0
  },
  "createTime" : "string",
  "id" : 0,
  "publishTime" : "string",
  "sourceUrl" : "string",
  "status" : "string",
  "tag" : {
    "color" : "string",
    "createTime" : "string",
    "id" : 0,
    "name" : "string"
  },
  "tagId" : 0,
  "title" : "string"
}

2.13.11. 修改公告

PUT /notice/{id}

参数

类型

名称

说明

架构

Path

id
可选

公告id

integer(int64)

Query

title
可选

标题

string

Query

content
可选

内容，富文本格式

string

Query

tagId
可选

标签ID

integer(int64)

Query

sourceUrl
可选

原文地址

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/notice/0

请求 query

{
  "title" : "string",
  "content" : "string",
  "tagId" : 0,
  "sourceUrl" : "string"
}

2.13.12. 上传附件（http表单）

POST /notice/{id}/attachment

参数

类型

名称

说明

架构

Path

id
可选

integer(int64)

FormData

file
必填

附件

file

响应

HTTP代码

说明

架构

200

NoticeAttachmentVo

消耗

multipart/form-data

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/notice/0/attachment

请求 formData

"file"

HTTP响应示例

响应 200

{
  "contentType" : "string",
  "cover" : false,
  "createTime" : "string",
  "downloadUrl" : "string",
  "id" : 0,
  "name" : "string",
  "noticeId" : 0,
  "size" : 0
}

2.13.13. 修改公告的封面（http表单）

PUT /notice/{id}/coverImg

参数

类型

名称

说明

架构

Path

id
可选

integer(int64)

FormData

image
必填

图片，不超过5MB

file

响应

HTTP代码

说明

架构

200

NoticeAttachmentVo

消耗

multipart/form-data

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/notice/0/coverImg

请求 formData

"file"

HTTP响应示例

响应 200

{
  "contentType" : "string",
  "cover" : false,
  "createTime" : "string",
  "downloadUrl" : "string",
  "id" : 0,
  "name" : "string",
  "noticeId" : 0,
  "size" : 0
}

2.13.14. 发布公告

PUT /notice/{id}/publish

参数

类型

名称

说明

架构

Path

id
可选

公告id

integer(int64)

Query

publishTime
可选

发布时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"，不设置时取当前时间

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/notice/0/publish

请求 query

{
  "publishTime" : "string"
}

2.13.15. 取消发布

PUT /notice/{id}/unpublish

参数

类型

名称

说明

架构

Path

id
可选

公告id

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/notice/0/unpublish

2.14. 15 Department Api

部门管理API

2.14.1. 添加部门

POST /department

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

Query

name
必填

部门名称

string

Query

description
可选

部门描述

string

Query

parentId
必填

父部门ID

integer(int64)

响应

HTTP代码

说明

架构

200

DepartmentVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/department

请求 query

{
  "teamId" : 0,
  "name" : "string",
  "description" : "string",
  "parentId" : 0
}

HTTP响应示例

响应 200

{
  "description" : "string",
  "id" : 0,
  "memberIds" : [ 0 ],
  "name" : "string",
  "parentId" : 0,
  "requestId" : "string",
  "roleId" : 0,
  "teamId" : 0
}

2.14.2. 获取部门结构树

GET /department

参数

类型名称说明架构默认列

Query

teamId
必填

所属团队ID

integer(int64)

Query

includeMembers
必填

是否包含成员

boolean

"true"

响应

HTTP代码

说明

架构

200

DepartmentTreeVo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/department

请求 query

{
  "teamId" : 0,
  "includeMembers" : true
}

HTTP响应示例

响应 200

{
  "description" : "string",
  "id" : 0,
  "memberIds" : [ 0 ],
  "name" : "string",
  "parentId" : 0,
  "requestId" : "string",
  "roleId" : 0,
  "subDepartments" : [ {
    "description" : "string",
    "id" : 0,
    "memberIds" : [ 0 ],
    "name" : "string",
    "parentId" : 0,
    "requestId" : "string",
    "roleId" : 0,
    "subDepartments" : [ "..." ],
    "teamId" : 0
  } ],
  "teamId" : 0
}

2.14.3. 切换组织架构视图

POST /department/init

说明

不可逆：切换为组织架构视图后将无法回退为扁平化用户视图。返回根部门。如果已经开启组织架构视图了，会抛出异常。

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

Query

name
必填

部门名称

string

Query

description
可选

部门描述

string

响应

HTTP代码

说明

架构

200

DepartmentTreeVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/department/init

请求 query

{
  "teamId" : 0,
  "name" : "string",
  "description" : "string"
}

HTTP响应示例

响应 200

{
  "description" : "string",
  "id" : 0,
  "memberIds" : [ 0 ],
  "name" : "string",
  "parentId" : 0,
  "requestId" : "string",
  "roleId" : 0,
  "subDepartments" : [ {
    "description" : "string",
    "id" : 0,
    "memberIds" : [ 0 ],
    "name" : "string",
    "parentId" : 0,
    "requestId" : "string",
    "roleId" : 0,
    "subDepartments" : [ "..." ],
    "teamId" : 0
  } ],
  "teamId" : 0
}

2.14.4. 查询团队是否开启了组织架构视图

GET /department/init

说明

不可逆：切换为组织架构视图后将无法回退为扁平化用户视图。返回根部门。如果已经开启组织架构视图了，会抛出异常。

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

BooleanVo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/department/init

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "value" : true
}

2.14.5. 获取部门信息（不含下级部门，含成员）

GET /department/{departmentId}

参数

类型

名称

说明

架构

Path

departmentId
必填

部门ID

integer(int64)

响应

HTTP代码

说明

架构

200

DepartmentVo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/department/0

HTTP响应示例

响应 200

{
  "description" : "string",
  "id" : 0,
  "memberIds" : [ 0 ],
  "name" : "string",
  "parentId" : 0,
  "requestId" : "string",
  "roleId" : 0,
  "teamId" : 0
}

2.14.6. 更新部门

PUT /department/{departmentId}

说明

修改名称和描述

参数

类型

名称

说明

架构

Path

departmentId
必填

部门ID

integer(int64)

Query

name
必填

部门名称

string

Query

description
可选

部门描述

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/department/0

请求 query

{
  "name" : "string",
  "description" : "string"
}

2.14.7. 删除部门

DELETE /department/{departmentId}

说明

删除之前保证部门下没有团队成员和子部门

参数

类型

名称

说明

架构

Path

departmentId
必填

部门ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/department/0

2.14.8. 移动成员到部门

PUT /department/{departmentId}/members

说明

成员会从原部门移除。返回当前部门信息

参数

类型

名称

说明

架构

Path

departmentId
必填

部门ID

integer(int64)

Query

memberIds
必填

成员ID列表,用逗号连接

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/department/0/members

请求 query

{
  "memberIds" : "string"
}

2.14.9. 获取部门列表（扁平数据）

GET /departmentFlat

参数

类型名称说明架构默认列

Query

teamId
必填

所属团队ID

integer(int64)

Query

includeMembers
必填

是否包含成员

boolean

"true"

响应

HTTP代码

说明

架构

200

FlatDepartmentInfo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/departmentFlat

请求 query

{
  "teamId" : 0,
  "includeMembers" : true
}

HTTP响应示例

响应 200

{
  "departments" : [ {
    "description" : "string",
    "id" : 0,
    "memberIds" : [ 0 ],
    "name" : "string",
    "parentId" : 0,
    "requestId" : "string",
    "roleId" : 0,
    "teamId" : 0
  } ],
  "membersMap" : {
    "string" : "array"
  },
  "relationshipMap" : {
    "string" : "array"
  },
  "requestId" : "string"
}

2.15. 16 System Api

系统管理API

2.15.1. 绑定LDAP用户

PUT /ldap/bind

说明

设置ldapAccount时，会将LDAP中的特定账户绑定到指定行云管家用户；未设置ldapAccount时，将根据行云管家用户的账号查询LDAP，并进行绑定。ldapAccountKey可以指定LDAP中的属性名称，未设置时，从LDAP配置中读取

参数

类型

名称

说明

架构

Query

baseDn
必填

baseDn

string

Query

userId
必填

用户ID

integer(int64)

Query

ldapAccountKey
可选

Ldap账号属性名。可选

string

Query

ldapAccount
可选

Ldap账号。可选

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/ldap/bind

请求 query

{
  "baseDn" : "string",
  "userId" : 0,
  "ldapAccountKey" : "string",
  "ldapAccount" : "string"
}

2.15.2. 添加一条LDAP/AD配置

POST /ldap/config

参数

类型

名称

说明

架构

Body

request
必填

request

AddLdapConfigRequest

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/ldap/config

请求 body

{
  "accountAttr" : "string",
  "accountSuffix" : "string",
  "baseDn" : "string",
  "connectTimeout" : 0,
  "emailAttr" : "string",
  "filterOrgUnit" : "string",
  "filterPerson" : "string",
  "genderAttr" : "string",
  "ip" : "string",
  "nicknameAttr" : "string",
  "password" : "string",
  "phoneAttr" : "string",
  "port" : 0,
  "userName" : "string"
}

2.15.3. 更新LDAP/AD配置（通过baseDn匹配）

PUT /ldap/config

说明

注意，不能改变baseDn，即通过baseDn查找现有配置

参数

类型

名称

说明

架构

Body

request
必填

request

AddLdapConfigRequest

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/ldap/config

请求 body

{
  "accountAttr" : "string",
  "accountSuffix" : "string",
  "baseDn" : "string",
  "connectTimeout" : 0,
  "emailAttr" : "string",
  "filterOrgUnit" : "string",
  "filterPerson" : "string",
  "genderAttr" : "string",
  "ip" : "string",
  "nicknameAttr" : "string",
  "password" : "string",
  "phoneAttr" : "string",
  "port" : 0,
  "userName" : "string"
}

2.15.4. 删除LDAP/AD配置

DELETE /ldap/config

说明

通过这个配置导入的用户，账号会被回收，无法通过LDAP账号登录。管理控制台管理员可以通过手工指定登录账号和密码恢复使用。会删除对应的同步设置规则。

参数

类型

名称

说明

架构

Query

baseDn
必填

baseDn

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/ldap/config

请求 query

{
  "baseDn" : "string"
}

HTTP响应示例

响应 200

{
  "count" : 0,
  "requestId" : "string"
}

2.15.5. 更新LDAP/AD配置的BaseDn

PUT /ldap/config/baseDn

说明

注意，已经导入的用户全部在新的baseDn下进行认证，更换baseDn可能导致他们无法登陆。返回受影响的用户数。

参数

类型

名称

说明

架构

Query

prevBaseDn
必填

旧的baseDn

string

Query

newBaseDn
必填

新的baseDn

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/ldap/config/baseDn

请求 query

{
  "prevBaseDn" : "string",
  "newBaseDn" : "string"
}

HTTP响应示例

响应 200

{
  "count" : 0,
  "requestId" : "string"
}

2.15.6. 获取系统LDAP/AD配置列表

GET /ldap/configs

响应

HTTP代码

说明

架构

200

LdapConfigVoList

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/ldap/configs

HTTP响应示例

响应 200

{
  "ldapConfigs" : [ {
    "accountAttr" : "string",
    "accountSuffix" : "string",
    "baseDn" : "string",
    "connectTimeout" : 0,
    "emailAttr" : "string",
    "filterOrgUnit" : "string",
    "filterPerson" : "string",
    "genderAttr" : "string",
    "ip" : "string",
    "nicknameAttr" : "string",
    "phoneAttr" : "string",
    "port" : 0,
    "userName" : "string"
  } ],
  "requestId" : "string"
}

2.15.7. 设置（或更新）同步配置

PUT /ldap/syncConfig

参数

类型

名称

说明

架构

Body

request
必填

request

LdapSyncConfigVo

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/ldap/syncConfig

请求 body

{
  "addUserWhenCreated" : false,
  "baseDn" : "string",
  "dnTeamList" : [ {
    "dn" : "string",
    "name" : "string",
    "teamId" : 0
  } ],
  "enabled" : false,
  "firstSyncTime" : "string",
  "interval" : 0,
  "intervalUnit" : "string",
  "joinTeam" : false,
  "strategyWhenDeleted" : "string",
  "syncUserWhenChanged" : false
}

2.15.8. 获取系统LDAP/AD同步配置列表

GET /ldap/syncConfigs

响应

HTTP代码

说明

架构

200

LdapSyncConfigVoList

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/ldap/syncConfigs

HTTP响应示例

响应 200

{
  "ldapSyncConfigs" : [ {
    "addUserWhenCreated" : false,
    "baseDn" : "string",
    "dnTeamList" : [ {
      "dn" : "string",
      "name" : "string",
      "teamId" : 0
    } ],
    "enabled" : false,
    "firstSyncTime" : "string",
    "interval" : 0,
    "intervalUnit" : "string",
    "joinTeam" : false,
    "strategyWhenDeleted" : "string",
    "syncUserWhenChanged" : false
  } ],
  "requestId" : "string"
}

2.15.9. 解绑LDAP用户

PUT /ldap/unbind

说明

newAccount未设置时，将生成随机账号，可以设置原来的账号，相当于保留账号，如果设置其他账号，不能与现有用户重复； newPassword设置时，将按照系统的复杂度规则进行校验,未设置时，不会修改原有用户的本地密码； generatePassword=true和newPassword不要同时设置； forceUpdatePwd,emailNewPassword的默认取值：false，当newPassword设置时或者generatePassword=true时，emailNewPassword=true才会生效

参数

类型名称说明架构默认列

Query

userId
必填

用户ID

integer(int64)

Query

newAccount
可选

解绑后的新账号。可选

string

Query

newPassword
可选

解绑后的新密码。可选

string

Query

generatePassword
可选

解绑后生成随机密码。默认false

boolean

"false"

Query

forceUpdatePwd
可选

下一次登录强制改密码

boolean

"false"

Query

emailNewPassword
可选

是否邮件通知用户（如果设置了邮箱）

boolean

"false"

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/ldap/unbind

请求 query

{
  "userId" : 0,
  "newAccount" : "string",
  "newPassword" : "string",
  "generatePassword" : true,
  "forceUpdatePwd" : true,
  "emailNewPassword" : true
}

2.16. 17 Workflow Api

工单API

2.16.1. 查询流程工作项（按创建时间）

GET /workTasks/byCreateTime

说明

按照创建时间的起始和截止，查询团队的工作项。按照[fromTime,toTime)的边界进行查询过滤

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

Query

workType
可选

按流程类型过滤

enum (Common, ApplyProduct, HostAccessAudit, CommandAudit, CustomService, CreateHost, AllocateHost, RunScriptAudit, FileTransferAudit)

Query

stage
可选

参与类型：我发起的、我的待办、我的已办

enum (MyStarted, MyPending, MyDone)

Query

fromTime
必填

创建时间的起始时间。UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

toTime
必填

创建时间的结束时间。UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

响应

HTTP代码

说明

架构

200

WorkTaskVoResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/workTasks/byCreateTime

请求 query

{
  "teamId" : 0,
  "workType" : "string",
  "stage" : "string",
  "fromTime" : "string",
  "toTime" : "string"
}

HTTP响应示例

响应 200

{
  "size" : 0,
  "tasks" : [ {
    "action" : "string",
    "applicantAccount" : "string",
    "applicantId" : 0,
    "applicantName" : "string",
    "applicantTeamId" : 0,
    "createTime" : "string",
    "finishTime" : "string",
    "id" : 0,
    "instanceDescription" : "string",
    "instanceId" : 0,
    "instanceSubject" : "string",
    "operatorAccount" : "string",
    "operatorId" : 0,
    "operatorName" : "string",
    "operatorTeamId" : 0,
    "result" : "string",
    "stage" : "string",
    "startTime" : "string",
    "status" : "string",
    "subject" : "string",
    "templateId" : 0,
    "templateName" : "string",
    "updateTime" : "string",
    "workNodeName" : "string",
    "workType" : "string"
  } ],
  "total" : 0
}

2.16.2. 查询流程工作项（按ID）

GET /workTasks/byCursor

说明

按照创建时间升序，查询团队的工作项。游标ID是工作项的ID，查询数据满足id>游标ID

参数

类型名称说明架构默认列

Query

teamId
必填

所属团队ID

integer(int64)

Query

workType
可选

按流程类型过滤

enum (Common, ApplyProduct, HostAccessAudit, CommandAudit, CustomService, CreateHost, AllocateHost, RunScriptAudit, FileTransferAudit)

Query

stage
可选

参与类型：我发起的、我的待办、我的已办

enum (MyStarted, MyPending, MyDone)

Query

cursorId
必填

游标ID

integer(int64)

"0"

Query

size
可选

请求记录数，默认20

integer(int32)

"20"

响应

HTTP代码

说明

架构

200

WorkTaskVoResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/workTasks/byCursor

请求 query

{
  "teamId" : 0,
  "workType" : "string",
  "stage" : "string",
  "cursorId" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "size" : 0,
  "tasks" : [ {
    "action" : "string",
    "applicantAccount" : "string",
    "applicantId" : 0,
    "applicantName" : "string",
    "applicantTeamId" : 0,
    "createTime" : "string",
    "finishTime" : "string",
    "id" : 0,
    "instanceDescription" : "string",
    "instanceId" : 0,
    "instanceSubject" : "string",
    "operatorAccount" : "string",
    "operatorId" : 0,
    "operatorName" : "string",
    "operatorTeamId" : 0,
    "result" : "string",
    "stage" : "string",
    "startTime" : "string",
    "status" : "string",
    "subject" : "string",
    "templateId" : 0,
    "templateName" : "string",
    "updateTime" : "string",
    "workNodeName" : "string",
    "workType" : "string"
  } ],
  "total" : 0
}

2.16.3. 查询流程工作项（按创建时间）

GET /workTasks/byUpdateTime

说明

按照更新时间的起始和截止，查询团队的工作项。按照[fromTime,toTime)的边界进行查询过滤

参数

类型

名称

说明

架构

Query

teamId
必填

所属团队ID

integer(int64)

Query

workType
可选

按流程类型过滤

enum (Common, ApplyProduct, HostAccessAudit, CommandAudit, CustomService, CreateHost, AllocateHost, RunScriptAudit, FileTransferAudit)

Query

stage
可选

参与类型：我发起的、我的待办、我的已办

enum (MyStarted, MyPending, MyDone)

Query

fromTime
必填

创建时间的起始时间。UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

toTime
必填

创建时间的结束时间。UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

响应

HTTP代码

说明

架构

200

WorkTaskVoResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/workTasks/byUpdateTime

请求 query

{
  "teamId" : 0,
  "workType" : "string",
  "stage" : "string",
  "fromTime" : "string",
  "toTime" : "string"
}

HTTP响应示例

响应 200

{
  "size" : 0,
  "tasks" : [ {
    "action" : "string",
    "applicantAccount" : "string",
    "applicantId" : 0,
    "applicantName" : "string",
    "applicantTeamId" : 0,
    "createTime" : "string",
    "finishTime" : "string",
    "id" : 0,
    "instanceDescription" : "string",
    "instanceId" : 0,
    "instanceSubject" : "string",
    "operatorAccount" : "string",
    "operatorId" : 0,
    "operatorName" : "string",
    "operatorTeamId" : 0,
    "result" : "string",
    "stage" : "string",
    "startTime" : "string",
    "status" : "string",
    "subject" : "string",
    "templateId" : 0,
    "templateName" : "string",
    "updateTime" : "string",
    "workNodeName" : "string",
    "workType" : "string"
  } ],
  "total" : 0
}

2.16.4. 查询我的流程工单

GET /workflow/myInstances

参数

类型名称说明架构默认列

Query

teamId
必填

所属团队ID

integer(int64)

Query

userId
必填

当前用户ID

integer(int64)

Query

stage
必填

参与类型：我发起的、我的待办、我的已办

enum (MyStarted, MyPending, MyDone)

Query

workType
可选

按流程类型过滤

enum (Common, ApplyProduct, HostAccessAudit, CommandAudit, CustomService, CreateHost, AllocateHost, RunScriptAudit, FileTransferAudit)

Query

page
可选

页码,从1开始

integer(int32)

"1"

Query

size
可选

每页记录数，默认20

integer(int32)

"20"

Query

sortField
可选

排序字段：createTime、status

string

"createTime"

Query

sortOrder
可选

顺序：desc,asc

string

"desc"

响应

HTTP代码

说明

架构

200

WorkflowInstanceVoResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/workflow/myInstances

请求 query

{
  "teamId" : 0,
  "userId" : 0,
  "stage" : "string",
  "workType" : "string",
  "page" : 0,
  "size" : 0,
  "sortField" : "string",
  "sortOrder" : "string"
}

HTTP响应示例

响应 200

{
  "page" : 0,
  "requestId" : "string",
  "size" : 0,
  "total" : 0,
  "workflowInstances" : [ {
    "closed" : false,
    "createTime" : "string",
    "creatorId" : 0,
    "creatorName" : "string",
    "description" : "string",
    "id" : 0,
    "result" : "string",
    "status" : "string",
    "subject" : "string",
    "teamId" : 0,
    "templateId" : 0,
    "timeout" : 0,
    "updateTime" : "string",
    "workType" : "string"
  } ]
}

2.17. 18 Key Pair Api

密钥对API

2.17.1. 创建密钥对

POST /keyPair

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

Query

name
必填

密钥对名称（团队唯一）

string

Query

description
可选

密钥对描述

string

Query

key
可选

密钥文件（用字符串表示），如果未设置后台会自动生成

string

响应

HTTP代码

说明

架构

200

KeyPairVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/keyPair

请求 query

{
  "teamId" : 0,
  "name" : "string",
  "description" : "string",
  "key" : "string"
}

HTTP响应示例

响应 200

{
  "comment" : "string",
  "createTime" : "string",
  "creator" : 0,
  "description" : "string",
  "id" : 0,
  "name" : "string",
  "publicKey" : "string",
  "requestId" : "string",
  "teamId" : 0
}

2.17.2. 获取密钥对详情（授权信息）

GET /keyPair/{id}

参数

类型

名称

说明

架构

Path

id
必填

密钥对ID

integer(int64)

响应

HTTP代码

说明

架构

200

KeyPairDetailVo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/keyPair/0

HTTP响应示例

响应 200

{
  "comment" : "string",
  "createTime" : "string",
  "creator" : 0,
  "departmentIds" : [ 0 ],
  "description" : "string",
  "id" : 0,
  "memberIds" : [ 0 ],
  "name" : "string",
  "publicKey" : "string",
  "requestId" : "string",
  "roleIds" : [ 0 ],
  "teamId" : 0
}

2.17.3. 修改密钥对名称和描述

PUT /keyPair/{id}

说明

v4.18的实现：如果密钥对添加到登录凭证的主机上，删除密钥对后不会删除登录凭证中的密钥

参数

类型

名称

说明

架构

Path

id
必填

密钥对ID

integer(int64)

Query

name
必填

密钥对名称（团队唯一）

string

Query

description
可选

密钥对描述

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/keyPair/0

请求 query

{
  "name" : "string",
  "description" : "string"
}

2.17.4. 删除密钥对

DELETE /keyPair/{id}

说明

v4.18的实现：如果密钥对添加到登录凭证的主机上，删除密钥对后不会删除登录凭证中的密钥

参数

类型

名称

说明

架构

Path

id
必填

密钥对ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/keyPair/0

2.17.5. 授权密钥对给组织单元

PUT /keyPair/{id}/departments

说明

如果没有传递departments，会取消所有组织单元授权

参数

类型

名称

说明

架构

Path

id
必填

密钥对ID

integer(int64)

Query

departments
可选

授权组织单元

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/keyPair/0/departments

请求 query

{
  "departments" : "string"
}

2.17.6. 授权密钥对给团队成员

PUT /keyPair/{id}/members

说明

如果没有传递members，会取消所有成员授权

参数

类型

名称

说明

架构

Path

id
必填

密钥对ID

integer(int64)

Query

members
可选

授权团队成员

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/keyPair/0/members

请求 query

{
  "members" : "string"
}

2.17.7. 授权密钥对给角色

PUT /keyPair/{id}/roles

说明

如果没有传递roles，会取消所有角色授权

参数

类型

名称

说明

架构

Path

id
必填

密钥对ID

integer(int64)

Query

roles
可选

授权角色

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/keyPair/0/roles

请求 query

{
  "roles" : "string"
}

2.17.8. 获取所有密钥对

GET /keyPairs

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

KeyPairListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/keyPairs

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "keyPars" : [ {
    "comment" : "string",
    "createTime" : "string",
    "creator" : 0,
    "description" : "string",
    "id" : 0,
    "name" : "string",
    "publicKey" : "string",
    "requestId" : "string",
    "teamId" : 0
  } ],
  "requestId" : "string"
}

2.18. 19 Ops Policy Api

运维策略API

2.18.1. 获取策略组子策略列表

GET /opsPolicies/byGroup/{groupId}

Caution

operation.deprecated

参数

类型

名称

说明

架构

Path

groupId
必填

策略组ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicies/byGroup/0

HTTP响应示例

响应 200

{
  "policies" : [ {
    "description" : "string",
    "id" : 0,
    "name" : "string",
    "priority" : 0,
    "requestId" : "string",
    "sourceId" : 0,
    "sourceType" : "string"
  } ],
  "requestId" : "string"
}

2.18.2. 创建子策略

POST /opsPolicy

Caution

operation.deprecated

参数

类型

名称

说明

架构

Query

policyGroupId
必填

策略组ID

integer(int64)

Query

name
必填

子策略名称

string

Query

description
必填

子策略描述

string

Query

priority
必填

子策略优先级

integer(int32)

Query

roles
可选

授权角色

string

Query

departments
可选

授权组织单元

string

Query

members
可选

授权团队成员

string

响应

HTTP代码

说明

架构

200

OpsPolicyVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicy

请求 query

{
  "policyGroupId" : 0,
  "name" : "string",
  "description" : "string",
  "priority" : 0,
  "roles" : "string",
  "departments" : "string",
  "members" : "string"
}

HTTP响应示例

响应 200

{
  "description" : "string",
  "id" : 0,
  "name" : "string",
  "priority" : 0,
  "requestId" : "string",
  "sourceId" : 0,
  "sourceType" : "string"
}

2.18.3. 获取云账户的子策略

GET /opsPolicy/byCloud/{cloudId}

Caution

operation.deprecated

参数

类型

名称

说明

架构

Path

cloudId
必填

云账户ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicy/byCloud/0

HTTP响应示例

响应 200

{
  "policies" : [ {
    "description" : "string",
    "id" : 0,
    "name" : "string",
    "priority" : 0,
    "requestId" : "string",
    "sourceId" : 0,
    "sourceType" : "string"
  } ],
  "requestId" : "string"
}

2.18.4. 获取默认运维策略条目

GET /opsPolicy/defaultItems

说明

返回当前系统中的运维策略列表，更新版本后，新增和修改的运维策略会返回

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicy/defaultItems

HTTP响应示例

响应 200

{
  "policyItems" : [ {
    "category" : "string",
    "defaultValue" : "object",
    "description" : "string",
    "domainEntityType" : "string",
    "key" : "string",
    "requestId" : "string",
    "value" : "object",
    "valueType" : "string"
  } ]
}

2.18.5. 获取子策略详情

GET /opsPolicy/{id}

参数

类型

名称

说明

架构

Path

id
必填

子策略ID

integer(int64)

响应

HTTP代码

说明

架构

200

OpsPolicyDetailVo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicy/0

HTTP响应示例

响应 200

{
  "departmentIds" : [ 0 ],
  "description" : "string",
  "id" : 0,
  "memberIds" : [ 0 ],
  "name" : "string",
  "priority" : 0,
  "requestId" : "string",
  "roleIds" : [ 0 ],
  "sourceId" : 0,
  "sourceType" : "string"
}

2.18.6. 删除子策略

DELETE /opsPolicy/{id}

参数

类型

名称

说明

架构

Path

id
必填

子策略ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicy/0

2.18.7. 授权子策略给组织单元

PUT /opsPolicy/{id}/departments

参数

类型

名称

说明

架构

Path

id
必填

子策略ID

integer(int64)

Query

departments
可选

组织单元ID列表

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicy/0/departments

请求 query

{
  "departments" : "string"
}

2.18.8. 获取子策略的条目

GET /opsPolicy/{id}/item/{identity}

说明

v4.18：目前不会返回BatchType的详细数据

参数

类型

名称

说明

架构

Path

id
必填

子策略ID

integer(int64)

Path

identity
必填

策略条目的Id

string

响应

HTTP代码

说明

架构

200

OpsPolicyItemVo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicy/0/item/string

HTTP响应示例

响应 200

{
  "category" : "string",
  "defaultValue" : "object",
  "description" : "string",
  "domainEntityType" : "string",
  "key" : "string",
  "requestId" : "string",
  "value" : "object",
  "valueType" : "string"
}

2.18.9. 获取子策略的条目

GET /opsPolicy/{id}/items

说明

v4.18：目前不会返回BatchType的详细数据

参数

类型

名称

说明

架构

Path

id
必填

子策略ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicy/0/items

HTTP响应示例

响应 200

{
  "policyItems" : [ {
    "category" : "string",
    "defaultValue" : "object",
    "description" : "string",
    "domainEntityType" : "string",
    "key" : "string",
    "requestId" : "string",
    "value" : "object",
    "valueType" : "string"
  } ]
}

2.18.10. 修改子策略的条目

PUT /opsPolicy/{id}/items

说明

注意：1，定义策略条目的identity:{category}.{key}； 2，更新请求的参数名是条目的identity，参数值是条目取值的字符串形式； 3，当前接口目前仅支持单一取值策略; 4，无法找到identity的参数，都会被忽略掉； 5，返回被修改过的策略条目

参数

类型

名称

说明

架构

Path

id
必填

子策略ID

integer(int64)

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicy/0/items

HTTP响应示例

响应 200

{
  "policyItems" : [ {
    "category" : "string",
    "defaultValue" : "object",
    "description" : "string",
    "domainEntityType" : "string",
    "key" : "string",
    "requestId" : "string",
    "value" : "object",
    "valueType" : "string"
  } ]
}

2.18.11. 授权子策略给团队成员

PUT /opsPolicy/{id}/members

参数

类型

名称

说明

架构

Path

id
必填

子策略ID

integer(int64)

Query

members
可选

团队成员ID列表

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicy/0/members

请求 query

{
  "members" : "string"
}

2.18.12. 授权子策略给角色

PUT /opsPolicy/{id}/roles

参数

类型

名称

说明

架构

Path

id
必填

子策略ID

integer(int64)

Query

roles
可选

角色ID列表

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicy/0/roles

请求 query

{
  "roles" : "string"
}

2.18.13. 创建策略组

POST /opsPolicyGroup

Caution

operation.deprecated

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

Query

name
必填

策略组名称

string

Query

hosts
可选

关联主机ID列表

string

响应

HTTP代码

说明

架构

200

OpsPolicyGroupVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicyGroup

请求 query

{
  "teamId" : 0,
  "name" : "string",
  "hosts" : "string"
}

HTTP响应示例

响应 200

{
  "createTime" : "string",
  "creator" : 0,
  "id" : 0,
  "policyName" : "string",
  "requestId" : "string",
  "teamId" : 0,
  "updateTime" : "string"
}

2.18.14. 获取策略组详情

GET /opsPolicyGroup/{id}

Caution

operation.deprecated

参数

类型

名称

说明

架构

Path

id
必填

策略组ID

integer(int64)

响应

HTTP代码

说明

架构

200

OpsPolicyGroupDetailVo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicyGroup/0

HTTP响应示例

响应 200

{
  "createTime" : "string",
  "creator" : 0,
  "hosts" : [ 0 ],
  "id" : 0,
  "policyName" : "string",
  "requestId" : "string",
  "teamId" : 0,
  "updateTime" : "string"
}

2.18.15. 删除策略组

DELETE /opsPolicyGroup/{id}

Caution

operation.deprecated

参数

类型

名称

说明

架构

Path

id
必填

策略组ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicyGroup/0

2.18.16. 添加主机到策略组

POST /opsPolicyGroup/{id}/hosts

Caution

operation.deprecated

参数

类型

名称

说明

架构

Path

id
必填

策略组ID

integer(int64)

Query

hosts
可选

主机ID列表，用逗号连接

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicyGroup/0/hosts

请求 query

{
  "hosts" : "string"
}

2.18.17. 修改策略组关联主机

PUT /opsPolicyGroup/{id}/hosts

Caution

operation.deprecated

参数

类型

名称

说明

架构

Path

id
必填

策略组ID

integer(int64)

Query

hosts
可选

主机ID列表，用逗号连接

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicyGroup/0/hosts

请求 query

{
  "hosts" : "string"
}

2.18.18. 删除策略组关联的主机

DELETE /opsPolicyGroup/{id}/hosts

Caution

operation.deprecated

参数

类型

名称

说明

架构

Path

id
必填

策略组ID

integer(int64)

Query

hosts
可选

主机ID列表，用逗号连接

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicyGroup/0/hosts

请求 query

{
  "hosts" : "string"
}

2.18.19. 修改策略组子策略优先级

PUT /opsPolicyGroup/{id}/priorities

说明

sortedPolicyIds：所有子策略的ID列表，用逗号连接，最前面的优先级越高

参数

类型

名称

说明

架构

Path

id
必填

策略组ID

integer(int64)

Query

sortedPolicyIds
必填

子策略ID排序列表

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicyGroup/0/priorities

请求 query

{
  "sortedPolicyIds" : "string"
}

2.18.20. 获取团队策略组列表

GET /opsPolicyGroups

Caution

operation.deprecated

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

OpsPolicyGroupResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/opsPolicyGroups

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "policyGroups" : [ {
    "createTime" : "string",
    "creator" : 0,
    "id" : 0,
    "policyName" : "string",
    "requestId" : "string",
    "teamId" : 0,
    "updateTime" : "string"
  } ],
  "requestId" : "string"
}

2.19. 20 Quota Api

配额API

2.19.1. 获取某个模块的所有购买时长

GET /moduleTerms/{moduleCode}

参数

类型

名称

说明

架构

Path

moduleCode
必填

模块代码

string

响应

HTTP代码

说明

架构

200

ModuleTermListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/moduleTerms/string

HTTP响应示例

响应 200

{
  "moduleTermVos" : [ {
    "moduleEditionCode" : "string",
    "moduleTerm" : 0
  } ],
  "requestId" : "string"
}

2.19.2. 获取配额条目

GET /quotaItems

响应

HTTP代码

说明

架构

200

QuotaItemResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/quotaItems

HTTP响应示例

响应 200

{
  "quotaItems" : [ {
    "code" : "string",
    "external" : false,
    "name" : "string",
    "tenantId" : 0,
    "unit" : "string",
    "unitPrice" : 0.0
  } ],
  "requestId" : "string"
}

2.19.3. 获取团队某个模块信息

GET /team/{id}/module/{code}

参数

类型

名称

说明

架构

Path

id
必填

团队ID

integer(int64)

Path

code
必填

模块代码

enum (waf, CScanner, CMonitor)

响应

HTTP代码

说明

架构

200

GetModuleResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/0/module/string

HTTP响应示例

响应 200

{
  "modules" : [ {
    "editionCode" : "string",
    "editionName" : "string",
    "expiredTime" : "string",
    "moduleCode" : "string",
    "moduleName" : "string",
    "quotas" : [ {
      "code" : "string",
      "external" : false,
      "name" : "string",
      "quota" : 0,
      "tenantId" : 0,
      "unit" : "string",
      "unitPrice" : 0.0,
      "used" : 0
    } ],
    "requestId" : "string"
  } ],
  "requestId" : "string"
}

2.19.4. 获取团队某个配额信息

GET /team/{id}/quota/{code}

参数

类型

名称

说明

架构

Path

id
必填

团队ID

integer(int64)

Path

code
必填

配额代码

string

响应

HTTP代码

说明

架构

200

QuotaUsedItemVo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/0/quota/string

HTTP响应示例

响应 200

{
  "code" : "string",
  "external" : false,
  "name" : "string",
  "quota" : 0,
  "tenantId" : 0,
  "unit" : "string",
  "unitPrice" : 0.0,
  "used" : 0
}

2.19.5. 用追加的方式修改团队外部配额的已用(v6）

POST /team/{id}/quota/{code}/increment

说明

仅支持外部配额

参数

类型

名称

说明

架构

Path

id
必填

团队ID

integer(int64)

Path

code
必填

配额代码

string

Query

increment
必填

已用配额的增量

integer(int64)

响应

HTTP代码

说明

架构

200

QuotaUsedItemVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/0/quota/string/increment

请求 query

{
  "increment" : 0
}

HTTP响应示例

响应 200

{
  "code" : "string",
  "external" : false,
  "name" : "string",
  "quota" : 0,
  "tenantId" : 0,
  "unit" : "string",
  "unitPrice" : 0.0,
  "used" : 0
}

2.19.6. 更新团队外部配额的已用(v6）

PUT /team/{id}/quota/{code}/used

说明

仅支持外部配额

参数

类型

名称

说明

架构

Path

id
必填

团队ID

integer(int64)

Path

code
必填

配额代码

string

Query

used
必填

已用

integer(int64)

响应

HTTP代码

说明

架构

200

QuotaUsedItemVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/0/quota/string/used

请求 query

{
  "used" : 0
}

HTTP响应示例

响应 200

{
  "code" : "string",
  "external" : false,
  "name" : "string",
  "quota" : 0,
  "tenantId" : 0,
  "unit" : "string",
  "unitPrice" : 0.0,
  "used" : 0
}

2.19.7. 获取团队所有配额信息

GET /team/{id}/quotas

参数

类型

名称

说明

架构

Path

id
必填

团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

QuotaUsedItemResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/team/0/quotas

HTTP响应示例

响应 200

{
  "quotaItems" : [ {
    "code" : "string",
    "external" : false,
    "name" : "string",
    "quota" : 0,
    "tenantId" : 0,
    "unit" : "string",
    "unitPrice" : 0.0,
    "used" : 0
  } ],
  "requestId" : "string"
}

2.20. 20 Session Api

会话API

2.20.1. 结束一个会话

DELETE /closeSession

参数

类型

名称

说明

架构

Query

sessionId
必填

会话ID

integer(int64)

Query

reason
可选

关闭理由

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/closeSession

请求 query

{
  "sessionId" : 0,
  "reason" : "string"
}

HTTP响应示例

响应 200

{
  "msg" : "string",
  "success" : true
}

2.20.2. 根据某个访问串获取唤醒本地工具的url

GET /getOpenNativeUrl

说明

id和endpoint优先使用id，如果未指定中转服务，默认使用团队可用中转的其中一个

参数

类型

名称

说明

架构

Query

account
必填

访问串用户名

string

Query

password
必填

会话账户密码

string

Query

transitId
可选

中转服务ID

integer(int64)

Query

endpoint
可选

中转服务endpoint

string

响应

HTTP代码

说明

架构

200

UrlResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/getOpenNativeUrl

请求 query

{
  "account" : "string",
  "password" : "string",
  "transitId" : 0,
  "endpoint" : "string"
}

HTTP响应示例

响应 200

{
  "url" : "string"
}

2.20.3. 获取自动打开主机会话的授权URL

GET /oauthSession

参数

类型名称说明架构默认列

Query

userId
必填

登录用户的ID

integer(int64)

Query

oneoff
必填

是否一次有效

boolean

"true"

Query

hostId
必填

主机ID

integer(int64)

Query

desktopType
必填

会话类型

enum (SSH, RDP, TELNET, APP, VNC, SFTP, FTP, SCP, ALIYUN_VNC, SHELL)

Query

port
可选

目标端口。不设置时根据协议选取默认端口

integer(int32)

Query

accessType
必填

接入方式

enum (PUBLIC_IP, INNER_IP)

Query

expireSeconds
必填

超时时间,秒,[2min,24h]，默认300秒

integer(int32)

"300"

Query

account
可选

会话账户,SSH/RDP会话是必须的

string

Query

password
可选

会话账户密码

string

Query

privateKey
可选

会话账户密钥

string

Query

privateKeyPass
可选

密钥的加密密码

string

Query

credentialId
可选

用户有权限的登录凭证ID，与上面的密码、密钥不要同时使用

integer(int64)

Query

screenResolution
可选

设置RDP分辨率（默认值1024x768）不设置时取默认值

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/oauthSession

请求 query

{
  "userId" : 0,
  "oneoff" : true,
  "hostId" : 0,
  "desktopType" : "string",
  "port" : 0,
  "accessType" : "string",
  "expireSeconds" : 0,
  "account" : "string",
  "password" : "string",
  "privateKey" : "string",
  "privateKeyPass" : "string",
  "credentialId" : 0,
  "screenResolution" : "string"
}

HTTP响应示例

响应 200

{
  "expiredSeconds" : 0,
  "url" : "string"
}

2.20.4. 根据分享code生成某个会话的分享链接url

GET /oauthSessionShare

参数

类型

名称

说明

架构

Query

userId
必填

被分享的用户ID，如果为空则表明要创建临时用户

integer(int64)

Query

shareCode
必填

会话分享Code

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/oauthSessionShare

请求 query

{
  "userId" : 0,
  "shareCode" : "string"
}

HTTP响应示例

响应 200

{
  "expiredSeconds" : 0,
  "url" : "string"
}

2.20.5. 创建并返回一个会话的websocketUrl

GET /openSessionGetWS

参数

类型

名称

说明

架构

Query

userId
必填

登录用户的ID

integer(int64)

Query

hostId
必填

主机ID

integer(int64)

Query

desktopType
必填

会话类型

enum (SSH, RDP, TELNET, APP, VNC, SFTP, FTP, SCP, ALIYUN_VNC, SHELL)

Query

port
可选

目标端口

integer(int32)

Query

accessType
必填

接入方式

enum (PUBLIC_IP, INNER_IP)

Query

account
可选

会话账户,SSH/RDP会话是必须的

string

Query

password
可选

会话账户密码

string

Query

privateKey
可选

会话账户密钥

string

Query

privateKeyPass
可选

密钥的加密密码

string

Query

credentialId
可选

用户有权限的登录凭证ID，与上面的密码、密钥不要同时使用

integer(int64)

响应

HTTP代码

说明

架构

200

SessionOpenResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/openSessionGetWS

请求 query

{
  "userId" : 0,
  "hostId" : 0,
  "desktopType" : "string",
  "port" : 0,
  "accessType" : "string",
  "account" : "string",
  "password" : "string",
  "privateKey" : "string",
  "privateKeyPass" : "string",
  "credentialId" : 0
}

HTTP响应示例

响应 200

{
  "deskType" : 0,
  "errorMsg" : "string",
  "sessionId" : 0,
  "success" : true,
  "websocketUrl" : "string"
}

2.20.6. 获取打开的会话数

GET /sessions/countReady

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/sessions/countReady

HTTP响应示例

响应 200

{
  "count" : 0,
  "requestId" : "string"
}

2.20.7. 获取团队在线成员数

GET /sessions/countReadyByTeam

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/sessions/countReadyByTeam

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "count" : 0,
  "requestId" : "string"
}

2.20.8. 获取团队可用中转列表

GET /teamUsableTransitServer

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

TransitServerResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/teamUsableTransitServer

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "transitServers" : [ {
    "code" : "string",
    "endpoints" : "string",
    "id" : 0,
    "ip" : "string",
    "name" : "string",
    "requestId" : "string"
  } ]
}

2.21. 21 Ops Policy Api V2

运维策略API v2

2.21.1. 创建策略

POST /v2/opsPolicy

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

Query

name
必填

策略名称

string

Query

description
必填

策略描述

string

Query

priority
必填

策略优先级

integer(int32)

Query

roles
可选

授权角色

string

Query

departments
可选

授权组织单元

string

Query

members
可选

授权团队成员

string

响应

HTTP代码

说明

架构

200

OpsPolicyVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/v2/opsPolicy

请求 query

{
  "teamId" : 0,
  "name" : "string",
  "description" : "string",
  "priority" : 0,
  "roles" : "string",
  "departments" : "string",
  "members" : "string"
}

HTTP响应示例

响应 200

{
  "description" : "string",
  "id" : 0,
  "name" : "string",
  "priority" : 0,
  "requestId" : "string",
  "sourceId" : 0,
  "sourceType" : "string"
}

2.21.2. 获取云账户的策略

GET /v2/opsPolicy/byCloud/{cloudId}

参数

类型

名称

说明

架构

Path

cloudId
必填

云账户ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/v2/opsPolicy/byCloud/0

HTTP响应示例

响应 200

{
  "policies" : [ {
    "description" : "string",
    "id" : 0,
    "name" : "string",
    "priority" : 0,
    "requestId" : "string",
    "sourceId" : 0,
    "sourceType" : "string"
  } ],
  "requestId" : "string"
}

2.21.3. 获取默认运维策略条目

GET /v2/opsPolicy/defaultItems

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/v2/opsPolicy/defaultItems

HTTP响应示例

响应 200

{
  "policyItems" : [ {
    "category" : "string",
    "defaultValue" : "object",
    "description" : "string",
    "domainEntityType" : "string",
    "key" : "string",
    "requestId" : "string",
    "value" : "object",
    "valueType" : "string"
  } ]
}

2.21.4. 删除策略

DELETE /v2/opsPolicy/{id}

参数

类型

名称

说明

架构

Path

id
必填

策略ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/v2/opsPolicy/0

2.21.5. 授权策略给组织单元

PUT /v2/opsPolicy/{id}/departments

参数

类型

名称

说明

架构

Path

id
必填

策略ID

integer(int64)

Query

departments
可选

组织单元ID列表

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/v2/opsPolicy/0/departments

请求 query

{
  "departments" : "string"
}

2.21.6. 添加主机到策略

POST /v2/opsPolicy/{id}/hosts

参数

类型

名称

说明

架构

Path

id
必填

策略ID

integer(int64)

Query

hosts
可选

主机ID列表，用逗号连接

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/v2/opsPolicy/0/hosts

请求 query

{
  "hosts" : "string"
}

2.21.7. 修改策略关联主机

PUT /v2/opsPolicy/{id}/hosts

参数

类型

名称

说明

架构

Path

id
必填

策略ID

integer(int64)

Query

hosts
可选

主机ID列表，用逗号连接

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/v2/opsPolicy/0/hosts

请求 query

{
  "hosts" : "string"
}

2.21.8. 删除策略关联的主机

DELETE /v2/opsPolicy/{id}/hosts

参数

类型

名称

说明

架构

Path

id
必填

策略ID

integer(int64)

Query

hosts
可选

主机ID列表，用逗号连接

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/v2/opsPolicy/0/hosts

请求 query

{
  "hosts" : "string"
}

2.21.9. 获取策略条目

GET /v2/opsPolicy/{id}/item/{identity}

说明

v4.18：目前不会返回BatchType的详细数据

参数

类型

名称

说明

架构

Path

id
必填

策略ID

integer(int64)

Path

identity
必填

策略条目的Id

string

响应

HTTP代码

说明

架构

200

OpsPolicyItemVo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/v2/opsPolicy/0/item/string

HTTP响应示例

响应 200

{
  "category" : "string",
  "defaultValue" : "object",
  "description" : "string",
  "domainEntityType" : "string",
  "key" : "string",
  "requestId" : "string",
  "value" : "object",
  "valueType" : "string"
}

2.21.10. 获取策略的条目

GET /v2/opsPolicy/{id}/items

说明

v4.18：目前不会返回BatchType的详细数据

参数

类型

名称

说明

架构

Path

id
必填

策略ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/v2/opsPolicy/0/items

HTTP响应示例

响应 200

{
  "policyItems" : [ {
    "category" : "string",
    "defaultValue" : "object",
    "description" : "string",
    "domainEntityType" : "string",
    "key" : "string",
    "requestId" : "string",
    "value" : "object",
    "valueType" : "string"
  } ]
}

2.21.11. 修改策略的条目

PUT /v2/opsPolicy/{id}/items

说明

参数

类型

名称

说明

架构

Path

id
必填

策略ID

integer(int64)

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/v2/opsPolicy/0/items

HTTP响应示例

响应 200

{
  "policyItems" : [ {
    "category" : "string",
    "defaultValue" : "object",
    "description" : "string",
    "domainEntityType" : "string",
    "key" : "string",
    "requestId" : "string",
    "value" : "object",
    "valueType" : "string"
  } ]
}

2.21.12. 授权策略给团队成员

PUT /v2/opsPolicy/{id}/members

参数

类型

名称

说明

架构

Path

id
必填

策略ID

integer(int64)

Query

members
可选

团队成员ID列表

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/v2/opsPolicy/0/members

请求 query

{
  "members" : "string"
}

2.21.13. 授权策略给角色

PUT /v2/opsPolicy/{id}/roles

参数

类型

名称

说明

架构

Path

id
必填

策略ID

integer(int64)

Query

roles
可选

角色ID列表

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/v2/opsPolicy/0/roles

请求 query

{
  "roles" : "string"
}

2.21.14. 修改策略优先级

PUT /v2/opsPolicy/{teamId}/priorities

说明

sortedPolicyIds：所有策略的ID列表，用逗号连接，最前面的优先级越高

参数

类型

名称

说明

架构

Path

teamId
必填

团队ID

integer(int64)

Query

sortedPolicyIds
必填

子策略ID排序列表

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/v2/opsPolicy/0/priorities

请求 query

{
  "sortedPolicyIds" : "string"
}

2.21.15. 获取策略详情

GET /v2/opsPolicyDetail/{id}

参数

类型

名称

说明

架构

Path

id
必填

策略ID

integer(int64)

响应

HTTP代码

说明

架构

200

OpsPolicyDetailVo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/v2/opsPolicyDetail/0

HTTP响应示例

响应 200

{
  "departmentIds" : [ 0 ],
  "description" : "string",
  "id" : 0,
  "memberIds" : [ 0 ],
  "name" : "string",
  "priority" : 0,
  "requestId" : "string",
  "roleIds" : [ 0 ],
  "sourceId" : 0,
  "sourceType" : "string"
}

2.21.16. 获取团队策略列表

GET /v2/opsPolicyList

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/v2/opsPolicyList

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "policies" : [ {
    "description" : "string",
    "id" : 0,
    "name" : "string",
    "priority" : 0,
    "requestId" : "string",
    "sourceId" : 0,
    "sourceType" : "string"
  } ],
  "requestId" : "string"
}

2.22. 22 Authorization Api

授权API

2.22.1. 追加某个资源的授权信息

POST /resource/{type}/{id}/authorization

说明

注意，这个接口是追加授权

参数

类型

名称

说明

架构

Path

type
必填

资源类型

enum (SHORTCUT, CLOUD, HOST_GROUP, VIRTUAL_HOST_GROUP, HOST_CREDENTIAL, HOST_KEY_PAIR, TASK_LIBRARY, SCRIPT_LIBRARY, HOST, BUCKET, CDN, DB_PLAN, OP_SUB_POLICY, REMOTE_APP, WAF_SITE, C_SCANNER, C_MONITOR, IMAGE_PRODUCT)

Path

id
必填

资源ID

integer(int64)

Query

teamId
必填

团队ID

integer(int64)

Query

roleIds
可选

角色ID，用逗号连接

string

Query

departmentIds
可选

部门ID，用逗号连接

string

Query

memberIds
可选

成员ID，用逗号连接

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/resource/string/0/authorization

请求 query

{
  "teamId" : 0,
  "roleIds" : "string",
  "departmentIds" : "string",
  "memberIds" : "string"
}

2.22.2. 获取某个资源的授权信息

GET /resource/{type}/{id}/authorization

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

Path

type
必填

资源类型

Path

id
必填

资源ID

integer(int64)

响应

HTTP代码

说明

架构

200

AuthorizationInfo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/resource/string/0/authorization

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "departments" : [ 0 ],
  "members" : [ 0 ],
  "roles" : [ 0 ]
}

2.22.3. 更新某个资源的授权信息

PUT /resource/{type}/{id}/authorization

说明

注意，这个接口不是追加授权，如果不设置roleIds、departmentIds、memberIds，将分别取消所有角色、部门、团队成员的授权

参数

类型

名称

说明

架构

Path

type
必填

资源类型

Path

id
必填

资源ID

integer(int64)

Query

teamId
必填

团队ID

integer(int64)

Query

roleIds
可选

角色ID，用逗号连接

string

Query

departmentIds
可选

部门ID，用逗号连接

string

Query

memberIds
可选

成员ID，用逗号连接

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/resource/string/0/authorization

请求 query

{
  "teamId" : 0,
  "roleIds" : "string",
  "departmentIds" : "string",
  "memberIds" : "string"
}

2.22.4. 撤销某个资源的授权信息

DELETE /resource/{type}/{id}/authorization

参数

类型

名称

说明

架构

Path

type
必填

资源类型

Path

id
必填

资源ID

integer(int64)

Query

teamId
必填

团队ID

integer(int64)

Query

roleIds
可选

角色ID，用逗号连接

string

Query

departmentIds
可选

部门ID，用逗号连接

string

Query

memberIds
可选

成员ID，用逗号连接

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/resource/string/0/authorization

请求 query

{
  "teamId" : 0,
  "roleIds" : "string",
  "departmentIds" : "string",
  "memberIds" : "string"
}

2.22.5. 获取用户有权限访问的所有资源

GET /resources/{type}/byUser/{userId}

参数

类型

名称

说明

架构

Path

type
必填

资源类型

Query

teamId
必填

团队ID

integer(int64)

Path

userId
必填

用户ID

integer(int64)

响应

HTTP代码

说明

架构

200

ResourceResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/resources/string/byUser/0

请求 query

{
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "resources" : [ {
    "id" : 0,
    "type" : "string"
  } ]
}

2.23. 23 Cas Server Api

SSO服务端API

2.23.1. 创建一个CAS应用

POST /cas/app

说明

指定teamId的app，在serviceValidate阶段，会在attributes里面添加一个字段teamId：{teamId}标识这个团队ID
evaluationOrder:当系统创建了多个serviceId是正则表达式的时候，寻找到匹配的app的校验顺序。这个值约小，优先级越高。

参数

类型名称说明架构默认列

Query

serviceId
必填

服务ID，全局唯一

string

Query

name
必填

应用名称

string

Query

module
可选

应用所属模块

string

Query

serviceType
必填

服务ID类型，完全匹配或者正则匹配

enum (Identical, Regex)

"Identical"

Query

teamId
可选

指定所属团队

integer(int64)

Query

logoutType
必填

SLO单点登出方式，默认是back channel

enum (back, front)

"back"

Query

logoutUrl
可选

指定app全局的登录URL，如果未指定，将使用SSO过程中的service参数发起注销

string

Query

evaluationOrder
可选

匹配服务ID的顺序

integer(int32)

"0"

Query

forceLogout
可选

注销CasServer强制注销SSO会话

boolean

"true"

响应

HTTP代码

说明

架构

200

CasAppVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cas/app

请求 query

{
  "serviceId" : "string",
  "name" : "string",
  "module" : "string",
  "serviceType" : "string",
  "teamId" : 0,
  "logoutType" : "string",
  "logoutUrl" : "string",
  "evaluationOrder" : 0,
  "forceLogout" : true
}

HTTP响应示例

响应 200

{
  "createTime" : "string",
  "evaluationOrder" : 0,
  "forceLogout" : false,
  "id" : 0,
  "logoutType" : "string",
  "logoutUrl" : "string",
  "module" : "string",
  "name" : "string",
  "requestId" : "string",
  "serviceId" : "string",
  "serviceType" : "string",
  "teamId" : 0
}

2.23.2. 删除一个CAS应用

DELETE /cas/app

参数

类型

名称

说明

架构

Query

serviceId
必填

服务ID，全局唯一

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/cas/app

请求 query

{
  "serviceId" : "string"
}

2.24. 24 Order Api

订单API

2.24.1. 查询团队某个模块的所有订单

GET /order/byModule

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

Query

moduleCode
必填

模块Code

string

响应

HTTP代码

说明

架构

200

OrderListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/order/byModule

请求 query

{
  "teamId" : 0,
  "moduleCode" : "string"
}

HTTP响应示例

响应 200

{
  "orders" : [ {
    "cancelReason" : "string",
    "createTime" : "string",
    "details" : [ {
      "amount" : 0.0,
      "editionCode" : "string",
      "editionName" : "string",
      "expireTime" : "string",
      "moduleCode" : "string",
      "moduleName" : "string",
      "orderNumber" : "string",
      "productId" : "string",
      "productTerm" : 0,
      "quotas" : [ {
        "quota" : 0,
        "quotaCode" : "string",
        "quotaName" : "string",
        "unit" : "string"
      } ]
    } ],
    "orderNumber" : "string",
    "orderType" : "string",
    "payAccountId" : 0,
    "payMethod" : "string",
    "payStatus" : "string",
    "payTime" : "string",
    "payTransactionNo" : "string",
    "payablePay" : 0.0,
    "productInfo" : "string",
    "productTerm" : 0,
    "realPay" : 0.0,
    "scope" : "string",
    "serveType" : "string",
    "teamId" : 0,
    "teamName" : "string",
    "totalPrice" : 0.0,
    "userId" : 0,
    "workflowInstanceId" : 0
  } ],
  "requestId" : "string"
}

2.24.2. 根据订单号查询订单

GET /order/byNumber

参数

类型

名称

说明

架构

Query

orderNumber
必填

订单号

string

响应

HTTP代码

说明

架构

200

OrderVo

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/order/byNumber

请求 query

{
  "orderNumber" : "string"
}

HTTP响应示例

响应 200

{
  "cancelReason" : "string",
  "createTime" : "string",
  "details" : [ {
    "amount" : 0.0,
    "editionCode" : "string",
    "editionName" : "string",
    "expireTime" : "string",
    "moduleCode" : "string",
    "moduleName" : "string",
    "orderNumber" : "string",
    "productId" : "string",
    "productTerm" : 0,
    "quotas" : [ {
      "quota" : 0,
      "quotaCode" : "string",
      "quotaName" : "string",
      "unit" : "string"
    } ]
  } ],
  "orderNumber" : "string",
  "orderType" : "string",
  "payAccountId" : 0,
  "payMethod" : "string",
  "payStatus" : "string",
  "payTime" : "string",
  "payTransactionNo" : "string",
  "payablePay" : 0.0,
  "productInfo" : "string",
  "productTerm" : 0,
  "realPay" : 0.0,
  "scope" : "string",
  "serveType" : "string",
  "teamId" : 0,
  "teamName" : "string",
  "totalPrice" : 0.0,
  "userId" : 0,
  "workflowInstanceId" : 0
}

2.24.3. 分页获取团队订单

GET /order/byTeam

参数

类型名称说明架构默认列

Query

teamId
必填

团队ID

integer(int64)

Query

serveType
可选

服务类型

enum (NEW_PURCHASE, RENEW, CHANGE, CHANGE_RENEW, TRIAL, OFFICIAL)

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

条数

integer(int32)

"20"

响应

HTTP代码

说明

架构

200

PagedOrderListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/order/byTeam

请求 query

{
  "teamId" : 0,
  "serveType" : "string",
  "page" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "orders" : [ {
    "cancelReason" : "string",
    "createTime" : "string",
    "details" : [ {
      "amount" : 0.0,
      "editionCode" : "string",
      "editionName" : "string",
      "expireTime" : "string",
      "moduleCode" : "string",
      "moduleName" : "string",
      "orderNumber" : "string",
      "productId" : "string",
      "productTerm" : 0,
      "quotas" : [ {
        "quota" : 0,
        "quotaCode" : "string",
        "quotaName" : "string",
        "unit" : "string"
      } ]
    } ],
    "orderNumber" : "string",
    "orderType" : "string",
    "payAccountId" : 0,
    "payMethod" : "string",
    "payStatus" : "string",
    "payTime" : "string",
    "payTransactionNo" : "string",
    "payablePay" : 0.0,
    "productInfo" : "string",
    "productTerm" : 0,
    "realPay" : 0.0,
    "scope" : "string",
    "serveType" : "string",
    "teamId" : 0,
    "teamName" : "string",
    "totalPrice" : 0.0,
    "userId" : 0,
    "workflowInstanceId" : 0
  } ],
  "page" : 0,
  "requestId" : "string",
  "size" : 0,
  "total" : 0
}

2.24.4. 创建订单

POST /order/create

参数

类型名称说明架构默认列

Query

userId
必填

创建者ID

integer(int64)

Query

teamId
必填

团队ID

integer(int64)

Query

serveType
必填

服务类型

enum (NEW_PURCHASE, RENEW, CHANGE, CHANGE_RENEW, TRIAL, OFFICIAL)

Query

productTerm
必填

购买时长

integer(int32)

Query

price
必填

订单总价

number

Query

moduleCode
可选

模块Code

string

Query

moduleName
可选

模块名称

string

Query

editionCode
可选

套餐Code

string

Query

editionName
可选

套餐名称

string

Query

quotas
可选

配额，格式为[{"quotaCode":"max_user", "quotaName":"最大用户数", "unit":"个", "quota": 10}]

string

Query

serveExpireTime
可选

服务过期时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"

string

Query

productId
可选

产品ID，用于标识某个产品

string

Query

scope
可选

订单来源

enum (Console, Portal)

"Portal"

响应

HTTP代码

说明

架构

200

OrderVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/order/create

请求 query

{
  "userId" : 0,
  "teamId" : 0,
  "serveType" : "string",
  "productTerm" : 0,
  "price" : 0.0,
  "moduleCode" : "string",
  "moduleName" : "string",
  "editionCode" : "string",
  "editionName" : "string",
  "quotas" : "string",
  "serveExpireTime" : "string",
  "productId" : "string",
  "scope" : "string"
}

HTTP响应示例

响应 200

{
  "cancelReason" : "string",
  "createTime" : "string",
  "details" : [ {
    "amount" : 0.0,
    "editionCode" : "string",
    "editionName" : "string",
    "expireTime" : "string",
    "moduleCode" : "string",
    "moduleName" : "string",
    "orderNumber" : "string",
    "productId" : "string",
    "productTerm" : 0,
    "quotas" : [ {
      "quota" : 0,
      "quotaCode" : "string",
      "quotaName" : "string",
      "unit" : "string"
    } ]
  } ],
  "orderNumber" : "string",
  "orderType" : "string",
  "payAccountId" : 0,
  "payMethod" : "string",
  "payStatus" : "string",
  "payTime" : "string",
  "payTransactionNo" : "string",
  "payablePay" : 0.0,
  "productInfo" : "string",
  "productTerm" : 0,
  "realPay" : 0.0,
  "scope" : "string",
  "serveType" : "string",
  "teamId" : 0,
  "teamName" : "string",
  "totalPrice" : 0.0,
  "userId" : 0,
  "workflowInstanceId" : 0
}

2.24.5. 结束订单

POST /order/finish

参数

类型名称说明架构默认列

Query

orderNumber
必填

订单号

string

Query

cancel
必填

是否取消

boolean

"false"

Query

reason
可选

取消原因

string

响应

HTTP代码

说明

架构

200

OrderVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/order/finish

请求 query

{
  "orderNumber" : "string",
  "cancel" : true,
  "reason" : "string"
}

HTTP响应示例

响应 200

{
  "cancelReason" : "string",
  "createTime" : "string",
  "details" : [ {
    "amount" : 0.0,
    "editionCode" : "string",
    "editionName" : "string",
    "expireTime" : "string",
    "moduleCode" : "string",
    "moduleName" : "string",
    "orderNumber" : "string",
    "productId" : "string",
    "productTerm" : 0,
    "quotas" : [ {
      "quota" : 0,
      "quotaCode" : "string",
      "quotaName" : "string",
      "unit" : "string"
    } ]
  } ],
  "orderNumber" : "string",
  "orderType" : "string",
  "payAccountId" : 0,
  "payMethod" : "string",
  "payStatus" : "string",
  "payTime" : "string",
  "payTransactionNo" : "string",
  "payablePay" : 0.0,
  "productInfo" : "string",
  "productTerm" : 0,
  "realPay" : 0.0,
  "scope" : "string",
  "serveType" : "string",
  "teamId" : 0,
  "teamName" : "string",
  "totalPrice" : 0.0,
  "userId" : 0,
  "workflowInstanceId" : 0
}

2.24.6. 查询团队的试用订单

GET /order/trial

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

Query

moduleCode
必填

模块Code

string

响应

HTTP代码

说明

架构

200

OrderListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/order/trial

请求 query

{
  "teamId" : 0,
  "moduleCode" : "string"
}

HTTP响应示例

响应 200

{
  "orders" : [ {
    "cancelReason" : "string",
    "createTime" : "string",
    "details" : [ {
      "amount" : 0.0,
      "editionCode" : "string",
      "editionName" : "string",
      "expireTime" : "string",
      "moduleCode" : "string",
      "moduleName" : "string",
      "orderNumber" : "string",
      "productId" : "string",
      "productTerm" : 0,
      "quotas" : [ {
        "quota" : 0,
        "quotaCode" : "string",
        "quotaName" : "string",
        "unit" : "string"
      } ]
    } ],
    "orderNumber" : "string",
    "orderType" : "string",
    "payAccountId" : 0,
    "payMethod" : "string",
    "payStatus" : "string",
    "payTime" : "string",
    "payTransactionNo" : "string",
    "payablePay" : 0.0,
    "productInfo" : "string",
    "productTerm" : 0,
    "realPay" : 0.0,
    "scope" : "string",
    "serveType" : "string",
    "teamId" : 0,
    "teamName" : "string",
    "totalPrice" : 0.0,
    "userId" : 0,
    "workflowInstanceId" : 0
  } ],
  "requestId" : "string"
}

2.24.7. 分页获取团队的有效订单

GET /order/valid

参数

类型名称说明架构默认列

Query

teamId
必填

团队ID

integer(int64)

Query

moduleCode
可选

模块Code

string

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

条数

integer(int32)

"20"

响应

HTTP代码

说明

架构

200

PagedOrderListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/order/valid

请求 query

{
  "teamId" : 0,
  "moduleCode" : "string",
  "page" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "orders" : [ {
    "cancelReason" : "string",
    "createTime" : "string",
    "details" : [ {
      "amount" : 0.0,
      "editionCode" : "string",
      "editionName" : "string",
      "expireTime" : "string",
      "moduleCode" : "string",
      "moduleName" : "string",
      "orderNumber" : "string",
      "productId" : "string",
      "productTerm" : 0,
      "quotas" : [ {
        "quota" : 0,
        "quotaCode" : "string",
        "quotaName" : "string",
        "unit" : "string"
      } ]
    } ],
    "orderNumber" : "string",
    "orderType" : "string",
    "payAccountId" : 0,
    "payMethod" : "string",
    "payStatus" : "string",
    "payTime" : "string",
    "payTransactionNo" : "string",
    "payablePay" : 0.0,
    "productInfo" : "string",
    "productTerm" : 0,
    "realPay" : 0.0,
    "scope" : "string",
    "serveType" : "string",
    "teamId" : 0,
    "teamName" : "string",
    "totalPrice" : 0.0,
    "userId" : 0,
    "workflowInstanceId" : 0
  } ],
  "page" : 0,
  "requestId" : "string",
  "size" : 0,
  "total" : 0
}

2.25. 25 Message Api

发送消息API

2.25.1. 发送邮件消息

POST /message/mail

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

Query

template
必填

邮件模板

enum (CScanner_Insufficient_Quota, CScanner_Buy_Overlay_Package_For_Times, CScanner_Buy_Overlay_Package_For_Task, CScanner_Generate_Report, CScanner_Find_Attack, CScanner_Start_Scanning, CMonitor_Generate_Report, CMonitor_Site_Cannot_Access, CMonitor_Site_Cannot_Resolve, monitorSiteCannotResolve_dns, monitorSiteCannotResolve_authorityDns, CMonitor_Site_Recovered, EDR_Alert, DDoS_Standard_Bandwidth_Use_Up, DDoS_Elastic_Bandwidth_Use_Up, DDoS_Defense_Inflow_Reach_Threshold, DDoS_Attack_Flow_Reach_Threshold, DDoS_Source_Flow_Reach_Threshold)

Query

values
可选

邮件模板参数

string

Query

subject
可选

邮件主题

string

FormData

attachment
可选

邮件附件

file

响应

HTTP代码

说明

架构

200

无内容

消耗

multipart/form-data

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/message/mail

请求 query

{
  "teamId" : 0,
  "template" : "string",
  "values" : "string",
  "subject" : "string"
}

请求 formData

"file"

2.25.2. 发送短信消息

POST /message/sms

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

Query

template
必填

短信模板

Query

values
可选

短信模板参数

string

响应

HTTP代码

说明

架构

200

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/message/sms

请求 query

{
  "teamId" : 0,
  "template" : "string",
  "values" : "string"
}

2.26. 26 Network Api

网络API

2.26.1. 创建安全组

POST /network/createSecurityGroup

参数

类型

名称

说明

架构

Query

cloudId
必填

云账户ID

integer(int64)

Query

regionId
必填

区域ID

string

Query

vpcId
可选

VPC ID

string

Query

securityGroupName
必填

安全组名称

string

Query

description
可选

安全组描述

string

Query

securityGroupRules
可选

安全组规则

string

响应

HTTP代码

说明

架构

200

SecurityGroupVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/createSecurityGroup

请求 query

{
  "cloudId" : 0,
  "regionId" : "string",
  "vpcId" : "string",
  "securityGroupName" : "string",
  "description" : "string",
  "securityGroupRules" : "string"
}

HTTP响应示例

响应 200

{
  "description" : "string",
  "regionId" : "string",
  "securityGroupId" : "string",
  "securityGroupName" : "string",
  "securityGroupRules" : [ {
    "destCidrIp" : "string",
    "direction" : "string",
    "ipProtocol" : "string",
    "nicType" : "string",
    "policy" : "string",
    "portRange" : "string",
    "priority" : "string",
    "securityGroupId" : "string",
    "sourceCidrIp" : "string"
  } ],
  "vpcId" : "string"
}

2.26.2. 创建子网

POST /network/createSubnet

参数

类型

名称

说明

架构

Query

cloudId
必填

云账户ID

integer(int64)

Query

regionId
必填

区域ID

string

Query

zoneId
可选

可用区ID

string

Query

instanceType
可选

实例规格，如果zoneId参数为空，就找一个可以售卖该实例规格的可用区

string

Query

vpcId
必填

VPC ID

string

Query

cidrBlock
必填

CIDR

string

Query

subnetName
必填

子网名称

string

Query

description
可选

子网描述

string

响应

HTTP代码

说明

架构

200

SubnetVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/createSubnet

请求 query

{
  "cloudId" : 0,
  "regionId" : "string",
  "zoneId" : "string",
  "instanceType" : "string",
  "vpcId" : "string",
  "cidrBlock" : "string",
  "subnetName" : "string",
  "description" : "string"
}

HTTP响应示例

响应 200

{
  "availableIpAddressCount" : 0,
  "requestId" : "string",
  "subnetCidr" : "string",
  "subnetId" : "string",
  "subnetName" : "string",
  "vpcId" : "string",
  "zoneId" : "string",
  "zoneName" : "string"
}

2.26.3. 把主机加入到安全组中

POST /network/joinHostToSecurityGroup

参数

类型

名称

说明

架构

Query

cloudId
必填

云账户ID

integer(int64)

Query

hostId
必填

主机ID

integer(int64)

Query

securityGroupId
必填

安全组ID

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/joinHostToSecurityGroup

请求 query

{
  "cloudId" : 0,
  "hostId" : 0,
  "securityGroupId" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.26.4. 从安全组中移除主机

POST /network/removeHostFromSecurityGroup

参数

类型

名称

说明

架构

Query

cloudId
必填

云账户ID

integer(int64)

Query

hostId
必填

主机ID

integer(int64)

Query

securityGroupId
必填

安全组ID

string

响应

HTTP代码

说明

架构

200

ZStackVirtualNetworkCreateResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/removeHostFromSecurityGroup

请求 query

{
  "cloudId" : 0,
  "hostId" : 0,
  "securityGroupId" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.26.5. 列出安全组的所有规则

GET /network/securityGroupRules

参数

类型

名称

说明

架构

Query

cloudId
必填

云账户ID

integer(int64)

Query

regionId
必填

区域ID

string

Query

securityGroupId
必填

安全组ID

string

响应

HTTP代码

说明

架构

200

SecurityGroupRuleResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/securityGroupRules

请求 query

{
  "cloudId" : 0,
  "regionId" : "string",
  "securityGroupId" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "securityGroupRules" : [ {
    "destCidrIp" : "string",
    "direction" : "string",
    "ipProtocol" : "string",
    "nicType" : "string",
    "policy" : "string",
    "portRange" : "string",
    "priority" : "string",
    "securityGroupId" : "string",
    "sourceCidrIp" : "string"
  } ]
}

2.26.6. 列出云账户的某个VPC下的所有安全组

GET /network/securityGroups

参数

类型

名称

说明

架构

Query

cloudId
必填

云账户ID

integer(int64)

Query

regionId
必填

区域ID

string

Query

vpcId
可选

VPC ID，腾讯云没有该参数

string

响应

HTTP代码

说明

架构

200

SecurityGroupResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/securityGroups

请求 query

{
  "cloudId" : 0,
  "regionId" : "string",
  "vpcId" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "securityGroups" : [ {
    "description" : "string",
    "regionId" : "string",
    "securityGroupId" : "string",
    "securityGroupName" : "string",
    "securityGroupRules" : [ {
      "destCidrIp" : "string",
      "direction" : "string",
      "ipProtocol" : "string",
      "nicType" : "string",
      "policy" : "string",
      "portRange" : "string",
      "priority" : "string",
      "securityGroupId" : "string",
      "sourceCidrIp" : "string"
    } ],
    "vpcId" : "string"
  } ]
}

2.26.7. 获取云账户的所有VPC

GET /network/vpcs

参数

类型

名称

说明

架构

Query

cloudId
必填

云账户ID

integer(int64)

Query

regionId
必填

区域ID

string

Query

zoneId
可选

可用区ID

string

Query

projectId
可选

项目ID

string

响应

HTTP代码

说明

架构

200

ListVpcsResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/vpcs

请求 query

{
  "cloudId" : 0,
  "regionId" : "string",
  "zoneId" : "string",
  "projectId" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "vpcs" : [ {
    "regionId" : "string",
    "requestId" : "string",
    "subnets" : [ {
      "availableIpAddressCount" : 0,
      "requestId" : "string",
      "subnetCidr" : "string",
      "subnetId" : "string",
      "subnetName" : "string",
      "vpcId" : "string",
      "zoneId" : "string",
      "zoneName" : "string"
    } ],
    "vpcCidr" : "string",
    "vpcId" : "string",
    "vpcName" : "string"
  } ]
}

2.26.8. 创建zstack虚拟网络

POST /network/zstack/virtualNetwork

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

l2NetworkName
必填

二层网络名称

string

Query

name
必填

三层网络名称

string

Query

physicalInterface
必填

物理网卡(eth1, eno1)

string

Query

startIp
必填

起始ip

string

Query

endIp
必填

结束ip

string

Query

gateway
必填

网关地址

string

Query

vLanId
可选

VLanId

integer(int32)

Query

netmask
可选

子网掩码

string

"255.255.255.0"

Query

prefixLen
可选

前缀长度

integer(int32)

Query

l3NetworkType
可选

三层网络类型

enum (L3BasicNetwork, L3VpcNetwork)

Query

l3NetworkCategoryType
可选

三层网络种类(Private,System,Public)

enum (Public, Private, System)

Query

ipVersion
可选

IPV4/IPV6

enum (IPv4, IPv6)

Query

dhcpIp
可选

DHCP服务IP

string

Query

dnsDomain
可选

DNS域名

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstack/virtualNetwork

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "l2NetworkName" : "string",
  "name" : "string",
  "physicalInterface" : "string",
  "startIp" : "string",
  "endIp" : "string",
  "gateway" : "string",
  "vLanId" : 0,
  "netmask" : "string",
  "prefixLen" : 0,
  "l3NetworkType" : "string",
  "l3NetworkCategoryType" : "string",
  "ipVersion" : "string",
  "dhcpIp" : "string",
  "dnsDomain" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "virtualNetworkId" : "string"
}

2.26.9. 删除zstack虚拟网络

DELETE /network/zstack/virtualNetwork/{l3NetworkId}

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Path

l3NetworkId
必填

L3网络Id

string

Query

safeDeleteL2Network
可选

是否同时删除二层网络

boolean

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstack/virtualNetwork/string

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "safeDeleteL2Network" : true
}

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.26.10. 向ZStack三层网络通过cidr方式添加IP地址范围

POST /network/zstackAddIpRangeByCidrToL3Network/{l3networkId}

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Path

l3networkId
必填

三层网络Id

string

Query

name
必填

ip地址范围名称

string

Query

cidr
必填

网络CIDR

string

Query

dhcpIp
必填

DHCP服务IP

string

Query

description
可选

描述

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackAddIpRangeByCidrToL3Network/string

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "name" : "string",
  "cidr" : "string",
  "dhcpIp" : "string",
  "description" : "string"
}

HTTP响应示例

响应 200

{
  "addressMode" : "string",
  "createDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "description" : "string",
  "endIp" : "string",
  "gateway" : "string",
  "ipVersion" : 0,
  "l3NetworkUuid" : "string",
  "lastOpDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "name" : "string",
  "netmask" : "string",
  "networkCidr" : "string",
  "prefixLen" : 0,
  "startIp" : "string",
  "uuid" : "string"
}

2.26.11. 向ZStack三层网络添加IP地址范围

POST /network/zstackAddIpRangeToL3Network/{l3networkId}

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Path

l3networkId
必填

三层网络Id

string

Query

name
必填

ip地址范围名称

string

Query

startIp
必填

起始Ip地址

string

Query

endIp
必填

结束Ip地址

string

Query

netmask
必填

子网掩码

string

Query

gateway
必填

网关地址

string

Query

dhcpIp
必填

DHCP服务IP

string

Query

description
可选

描述

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackAddIpRangeToL3Network/string

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "name" : "string",
  "startIp" : "string",
  "endIp" : "string",
  "netmask" : "string",
  "gateway" : "string",
  "dhcpIp" : "string",
  "description" : "string"
}

HTTP响应示例

响应 200

{
  "addressMode" : "string",
  "createDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "description" : "string",
  "endIp" : "string",
  "gateway" : "string",
  "ipVersion" : 0,
  "l3NetworkUuid" : "string",
  "lastOpDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "name" : "string",
  "netmask" : "string",
  "networkCidr" : "string",
  "prefixLen" : 0,
  "startIp" : "string",
  "uuid" : "string"
}

2.26.12. 向ZStack三层网络通过cidr方式添加IPv6地址范围

POST /network/zstackAddIpv6RangeByCidrToL3Network/{l3networkId}

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Path

l3networkId
必填

三层网络Id

string

Query

name
必填

ip地址范围名称

string

Query

cidr
必填

网络CIDR

string

Query

ipv6AddressMode
必填

IPv6地址分配模式

enum (StatefulDHCP, StatelessDHCP, SLAAC)

Query

dhcpIp
必填

DHCP服务IP

string

Query

description
可选

描述

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackAddIpv6RangeByCidrToL3Network/string

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "name" : "string",
  "cidr" : "string",
  "ipv6AddressMode" : "string",
  "dhcpIp" : "string",
  "description" : "string"
}

HTTP响应示例

响应 200

{
  "addressMode" : "string",
  "createDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "description" : "string",
  "endIp" : "string",
  "gateway" : "string",
  "ipVersion" : 0,
  "l3NetworkUuid" : "string",
  "lastOpDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "name" : "string",
  "netmask" : "string",
  "networkCidr" : "string",
  "prefixLen" : 0,
  "startIp" : "string",
  "uuid" : "string"
}

2.26.13. 向ZStack三层网络添加IPv6地址范围

POST /network/zstackAddIpv6RangeToL3Network/{l3networkId}

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Path

l3networkId
必填

三层网络Id

string

Query

name
必填

ip地址范围名称

string

Query

startIp
必填

起始Ip地址

string

Query

endIp
必填

结束Ip地址

string

Query

gateway
必填

网关地址

string

Query

prefixLen
必填

前缀长度

integer(int32)

Query

dhcpIp
必填

DHCP服务IP

string

Query

description
可选

描述

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackAddIpv6RangeToL3Network/string

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "name" : "string",
  "startIp" : "string",
  "endIp" : "string",
  "gateway" : "string",
  "prefixLen" : 0,
  "dhcpIp" : "string",
  "description" : "string"
}

HTTP响应示例

响应 200

{
  "addressMode" : "string",
  "createDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "description" : "string",
  "endIp" : "string",
  "gateway" : "string",
  "ipVersion" : 0,
  "l3NetworkUuid" : "string",
  "lastOpDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "name" : "string",
  "netmask" : "string",
  "networkCidr" : "string",
  "prefixLen" : 0,
  "startIp" : "string",
  "uuid" : "string"
}

2.26.14. ZStack三层网络添加DNS

POST /network/zstackDns/{dns}/AddToL3Network/{l3networkId}

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Path

dns
必填

dns地址

string

Path

l3networkId
必填

三层网络Id

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackDns/string/AddToL3Network/string

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string"
}

HTTP响应示例

响应 200

{
  "category" : "string",
  "createDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "description" : "string",
  "dns" : [ "object" ],
  "dnsDomain" : "string",
  "hostRoute" : [ "object" ],
  "ipRanges" : [ "object" ],
  "ipVersion" : 0,
  "l2NetworkUuid" : "string",
  "lastOpDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "name" : "string",
  "networkServices" : [ "object" ],
  "state" : "string",
  "system" : true,
  "type" : "string",
  "uuid" : "string",
  "zoneUuid" : "string"
}

2.26.15. ZStack三层网络移除DNS

POST /network/zstackDns/{dns}/RemoveFromL3Network/{l3networkId}

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Path

dns
必填

dns地址

string

Path

l3networkId
必填

三层网络Id

string

响应

HTTP代码

说明

架构

200

GetIpAddressCapacityResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackDns/string/RemoveFromL3Network/string

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string"
}

HTTP响应示例

响应 200

{
  "category" : "string",
  "createDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "description" : "string",
  "dns" : [ "object" ],
  "dnsDomain" : "string",
  "hostRoute" : [ "object" ],
  "ipRanges" : [ "object" ],
  "ipVersion" : 0,
  "l2NetworkUuid" : "string",
  "lastOpDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "name" : "string",
  "networkServices" : [ "object" ],
  "state" : "string",
  "system" : true,
  "type" : "string",
  "uuid" : "string",
  "zoneUuid" : "string"
}

2.26.16. 列出zstackIP网络地址容量

GET /network/zstackIpAddressCapacity

参数

类型名称说明架构默认列

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

l3networkIds
可选

所属三层网络Id

< string > array(multi)

Query

ipRangeIds
可选

ip范围Id列表

< string > array(multi)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackIpAddressCapacity

请求 query

{
  "cloudId" : 0,
  "scope" : "string",
  "l3networkIds" : "string",
  "ipRangeIds" : "string"
}

HTTP响应示例

响应 200

{
  "availableCapacity" : 0,
  "totalCapacity" : 0,
  "usedIpAddressNumber" : 0
}

2.26.17. 删除ZStackIP地址范围

DELETE /network/zstackIpRange/{ipRangeId}

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Path

ipRangeId
必填

ip范围Id

string

Query

deleteMode
可选

删除方式

enum (Permissive, Enforcing)

响应

HTTP代码

说明

架构

200

ListZStackL3NetworkIpStatisticResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackIpRange/string

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "deleteMode" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.26.18. 列出zstackIP地址范围

GET /network/zstackIpRanges

参数

类型名称说明架构默认列

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

ipRangeIds
可选

ip范围Id列表

< string > array(multi)

Query

l2networkId
可选

所属二层网络Id

string

Query

l3networkId
可选

所属三层网络Id

string

响应

HTTP代码

说明

架构

200

ListZStackIpRangesResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackIpRanges

请求 query

{
  "cloudId" : 0,
  "scope" : "string",
  "ipRangeIds" : "string",
  "l2networkId" : "string",
  "l3networkId" : "string"
}

HTTP响应示例

响应 200

{
  "ipRanges" : [ {
    "addressMode" : "string",
    "createDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "description" : "string",
    "endIp" : "string",
    "gateway" : "string",
    "ipVersion" : 0,
    "l3NetworkUuid" : "string",
    "lastOpDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "name" : "string",
    "netmask" : "string",
    "networkCidr" : "string",
    "prefixLen" : 0,
    "startIp" : "string",
    "uuid" : "string"
  } ],
  "requestId" : "string"
}

2.26.19. 查询zstack三层网络Ip统计信息

GET /network/zstackIpStatistic/{l3NetworkId}

参数

类型名称说明架构默认列

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Console"

Path

l3NetworkId
必填

三层网络Id

string

Query

ipResourceType
可选

ip资源类型

enum (Vip, VM)

Query

ipAddress
可选

ip地址

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackIpStatistic/string

请求 query

{
  "cloudId" : 0,
  "scope" : "string",
  "ipResourceType" : "string",
  "ipAddress" : "string"
}

HTTP响应示例

响应 200

{
  "l3NetworkIpStatistics" : [ {
    "createDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "ip" : "string",
    "ownerName" : "string",
    "resourceTypes" : [ "object" ],
    "state" : "string",
    "useFor" : "string",
    "vip" : {
      "createDate" : {
        "date" : 0,
        "day" : 0,
        "hours" : 0,
        "minutes" : 0,
        "month" : 0,
        "nanos" : 0,
        "seconds" : 0,
        "time" : 0,
        "timezoneOffset" : 0,
        "year" : 0
      },
      "description" : "string",
      "gateway" : "string",
      "ip" : "string",
      "l3NetworkUuid" : "string",
      "lastOpDate" : {
        "date" : 0,
        "day" : 0,
        "hours" : 0,
        "minutes" : 0,
        "month" : 0,
        "nanos" : 0,
        "seconds" : 0,
        "time" : 0,
        "timezoneOffset" : 0,
        "year" : 0
      },
      "name" : "string",
      "netmask" : "string",
      "peerL3NetworkUuids" : [ "object" ],
      "prefixLen" : 0,
      "serviceProvider" : "string",
      "servicesRefs" : [ "object" ],
      "state" : "string",
      "system" : true,
      "useFor" : "string",
      "uuid" : "string"
    },
    "vipName" : "string",
    "vipUuid" : "string",
    "vm" : {
      "allVolumes" : [ "object" ],
      "allocatorStrategy" : "string",
      "clusterUuid" : "string",
      "cpuNum" : 0,
      "cpuSpeed" : 0,
      "createDate" : {
        "date" : 0,
        "day" : 0,
        "hours" : 0,
        "minutes" : 0,
        "month" : 0,
        "nanos" : 0,
        "seconds" : 0,
        "time" : 0,
        "timezoneOffset" : 0,
        "year" : 0
      },
      "defaultL3NetworkUuid" : "string",
      "description" : "string",
      "hostUuid" : "string",
      "hypervisorType" : "string",
      "imageUuid" : "string",
      "instanceOfferingUuid" : "string",
      "lastHostUuid" : "string",
      "lastOpDate" : {
        "date" : 0,
        "day" : 0,
        "hours" : 0,
        "minutes" : 0,
        "month" : 0,
        "nanos" : 0,
        "seconds" : 0,
        "time" : 0,
        "timezoneOffset" : 0,
        "year" : 0
      },
      "memorySize" : 0,
      "name" : "string",
      "platform" : "string",
      "rootVolumeUuid" : "string",
      "state" : "string",
      "type" : "string",
      "uuid" : "string",
      "vmCdRoms" : [ "object" ],
      "vmNics" : [ "object" ],
      "zoneUuid" : "string"
    },
    "vmDefaultIp" : "string",
    "vmInstanceName" : "string",
    "vmInstanceType" : "string",
    "vmInstanceUuid" : "string",
    "vpc" : {
      "agentPort" : 0,
      "allVolumes" : [ "object" ],
      "allocatorStrategy" : "string",
      "applianceVmType" : "string",
      "clusterUuid" : "string",
      "cpuNum" : 0,
      "cpuSpeed" : 0,
      "createDate" : {
        "date" : 0,
        "day" : 0,
        "hours" : 0,
        "minutes" : 0,
        "month" : 0,
        "nanos" : 0,
        "seconds" : 0,
        "time" : 0,
        "timezoneOffset" : 0,
        "year" : 0
      },
      "defaultL3NetworkUuid" : "string",
      "defaultRouteL3NetworkUuid" : "string",
      "description" : "string",
      "dns" : [ "object" ],
      "haRef" : [ "object" ],
      "haStatus" : "string",
      "hostUuid" : "string",
      "hypervisorType" : "string",
      "imageUuid" : "string",
      "instanceOfferingUuid" : "string",
      "lastHostUuid" : "string",
      "lastOpDate" : {
        "date" : 0,
        "day" : 0,
        "hours" : 0,
        "minutes" : 0,
        "month" : 0,
        "nanos" : 0,
        "seconds" : 0,
        "time" : 0,
        "timezoneOffset" : 0,
        "year" : 0
      },
      "managementNetworkUuid" : "string",
      "memorySize" : 0,
      "name" : "string",
      "platform" : "string",
      "publicNetworkUuid" : "string",
      "rootVolumeUuid" : "string",
      "state" : "string",
      "status" : "string",
      "type" : "string",
      "uuid" : "string",
      "virtualRouterVips" : [ "object" ],
      "vmCdRoms" : [ "object" ],
      "vmNics" : [ "object" ],
      "zoneUuid" : "string"
    }
  } ],
  "requestId" : "string"
}

2.26.20. 查询已用zstackVlanId列表

GET /network/zstackL2/existsVLanIds

参数

类型名称说明架构默认列

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

响应

HTTP代码

说明

架构

200

SetZStackL2VLanIdsResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackL2/existsVLanIds

请求 query

{
  "cloudId" : 0,
  "scope" : "string"
}

HTTP响应示例

响应 200

{
  "l2VLanIds" : [ 0 ],
  "requestId" : "string"
}

2.26.21. 查询所有zstackL2网络

GET /network/zstackL2/networks

参数

类型名称说明架构默认列

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

networkIds
可选

二层网络Id列表

< string > array(multi)

Query

physicalInterface
可选

物理网卡

string

Query

startIp
可选

起始ip

string

响应

HTTP代码

说明

架构

200

ListZStackL2NetworksResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackL2/networks

请求 query

{
  "cloudId" : 0,
  "scope" : "string",
  "networkIds" : "string",
  "physicalInterface" : "string",
  "startIp" : "string"
}

HTTP响应示例

响应 200

{
  "l2Networks" : [ {
    "attachedClusterUuids" : [ "object" ],
    "createDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "description" : "string",
    "lastOpDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "name" : "string",
    "physicalInterface" : "string",
    "type" : "string",
    "uuid" : "string",
    "zoneUuid" : "string"
  } ],
  "requestId" : "string"
}

2.26.22. 创建zstack普通二层网络,并加入集群

POST /network/zstackL2/noVLan

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

name
必填

二层网络名称

string

Query

physicalInterface
必填

物理网卡(eth1, eno1)

string

Query

description
可选

二层网络的详细描述

string

Query

clusterId
可选

加入到的集群Id

string

响应

HTTP代码

说明

架构

200

CreateZStackL2NoVLanNetworkResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackL2/noVLan

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "name" : "string",
  "physicalInterface" : "string",
  "description" : "string",
  "clusterId" : "string"
}

HTTP响应示例

响应 200

{
  "l2NoVLanNetwork" : {
    "attachedClusterUuids" : [ "object" ],
    "createDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "description" : "string",
    "lastOpDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "name" : "string",
    "physicalInterface" : "string",
    "type" : "string",
    "uuid" : "string",
    "zoneUuid" : "string"
  },
  "requestId" : "string"
}

2.26.23. 创建zstackVLan二层网络,并加入集群

POST /network/zstackL2/vLan

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

name
必填

二层网络名称

string

Query

vLanId
必填

VLanId

integer(int32)

Query

physicalInterface
必填

物理网卡(eth1, eno1)

string

Query

description
可选

二层网络的详细描述

string

Query

clusterId
可选

加入到的集群Id

string

响应

HTTP代码

说明

架构

200

CreateZStackL2VLanNetworkResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackL2/vLan

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "name" : "string",
  "vLanId" : 0,
  "physicalInterface" : "string",
  "description" : "string",
  "clusterId" : "string"
}

HTTP响应示例

响应 200

{
  "l2VLanNetworkInventory" : {
    "attachedClusterUuids" : [ "object" ],
    "createDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "description" : "string",
    "lastOpDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "name" : "string",
    "physicalInterface" : "string",
    "type" : "string",
    "uuid" : "string",
    "zoneUuid" : "string"
  },
  "requestId" : "string"
}

2.26.24. 查询zstackVlan

GET /network/zstackL2/vLans

参数

类型名称说明架构默认列

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

networkIds
可选

二层网络Id列表

< string > array(multi)

Query

physicalInterface
可选

物理网卡

string

响应

HTTP代码

说明

架构

200

ListZStackL2VLanNetworksResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackL2/vLans

请求 query

{
  "cloudId" : 0,
  "scope" : "string",
  "networkIds" : "string",
  "physicalInterface" : "string"
}

HTTP响应示例

响应 200

{
  "l2VLanNetworks" : [ {
    "attachedClusterUuids" : [ "object" ],
    "createDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "description" : "string",
    "lastOpDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "name" : "string",
    "physicalInterface" : "string",
    "type" : "string",
    "uuid" : "string",
    "vlan" : 0,
    "zoneUuid" : "string"
  } ],
  "requestId" : "string"
}

2.26.25. 创建zstackVxLan二层网络

POST /network/zstackL2/vxLan

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

name
必填

二层网络名称

string

Query

vxLanPoolId
必填

VxLan池Id

string

Query

description
可选

二层网络的详细描述

string

Query

vni
可选

vni

integer(int32)

响应

HTTP代码

说明

架构

200

CreateZStackL2VxLanNetworkResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackL2/vxLan

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "name" : "string",
  "vxLanPoolId" : "string",
  "description" : "string",
  "vni" : 0
}

HTTP响应示例

响应 200

{
  "l2VxLanNetwork" : {
    "attachedClusterUuids" : [ "object" ],
    "createDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "description" : "string",
    "lastOpDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "name" : "string",
    "physicalInterface" : "string",
    "type" : "string",
    "uuid" : "string",
    "zoneUuid" : "string"
  },
  "requestId" : "string"
}

2.26.26. 创建zstackVxlan池,并加入集群

POST /network/zstackL2/vxLanPool

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

name
必填

二层网络名称

string

Query

description
可选

二层网络的详细描述

string

Query

startVni
可选

起始Vni

integer(int32)

Query

endVni
可选

结束Vni

integer(int32)

Query

clusterId
可选

加入到的集群Id

string

Query

cidr
可选

VTEP CIDR

string

响应

HTTP代码

说明

架构

200

CreateZStackL2VxLanPoolResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackL2/vxLanPool

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "name" : "string",
  "description" : "string",
  "startVni" : 0,
  "endVni" : 0,
  "clusterId" : "string",
  "cidr" : "string"
}

HTTP响应示例

响应 200

{
  "l2VxlanPool" : {
    "attachedCidrs" : "object",
    "attachedClusterUuids" : [ "object" ],
    "attachedVniRanges" : [ "object" ],
    "attachedVtepRefs" : [ "object" ],
    "attachedVxlanNetworkRefs" : [ "object" ],
    "createDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "description" : "string",
    "lastOpDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "name" : "string",
    "physicalInterface" : "string",
    "type" : "string",
    "uuid" : "string",
    "zoneUuid" : "string"
  },
  "requestId" : "string"
}

2.26.27. 查询zstackVxlan池

GET /network/zstackL2/vxLanPools

参数

类型名称说明架构默认列

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

networkIds
可选

二层网络Id列表

< string > array(multi)

响应

HTTP代码

说明

架构

200

ListZStackL2VxLanPoolsResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackL2/vxLanPools

请求 query

{
  "cloudId" : 0,
  "scope" : "string",
  "networkIds" : "string"
}

HTTP响应示例

响应 200

{
  "l2VxLanPools" : [ {
    "attachedCidrs" : "object",
    "attachedClusterUuids" : [ "object" ],
    "attachedVniRanges" : [ "object" ],
    "attachedVtepRefs" : [ "object" ],
    "attachedVxlanNetworkRefs" : [ "object" ],
    "createDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "description" : "string",
    "lastOpDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "name" : "string",
    "physicalInterface" : "string",
    "type" : "string",
    "uuid" : "string",
    "zoneUuid" : "string"
  } ],
  "requestId" : "string"
}

2.26.28. 查询zstackVxlan

GET /network/zstackL2/vxLans

参数

类型名称说明架构默认列

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

networkIds
可选

二层网络Id列表

< string > array(multi)

响应

HTTP代码

说明

架构

200

ListZStackL2VxLanNetworksResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackL2/vxLans

请求 query

{
  "cloudId" : 0,
  "scope" : "string",
  "networkIds" : "string"
}

HTTP响应示例

响应 200

{
  "l2VxLanNetworks" : [ {
    "attachedClusterUuids" : [ "object" ],
    "createDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "description" : "string",
    "lastOpDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "name" : "string",
    "physicalInterface" : "string",
    "poolUuid" : "string",
    "type" : "string",
    "uuid" : "string",
    "vni" : 0,
    "zoneUuid" : "string"
  } ],
  "requestId" : "string"
}

2.26.29. 删除zstack二层网络

DELETE /network/zstackL2/{networkId}

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Path

networkId
必填

L2网络Id

string

Query

deleteMode
可选

删除方式

enum (Permissive, Enforcing)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackL2/string

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "deleteMode" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.26.30. 将zstack二层网络加入集群

POST /network/zstackL2/{networkId}/attachTo/{clusterId}

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Path

networkId
必填

二层网络Id

string

Path

clusterId
必填

加入到的集群Id

string

Query

cidr
可选

VTEP CIDR

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackL2/string/attachTo/string

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "cidr" : "string"
}

HTTP响应示例

响应 200

{
  "attachedClusterUuids" : [ "object" ],
  "createDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "description" : "string",
  "lastOpDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "name" : "string",
  "physicalInterface" : "string",
  "type" : "string",
  "uuid" : "string",
  "zoneUuid" : "string"
}

2.26.31. 删除多个zstack三层网络

DELETE /network/zstackL3

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

networkIds
必填

L3网络Id

< string > array(multi)

Query

deleteMode
可选

删除方式

enum (Permissive, Enforcing)

响应

HTTP代码

说明

架构

200

ListZStackL3NetworksResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackL3

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "networkIds" : "string",
  "deleteMode" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.26.32. 查询所有zstackL3网络

GET /network/zstackL3/networks

参数

类型名称说明架构默认列

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

l3NetworkIds
可选

三层网络Id列表

< string > array(multi)

Query

l3NetworkName
可选

三层网络名称

string

Query

l2NetworkId
可选

二层网络Id

string

Query

usingState
可选

使用状态

enum (Enabled, Disabled, Maintenance)

Query

networkType
可选

网络类型

enum (L3BasicNetwork, L3VpcNetwork)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackL3/networks

请求 query

{
  "cloudId" : 0,
  "scope" : "string",
  "l3NetworkIds" : "string",
  "l3NetworkName" : "string",
  "l2NetworkId" : "string",
  "usingState" : "string",
  "networkType" : "string"
}

HTTP响应示例

响应 200

{
  "l3Networks" : [ {
    "category" : "string",
    "createDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "description" : "string",
    "dns" : [ "object" ],
    "dnsDomain" : "string",
    "hostRoute" : [ "object" ],
    "ipRanges" : [ "object" ],
    "ipVersion" : 0,
    "l2NetworkUuid" : "string",
    "lastOpDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "name" : "string",
    "networkServices" : [ "object" ],
    "state" : "string",
    "system" : true,
    "type" : "string",
    "uuid" : "string",
    "zoneUuid" : "string"
  } ],
  "requestId" : "string"
}

2.26.33. 创建zstack私有网络

POST /network/zstackL3/privateNetwork

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

l2NetworkId
必填

二层网络Id

string

Query

name
必填

三层网络名称

string

Query

description
可选

三层网络描述

string

Query

dnsDomain
可选

DNS域

string

Query

mirrorNetworkId
可选

镜像网络Id

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackL3/privateNetwork

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "l2NetworkId" : "string",
  "name" : "string",
  "description" : "string",
  "dnsDomain" : "string",
  "mirrorNetworkId" : "string"
}

HTTP响应示例

响应 200

{
  "category" : "string",
  "createDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "description" : "string",
  "dns" : [ "object" ],
  "dnsDomain" : "string",
  "hostRoute" : [ "object" ],
  "ipRanges" : [ "object" ],
  "ipVersion" : 0,
  "l2NetworkUuid" : "string",
  "lastOpDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "name" : "string",
  "networkServices" : [ "object" ],
  "state" : "string",
  "system" : true,
  "type" : "string",
  "uuid" : "string",
  "zoneUuid" : "string"
}

2.26.34. 创建zstack公有网络

POST /network/zstackL3/publicNetwork

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

l2NetworkId
必填

二层网络Id

string

Query

ipVersion
必填

ip协议号[4,6]

enum (IPv4, IPv6)

Query

name
必填

三层网络名称

string

Query

description
可选

三层网络描述

string

Query

dnsDomain
可选

DNS域

string

Query

mirrorNetworkId
可选

镜像网络Id

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackL3/publicNetwork

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "l2NetworkId" : "string",
  "ipVersion" : "string",
  "name" : "string",
  "description" : "string",
  "dnsDomain" : "string",
  "mirrorNetworkId" : "string"
}

HTTP响应示例

响应 200

{
  "category" : "string",
  "createDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "description" : "string",
  "dns" : [ "object" ],
  "dnsDomain" : "string",
  "hostRoute" : [ "object" ],
  "ipRanges" : [ "object" ],
  "ipVersion" : 0,
  "l2NetworkUuid" : "string",
  "lastOpDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "name" : "string",
  "networkServices" : [ "object" ],
  "state" : "string",
  "system" : true,
  "type" : "string",
  "uuid" : "string",
  "zoneUuid" : "string"
}

2.26.35. 创建zstack系统网络

POST /network/zstackL3/systemNetwork

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

l2NetworkId
必填

二层网络Id

string

Query

name
必填

三层网络名称

string

Query

description
可选

三层网络描述

string

Query

dnsDomain
可选

DNS域

string

响应

HTTP代码

说明

架构

200

ListZStackNetworkServiceProvidersResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackL3/systemNetwork

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "l2NetworkId" : "string",
  "name" : "string",
  "description" : "string",
  "dnsDomain" : "string"
}

HTTP响应示例

响应 200

{
  "category" : "string",
  "createDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "description" : "string",
  "dns" : [ "object" ],
  "dnsDomain" : "string",
  "hostRoute" : [ "object" ],
  "ipRanges" : [ "object" ],
  "ipVersion" : 0,
  "l2NetworkUuid" : "string",
  "lastOpDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "name" : "string",
  "networkServices" : [ "object" ],
  "state" : "string",
  "system" : true,
  "type" : "string",
  "uuid" : "string",
  "zoneUuid" : "string"
}

2.26.36. 列出zstack网络服务模块

GET /network/zstackServiceProviders

参数

类型名称说明架构默认列

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackServiceProviders

请求 query

{
  "cloudId" : 0,
  "scope" : "string"
}

HTTP响应示例

响应 200

{
  "networkServiceProviders" : [ {
    "attachedL2NetworkUuids" : [ "object" ],
    "createDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "description" : "string",
    "lastOpDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "name" : "string",
    "networkServiceTypes" : [ "object" ],
    "type" : "string",
    "uuid" : "string"
  } ],
  "requestId" : "string"
}

2.26.37. 创建zstack云路由规格

POST /network/zstackVirtualRouterOffering

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

managementL3NetworkId
必填

管理L3网络Id

string

Query

publicL3NetworkId
必填

公有L3网络Id

string

Query

imageId
必填

镜像Id

string

Query

name
必填

名称

string

Query

cpuNum
必填

CPU数量

integer(int32)

Query

memorySizeInMb
必填

内存大小(Mb)

integer(int64)

Query

description
可选

描述

string

Query

isDefault
可选

是否默认

boolean

响应

HTTP代码

说明

架构

200

VirtualRouterOfferingInventory

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackVirtualRouterOffering

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "managementL3NetworkId" : "string",
  "publicL3NetworkId" : "string",
  "imageId" : "string",
  "name" : "string",
  "cpuNum" : 0,
  "memorySizeInMb" : 0,
  "description" : "string",
  "isDefault" : true
}

HTTP响应示例

响应 200

{
  "allocatorStrategy" : "string",
  "cpuNum" : 0,
  "cpuSpeed" : 0,
  "createDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "description" : "string",
  "imageUuid" : "string",
  "isDefault" : true,
  "lastOpDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "managementNetworkUuid" : "string",
  "memorySize" : 0,
  "name" : "string",
  "publicNetworkUuid" : "string",
  "sortKey" : 0,
  "state" : "string",
  "type" : "string",
  "uuid" : "string",
  "zoneUuid" : "string"
}

2.26.38. 查询zstack云路由规格列表

GET /network/zstackVirtualRouterOfferings

参数

类型名称说明架构默认列

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

virtualRouterTypeIds
可选

云规格路由id列表

< string > array(multi)

Query

imageId
可选

镜像Id

string

Query

managementL3NetworkId
可选

管理L3网络Id

string

Query

usingState
可选

状态[启用/停用]

enum (Enabled, Disabled, Maintenance)

Query

cpuNum
可选

cpu数量(大于等于)

integer(int32)

Query

memorySizeInMb
可选

内存大小Mb(大于等于)

integer(int64)

响应

HTTP代码

说明

架构

200

ListZStackVirtualRouterOfferingsResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackVirtualRouterOfferings

请求 query

{
  "cloudId" : 0,
  "scope" : "string",
  "virtualRouterTypeIds" : "string",
  "imageId" : "string",
  "managementL3NetworkId" : "string",
  "usingState" : "string",
  "cpuNum" : 0,
  "memorySizeInMb" : 0
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "virtualRouterOfferings" : [ {
    "allocatorStrategy" : "string",
    "cpuNum" : 0,
    "cpuSpeed" : 0,
    "createDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "description" : "string",
    "imageUuid" : "string",
    "isDefault" : true,
    "lastOpDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "managementNetworkUuid" : "string",
    "memorySize" : 0,
    "name" : "string",
    "publicNetworkUuid" : "string",
    "sortKey" : 0,
    "state" : "string",
    "type" : "string",
    "uuid" : "string",
    "zoneUuid" : "string"
  } ]
}

2.26.39. 删除zstackVpc路由器

DELETE /network/zstackVpcRouter/{vpcRouterId}

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

vpcRouterId
必填

vpc路由Id

string

响应

HTTP代码

说明

架构

200

VirtualRouterVmInventory

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackVpcRouter/{vpcRouterId}

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "vpcRouterId" : "string"
}

HTTP响应示例

响应 200

{
  "agentPort" : 0,
  "allVolumes" : [ "object" ],
  "allocatorStrategy" : "string",
  "applianceVmType" : "string",
  "clusterUuid" : "string",
  "cpuNum" : 0,
  "cpuSpeed" : 0,
  "createDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "defaultL3NetworkUuid" : "string",
  "defaultRouteL3NetworkUuid" : "string",
  "description" : "string",
  "haStatus" : "string",
  "hostUuid" : "string",
  "hypervisorType" : "string",
  "imageUuid" : "string",
  "instanceOfferingUuid" : "string",
  "lastHostUuid" : "string",
  "lastOpDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "managementNetworkUuid" : "string",
  "memorySize" : 0,
  "name" : "string",
  "platform" : "string",
  "publicNetworkUuid" : "string",
  "rootVolumeUuid" : "string",
  "state" : "string",
  "status" : "string",
  "type" : "string",
  "uuid" : "string",
  "virtualRouterVips" : [ "object" ],
  "vmCdRoms" : [ "object" ],
  "vmNics" : [ "object" ],
  "zoneUuid" : "string"
}

2.26.40. 向zstackVpc路由器添加/删除dns

POST /network/zstackVpcRouter/{vpcRouterId}/Dns/{dns}

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Path

vpcRouterId
必填

vpc路由Id

string

Path

dns
必填

DNS

string

Query

action
必填

操作(添加/删除)

enum (add, remove)

响应

HTTP代码

说明

架构

200

VpcRouterVmInventory

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackVpcRouter/string/Dns/string

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "action" : "string"
}

HTTP响应示例

响应 200

{
  "agentPort" : 0,
  "allVolumes" : [ "object" ],
  "allocatorStrategy" : "string",
  "applianceVmType" : "string",
  "clusterUuid" : "string",
  "cpuNum" : 0,
  "cpuSpeed" : 0,
  "createDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "defaultL3NetworkUuid" : "string",
  "defaultRouteL3NetworkUuid" : "string",
  "description" : "string",
  "dns" : [ "object" ],
  "haRef" : [ "object" ],
  "haStatus" : "string",
  "hostUuid" : "string",
  "hypervisorType" : "string",
  "imageUuid" : "string",
  "instanceOfferingUuid" : "string",
  "lastHostUuid" : "string",
  "lastOpDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "managementNetworkUuid" : "string",
  "memorySize" : 0,
  "name" : "string",
  "platform" : "string",
  "publicNetworkUuid" : "string",
  "rootVolumeUuid" : "string",
  "state" : "string",
  "status" : "string",
  "type" : "string",
  "uuid" : "string",
  "virtualRouterVips" : [ "object" ],
  "vmCdRoms" : [ "object" ],
  "vmNics" : [ "object" ],
  "zoneUuid" : "string"
}

2.26.41. 创建zstackVpc路由器,并添加dns

POST /network/zstackVpcRouterWithDns

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

virtualRouterOfferingId
必填

云路由规格Id

string

Query

name
必填

名称

string

Query

description
可选

描述

string

Query

dns
可选

DNS

string

Query

staticVip
可选

默认静态ip

string

Query

haGroupId
可选

高可用组id

string

Query

clusterId
可选

集群id

string

响应

HTTP代码

说明

架构

200

VirtualRouterVmInventory

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackVpcRouterWithDns

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "virtualRouterOfferingId" : "string",
  "name" : "string",
  "description" : "string",
  "dns" : "string",
  "staticVip" : "string",
  "haGroupId" : "string",
  "clusterId" : "string"
}

HTTP响应示例

响应 200

{
  "agentPort" : 0,
  "allVolumes" : [ "object" ],
  "allocatorStrategy" : "string",
  "applianceVmType" : "string",
  "clusterUuid" : "string",
  "cpuNum" : 0,
  "cpuSpeed" : 0,
  "createDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "defaultL3NetworkUuid" : "string",
  "defaultRouteL3NetworkUuid" : "string",
  "description" : "string",
  "haStatus" : "string",
  "hostUuid" : "string",
  "hypervisorType" : "string",
  "imageUuid" : "string",
  "instanceOfferingUuid" : "string",
  "lastHostUuid" : "string",
  "lastOpDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "managementNetworkUuid" : "string",
  "memorySize" : 0,
  "name" : "string",
  "platform" : "string",
  "publicNetworkUuid" : "string",
  "rootVolumeUuid" : "string",
  "state" : "string",
  "status" : "string",
  "type" : "string",
  "uuid" : "string",
  "virtualRouterVips" : [ "object" ],
  "vmCdRoms" : [ "object" ],
  "vmNics" : [ "object" ],
  "zoneUuid" : "string"
}

2.26.42. 查询zstackVpc路由器列表

GET /network/zstackVpcRouters

参数

类型名称说明架构默认列

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

vpcRouterIds
可选

vpc路由器id列表

< string > array(multi)

Query

name
可选

名称

string

Query

clusterId
可选

集群Id

string

Query

defaultL3NetworkId
可选

默认三层网络Id

string

Query

defaultRouteL3NetworkId
可选

默认路由（default routing）的三层网络Id

string

Query

hostId
可选

物理主机Id

string

Query

imageId
可选

镜像Id

string

Query

managementNetworkId
可选

管理网络Id

string

Query

publicNetworkId
可选

公有网络Id

string

Query

instanceOfferingId
可选

云路由规格Id

string

Query

state
可选

状态(常用[Stopped/Running])

enum (Created, Starting, Running, Stopping, Stopped, Rebooting, Destroying, Destroyed, Migrating, Expunging, Pausing, Paused, Resuming, VolumeMigrating, Unknown)

响应

HTTP代码

说明

架构

200

ListZStackVpcRoutersResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/network/zstackVpcRouters

请求 query

{
  "cloudId" : 0,
  "scope" : "string",
  "vpcRouterIds" : "string",
  "name" : "string",
  "clusterId" : "string",
  "defaultL3NetworkId" : "string",
  "defaultRouteL3NetworkId" : "string",
  "hostId" : "string",
  "imageId" : "string",
  "managementNetworkId" : "string",
  "publicNetworkId" : "string",
  "instanceOfferingId" : "string",
  "state" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "vpcRouters" : [ {
    "agentPort" : 0,
    "allVolumes" : [ "object" ],
    "allocatorStrategy" : "string",
    "applianceVmType" : "string",
    "clusterUuid" : "string",
    "cpuNum" : 0,
    "cpuSpeed" : 0,
    "createDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "defaultL3NetworkUuid" : "string",
    "defaultRouteL3NetworkUuid" : "string",
    "description" : "string",
    "dns" : [ "object" ],
    "haRef" : [ "object" ],
    "haStatus" : "string",
    "hostUuid" : "string",
    "hypervisorType" : "string",
    "imageUuid" : "string",
    "instanceOfferingUuid" : "string",
    "lastHostUuid" : "string",
    "lastOpDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "managementNetworkUuid" : "string",
    "memorySize" : 0,
    "name" : "string",
    "platform" : "string",
    "publicNetworkUuid" : "string",
    "rootVolumeUuid" : "string",
    "state" : "string",
    "status" : "string",
    "type" : "string",
    "uuid" : "string",
    "virtualRouterVips" : [ "object" ],
    "vmCdRoms" : [ "object" ],
    "vmNics" : [ "object" ],
    "zoneUuid" : "string"
  } ]
}

2.27. 27 Image Api

镜像操作API

2.27.1. 取消共享镜像

POST /image/cancelShare

参数

类型

名称

说明

架构

Query

vendor
必填

供应商

string

Query

regionId
必填

共享者的镜像所在区域ID

string

Query

imageId
必填

共享者的镜像ID

string

Query

cloudId
必填

被共享者的云环境ID

integer(int64)

Query

accountId
可选

被共享者的账号ID

string

Query

projectId
可选

被共享者的项目ID，华为云需要指定项目

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/image/cancelShare

请求 query

{
  "vendor" : "string",
  "regionId" : "string",
  "imageId" : "string",
  "cloudId" : 0,
  "accountId" : "string",
  "projectId" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.27.2. 查询zstack镜像列表

GET /image/cloud/{cloudId}/zstackList

参数

类型名称说明架构默认列

Path

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

imageId
可选

镜像Id

string

Query

status
可选

镜像状态

enum (Ready, Creating, Downloading)

响应

HTTP代码

说明

架构

200

CloudImageListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/image/cloud/0/zstackList

请求 query

{
  "scope" : "string",
  "imageId" : "string",
  "status" : "string"
}

HTTP响应示例

响应 200

{
  "images" : [ {
    "creationTime" : "string",
    "description" : "string",
    "imageId" : "string",
    "imageName" : "string",
    "imageType" : "string",
    "osName" : "string",
    "platform" : "string",
    "regionId" : "string",
    "share" : true,
    "status" : "string"
  } ],
  "requestId" : "string"
}

2.27.3. 修改镜像权限

POST /image/modifyImageSharePermission

参数

类型名称说明架构默认列

Query

vendor
必填

供应商

string

Query

provider
必填

云厂商

string

Query

regionId
必填

共享者的镜像所在区域ID

string

Query

imageId
必填

共享者的镜像ID

string

Query

accountId
可选

被共享者的账号ID

string

Query

projectId
可选

被共享者的项目ID，华为云需要指定项目

string

Query

type
必填

类型,SHARE|CANCEL

enum (SHARE, CANCEL)

"SHARE"

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/image/modifyImageSharePermission

请求 query

{
  "vendor" : "string",
  "provider" : "string",
  "regionId" : "string",
  "imageId" : "string",
  "accountId" : "string",
  "projectId" : "string",
  "type" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.27.4. 共享镜像

POST /image/share

参数

类型

名称

说明

架构

Query

vendor
必填

供应商

string

Query

regionId
必填

共享者的镜像所在区域ID

string

Query

imageId
必填

共享者的镜像ID

string

Query

cloudId
必填

被共享者的云环境ID

integer(int64)

Query

accountId
可选

被共享者的账号ID

string

Query

projectId
可选

被共享者的项目ID，华为云需要指定项目

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/image/share

请求 query

{
  "vendor" : "string",
  "regionId" : "string",
  "imageId" : "string",
  "cloudId" : 0,
  "accountId" : "string",
  "projectId" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.28. 29 Image Host Api

镜像类主机操作API

2.28.1. 创建ZStack虚拟机

POST /imageHost/cloud/{cloudId}/zstackCreate

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

teamId
必填

团队ID

integer(int64)

Path

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Console"

Query

zoneId
可选

可用区ID

string

Query

clusterId
可选

集群ID

string

Query

hostId
可选

物理主机ID

string

Query

imageId
必填

镜像ID

string

Query

instanceOfferingId
必填

实例规格ID

string

Query

networkIds
必填

L3网络ID有序列表

< string > array(multi)

Query

defaultNetworkId
可选

默认的L3网络

string

Query

instanceName
必填

实例名称

string

Query

description
可选

实例描述

string

Query

hostName
可选

主机名

string

Query

rootDiskOfferingId
可选

根云盘(系统盘)规格Id

string

Query

rootDiskSize
可选

根云盘大小Gb

integer(int64)

Query

primaryStorageIdForRootVolume
可选

主存储UUID

string

Query

rootVolumeProvisioningStrategy
可选

根磁盘置备方式

enum (ThinProvisioning, ThickProvisioning)

Query

dataDiskOfferingIds
可选

云盘规格uuid列表

< string > array(multi)

Query

dataVolumeProvisioningStrategy
可选

数据盘置备方式

enum (ThinProvisioning, ThickProvisioning)

Query

systemTags
可选

系统设置,VMCreateSystemTags参数对象(json)

string

Query

createStrategy
可选

云主机创建策略

enum (InstantStart, JustCreate, CreateStopped)

Query

instanceCount
可选

购买数量

integer(int32)

"1"

响应

HTTP代码

说明

架构

200

ZStackPhysicalHostListResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/cloud/0/zstackCreate

请求 query

{
  "clientToken" : "string",
  "teamId" : 0,
  "scope" : "string",
  "zoneId" : "string",
  "clusterId" : "string",
  "hostId" : "string",
  "imageId" : "string",
  "instanceOfferingId" : "string",
  "networkIds" : "string",
  "defaultNetworkId" : "string",
  "instanceName" : "string",
  "description" : "string",
  "hostName" : "string",
  "rootDiskOfferingId" : "string",
  "rootDiskSize" : 0,
  "primaryStorageIdForRootVolume" : "string",
  "rootVolumeProvisioningStrategy" : "string",
  "dataDiskOfferingIds" : "string",
  "dataVolumeProvisioningStrategy" : "string",
  "systemTags" : "string",
  "createStrategy" : "string",
  "instanceCount" : 0
}

HTTP响应示例

响应 200

{
  "hosts" : [ {
    "agentStatus" : "string",
    "cloudId" : 0,
    "cloudName" : "string",
    "dataDisks" : [ {
      "category" : "string",
      "deleteWithInstance" : false,
      "diskId" : "string",
      "diskName" : "string",
      "jobId" : 0,
      "size" : 0
    } ],
    "description" : "string",
    "groupId" : 0,
    "hostId" : 0,
    "hostName" : "string",
    "importTime" : "string",
    "innerIp" : "string",
    "installedAgent" : false,
    "instanceId" : "string",
    "instanceName" : "string",
    "jobId" : 0,
    "macAddr" : "string",
    "memory" : 0,
    "operatingSystem" : "string",
    "platform" : "string",
    "processorCores" : 0,
    "provider" : "string",
    "proxyHostId" : 0,
    "proxyInnerIp" : "string",
    "proxyInstalledAgent" : false,
    "proxyInstanceName" : "string",
    "proxyPublicIp" : "string",
    "publicIp" : "string",
    "regionId" : "string",
    "scope" : "string",
    "status" : "string",
    "systemDisk" : {
      "category" : "string",
      "diskId" : "string",
      "size" : 0
    },
    "teamId" : 0,
    "zoneId" : "string"
  } ],
  "jobId" : 0
}

2.28.2. 查询ZStack物理机

GET /imageHost/cloud/{cloudId}/zstackPhysicalHosts

参数

类型名称说明架构默认列

Path

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Console"

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/cloud/0/zstackPhysicalHosts

请求 query

{
  "scope" : "string"
}

HTTP响应示例

响应 200

{
  "physicalHosts" : [ {
    "availableCpuCapacity" : 0,
    "availableMemoryCapacity" : 0,
    "clusterId" : "string",
    "cpuNum" : 0,
    "cpuSockets" : 0,
    "createDate" : "string",
    "description" : "string",
    "hypervisorType" : "string",
    "id" : "string",
    "lastOpDate" : "string",
    "managementIp" : "string",
    "name" : "string",
    "state" : "string",
    "status" : "string",
    "totalCpuCapacity" : 0,
    "totalMemoryCapacity" : 0,
    "zoneId" : "string"
  } ],
  "requestId" : "string"
}

2.28.3. 查询ZStack服务资源信息

GET /imageHost/cloud/{cloudId}/zstackPhysicalResourceSummary

参数

类型名称说明架构默认列

Path

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Console"

响应

HTTP代码

说明

架构

200

ZStackPhysicalResourceSummary

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/cloud/0/zstackPhysicalResourceSummary

请求 query

{
  "scope" : "string"
}

HTTP响应示例

响应 200

{
  "availableCpu" : 0,
  "availableMemoryInGB" : 0.0,
  "availableStorageInGB" : 0.0,
  "requestId" : "string"
}

2.28.4. 创建ZStack计算规格

POST /imageHost/cloud/{cloudId}/zstackSpec

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Path

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Console"

Query

name
必填

计算规格名

string

Query

cpuNum
必填

cpu核数

integer(int32)

Query

memorySizeInMb
必填

内存大小(Mb)

integer(int64)

Query

allocatorStrategy
必填

物理机分配策略

enum (DefaultHostAllocatorStrategy, LeastVmPreferredHostAllocatorStrategy, MinimumCPUUsageHostAllocatorStrategy, MinimumMemoryUsageHostAllocatorStrategy, MaxInstancePerHostHostAllocatorStrategy, LastHostPreferredAllocatorStrategy)

Query

description
可选

描述

string

Query

maxInstancePerHost
可选

运行云主机最大数量

integer(int32)

Query

volumeTotalBandwidthInMb
可选

磁盘总速率(Mb/s)

integer(int64)

Query

volumeReadBandwidthInMb
可选

磁盘读速率(Mb/s)

integer(int64)

Query

volumeWriteBandwidthInMb
可选

磁盘写速率(Mb/s)

integer(int64)

Query

networkInboundBandwidthInKb
可选

网络带宽上行速率(Kb/s)

integer(int64)

Query

networkOutboundBandwidthInKb
可选

网络带宽下行速率(Kb/s)

integer(int64)

Query

minimumCPUUsageHostAllocatorStrategy
可选

cpu最低策略模式

enum (hard, soft)

Query

minimumMemoryUsageHostAllocatorStrategy
可选

内存最低策略模式

enum (hard, soft)

响应

HTTP代码

说明

架构

200

ZStackHostSpecVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/cloud/0/zstackSpec

请求 query

{
  "clientToken" : "string",
  "scope" : "string",
  "name" : "string",
  "cpuNum" : 0,
  "memorySizeInMb" : 0,
  "allocatorStrategy" : "string",
  "description" : "string",
  "maxInstancePerHost" : 0,
  "volumeTotalBandwidthInMb" : 0,
  "volumeReadBandwidthInMb" : 0,
  "volumeWriteBandwidthInMb" : 0,
  "networkInboundBandwidthInKb" : 0,
  "networkOutboundBandwidthInKb" : 0,
  "minimumCPUUsageHostAllocatorStrategy" : "string",
  "minimumMemoryUsageHostAllocatorStrategy" : "string"
}

HTTP响应示例

响应 200

{
  "allocatorStrategy" : "string",
  "cpuNum" : 0,
  "createDate" : "string",
  "description" : "string",
  "id" : "string",
  "memorySizeInMb" : 0,
  "name" : "string",
  "state" : "string"
}

2.28.5. 查询ZStack计算规格

GET /imageHost/cloud/{cloudId}/zstackSpecs

参数

类型名称说明架构默认列

Path

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Console"

Query

instanceOfferingIds
可选

计算规格Id列表

< string > array(multi)

Query

name
可选

计算规格名

string

Query

cpuNum
可选

cpu核数(大于等于)

integer(int32)

Query

memorySizeInMb
可选

内存大小(Mb)(大于等于)

integer(int64)

Query

allocatorStrategy
可选

物理机分配策略

Query

usingState
可选

使用状态

enum (Enabled, Disabled, Maintenance)

响应

HTTP代码

说明

架构

200

ZStackHostSpecListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/cloud/0/zstackSpecs

请求 query

{
  "scope" : "string",
  "instanceOfferingIds" : "string",
  "name" : "string",
  "cpuNum" : 0,
  "memorySizeInMb" : 0,
  "allocatorStrategy" : "string",
  "usingState" : "string"
}

HTTP响应示例

响应 200

{
  "hostSpecs" : [ {
    "allocatorStrategy" : "string",
    "cpuNum" : 0,
    "createDate" : "string",
    "description" : "string",
    "id" : "string",
    "memorySizeInMb" : 0,
    "name" : "string",
    "state" : "string"
  } ],
  "requestId" : "string"
}

2.28.6. 创建虚拟机

POST /imageHost/create

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性，最大值不超过64个ASCII字符

string

Query

teamId
可选

团队ID

integer(int64)

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

projectId
可选

项目ID

string

Query

regionId
必填

区域ID

string

Query

zoneId
可选

可用区ID

string

Query

imageId
必填

镜像ID

string

Query

securityGroupId
可选

安全组ID

string

Query

instanceType
必填

实例规格

string

Query

vpcId
必填

VPC ID

string

Query

subnetId
可选

子网ID

string

Query

instanceName
可选

实例名称

string

Query

description
可选

实例描述

string

Query

password
可选

实例密码

string

Query

instanceCount
可选

购买数量

integer(int32)

"1"

Query

instanceChargeType
可选

实例收费类型

enum (PrePaid, PostPaid)

"PostPaid"

Query

internetChargeType
可选

网络类型

enum (PayByBandwidth, PayByTraffic)

"PayByBandwidth"

Query

internetMaxBandwidthOut
可选

最大公网出口带宽

integer(int32)

"0"

Query

period
可选

购买时长

integer(int32)

"1"

Query

periodUnit
可选

时长单位

enum (Hour, Week, Month, Year)

"Month"

Query

systemDisk
可选

系统盘，格式如{"category" : "SSD", "size" : 10}

string

Query

dataDisks
可选

数据盘，格式如[{"category" : "SSD", "size" : 10, "deleteWithInstance" : true}]

string

响应

HTTP代码

说明

架构

200

InstanceOfferingInventory

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/create

请求 query

{
  "clientToken" : "string",
  "teamId" : 0,
  "cloudId" : 0,
  "scope" : "string",
  "projectId" : "string",
  "regionId" : "string",
  "zoneId" : "string",
  "imageId" : "string",
  "securityGroupId" : "string",
  "instanceType" : "string",
  "vpcId" : "string",
  "subnetId" : "string",
  "instanceName" : "string",
  "description" : "string",
  "password" : "string",
  "instanceCount" : 0,
  "instanceChargeType" : "string",
  "internetChargeType" : "string",
  "internetMaxBandwidthOut" : 0,
  "period" : 0,
  "periodUnit" : "string",
  "systemDisk" : "string",
  "dataDisks" : "string"
}

HTTP响应示例

响应 200

{
  "hosts" : [ {
    "agentStatus" : "string",
    "cloudId" : 0,
    "cloudName" : "string",
    "dataDisks" : [ {
      "category" : "string",
      "deleteWithInstance" : false,
      "diskId" : "string",
      "diskName" : "string",
      "jobId" : 0,
      "size" : 0
    } ],
    "description" : "string",
    "groupId" : 0,
    "hostId" : 0,
    "hostName" : "string",
    "importTime" : "string",
    "innerIp" : "string",
    "installedAgent" : false,
    "instanceId" : "string",
    "instanceName" : "string",
    "jobId" : 0,
    "macAddr" : "string",
    "memory" : 0,
    "operatingSystem" : "string",
    "platform" : "string",
    "processorCores" : 0,
    "provider" : "string",
    "proxyHostId" : 0,
    "proxyInnerIp" : "string",
    "proxyInstalledAgent" : false,
    "proxyInstanceName" : "string",
    "proxyPublicIp" : "string",
    "publicIp" : "string",
    "regionId" : "string",
    "scope" : "string",
    "status" : "string",
    "systemDisk" : {
      "category" : "string",
      "diskId" : "string",
      "size" : 0
    },
    "teamId" : 0,
    "zoneId" : "string"
  } ],
  "jobId" : 0
}

2.28.7. 获取主机状态

GET /imageHost/findStatus

说明

包括API导入和行云管家页面导入的主机ID

参数

类型

名称

说明

架构

Query

teamId
必填

团队ID

integer(int64)

Query

hostIds
可选

主机ID列表

string

响应

HTTP代码

说明

架构

200

GetHostsStatusResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/findStatus

请求 query

{
  "teamId" : 0,
  "hostIds" : "string"
}

HTTP响应示例

响应 200

{
  "statusMap" : {
    "string" : "string"
  }
}

2.28.8. 查询购买虚拟机每个月的预估费用

POST /imageHost/inquiryPriceMonthly

参数

类型名称说明架构默认列

Query

vendor
可选

供应商

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Portal"

Query

projectId
可选

项目ID

string

Query

regionId
必填

区域ID

string

Query

zoneId
可选

可用区ID

string

Query

imageId
可选

镜像ID

string

Query

securityGroupId
可选

安全组ID

string

Query

instanceType
必填

实例规格

string

Query

vpcId
可选

VPC ID

string

Query

subnetId
可选

子网ID

string

Query

instanceName
可选

实例名称

string

Query

description
可选

实例描述

string

Query

password
可选

实例密码

string

Query

instanceCount
可选

购买数量

integer(int32)

"1"

Query

instanceChargeType
可选

实例收费类型

enum (PrePaid, PostPaid)

"PostPaid"

Query

internetChargeType
可选

网络类型

enum (PayByBandwidth, PayByTraffic)

"PayByBandwidth"

Query

internetMaxBandwidthOut
可选

最大公网出口带宽

integer(int32)

"0"

Query

period
可选

购买时长

integer(int32)

"1"

Query

periodUnit
可选

时长单位

enum (Hour, Week, Month, Year)

"Month"

Query

systemDisk
可选

系统盘，格式如{"category" : "SSD", "size" : 10}

string

Query

dataDisks
可选

数据盘，格式如[{"category" : "SSD", "size" : 10, "deleteWithInstance" : true}]

string

响应

HTTP代码

说明

架构

200

DoubleResponse

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/inquiryPriceMonthly

请求 query

{
  "vendor" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "projectId" : "string",
  "regionId" : "string",
  "zoneId" : "string",
  "imageId" : "string",
  "securityGroupId" : "string",
  "instanceType" : "string",
  "vpcId" : "string",
  "subnetId" : "string",
  "instanceName" : "string",
  "description" : "string",
  "password" : "string",
  "instanceCount" : 0,
  "instanceChargeType" : "string",
  "internetChargeType" : "string",
  "internetMaxBandwidthOut" : 0,
  "period" : 0,
  "periodUnit" : "string",
  "systemDisk" : "string",
  "dataDisks" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "value" : 0.0
}

2.28.9. 更改zstack实例规格状态

PUT /imageHost/zstackInstanceOffering/{instanceOfferingId}

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Console"

Path

instanceOfferingId
必填

实例规格Id

string

Query

stateEvent
必填

状态(启用/停用)

enum (enable, disable)

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/zstackInstanceOffering/string

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "stateEvent" : "string"
}

HTTP响应示例

响应 200

{
  "allocatorStrategy" : "string",
  "cpuNum" : 0,
  "cpuSpeed" : 0,
  "createDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "description" : "string",
  "lastOpDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "memorySize" : 0,
  "name" : "string",
  "sortKey" : 0,
  "state" : "string",
  "type" : "string",
  "uuid" : "string"
}

2.28.10. 删除zstack实例规格

DELETE /imageHost/zstackInstanceOffering/{instanceOfferingId}

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性

string

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Console"

Path

instanceOfferingId
必填

实例规格Id

string

Query

deleteMode
可选

删除方式

enum (Permissive, Enforcing)

响应

HTTP代码

说明

架构

200

InstanceOfferingInventory

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/zstackInstanceOffering/string

请求 query

{
  "clientToken" : "string",
  "cloudId" : 0,
  "scope" : "string",
  "deleteMode" : "string"
}

HTTP响应示例

响应 200

{
  "allocatorStrategy" : "string",
  "cpuNum" : 0,
  "cpuSpeed" : 0,
  "createDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "description" : "string",
  "lastOpDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "memorySize" : 0,
  "name" : "string",
  "sortKey" : 0,
  "state" : "string",
  "type" : "string",
  "uuid" : "string"
}

2.28.11. 获取zstack实例网络信息

GET /imageHost/zstackVmNic/{instanceId}

参数

类型名称说明架构默认列

Query

cloudId
必填

云账户ID

integer(int64)

Query

scope
必填

云账户来源

enum (Console, Portal)

"Console"

Path

instanceId
必填

实例Id

string

响应

HTTP代码

说明

架构

200

ZStackVmNicInfoResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/zstackVmNic/string

请求 query

{
  "cloudId" : 0,
  "scope" : "string"
}

HTTP响应示例

响应 200

{
  "defaultL3NetworkId" : "string",
  "defaultL3NetworkName" : "string",
  "instanceId" : "string",
  "l3Networks" : {
    "string" : "string"
  },
  "requestId" : "string",
  "vmNics" : [ {
    "createDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "deviceId" : 0,
    "gateway" : "string",
    "hypervisorType" : "string",
    "ip" : "string",
    "ipVersion" : 0,
    "l3NetworkUuid" : "string",
    "lastOpDate" : {
      "date" : 0,
      "day" : 0,
      "hours" : 0,
      "minutes" : 0,
      "month" : 0,
      "nanos" : 0,
      "seconds" : 0,
      "time" : 0,
      "timezoneOffset" : 0,
      "year" : 0
    },
    "mac" : "string",
    "metaData" : "string",
    "netmask" : "string",
    "usedIps" : [ "object" ],
    "uuid" : "string",
    "vmInstanceUuid" : "string"
  } ]
}

2.28.12. 销毁虚拟机

DELETE /imageHost/{hostId}/destroy

参数

类型

名称

说明

架构

Path

hostId
必填

主机ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/0/destroy

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.28.13. 升级虚拟机的规格以及磁盘大小

POST /imageHost/{hostId}/expandHostAndDisk

参数

类型

名称

说明

架构

Query

clientToken
可选

保证请求幂等性，最大值不超过64个ASCII字符

string

Path

hostId
必填

主机ID

integer(int64)

Query

instanceType
可选

实例规格，如ecs.g6.large

string

Query

diskId
可选

磁盘ID，如d-bp67acfmxazb4p

string

Query

newSize
可选

磁盘大小(GB)

integer(int32)

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/0/expandHostAndDisk

请求 query

{
  "clientToken" : "string",
  "instanceType" : "string",
  "diskId" : "string",
  "newSize" : 0
}

HTTP响应示例

响应 200

{
  "agentStatus" : "string",
  "cloudId" : 0,
  "cloudName" : "string",
  "dataDisks" : [ {
    "category" : "string",
    "deleteWithInstance" : false,
    "diskId" : "string",
    "diskName" : "string",
    "jobId" : 0,
    "size" : 0
  } ],
  "description" : "string",
  "groupId" : 0,
  "hostId" : 0,
  "hostName" : "string",
  "importTime" : "string",
  "innerIp" : "string",
  "installedAgent" : false,
  "instanceId" : "string",
  "instanceName" : "string",
  "jobId" : 0,
  "macAddr" : "string",
  "memory" : 0,
  "operatingSystem" : "string",
  "platform" : "string",
  "processorCores" : 0,
  "provider" : "string",
  "proxyHostId" : 0,
  "proxyInnerIp" : "string",
  "proxyInstalledAgent" : false,
  "proxyInstanceName" : "string",
  "proxyPublicIp" : "string",
  "publicIp" : "string",
  "regionId" : "string",
  "scope" : "string",
  "status" : "string",
  "systemDisk" : {
    "category" : "string",
    "diskId" : "string",
    "size" : 0
  },
  "teamId" : 0,
  "zoneId" : "string"
}

2.28.14. 升级虚拟机配置

POST /imageHost/{hostId}/modifySpec

参数

类型

名称

说明

架构

Query

clientToken
可选

保证请求幂等性，最大值不超过64个ASCII字符

string

Path

hostId
必填

主机ID

integer(int64)

Query

instanceType
必填

实例规格，如ecs.g6.large

string

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/0/modifySpec

请求 query

{
  "clientToken" : "string",
  "instanceType" : "string"
}

HTTP响应示例

响应 200

{
  "agentStatus" : "string",
  "cloudId" : 0,
  "cloudName" : "string",
  "dataDisks" : [ {
    "category" : "string",
    "deleteWithInstance" : false,
    "diskId" : "string",
    "diskName" : "string",
    "jobId" : 0,
    "size" : 0
  } ],
  "description" : "string",
  "groupId" : 0,
  "hostId" : 0,
  "hostName" : "string",
  "importTime" : "string",
  "innerIp" : "string",
  "installedAgent" : false,
  "instanceId" : "string",
  "instanceName" : "string",
  "jobId" : 0,
  "macAddr" : "string",
  "memory" : 0,
  "operatingSystem" : "string",
  "platform" : "string",
  "processorCores" : 0,
  "provider" : "string",
  "proxyHostId" : 0,
  "proxyInnerIp" : "string",
  "proxyInstalledAgent" : false,
  "proxyInstanceName" : "string",
  "proxyPublicIp" : "string",
  "publicIp" : "string",
  "regionId" : "string",
  "scope" : "string",
  "status" : "string",
  "systemDisk" : {
    "category" : "string",
    "diskId" : "string",
    "size" : 0
  },
  "teamId" : 0,
  "zoneId" : "string"
}

2.28.15. 获取主机特定监控项的最后一个数据点

GET /imageHost/{hostId}/monitor

说明

如果监控项包括不同的dimension，返回的数据会包含所有dimension

参数

类型

名称

说明

架构

Path

hostId
必填

主机ID

integer(int64)

Query

metrics
必填

主机监控项(MonitorMetric)，用逗号连接

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/0/monitor

请求 query

{
  "metrics" : "string"
}

HTTP响应示例

响应 200

{
  "dataPoints" : {
    "string" : 0.0
  }
}

2.28.16. 续费虚拟机

POST /imageHost/{hostId}/renew

参数

类型名称说明架构默认列

Query

clientToken
可选

保证请求幂等性，最大值不超过64个ASCII字符

string

Path

hostId
必填

主机ID

integer(int64)

Query

period
必填

包年包月续费时长

integer(int32)

"1"

Query

periodUnit
必填

续费时长的时间单位

enum (Week, Month, Year)

"Month"

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/0/renew

请求 query

{
  "clientToken" : "string",
  "period" : 0,
  "periodUnit" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.28.17. 扩展数据盘大小

POST /imageHost/{hostId}/resizeDisk

参数

类型

名称

说明

架构

Query

clientToken
可选

保证请求幂等性，最大值不超过64个ASCII字符

string

Path

hostId
必填

主机ID

integer(int64)

Query

diskId
必填

磁盘ID，如d-bp67acfmxazb4p

string

Query

newSize
必填

磁盘大小(GB)

integer(int32)

响应

HTTP代码

说明

架构

200

DataDiskVo

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/0/resizeDisk

请求 query

{
  "clientToken" : "string",
  "diskId" : "string",
  "newSize" : 0
}

HTTP响应示例

响应 200

{
  "category" : "string",
  "deleteWithInstance" : false,
  "diskId" : "string",
  "diskName" : "string",
  "jobId" : 0,
  "size" : 0
}

2.28.18. 重启虚拟机

POST /imageHost/{hostId}/restart

参数

类型名称说明架构默认列

Path

hostId
必填

主机ID

integer(int64)

Query

force
可选

是否强制重启

boolean

"false"

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/0/restart

请求 query

{
  "force" : true
}

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.28.19. 启动虚拟机

POST /imageHost/{hostId}/start

参数

类型

名称

说明

架构

Path

hostId
必填

主机ID

integer(int64)

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/0/start

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.28.20. 关闭虚拟机

POST /imageHost/{hostId}/stop

参数

类型

名称

说明

架构

Path

hostId
必填

主机ID

integer(int64)

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/0/stop

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.28.21. 加载ZStackL3网络到云主机

PUT /imageHost/{hostId}/zstackAttachL3Network/{l3NetworkId}

参数

类型

名称

说明

架构

Query

clientToken
可选

保证请求幂等性

string

Path

hostId
必填

主机ID

integer(int64)

Query

l3NetworkId
必填

L3网络Id

string

Query

staticIp
可选

静态ip地址

string

响应

HTTP代码

说明

架构

200

VmInstanceInventory

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/0/zstackAttachL3Network/{l3NetworkId}

请求 query

{
  "clientToken" : "string",
  "l3NetworkId" : "string",
  "staticIp" : "string"
}

HTTP响应示例

响应 200

{
  "allVolumes" : [ "object" ],
  "allocatorStrategy" : "string",
  "clusterUuid" : "string",
  "cpuNum" : 0,
  "cpuSpeed" : 0,
  "createDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "defaultL3NetworkUuid" : "string",
  "description" : "string",
  "hostUuid" : "string",
  "hypervisorType" : "string",
  "imageUuid" : "string",
  "instanceOfferingUuid" : "string",
  "lastHostUuid" : "string",
  "lastOpDate" : {
    "date" : 0,
    "day" : 0,
    "hours" : 0,
    "minutes" : 0,
    "month" : 0,
    "nanos" : 0,
    "seconds" : 0,
    "time" : 0,
    "timezoneOffset" : 0,
    "year" : 0
  },
  "memorySize" : 0,
  "name" : "string",
  "platform" : "string",
  "rootVolumeUuid" : "string",
  "state" : "string",
  "type" : "string",
  "uuid" : "string",
  "vmCdRoms" : [ "object" ],
  "vmNics" : [ "object" ],
  "zoneUuid" : "string"
}

2.28.22. 修改ZStack默认网卡

PUT /imageHost/{hostId}/zstackDefaultNetwork

参数

类型

名称

说明

架构

Query

clientToken
可选

保证请求幂等性

string

Path

hostId
必填

主机ID

integer(int64)

Query

defaultNetworkId
必填

默认L3网络Id

string

Query

reboot
可选

是否立即重启

boolean

响应

HTTP代码

说明

架构

200

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/0/zstackDefaultNetwork

请求 query

{
  "clientToken" : "string",
  "defaultNetworkId" : "string",
  "reboot" : true
}

HTTP响应示例

响应 200

{
  "requestId" : "string"
}

2.28.23. 获取主机详情

GET /imageHost/{id}

参数

类型

名称

说明

架构

Path

id
必填

主机id

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/imageHost/0

HTTP响应示例

响应 200

{
  "agentStatus" : "string",
  "cloudId" : 0,
  "cloudName" : "string",
  "dataDisks" : [ {
    "category" : "string",
    "deleteWithInstance" : false,
    "diskId" : "string",
    "diskName" : "string",
    "jobId" : 0,
    "size" : 0
  } ],
  "description" : "string",
  "groupId" : 0,
  "hostId" : 0,
  "hostName" : "string",
  "importTime" : "string",
  "innerIp" : "string",
  "installedAgent" : false,
  "instanceId" : "string",
  "instanceName" : "string",
  "jobId" : 0,
  "macAddr" : "string",
  "memory" : 0,
  "operatingSystem" : "string",
  "platform" : "string",
  "processorCores" : 0,
  "provider" : "string",
  "proxyHostId" : 0,
  "proxyInnerIp" : "string",
  "proxyInstalledAgent" : false,
  "proxyInstanceName" : "string",
  "proxyPublicIp" : "string",
  "publicIp" : "string",
  "regionId" : "string",
  "scope" : "string",
  "status" : "string",
  "systemDisk" : {
    "category" : "string",
    "diskId" : "string",
    "size" : 0
  },
  "teamId" : 0,
  "zoneId" : "string"
}

2.29. Credential Api

登录凭证API

2.29.1. 创建一个登录凭证

POST /credential

说明

参数roles用逗号连接多个角色id，如果是系统角色，可以用RoleCode。例如：roles='12,TEAM_ADMINER’表示将登录凭证授权给id=12的角色和团队管理员角色。私有部署版包括通过role_templates.json配置的系统角色

参数

类型

名称

说明

架构

Body

request
必填

request

CreateCredentialRequest

响应

HTTP代码

说明

架构

200

201

Credential created successfully

400

parameter error

无内容

409

credential name conflict

无内容

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/credential

请求 body

{
  "account" : "string",
  "authType" : "string",
  "creator" : 0,
  "desktopType" : "string",
  "hosts" : [ {
    "hostId" : 0,
    "key" : "string",
    "password" : "string",
    "port" : 0,
    "sshKeyId" : 0,
    "suPassword" : "string"
  } ],
  "key" : "string",
  "name" : "string",
  "password" : "string",
  "port" : 0,
  "roles" : "string",
  "sshKeyId" : 0,
  "suCommand" : "string",
  "suPassword" : "string",
  "suUser" : "string",
  "teamId" : 0
}

HTTP响应示例

响应 200

{
  "authType" : "string",
  "createTime" : "string",
  "creatorId" : 0,
  "desktopType" : "string",
  "id" : 0,
  "name" : "string",
  "suCommand" : "string",
  "suUser" : "string",
  "user" : "string"
}

响应 201

{
  "authType" : "string",
  "createTime" : "string",
  "creatorId" : 0,
  "desktopType" : "string",
  "id" : 0,
  "name" : "string",
  "suCommand" : "string",
  "suUser" : "string",
  "user" : "string"
}

2.29.2. 获取主机登录凭证列表

GET /credential/byHost/{hostId}

参数

类型

名称

说明

架构

Path

hostId
必填

主机ID

integer(int64)

响应

HTTP代码

说明

架构

200

GetCredentialListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/credential/byHost/0

HTTP响应示例

响应 200

{
  "credentials" : [ {
    "authType" : "string",
    "createTime" : "string",
    "creatorId" : 0,
    "desktopType" : "string",
    "id" : 0,
    "name" : "string",
    "suCommand" : "string",
    "suUser" : "string",
    "user" : "string"
  } ],
  "page" : 0,
  "requestId" : "string",
  "size" : 0,
  "total" : 0
}

2.29.3. 获取团队登录凭证列表（根据团队teamId）

GET /credential/byTeam/{teamId}

参数

类型名称说明架构默认列

Path

teamId
必填

团队ID

integer(int64)

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

条数

integer(int32)

"20"

响应

HTTP代码

说明

架构

200

GetCredentialListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/credential/byTeam/0

请求 query

{
  "page" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "credentials" : [ {
    "authType" : "string",
    "createTime" : "string",
    "creatorId" : 0,
    "desktopType" : "string",
    "id" : 0,
    "name" : "string",
    "suCommand" : "string",
    "suUser" : "string",
    "user" : "string"
  } ],
  "page" : 0,
  "requestId" : "string",
  "size" : 0,
  "total" : 0
}

2.29.4. 获取团队登录凭证列表（根据团队code）

GET /credential/byTeamCode/{teamCode}

参数

类型名称说明架构默认列

Path

teamCode
必填

团队code

string

Query

page
可选

页码

integer(int32)

"1"

Query

size
可选

条数

integer(int32)

"20"

响应

HTTP代码

说明

架构

200

GetCredentialListResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/credential/byTeamCode/string

请求 query

{
  "page" : 0,
  "size" : 0
}

HTTP响应示例

响应 200

{
  "credentials" : [ {
    "authType" : "string",
    "createTime" : "string",
    "creatorId" : 0,
    "desktopType" : "string",
    "id" : 0,
    "name" : "string",
    "suCommand" : "string",
    "suUser" : "string",
    "user" : "string"
  } ],
  "page" : 0,
  "requestId" : "string",
  "size" : 0,
  "total" : 0
}

2.29.5. 修改一个登录凭证

PUT /credential/{credentialId}

说明

参数roles用逗号连接多个角色id，如果是系统角色，可以用RoleCode。例如：roles='12,TEAM_ADMINER’表示将创建的登录凭证授权给id=12的角色和团队管理员角色。私有部署版包括通过role_templates.json配置的系统角色

参数

类型

名称

说明

架构

Path

credentialId
必填

登录凭证ID

integer(int64)

Query

name
可选

凭证名称,团队唯一。不传入时不更新

string

Query

account
可选

登录账号,不传入时不更新

string

Query

roles
可选

授权角色，不传入则不更新。注意，这个参数是替换授权而不是追加授权。

string

Query

operator
可选

操作者ID，不传入时，默认团队创建者

integer(int64)

Query

suUser
可选

切换用户名，不传入时不更新

string

Query

suCommand
可选

切换用户使用的命令，不传入则不更新。

string

响应

HTTP代码

说明

架构

200

DeleteCredentialHostResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/credential/0

请求 query

{
  "name" : "string",
  "account" : "string",
  "roles" : "string",
  "operator" : 0,
  "suUser" : "string",
  "suCommand" : "string"
}

HTTP响应示例

响应 200

{
  "authType" : "string",
  "createTime" : "string",
  "creatorId" : 0,
  "desktopType" : "string",
  "id" : 0,
  "name" : "string",
  "suCommand" : "string",
  "suUser" : "string",
  "user" : "string"
}

2.29.6. 删除登录凭证

DELETE /credential/{credentialId}

说明

会级联删除登录凭证中的主机

参数

类型

名称

说明

架构

Path

credentialId
必填

登录凭证ID

integer(int64)

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/credential/0

2.29.7. 获取登录凭证主机列表

GET /credential/{credentialId}/hosts

参数

类型

名称

说明

架构

Path

credentialId
必填

登录凭证ID

integer(int64)

响应

HTTP代码

说明

架构

200

CredentialHostsResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/credential/0/hosts

HTTP响应示例

响应 200

{
  "credential" : {
    "authType" : "string",
    "createTime" : "string",
    "creatorId" : 0,
    "desktopType" : "string",
    "id" : 0,
    "name" : "string",
    "suCommand" : "string",
    "suUser" : "string",
    "user" : "string"
  },
  "hosts" : [ {
    "authType" : "string",
    "hostId" : 0,
    "keySet" : false,
    "passwordSet" : false,
    "port" : 0,
    "suPasswordSet" : false,
    "suSet" : false
  } ],
  "requestId" : "string"
}

2.29.8. 获取登录凭证授权角色列表

GET /credential/{credentialId}/roles

参数

类型

名称

说明

架构

Path

credentialId
必填

登录凭证ID

integer(int64)

响应

HTTP代码

说明

架构

200

CredentialRolesResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/credential/0/roles

HTTP响应示例

响应 200

{
  "credential" : {
    "authType" : "string",
    "createTime" : "string",
    "creatorId" : 0,
    "desktopType" : "string",
    "id" : 0,
    "name" : "string",
    "suCommand" : "string",
    "suUser" : "string",
    "user" : "string"
  },
  "requestId" : "string",
  "roles" : [ {
    "code" : "string",
    "description" : "string",
    "id" : 0,
    "locked" : false,
    "name" : "string",
    "requestId" : "string",
    "roleType" : 0,
    "system" : false,
    "teamId" : 0
  } ]
}

2.29.9. 添加主机到登录凭证（如果已经添加，则修改）

POST /credential/{credentialId}/{hostId}

参数

类型

名称

说明

架构

Path

credentialId
必填

登录凭证ID

integer(int64)

Path

hostId
必填

主机ID

integer(int64)

Query

port
可选

访问端口，不传入时，使用协议默认端口

integer(int32)

Query

password
可选

登录密码，当认证类型是密码时，可以传入

string

Query

key
可选

登录密钥，当认证类型是密钥时，可以传入

string

Query

sshKeyId
可选

登录密钥使用密钥对，当认证类型是密钥时，可以传入，不要与password、key重复传入

integer(int64)

Query

operator
可选

操作者ID

integer(int64)

Query

suPassword
可选

切换用户的密码，可选

string

响应

HTTP代码

说明

架构

200

CredentialHostBrief

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/credential/0/0

请求 query

{
  "port" : 0,
  "password" : "string",
  "key" : "string",
  "sshKeyId" : 0,
  "operator" : 0,
  "suPassword" : "string"
}

HTTP响应示例

响应 200

{
  "authType" : "string",
  "hostId" : 0,
  "keySet" : false,
  "passwordSet" : false,
  "port" : 0,
  "suPasswordSet" : false,
  "suSet" : false
}

2.29.10. 删除登录凭证中的主机

DELETE /credential/{credentialId}/{hostId}

参数

类型

名称

说明

架构

Path

credentialId
必填

登录凭证ID

integer(int64)

Path

hostId
必填

主机ID

integer(int64)

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/credential/0/0

HTTP响应示例

响应 200

{
  "deleted" : false,
  "requestId" : "string"
}

2.30. Other Api

其他API

2.30.1. 检查某个jwt是否有效

POST /checkJwt

参数

类型

名称

说明

架构

Query

jwt
必填

jwt字符串

string

响应

HTTP代码

说明

架构

200

CheckJwtResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/checkJwt

请求 query

{
  "jwt" : "string"
}

HTTP响应示例

响应 200

{
  "expireTime" : "string",
  "jwtTokenId" : "string",
  "msg" : "string",
  "nickName" : "string",
  "requestId" : "string",
  "success" : false,
  "userId" : 0
}

2.30.2. 检查是否SaaS版

GET /checkSaaS

响应

HTTP代码

说明

架构

200

BooleanResponse

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/checkSaaS

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "value" : false
}

2.30.3. 获取OAuth Token（客户端不需要认证）

GET /oauth

说明

客户端无需认证（即签名或者设置Authentication请求头）即可发起请求，建议在https环境下使用，以避免泄露accessKeySecret

参数

类型名称说明架构默认列

Query

accessKeyId
必填

accessKeyId

string

Query

accessKeySecret
必填

accessKeySecret

string

Query

expireSeconds
必填

超时时间，单位秒，取值范围：[120,86400]

integer(int32)

"300"

响应

HTTP代码

说明

架构

200

AkAccessToken

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/oauth

请求 query

{
  "accessKeyId" : "string",
  "accessKeySecret" : "string",
  "expireSeconds" : 0
}

HTTP响应示例

响应 200

{
  "expireTime" : "string",
  "requestId" : "string",
  "token" : "string"
}

2.30.4. 删除OAuth Token（客户端无需认证）

DELETE /oauth/{token}

说明

客户端无需认证（即签名或者设置Authentication请求头）即可发起请求，建议在https环境下使用，以避免泄露accessKeySecret。这个接口可以删除API请求和登录链接的token

参数

类型

名称

说明

架构

Query

accessKeyId
必填

accessKeyId

string

Query

accessKeySecret
必填

accessKeySecret

string

Path

token
必填

token

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/oauth/string

请求 query

{
  "accessKeyId" : "string",
  "accessKeySecret" : "string"
}

2.30.5. 获取自动登的录授权URL

GET /oauthLogin

参数

类型名称说明架构默认列

Query

userId
必填

登录用户的ID

integer(int64)

Query

oneoff
必填

是否一次有效

boolean

"true"

Query

expireSeconds
必填

链接超时时间，单位：秒，取值范围[5min,24hr]

integer(int64)

"600"

Query

teamId
可选

登录后重定向的团队ID,如果未设置，打开默认团队

integer(int64)

Query

hostId
可选

如果设置了，登录后重定向到主机详情页

integer(int64)

Query

page
可选

如果设置了，登录后打开特定菜单

enum (Home, Hosts, HostDetail, HostAccess, Exam, HostExam, Audit, OpsStrategy, Log, OperationReport, UserTrail, HostTrail, AuditRecord, OperationRecord, TeamInfo, TeamMember, RoleManage, TeamAccount, ResPool, Net, Snapshot, Cost, Disk, OpWork, OpTask, Oss, Cdn, HostTemplate, DBAudit, RemoteApp, Workflow, WorkflowInstance, WorkflowMyStarted, WorkflowMyTodo, WorkflowMyDone)

"Home"

Query

workflowInstanceId
可选

如果设置了，登录后重定向到对应的工单流程

integer(int64)

Query

redirectUrl
可选

重定向URL。如果设置了，登录后打开特定URL，优先级比page和hostId高

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/oauthLogin

请求 query

{
  "userId" : 0,
  "oneoff" : true,
  "expireSeconds" : 0,
  "teamId" : 0,
  "hostId" : 0,
  "page" : "string",
  "workflowInstanceId" : 0,
  "redirectUrl" : "string"
}

HTTP响应示例

响应 200

{
  "expiredSeconds" : 0,
  "url" : "string"
}

2.30.6. 获取OAuth Token（限已认证的客户端）

GET /oauthV2

说明

客户端需要认证（即签名或者设置Authentication请求头）才能发起请求

参数

类型名称说明架构默认列

Query

expireSeconds
必填

超时时间，单位秒，取值范围：[120,86400]

integer(int32)

"300"

响应

HTTP代码

说明

架构

200

AkAccessToken

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/oauthV2

请求 query

{
  "expireSeconds" : 0
}

HTTP响应示例

响应 200

{
  "expireTime" : "string",
  "requestId" : "string",
  "token" : "string"
}

2.30.7. 删除OAuth Token（仅限已认证的客户端）

DELETE /oauthV2/{token}

说明

客户端需要认证（即签名或者设置Authentication请求头）才能发起请求。这个接口可以删除API请求和登录链接的token

参数

类型

名称

说明

架构

Path

token
必填

token

string

响应

HTTP代码

说明

架构

200

无内容

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/oauthV2/string

2.30.8. 查询权限的配额使用情况

GET /permissionQuota

参数

类型

名称

说明

架构

Query

permissions
必填

权限名称列表，用','连接

string

响应

HTTP代码

说明

架构

200

PermissionQuotaResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/permissionQuota

请求 query

{
  "permissions" : "string"
}

HTTP响应示例

响应 200

{
  "quotaList" : [ {
    "permission" : "string",
    "quotaType" : "string",
    "time" : "string",
    "total" : 0,
    "used" : 0
  } ],
  "requestId" : "string"
}

2.30.9. 检测openapi的连通性

GET /ping

说明

当前操作不需要认证也可以进行

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/ping

HTTP响应示例

响应 200

{
  "msg" : "string",
  "success" : true
}

2.30.10. 查询系统配额以及使用情况

GET /quota

Caution

operation.deprecated

说明

私有部署环境查询系统所有资源和配额；SAAS环境查询当前ISV所有资源和配额。v6之后升级了全新的配额系统

响应

HTTP代码

说明

架构

200

GetQuotaResult

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/quota

HTTP响应示例

响应 200

{
  "buckets" : 0,
  "cdns" : 0,
  "dbs" : 0,
  "hosts" : 0,
  "maxResources" : 0,
  "maxTeams" : 0,
  "maxUsers" : 0,
  "requestId" : "string",
  "resources" : 0,
  "teams" : 0,
  "users" : 0
}

2.30.11. 发送短信

POST /sms

参数

类型

名称

说明

架构

Body

request
必填

短信手机号模版等信息

SmsRequest

响应

HTTP代码

说明

架构

200

SmsResult

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/sms

请求 body

{
  "parameters" : [ "string" ],
  "phones" : [ "string" ],
  "template" : "string"
}

HTTP响应示例

响应 200

{
  "resultSet" : {
    "string" : "<<_smsresult>>"
  },
  "statusCode" : "string",
  "statusMsg" : "string",
  "success" : true
}

2.30.12. 发送短信，支持国际手机号

POST /smsV2

说明

返回每个手机号的发送结果

参数

类型

名称

说明

架构

Body

request
必填

短信手机号模版等信息

SmsRequest

响应

HTTP代码

说明

架构

200

SmsResultV2

消耗

application/json

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/smsV2

请求 body

{
  "parameters" : [ "string" ],
  "phones" : [ "string" ],
  "template" : "string"
}

HTTP响应示例

响应 200

{
  "requestId" : "string",
  "resultMap" : {
    "string" : "<<_smsresult>>"
  }
}

2.30.13. 校验手机验证码

GET /verifyPhoneCode/{sessionId}/{code}

参数

类型

名称

说明

架构

Path

sessionId
必填

sessionId

string

Path

code
必填

code

string

响应

HTTP代码

说明

架构

200

生成

application/json

安全

类型

名称

作用域

apiKey

Token

global

HTTP请求示例

请求 path

/verifyPhoneCode/string/string

HTTP响应示例

响应 200

{
  "msg" : "string",
  "success" : true
}

3. 安全

3.1. Token

类型 : apiKey
名称 : Authorization
在 : HEADER

4. 定义

4.1. AccessAuthResult

名称说明架构

account
可选

账号
例子 : "string"

string

credentialId
可选

登陆凭证ID
例子 : 0

integer(int64)

hostId
可选

主机ID
例子 : 0

integer(int64)

id
可选

访问串ID
例子 : 0

integer(int64)

password
可选

密码
例子 : "string"

string

port
可选

服务端口
例子 : 0

integer(int32)

requestId
可选

请求ID
例子 : "string"

string

serverAddr
可选

跳板机地址
例子 : "string"

string

userId
可选

用户ID
例子 : 0

integer(int64)

4.2. Actor

名称说明架构

avatar
可选

操作人头像地址
例子 : "string"

string

id
可选

操作人用户ID
例子 : 0

integer(int64)

name
可选

操作人账号
例子 : "string"

string

nickname
可选

操作人昵称
例子 : "string"

string

teamNickname
可选

操作人团队昵称
例子 : "string"

string

uid
可选

操作人UID
例子 : "string"

string

4.3. AddLdapConfigRequest

名称说明架构

accountAttr
可选

账号映射属性：LDAP/AD用户的某个属性，映射到门户用户的账号。取值全局唯一。对于AD域建议使用userPrincipalName
例子 : "string"

string

accountSuffix
可选

导入门户后的账号的后缀。可选。在多个LDAP server的账号映射无法唯一时使用
例子 : "string"

string

baseDn
可选

Base DN
例子 : "string"

string

connectTimeout
可选

连接超时
例子 : 0

integer(int32)

emailAttr
可选

邮箱映射属性，可选。
例子 : "string"

string

filterOrgUnit
可选

部门过滤器，默认是objectClass=organizationalUnit
例子 : "string"

string

filterPerson
可选

用户过滤器，默认是objectClass=person
例子 : "string"

string

genderAttr
可选

性别映射属性，可选。
例子 : "string"

string

ip
可选

LDAP协议连接的IP
例子 : "string"

string

nicknameAttr
可选

昵称映射属性：LDAP/AD用户的某个属性，映射到门户用户的昵称。对于AD域建议使用cn
例子 : "string"

string

password
可选

LDAP Server的管理员密码
例子 : "string"

string

phoneAttr
可选

手机号映射属性，可选。
例子 : "string"

string

port
可选

LDAP协议连接的端口
例子 : 0

integer(int32)

userName
可选

LDAP Server的管理员账号
例子 : "string"

string

4.4. AddLogRequest

名称说明架构

action
可选

操作名称
例子 : "string"

string

actionSource
可选

事件源
例子 : "string"

string

actorId
可选

操作人
例子 : 0

integer(int64)

cluster
可选

日志分类，以EXT_开头
例子 : "string"

string

createTime
可选

创建时间，UTC时间，格式"yyyy-MM-dd’T’HH:mm:ss’Z'"
例子 : "string"

string

errorCode
可选

错误码
例子 : "string"

string

errorMsg
可选

错误信息
例子 : "string"

string

extraInfo
可选

额外信息
例子 : "object"

object

remoteIp
可选

操作人远程IP
例子 : "string"

string

status
可选

日志状态
例子 : "string"

string

teamId
可选

所属团队ID
例子 : 0

integer(int64)

4.5. AddLogResult

名称说明架构

id
可选

日志的ID
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

4.6. AggregationData

名称说明架构

dataPoints
可选

聚合函数的数据点。{funcName=>value}
例子 : { "string" : 0.0 }

< string, number(double) > map

4.7. AkAccessToken

名称说明架构

expireTime
可选

Token超时时间
例子 : "string"

string(date-time)

requestId
可选

请求ID
例子 : "string"

string

token
可选

登录的token
例子 : "string"

string

4.8. AuthorizationInfo

名称说明架构

departments
可选

授权的部门
例子 : [ 0 ]

< integer(int64) > array

members
可选

授权的团队成员
例子 : [ 0 ]

< integer(int64) > array

roles
可选

授权的角色
例子 : [ 0 ]

< integer(int64) > array

4.9. BatchHostAggregationData

名称说明架构

batchDataPoints
可选

批量主机聚合函数值，{hostId=>AggregationData}
例子 : { "string" : "AggregationData" }

< string, AggregationData > map

requestId
可选

请求ID
例子 : "string"

string

4.10. BooleanResponse

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

value
可选

值
例子 : false

boolean

4.11. BooleanResult

名称说明架构

msg
可选

例子 : "string"

string

success
可选

例子 : true

boolean

4.12. BooleanVo

名称说明架构

value
可选

例子 : true

boolean

4.13. BucketVo

名称说明架构

bucketId
可选

对象存储ID
例子 : 0

integer(int64)

cloudId
可选

所属云账户
例子 : 0

integer(int64)

createTime
可选

导入时间
例子 : "string"

string(date-time)

importTime
可选

导入时间
例子 : "string"

string(date-time)

provider
可选

所属云厂商
例子 : "string"

string

regionId
可选

区域id
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

teamId
可选

所属团队
例子 : 0

integer(int64)

4.14. CasAppVo

名称说明架构

createTime
可选

创建时间
例子 : "string"

string(date-time)

evaluationOrder
可选

匹配服务ID的顺序
例子 : 0

integer(int32)

forceLogout
可选

注销CasServer强制注销SSO会话
例子 : false

boolean

id
可选

应用ID
例子 : 0

integer(int64)

logoutType
可选

SLO单点登出方式，默认是back
例子 : "string"

enum (back, front)

logoutUrl
可选

logoutType=back时调用的注销URL
例子 : "string"

string

module
可选

产品所属模块
例子 : "string"

string

name
可选

应用名称
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

serviceId
可选

服务ID，全局唯一
例子 : "string"

string

serviceType
可选

服务ID的匹配规则，默认是Identical，即完全相同
例子 : "string"

enum (Identical, Regex)

teamId
可选

应用所属团队，为null时是全局应用
例子 : 0

integer(int64)

4.15. CdnVo

名称说明架构

cdnId
可选

CDN ID
例子 : 0

integer(int64)

cloudId
可选

云账户ID
例子 : 0

integer(int64)

createTime
可选

创建时间
例子 : "string"

string(date-time)

domainName
可选

域名
例子 : "string"

string

importTime
可选

导入时间
例子 : "string"

string(date-time)

provider
可选

所属云厂商
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

sourceType
可选

源类型
例子 : "string"

string

sources
可选

域名的源
例子 : "string"

string

sslProtocol
可选

是否开启ssl
例子 : false

boolean

status
可选

域名状态
例子 : "string"

string

teamId
可选

所属团队ID
例子 : 0

integer(int64)

4.16. CheckJwtResult

名称说明架构

expireTime
可选

例子 : "string"

string(date-time)

jwtTokenId
可选

例子 : "string"

string

msg
可选

例子 : "string"

string

nickName
可选

例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

success
可选

该jwt是否有效，如果无效，msg解析原因
例子 : false

boolean

userId
可选

例子 : 0

integer(int64)

4.17. CloudHostResult

名称说明架构

hosts
可选

主机列表
例子 : [ "CloudHostVo" ]

< CloudHostVo > array

jobId
可选

任务ID
例子 : 0

integer(int64)

4.18. CloudHostVo

名称说明架构

agentStatus
可选

Agent的状态:STOPPED,READY
例子 : "string"

string

cloudId
可选

云账户ID
例子 : 0

integer(int64)

cloudName
可选

云账号名称
例子 : "string"

string

dataDisks
可选

数据盘
例子 : [ "DataDiskVo" ]

< DataDiskVo > array

description
可选

主机描述
例子 : "string"

string

groupId
可选

主机所在组ID
例子 : 0

integer(int64)

hostId
可选

例子 : 0

integer(int64)

hostName
可选

例子 : "string"

string

importTime
可选

例子 : "string"

string(date-time)

innerIp
可选

例子 : "string"

string

installedAgent
可选

是否安装了Agent
例子 : false

boolean

instanceId
可选

例子 : "string"

string

instanceName
可选

主机名称
例子 : "string"

string

jobId
可选

任务ID
例子 : 0

integer(int64)

macAddr
可选

MAC地址
例子 : "string"

string

memory
可选

例子 : 0

integer(int32)

operatingSystem
可选

例子 : "string"

string

platform
可选

例子 : "string"

string

processorCores
可选

例子 : 0

integer(int32)

provider
可选

云厂商
例子 : "string"

string

proxyHostId
可选

主机能够访问的Proxy所在主机的ID
例子 : 0

integer(int64)

proxyInnerIp
可选

主机能够访问的Proxy内网IP
例子 : "string"

string

proxyInstalledAgent
可选

主机能够访问的Proxy所在主机的是否已安装Agent
例子 : false

boolean

proxyInstanceName
可选

主机能够访问的Proxy所在主机的实例名称
例子 : "string"

string

proxyPublicIp
可选

主机能够访问的Proxy公网IP
例子 : "string"

string

publicIp
可选

例子 : "string"

string

regionId
可选

区域ID
例子 : "string"

string

scope
可选

云账户来源，门户：Portal|管理控制台：Console
例子 : "string"

enum (Console, Portal)

status
可选

主机状态
例子 : "string"

string

systemDisk
可选

系统盘
例子 : "SystemDiskVo"

SystemDiskVo

teamId
可选

例子 : 0

integer(int64)

zoneId
可选

可用区ID
例子 : "string"

string

4.19. CloudImageListResult

名称说明架构

images
可选

镜像列表
例子 : [ "CloudImageVo" ]

< CloudImageVo > array

requestId
可选

请求ID
例子 : "string"

string

4.20. CloudImageVo

名称说明架构

creationTime
可选

例子 : "string"

string(date-time)

description
可选

例子 : "string"

string

imageId
可选

例子 : "string"

string

imageName
可选

例子 : "string"

string

imageType
可选

例子 : "string"

string

osName
可选

例子 : "string"

string

platform
可选

例子 : "string"

string

regionId
可选

例子 : "string"

string

share
可选

例子 : true

boolean

status
可选

例子 : "string"

string

4.21. CloudVo

名称说明架构

accountId
可选

账号ID
例子 : "string"

string

cloudIntranetAccessType
可选

内网连接方式
例子 : "string"

enum (directly, proxy)

createTime
可选

创建时间
例子 : "string"

string(date-time)

id
可选

云账户ID
例子 : 0

integer(int64)

name
可选

云账户名称
例子 : "string"

string

provider
可选

云账户厂商,比如阿里云:aliyun;腾讯云:qcloud;局域网:private
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

scope
可选

云账户来源，门户：Portal|管理控制台：Console
例子 : "string"

enum (Console, Portal)

teamId
可选

所属团队ID
例子 : 0

integer(int64)

4.22. CountResult

名称说明架构

count
可选

计数
例子 : 0

integer(int32)

requestId
可选

请求ID
例子 : "string"

string

4.23. CreateCloudRequest

名称说明架构

clouds
可选

云账户信息列表
例子 : [ "CreateCloudVo" ]

< CreateCloudVo > array

4.24. CreateCloudResult

名称说明架构

cloudIds
可选

例子 : [ 0 ]

< integer(int64) > array

requestId
可选

请求ID
例子 : "string"

string

4.25. CreateCloudVo

名称说明架构

cidrRule
可选

网段划分方式，4.18新增，默认是auto(自动按C网段划分)。manual:按设定的CIDR划分
例子 : "string"

enum (auto, manual)

cidrs
可选

手工（cidrRule=manual）指定cidr网段，4.18新增。用逗号连接
例子 : "string"

string

creatorId
可选

创建者，未设置时使用团队创建者
例子 : 0

integer(int64)

intranetAccessType
可选

内网连接方式，4.18新增,SAAS必须设置为proxy
例子 : "string"

enum (directly, proxy)

name
必填

云账户名称，团队内唯一
例子 : "string"

string

referencedPolicyId
可选

指定团队内的一个运维子策略ID，新建的云账户的运维策略将引用这个策略中的条目设置默认值，4.18新增
例子 : 0

integer(int64)

roles
必填

4.8新增属性。给云账户授权的角色，用逗号连接多个角色id，如果是系统角色，可以用RoleCode。例如：roles='12,TEAM_ADMINER’表示id=12的角色和团队管理员角色。为了兼容旧API，如果不设置时，默认值是TEAM_MEMBER，而不是空值，即云账户对团队所有用户可见。roles不能设置为TEAM_CREATOR
例子 : "string"

string

teamId
必填

所属团队ID
例子 : 0

integer(int64)

4.26. CreateCredentialRequest

名称说明架构

account
可选

登录账号，VCN协议不需要，但是RDP和SSH需要设置
例子 : "string"

string

authType
必填

凭证类型：密码和密钥
例子 : "string"

enum (PASSWORD, KEY_FILE)

creator
可选

创建者，默认是团队拥有者
例子 : 0

integer(int64)

desktopType
必填

协议类型:RDP,SSH,VNC
例子 : "string"

enum (SSH, RDP, TELNET, APP, VNC, SFTP, FTP, SCP, ALIYUN_VNC, SHELL)

hosts
可选

加入主机列表
例子 : [ "CredentialHostVo" ]

< CredentialHostVo > array

key
可选

登录密钥，可选。当authType=KEY_FILE可以设置。与参数password不要同时设置。当CredentialHostVo没有设置时，会使用这个值做默认值。
例子 : "string"

string

name
必填

凭证名称,团队唯一。
例子 : "string"

string

password
可选

登录密码，可选。当authType=PASSWORD可以设置。与参数key不要同时设置。当CredentialHostVo没有设置时，会使用这个值做默认值。
例子 : "string"

string

port
可选

访问端口，未设置时，使用协议默认端口，即SSH：22，RDP：3389，等。
例子 : 0

integer(int32)

roles
可选

授权角色，默认是团队拥有者。用逗号连接多个角色id，如果是系统角色，可以用RoleCode。
例子 : "string"

string

sshKeyId
可选

登录密钥对ID，可选。当authType=KEY_FILE可以设置。与参数password和key不要同时设置。当CredentialHostVo没有设置时，会使用这个值做默认值。v4.18添加
例子 : 0

integer(int64)

suCommand
可选

切换用户使用的命令，可选。v4.13新增属性
例子 : "string"

string

suPassword
可选

切换用户的密码，可选。v4.13新增属性
例子 : "string"

string

suUser
可选

切换用户名，可选。v4.13新增属性
例子 : "string"

string

teamId
必填

团队ID
例子 : 0

integer(int64)

4.27. CreateRoleResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

roleId
可选

角色id
例子 : 0

integer(int64)

4.28. CreateZStackL2NoVLanNetworkResult

名称说明架构

l2NoVLanNetwork
可选

zstack二层网络NoVLan列表
例子 : "L2NetworkInventory"

requestId
可选

请求ID
例子 : "string"

string

4.29. CreateZStackL2VLanNetworkResult

名称说明架构

l2VLanNetworkInventory
可选

zstack二层VLan网络
例子 : "L2NetworkInventory"

requestId
可选

请求ID
例子 : "string"

string

4.30. CreateZStackL2VxLanNetworkResult

名称说明架构

l2VxLanNetwork
可选

zstack二层VxLan网络
例子 : "L2NetworkInventory"

L2VxlanNetworkPoolInventory

requestId
可选

请求ID
例子 : "string"

string

4.31. CreateZStackL2VxLanPoolResult

名称说明架构

l2VxlanPool
可选

zstack二层VxlanPool网络
例子 : "L2VxlanNetworkPoolInventory"

requestId
可选

请求ID
例子 : "string"

string

4.32. CredentialHostBrief

名称说明架构

authType
可选

认证方式
例子 : "string"

enum (PASSWORD, KEY_FILE)

hostId
可选

主机ID
例子 : 0

integer(int64)

keySet
可选

是否设置了密钥
例子 : false

boolean

passwordSet
可选

是否设置了密码
例子 : false

boolean

port
可选

访问端口
例子 : 0

integer(int32)

suPasswordSet
可选

是否设置了切换用户的密码
例子 : false

boolean

suSet
可选

是否设置了切换用户
例子 : false

boolean

4.33. CredentialHostVo

名称说明架构

hostId
必填

主机ID
例子 : 0

integer(int64)

key
可选

当前主机登录密钥，未设置时，使用CreateCredentialRequest中的默认值
例子 : "string"

string

password
可选

当前主机登录密码，未设置时，使用CreateCredentialRequest中的默认值
例子 : "string"

string

port
可选

访问端口
例子 : 0

integer(int32)

sshKeyId
可选

登录密钥对ID，可选。与参数password和key不要同时设置。v4.18添加
例子 : 0

integer(int64)

suPassword
可选

切换用户的密码，可选。v4.13新增属性。未设置时，使用CreateCredentialRequest中的默认值
例子 : "string"

string

4.34. CredentialHostsResult

名称说明架构

credential
可选

例子 : "CredentialVo"

hosts
可选

例子 : [ "CredentialHostBrief" ]

< CredentialHostBrief > array

requestId
可选

请求ID
例子 : "string"

string

4.35. CredentialRolesResult

名称说明架构

credential
可选

例子 : "CredentialVo"

requestId
可选

请求ID
例子 : "string"

string

roles
可选

例子 : [ "RoleVo" ]

< RoleVo > array

4.36. CredentialVo

名称说明架构

authType
可选

凭证类型：密码或密钥
例子 : "string"

enum (PASSWORD, KEY_FILE)

createTime
可选

创建时间
例子 : "string"

string(date-time)

creatorId
可选

创建者ID
例子 : 0

integer(int64)

desktopType
可选

登录协议,SSH,RDP,等等
例子 : "string"

string

id
可选

登录凭证ID
例子 : 0

integer(int64)

name
可选

登录凭证名称
例子 : "string"

string

suCommand
可选

切换用户的命令
例子 : "string"

string

suUser
可选

切换的用户
例子 : "string"

string

user
可选

登录账号
例子 : "string"

string

4.37. DataDiskVo

名称说明架构

category
必填

磁盘类型
例子 : "string"

string

deleteWithInstance
可选

磁盘是否随虚拟机一起销毁
例子 : false

boolean

diskId
可选

磁盘ID
例子 : "string"

string

diskName
可选

磁盘名称
例子 : "string"

string

jobId
可选

任务ID
例子 : 0

integer(int64)

size
必填

磁盘大小，单位为G
例子 : 0

integer(int32)

4.38. DbGroupVo

名称说明架构

createTime
可选

创建时间
例子 : "string"

string(date-time)

id
可选

分组列表
例子 : 0

integer(int64)

name
可选

名称
例子 : "string"

string

4.39. DbSqlLogResult

名称说明架构

logs
可选

例子 : [ "SqlLog" ]

< SqlLog > array

page
可选

当前第几页
例子 : 0

integer(int32)

requestId
可选

请求ID
例子 : "string"

string

size
可选

每页记录条数
例子 : 0

integer(int32)

total
可选

总共多少条记录
例子 : 0

integer(int32)

4.40. DbVo

名称说明架构

cluseterUri
可选

DB集群连接串
例子 : "string"

string

cluster
可选

例子 : true

boolean

creatorId
可选

创建者ID
例子 : 0

integer(int64)

dbGroupId
可选

所在分组ID
例子 : 0

integer(int64)

dbInstance
可选

DB实例
例子 : "string"

string

dbPassword
可选

DB密码
例子 : "string"

string

dbType
可选

数据库类型
例子 : "string"

enum (RDS, MYSQL, SQLSERVER, ORACLE, POSTGRESQL, HIVE, VERTICA, REDIS, REDSHIFT, MONGODB, GAUSSDB)

dbUser
可选

DB用户名
例子 : "string"

string

description
可选

DB描述
例子 : "string"

string

hostId
可选

DB宿主机ID，RDS时为null
例子 : 0

integer(int64)

id
可选

数据库ID
例子 : 0

integer(int64)

inner
可选

例子 : true

boolean

ip
可选

DB连接IP
例子 : "string"

string

jumpServerId
可选

跳板机ID（中转或Proxy）
例子 : 0

integer(int64)

jumpServerPort
可选

跳板机端口
例子 : 0

integer(int32)

jumpServerType
可选

跳板机类型（中转或Proxy）
例子 : "string"

enum (Proxy, Transit)

location
可选

DB位置：主机、RDS
例子 : "string"

enum (Host, RDS)

name
可选

数据库名称
例子 : "string"

string

port
可选

DB连接端口
例子 : 0

integer(int32)

teamId
可选

所属团队
例子 : 0

integer(int64)

4.41. DeleteCredentialHostResult

名称说明架构

deleted
可选

是否存在且删除成功，如果false，则表示主机不在登录凭证中
例子 : false

boolean

requestId
可选

请求ID
例子 : "string"

string

4.42. DeleteEntitiesResult

名称说明架构

count
可选

被删除的记录个数
例子 : 0

integer(int32)

requestId
可选

请求ID
例子 : "string"

string

4.43. DepartmentTreeVo

名称说明架构

description
可选

部门描述
例子 : "string"

string

id
可选

部门ID
例子 : 0

integer(int64)

memberIds
可选

部门成员列表
例子 : [ 0 ]

< integer(int64) > array

name
可选

部门名称
例子 : "string"

string

parentId
可选

上级部门ID，顶级部门的上级部门ID=0
例子 : 0

integer(int64)

requestId
可选

请求ID
例子 : "string"

string

roleId
可选

部门关联角色Id
例子 : 0

integer(int64)

subDepartments
可选

下级部门
例子 : [ "DepartmentTreeVo" ]

< DepartmentTreeVo > array

teamId
可选

所属团队ID
例子 : 0

integer(int64)

4.44. DepartmentVo

名称说明架构

description
可选

部门描述
例子 : "string"

string

id
可选

部门ID
例子 : 0

integer(int64)

memberIds
可选

部门成员列表
例子 : [ 0 ]

< integer(int64) > array

name
可选

部门名称
例子 : "string"

string

parentId
可选

上级部门ID，顶级部门的上级部门ID=0
例子 : 0

integer(int64)

requestId
可选

请求ID
例子 : "string"

string

roleId
可选

部门关联角色Id
例子 : 0

integer(int64)

teamId
可选

所属团队ID
例子 : 0

integer(int64)

4.45. DiskTypeResult

名称说明架构

diskTypes
可选

磁盘规格
例子 : [ "DiskTypeVo" ]

< DiskTypeVo > array

requestId
可选

请求ID
例子 : "string"

string

4.46. DiskTypeVo

名称说明架构

categories
可选

磁盘规格
例子 : [ "string" ]

< string > array

regionId
可选

区域
例子 : "string"

string

zoneId
可选

可用区
例子 : "string"

string

4.47. DoubleResponse

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

value
可选

数值
例子 : 0.0

number(double)

4.48. File

名称说明架构

absolute
可选

例子 : true

boolean

absoluteFile
可选

例子 : "File"

absolutePath
可选

例子 : "string"

string

canonicalFile
可选

例子 : "File"

canonicalPath
可选

例子 : "string"

string

directory
可选

例子 : true

boolean

file
可选

例子 : true

boolean

freeSpace
可选

例子 : 0

integer(int64)

hidden
可选

例子 : true

boolean

name
可选

例子 : "string"

string

parent
可选

例子 : "string"

string

parentFile
可选

例子 : "File"

path
可选

例子 : "string"

string

totalSpace
可选

例子 : 0

integer(int64)

usableSpace
可选

例子 : 0

integer(int64)

4.49. FlatDepartmentInfo

名称说明架构

departments
可选

部门列表
例子 : [ "DepartmentVo" ]

< DepartmentVo > array

membersMap
可选

部门成员关系:部门->成员列表
例子 : { "string" : "array" }

< string, < integer(int64) > array > map

relationshipMap
可选

部门关系:父部门->子部门
例子 : { "string" : "array" }

< string, < integer(int64) > array > map

requestId
可选

请求ID
例子 : "string"

string

4.50. Func

名称说明架构

name
可选

函数名
例子 : "string"

enum (mean, median, stddev, first, last, max, min, sum, percentile)

4.51. FunctionVo

功能权限信息，简称权限

名称说明架构

businessRole
可选

业务角色
例子 : "string"

string

code
可选

权限项代码
例子 : "string"

string

description
可选

描述
例子 : "string"

string

module
可选

所属分类模块
例子 : "string"

string

name
可选

权限项名称
例子 : "string"

string

path
可选

权限请求路径
例子 : "string"

string

roleCode
可选

如果非空，表示某个角色的专有功能
例子 : "string"

string

sortNumber
可选

排序
例子 : 0

integer(int32)

type
可选

校验类型
例子 : "string"

enum (FUNCTION_CODE, API_PATH, BUSINESS_ROLE)

4.52. GetAgentScriptResult

名称说明架构

cloudId
可选

云账户ID
例子 : 0

integer(int64)

hostId
可选

主机ID
例子 : 0

integer(int64)

linuxInstallScript
可选

linux安装脚本（shell）
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

windowsBatScript
可选

windows安装脚本（bat）
例子 : "string"

string

windowsScript
可选

windows安装脚本（powershell）
例子 : "string"

string

4.53. GetCredentialListResult

名称说明架构

credentials
可选

登录凭证列表
例子 : [ "CredentialVo" ]

< CredentialVo > array

page
可选

当前页码
例子 : 0

integer(int32)

requestId
可选

请求ID
例子 : "string"

string

size
可选

当前页的记录数
例子 : 0

integer(int32)

total
可选

总记录数
例子 : 0

integer(int32)

4.54. GetFunctionResult

名称说明架构

functions
可选

例子 : [ "FunctionVo" ]

< FunctionVo > array

requestId
可选

请求ID
例子 : "string"

string

4.55. GetHostBriefResult

名称说明架构

hostIds
可选

例子 : [ 0 ]

< integer(int64) > array

4.56. GetHostsStatusResult

名称说明架构

statusMap
必填

ID=>status
例子 : { "string" : "string" }

< string, string > map

4.57. GetIpAddressCapacityResult

名称说明架构

availableCapacity
可选

例子 : 0

integer(int64)

totalCapacity
可选

例子 : 0

integer(int64)

usedIpAddressNumber
可选

例子 : 0

integer(int64)

4.58. GetModuleResult

名称说明架构

modules
可选

模块
例子 : [ "ModuleVo" ]

< ModuleVo > array

requestId
可选

请求ID
例子 : "string"

string

4.59. GetProjectResult

名称说明架构

projects
可选

项目
例子 : [ "ProjectVo" ]

< ProjectVo > array

requestId
可选

请求ID
例子 : "string"

string

4.60. GetProxyScriptResult

名称说明架构

cloudId
可选

云账户ID
例子 : 0

integer(int64)

linuxInstallScript
可选

linux安装脚本（shell）
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

windowsBatScript
可选

windows安装脚本（bat）
例子 : "string"

string

windowsScript
可选

windows安装脚本（powershell）
例子 : "string"

string

4.61. GetQuotaResult

名称说明架构

buckets
可选

系统Bucket数
例子 : 0

integer(int32)

cdns
可选

系统CDN数
例子 : 0

integer(int32)

dbs
可选

系统DB数
例子 : 0

integer(int32)

hosts
可选

系统HOST数
例子 : 0

integer(int32)

maxResources
可选

最大资源数
例子 : 0

integer(int32)

maxTeams
可选

最大团队数
例子 : 0

integer(int32)

maxUsers
可选

最大用户数
例子 : 0

integer(int32)

requestId
可选

请求ID
例子 : "string"

string

resources
可选

资源总数，包括:HOST，CDN，BUCKET，DB
例子 : 0

integer(int32)

teams
可选

系统团队数
例子 : 0

integer(int32)

users
可选

系统用户数
例子 : 0

integer(int32)

4.62. GetRegionResult

名称说明架构

provider
可选

云厂商
例子 : "string"

string

regions
可选

区域
例子 : [ "RegionVo" ]

< RegionVo > array

requestId
可选

请求ID
例子 : "string"

string

4.63. GetRoleResourcesResult

名称说明架构

bucketIds
可选

当前角色可见bucket列表
例子 : [ 0 ]

< integer(int64) > array

cdnIds
可选

当前角色可见CDN列表
例子 : [ 0 ]

< integer(int64) > array

hostIds
可选

当前角色可见主机列表
例子 : [ 0 ]

< integer(int64) > array

requestId
可选

请求ID
例子 : "string"

string

roleId
可选

角色ID
例子 : 0

integer(int64)

4.64. GetRoleTemplatesResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

roleTemplates
可选

role code => Tempalte
例子 : { "string" : "RoleTemplateVo" }

< string, RoleTemplateVo > map

4.65. GetShortcutsResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

shortcuts
可选

例子 : [ "ShortcutVo" ]

< ShortcutVo > array

4.66. GetTeamListResult

名称说明架构

page
可选

当前第几页
例子 : 0

integer(int32)

requestId
可选

请求ID
例子 : "string"

string

size
可选

当前页的记录数
例子 : 0

integer(int32)

teams
可选

团队列表
例子 : [ "TeamVo" ]

< TeamVo > array

total
可选

团队总数
例子 : 0

integer(int32)

4.67. GetTeamQuotaResult

名称说明架构

buckets
可选

团队Bucket数
例子 : 0

integer(int32)

cdns
可选

团队CDN数
例子 : 0

integer(int32)

clouds
可选

团队云账户数
例子 : 0

integer(int32)

dbs
可选

团队DB数
例子 : 0

integer(int32)

fileKeepDuration
可选

文件传输冗余文件保留时长
例子 : 0

integer(int32)

hosts
可选

团队HOST数
例子 : 0

integer(int32)

logKeepDuration
可选

日志保留天数
例子 : 0

integer(int32)

maxCdnResources
可选

最大CDN数
例子 : 0

integer(int32)

maxClouds
可选

最大云账户数
例子 : 0

integer(int32)

maxDbResources
可选

最大DB数
例子 : 0

integer(int32)

maxHostResources
可选

最大主机数
例子 : 0

integer(int32)

maxMembers
可选

最大成员数
例子 : 0

integer(int32)

maxOssResources
可选

最大OSS数
例子 : 0

integer(int32)

maxResources
可选

最大云资源数（包括主机、对象存储、CDN、DB）
例子 : 0

integer(int32)

maxScriptRuns
可选

最大并发脚本执行数
例子 : 0

integer(int32)

maxSessions
可选

最大并发会话数量
例子 : 0

integer(int32)

members
可选

团队成员数
例子 : 0

integer(int32)

netDiskMaxCapability
可选

网盘容量限额,byte
例子 : 0

integer(int64)

netDiskMaxFileSize
可选

上传单个文件尺寸允许最大值,byte
例子 : 0

integer(int64)

requestId
可选

请求ID
例子 : "string"

string

resources
可选

团队资源数
例子 : 0

integer(int32)

teamId
可选

团队ID
例子 : 0

integer(int64)

4.68. GetTeamResult

名称说明架构

code
可选

团队标识
例子 : "string"

string

createTime
可选

团队创建时间
例子 : "string"

string(date-time)

creator
可选

团队创建者ID
例子 : 0

integer(int64)

departmentEnabled
可选

是否开启了组织架构视图,v4.17新增
例子 : false

boolean

memberAccounts
可选

团队成员用户ID与用户账户的映射。includeMembers=true时返回
例子 : { "string" : "string" }

< string, string > map

members
可选

团队成员，includeMembers=true时返回
例子 : [ 0 ]

< integer(int64) > array

name
可选

团队名称
例子 : "string"

string

quotaExceed
可选

配额是否超限
例子 : false

boolean

requestId
可选

请求ID
例子 : "string"

string

serveEndTime
可选

专业版到期时间
例子 : "string"

string(date-time)

teamId
可选

团队ID
例子 : 0

integer(int64)

teamType
可选

团队类型
例子 : "string"

enum (BASIC, PRO, ADV_PRO, ENT, ULTIMATE)

4.69. HostAccessAuthResult

名称说明架构

accessAuthResults
可选

访问串列表
例子 : [ "AccessAuthResult" ]

< AccessAuthResult > array

count
可选

访问串总数
例子 : 0

integer(int32)

requestId
可选

请求ID
例子 : "string"

string

4.70. HostCostItem

名称说明架构

bandwidthCost
可选

带宽（元／月）
例子 : 0.0

number(double)

chargeType
可选

计费类型
例子 : "string"

enum (UNKNOWN, PrePaid, PostPaid)

diskCost
可选

磁盘（元／月）
例子 : 0.0

number(double)

id
可选

主机ID
例子 : 0

integer(int64)

instanceCost
可选

实例（元／月）
例子 : 0.0

number(double)

instanceId
可选

实例ID
例子 : "string"

string

instanceName
可选

实例名称
例子 : "string"

string

platform
可选

操作系统
例子 : "string"

string

snapshotCost
可选

快照（元／月）
例子 : 0.0

number(double)

totalCost
可选

小计（元／月）
例子 : 0.0

number(double)

4.71. HostCostResult

名称说明架构

bandwidthCost
可选

带宽（元／月）
例子 : 0.0

number(double)

diskCost
可选

磁盘（元／月）
例子 : 0.0

number(double)

hostCosts
可选

例子 : [ "HostCostItem" ]

< HostCostItem > array

instanceCost
可选

实例（元／月）
例子 : 0.0

number(double)

requestId
可选

请求ID
例子 : "string"

string

snapshotCost
可选

快照（元／月）
例子 : 0.0

number(double)

totalCost
可选

小计（元／月）
例子 : 0.0

number(double)

4.72. HostDetailListResult

名称说明架构

hosts
可选

主机详情列表
例子 : [ "HostDetailVo" ]

< HostDetailVo > array

requestId
可选

请求ID
例子 : "string"

string

4.73. HostDetailVo

名称说明架构

agentStatus
可选

Agent的状态:STOPPED,READY
例子 : "string"

string

cloudId
可选

云账户ID
例子 : 0

integer(int64)

groupId
可选

主机物理分组ID
例子 : 0

integer(int64)

hostId
可选

主机ID
例子 : 0

integer(int64)

hostName
可选

主机hostName
例子 : "string"

string

importTime
可选

导入时间
例子 : "string"

string(date-time)

innerIp
可选

内网IP
例子 : "string"

string

installedAgent
可选

是否安装了Agent
例子 : false

boolean

instanceId
可选

主机实例ID，在云账户中唯一
例子 : "string"

string

instanceName
可选

主机名称
例子 : "string"

string

memory
可选

内存（MB）
例子 : 0

integer(int32)

operatingSystem
可选

主机操作系统
例子 : "string"

string

platform
可选

主机平台
例子 : "string"

string

processorCores
可选

CPU核数
例子 : 0

integer(int32)

publicIp
可选

公网IP
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

scope
可选

云账户来源，门户：Portal|管理控制台：Console
例子 : "string"

enum (Console, Portal)

status
可选

主机状态
例子 : "string"

string

teamId
可选

所属团队
例子 : 0

integer(int64)

4.74. HostGroupVo

名称说明架构

cloudId
可选

所属云账户ID
例子 : 0

integer(int64)

id
可选

主机分组ID
例子 : 0

integer(int64)

name
可选

主机分组名称
例子 : "string"

string

networkType
可选

网络类型:class,vpc,lan，分别表示云主机的经典网络、VPC和局域网网络
例子 : "string"

string

regionId
可选

区域：云主机的区域id或者局域网主机的子网
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

teamId
可选

所属团队ID
例子 : 0

integer(int64)

4.75. HostGroupVoResult

物理网络列表

名称说明架构

hostgroups
可选

主机分组列表
例子 : [ "HostGroupVo" ]

< HostGroupVo > array

4.76. HostLog

名称说明架构

accessIp
可选

操作者IP
例子 : "string"

string

accessUserAgent
可选

操作者浏览器UserAgent
例子 : "string"

string

action
可选

操作类型
例子 : "string"

enum (ACCESS, ADD, REMOVE, START, STOP, RESTART, RESET_PWD, MODIFY, RESET_MCONSOLE_PWD, CHANGE_SNAPSHOT_POLICY, ALLOCATE)

actionSource
可选

操作者的位置
例子 : "string"

string

actorId
可选

操作者ID
例子 : 0

integer(int64)

actorName
可选

操作者昵称
例子 : "string"

string

cloudId
可选

目标主机所属云账户
例子 : 0

integer(int64)

cloudName
可选

目标主机所属云账户名称
例子 : "string"

string

cloudProvider
可选

云主机分类
例子 : "string"

string

createTime
可选

操作时间
例子 : "string"

string(date-time)

extraInfo
可选

会话日志额外信息
例子 : "object"

object

hostDeleted
可选

主机是否已经删除
例子 : false

boolean

hostGroupId
可选

目标主机所在的组
例子 : 0

integer(int64)

hostId
可选

目标主机ID
例子 : 0

integer(int64)

hostInnerIp
可选

目标主机内网IP
例子 : "string"

string

hostInstanceId
可选

目标主机实例ID
例子 : "string"

string

hostName
可选

目标主机名称
例子 : "string"

string

hostPlatform
可选

目标主机平台
例子 : "string"

string

hostPublicIp
可选

目标主机公网IP
例子 : "string"

string

id
可选

例子 : "string"

string

status
可选

操作的结果
例子 : "string"

enum (FAIL, SUCCESS, RUNNING, UNKNOWN)

teamId
可选

所属团队
例子 : 0

integer(int64)

4.77. HostLogResult

名称说明架构

logs
可选

日志记录数组
例子 : [ "HostLog" ]

< HostLog > array

page
可选

当前第几页
例子 : 0

integer(int32)

requestId
可选

请求ID
例子 : "string"

string

size
可选

每页记录条数
例子 : 0

integer(int32)

total
可选

总共多少条记录
例子 : 0

integer(int32)

4.78. HostVo

名称说明架构

cloudId
可选

云账户ID
例子 : 0

integer(int64)

groupId
可选

主机物理分组ID
例子 : 0

integer(int64)

hostId
可选

主机ID
例子 : 0

integer(int64)

hostName
可选

主机hostName
例子 : "string"

string

importTime
可选

导入时间
例子 : "string"

string(date-time)

innerIp
可选

内网IP
例子 : "string"

string

instanceId
可选

主机实例ID，在云账户中唯一
例子 : "string"

string

instanceName
可选

主机名称
例子 : "string"

string

memory
可选

内存（MB）
例子 : 0

integer(int32)

operatingSystem
可选

主机操作系统
例子 : "string"

string

platform
可选

主机平台
例子 : "string"

string

processorCores
可选

CPU核数
例子 : 0

integer(int32)

publicIp
可选

公网IP
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

scope
可选

云账户来源，门户：Portal|管理控制台：Console
例子 : "string"

enum (Console, Portal)

status
可选

主机状态
例子 : "string"

string

teamId
可选

所属团队
例子 : 0

integer(int64)

4.79. ImportHostRequest

名称说明架构

cloudId
必填

所属云账户ID
例子 : 0

integer(int64)

hosts
必填

主机信息列表
例子 : [ "ImportHostVo" ]

< ImportHostVo > array

teamId
必填

所属团队id
例子 : 0

integer(int64)

vgIds
可选

4.8添加的属性：导入主机默认加入的虚拟分组的ID列表。默认不添加到任何虚拟分组
例子 : [ 0 ]

< integer(int64) > array

4.80. ImportHostResult

名称说明架构

cloudId
可选

例子 : 0

integer(int64)

groupId
可选

例子 : 0

integer(int64)

hostIds
可选

例子 : [ 0 ]

< integer(int64) > array

teamId
可选

例子 : 0

integer(int64)

4.81. ImportHostVo

名称说明架构

defaultVgIds
可选

可选。主机默认加入的虚拟分组。会与ImportHostRequest.vgIds合并生效
例子 : [ 0 ]

< integer(int64) > array

description
可选

描述信息
例子 : "string"

string

innerIp
必填

内网地址
例子 : "string"

string

instanceId
可选

厂商提供的ID，在云账户中唯一，不设置时系统自动生成
例子 : "string"

string

memory
可选

内存，单位MB
例子 : 0

integer(int32)

name
必填

主机名称
例子 : "string"

string

operatingSystem
必填

操作系统
例子 : "string"

string

processor
可选

CPU核数
例子 : 0

integer(int32)

publicIp
可选

公网地址
例子 : "string"

string

status
可选

状态,可取值Stopped,Running,Unknown,Expired,Pending,Starting等，后面3种主要来自云主机
例子 : "string"

string

4.82. ImportPublicHostRequest

名称说明架构

cloudId
必填

所属云账户ID
例子 : 0

integer(int64)

creatorId
可选

创建者ID，不设置时是团队所有者
例子 : 0

integer(int64)

instanceRegionMap
必填

实例ID=>RegionId映射
例子 : { "string" : "string" }

< string, string > map

4.83. ImportTeamRequest

名称说明架构

teams
必填

团队信息列表
例子 : [ "ImportTeamVo" ]

< ImportTeamVo > array

4.84. ImportTeamResult

名称说明架构

teamCodes
必填

团队ID=>团队code
例子 : { "string" : "string" }

< string, string > map

4.85. ImportTeamVo

名称说明架构

code
可选

团队code，可选。只能是数字、字母、下划线，即满足正则：[A-Za-z0-9_]。保证全局唯一，不设置时由系统自动生成，是访问团队资源的URL context path。注意：code字段不能设置为保留字。4.10新增属性。
例子 : "string"

string

creator
可选

创建者用户ID，与creatorAccount必填其中一个。必须是当前ISV有权限操作的用户，私有部署环境可以是任何用户。
例子 : 0

integer(int64)

creatorAccount
可选

创建者用户账号，与creator必填其中一个。必须是当前ISV有权限操作的用户，私有部署环境可以是任何用户。如果设置了creatorAccount，会忽略creator。4.10新增参数。
例子 : "string"

string

memberAccounts
可选

默认添加的团队成员账号列表，可选。必须是ISV有权限操作的用户，私有部署环境可以是任何用户。与members不要同时设置，如果memberAccounts非空，会忽略members。4。10新增属性。
例子 : [ "string" ]

< string > array

memberQuota
可选

设置团队的成员数配额，可选。默认值：SAAS环境是ISV用户配额；私有部署环境是License的用户配额。注意不能超过配额。需要控制团队成员规模时，通过这个参数指定。
例子 : 0

integer(int32)

members
可选

默认添加的团队成员列表，可选。必须是ISV有权限操作的用户，私有部署环境可以是任何用户。
例子 : [ 0 ]

< integer(int64) > array

name
必填

团队名称，必填。
例子 : "string"

string

4.86. ImportUserRequest

导入用户请求

名称说明架构

users
必填

用户信息列表
例子 : [ "ImportUserVo" ]

< ImportUserVo > array

4.87. ImportUserResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

userAccounts
可选

用户ID=>用户账号
例子 : { "string" : "string" }

< string, string > map

userIds
可选

新导入的用户ID列表
例子 : [ 0 ]

< integer(int64) > array

4.88. ImportUserVo

名称说明架构

account
可选

登录账户，可选。需保证全局唯一,未设置时，将由系统自动生成。4.8新增属性，只能在私有部署版中设置，SAAS版的Openapi不支持设置登录账户。账号不能包含逗号','。
例子 : "string"

string

address
可选

地址，可选。
例子 : "string"

string

email
可选

登录邮箱，可选。需保证全局唯一。4.9新增属性，只能在私有部署版中设置，SAAS用户的邮箱需要通过验证码绑定。
例子 : "string"

string

expirationDate
可选

用户在团队中的有效期，可选。如果设置，会在到期后自动退出团队，如果不设置，则是永久成员。日期格式：yyyy-MM-dd。4.8新增属性。
例子 : "string"

string

forceUpdate
可选

首次登录强制修改密码，可选。默认为false。4.8新增属性。
例子 : false

boolean

gender
必填

性别，可选。0:未知；1：男；2：女。不填时默认值为0。
最小值 : 0
最大值 : 2
例子 : 0

integer(int32)

introduce
可选

用户签名，可选。用户自定义描述
例子 : "string"

string

joinTeam
可选

默认加入的团队，可选。团队ID。4.8新增属性。
例子 : 0

integer(int64)

joinTeamCode
可选

默认加入的团队，可选。团队code，与joinTeam不要同时设置，如果设置了joinTeamCode，会忽略joinTeam。4.10新加字段。
例子 : "string"

string

name
必填

用户昵称，必填。
例子 : "string"

string

password
可选

登录密码，可选。长度4~40个字符，即使设置了用户密码策略也不校验复杂性。4.8新增属性。
例子 : "string"

string

roles
可选

在加入团队中默认授权的角色，可选。必须设置joinTeam或者joinTeamIdOrCode才可以设置roles。格式：用逗号','连接的角色ID或者code，code可以设定私有部署环境roles_template.json定义的系统角色。
例子 : "string"

string

sendEmail
可选

是否发送通知邮件，可选。默认为false，只有设置了email才会生效。4.11新增属性。
例子 : false

boolean

4.89. InputStream

类型 : object

4.90. InputStreamResource

名称说明架构

description
可选

例子 : "string"

string

file
可选

例子 : "File"

filename
可选

例子 : "string"

string

inputStream
可选

例子 : "InputStream"

InputStream

open
可选

例子 : true

boolean

readable
可选

例子 : true

boolean

uri
可选

例子 : "URI"

URI

url
可选

例子 : "URL"

URL

4.91. InstanceOfferingInventory

名称说明架构

allocatorStrategy
可选

例子 : "string"

string

cpuNum
可选

例子 : 0

integer(int32)

cpuSpeed
可选

例子 : 0

integer(int32)

createDate
可选

例子 : "Timestamp"

description
可选

例子 : "string"

string

lastOpDate
可选

例子 : "Timestamp"

memorySize
可选

例子 : 0

integer(int64)

name
可选

例子 : "string"

string

sortKey
可选

例子 : 0

integer(int32)

state
可选

例子 : "string"

string

type
可选

例子 : "string"

string

uuid
可选

例子 : "string"

string

4.92. InstanceTypeConfigVo

名称说明架构

cpu
可选

cpu个数
例子 : 0

integer(int32)

instanceType
可选

实例规格
例子 : "string"

string

instanceTypeFamily
可选

实例规格簇
例子 : "string"

string

memoryInMB
可选

内存大小
例子 : 0

integer(int32)

4.93. InstanceTypeResult

名称说明架构

instanceTypes
可选

实例规格
例子 : [ "InstanceTypeVo" ]

< InstanceTypeVo > array

requestId
可选

请求ID
例子 : "string"

string

4.94. InstanceTypeVo

名称说明架构

instanceTypes
可选

实例规格配置信息
例子 : [ "InstanceTypeConfigVo" ]

< InstanceTypeConfigVo > array

regionId
可选

区域
例子 : "string"

string

zoneId
可选

可用区
例子 : "string"

string

4.95. IpRangeInventory

名称说明架构

addressMode
可选

例子 : "string"

string

createDate
可选

例子 : "Timestamp"

description
可选

例子 : "string"

string

endIp
可选

例子 : "string"

string

gateway
可选

例子 : "string"

string

ipVersion
可选

例子 : 0

integer(int32)

l3NetworkUuid
可选

例子 : "string"

string

lastOpDate
可选

例子 : "Timestamp"

name
可选

例子 : "string"

string

netmask
可选

例子 : "string"

string

networkCidr
可选

例子 : "string"

string

prefixLen
可选

例子 : 0

integer(int32)

startIp
可选

例子 : "string"

string

uuid
可选

例子 : "string"

string

4.96. JobInfoVo

名称说明架构

completed
可选

任务完成量
例子 : 0

integer(int64)

createTime
可选

创建时间
例子 : "string"

string(date-time)

description
可选

任务描述
例子 : "string"

string

done
可选

例子 : true

boolean

finishTime
可选

结束时间
例子 : "string"

string(date-time)

id
可选

异步任务ID
例子 : 0

integer(int64)

meta
可选

任务扩展属性
例子 : "object"

object

requestId
可选

请求ID
例子 : "string"

string

startTime
可选

启动时间
例子 : "string"

string(date-time)

status
可选

任务状态
例子 : "string"

enum (AUDITING, PENDING, RUNNING, SUCCESS, PARAM_ERROR, FAIL, TIMEOUT, CANCELLED, UNKNOWN)

success
可选

例子 : true

boolean

targetId
可选

任务关联的目标ID，可能为null
例子 : 0

integer(int64)

teamId
可选

所属团队ID
例子 : 0

integer(int64)

total
可选

任务总量，如果为0表示当前任务不支持进度
例子 : 0

integer(int64)

type
可选

任务类型
例子 : "string"

enum (UN_KNOW, SessionOp, DiskOp, MigrateTeamData, DiskSnapshotOp, HostImportOp, GatewayInstruction, CdnImportOp, BucketUtilizationAnalyse, SyncImage, RefreshImages, BucketImportOp, SecurityGroupAddInstance, ScriptRun, DistributeFile, DistributeUploadOp, CommandRun, InstallAgent, BatchInstallAgent, TaskScheduleRun, CollectFile, PurchaseCloudHost, HealthCheckPageToPdf, InstallGateway, CredentialChangePassword, TransitJob, BatchIssueTheKey)

4.97. JobVo

名称说明架构

id
可选

异步任务ID
例子 : 0

integer(int64)

requestId
可选

请求ID
例子 : "string"

string

4.98. KeyPairDetailVo

名称说明架构

comment
可选

SSH公钥的注释
例子 : "string"

string

createTime
可选

创建时间
例子 : "string"

string(date-time)

creator
可选

密钥对的创建人
例子 : 0

integer(int64)

departmentIds
可选

授权组织单元ID列表
例子 : [ 0 ]

< integer(int64) > array

description
可选

描述
例子 : "string"

string

id
可选

密钥对ID
例子 : 0

integer(int64)

memberIds
可选

授权成员ID列表
例子 : [ 0 ]

< integer(int64) > array

name
可选

密钥对名称
例子 : "string"

string

publicKey
可选

SSH公钥
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

roleIds
可选

授权角色ID列表
例子 : [ 0 ]

< integer(int64) > array

teamId
可选

所属团队ID
例子 : 0

integer(int64)

4.99. KeyPairListResult

名称说明架构

keyPars
可选

例子 : [ "KeyPairVo" ]

< KeyPairVo > array

requestId
可选

请求ID
例子 : "string"

string

4.100. KeyPairVo

名称说明架构

comment
可选

SSH公钥的注释
例子 : "string"

string

createTime
可选

创建时间
例子 : "string"

string(date-time)

creator
可选

密钥对的创建人
例子 : 0

integer(int64)

description
可选

描述
例子 : "string"

string

id
可选

密钥对ID
例子 : 0

integer(int64)

name
可选

密钥对名称
例子 : "string"

string

publicKey
可选

SSH公钥
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

teamId
可选

所属团队ID
例子 : 0

integer(int64)

4.101. L2NetworkInventory

名称说明架构

attachedClusterUuids
可选

例子 : [ "object" ]

< object > array

createDate
可选

例子 : "Timestamp"

description
可选

例子 : "string"

string

lastOpDate
可选

例子 : "Timestamp"

name
可选

例子 : "string"

string

physicalInterface
可选

例子 : "string"

string

type
可选

例子 : "string"

string

uuid
可选

例子 : "string"

string

zoneUuid
可选

例子 : "string"

string

4.102. L2VlanNetworkInventory

名称说明架构

attachedClusterUuids
可选

例子 : [ "object" ]

< object > array

createDate
可选

例子 : "Timestamp"

description
可选

例子 : "string"

string

lastOpDate
可选

例子 : "Timestamp"

name
可选

例子 : "string"

string

physicalInterface
可选

例子 : "string"

string

type
可选

例子 : "string"

string

uuid
可选

例子 : "string"

string

vlan
可选

例子 : 0

integer(int32)

zoneUuid
可选

例子 : "string"

string

4.103. L2VxlanNetworkInventory

名称说明架构

attachedClusterUuids
可选

例子 : [ "object" ]

< object > array

createDate
可选

例子 : "Timestamp"

description
可选

例子 : "string"

string

lastOpDate
可选

例子 : "Timestamp"

name
可选

例子 : "string"

string

physicalInterface
可选

例子 : "string"

string

poolUuid
可选

例子 : "string"

string

type
可选

例子 : "string"

string

uuid
可选

例子 : "string"

string

vni
可选

例子 : 0

integer(int32)

zoneUuid
可选

例子 : "string"

string

4.104. L2VxlanNetworkPoolInventory

名称说明架构

attachedCidrs
可选

例子 : "object"

object

attachedClusterUuids
可选

例子 : [ "object" ]

< object > array

attachedVniRanges
可选

例子 : [ "object" ]

< object > array

attachedVtepRefs
可选

例子 : [ "object" ]

< object > array

attachedVxlanNetworkRefs
可选

例子 : [ "object" ]

< object > array

createDate
可选

例子 : "Timestamp"

description
可选

例子 : "string"

string

lastOpDate
可选

例子 : "Timestamp"

name
可选

例子 : "string"

string

physicalInterface
可选

例子 : "string"

string

type
可选

例子 : "string"

string

uuid
可选

例子 : "string"

string

zoneUuid
可选

例子 : "string"

string

4.105. L3NetworkInventory

名称说明架构

category
可选

例子 : "string"

string

createDate
可选

例子 : "Timestamp"

description
可选

例子 : "string"

string

dns
可选

例子 : [ "object" ]

< object > array

dnsDomain
可选

例子 : "string"

string

hostRoute
可选

例子 : [ "object" ]

< object > array

ipRanges
可选

例子 : [ "object" ]

< object > array

ipVersion
可选

例子 : 0

integer(int32)

l2NetworkUuid
可选

例子 : "string"

string

lastOpDate
可选

例子 : "Timestamp"

name
可选

例子 : "string"

string

networkServices
可选

例子 : [ "object" ]

< object > array

state
可选

例子 : "string"

string

system
可选

例子 : true

boolean

type
可选

例子 : "string"

string

uuid
可选

例子 : "string"

string

zoneUuid
可选

例子 : "string"

string

4.106. LdapConfigVo

名称说明架构

accountAttr
可选

账号映射属性：LDAP/AD用户的某个属性，映射到门户用户的账号。取值全局唯一。对于AD域建议使用userPrincipalName
例子 : "string"

string

accountSuffix
可选

导入门户后的账号的后缀。可选。在多个LDAP server的账号映射无法唯一时使用
例子 : "string"

string

baseDn
可选

Base DN
例子 : "string"

string

connectTimeout
可选

连接超时
例子 : 0

integer(int32)

emailAttr
可选

邮箱映射属性，可选。
例子 : "string"

string

filterOrgUnit
可选

部门过滤器，默认是objectClass=organizationalUnit
例子 : "string"

string

filterPerson
可选

用户过滤器，默认是objectClass=person
例子 : "string"

string

genderAttr
可选

性别映射属性，可选。
例子 : "string"

string

ip
可选

LDAP协议连接的IP
例子 : "string"

string

nicknameAttr
可选

昵称映射属性：LDAP/AD用户的某个属性，映射到门户用户的昵称。对于AD域建议使用cn
例子 : "string"

string

phoneAttr
可选

手机号映射属性，可选。
例子 : "string"

string

port
可选

LDAP协议连接的端口
例子 : 0

integer(int32)

userName
可选

LDAP Server的管理员账号
例子 : "string"

string

4.107. LdapConfigVoList

名称说明架构

ldapConfigs
可选

例子 : [ "LdapConfigVo" ]

< LdapConfigVo > array

requestId
可选

请求ID
例子 : "string"

string

4.108. LdapDnTeamVo

名称说明架构

dn
可选

需要同步创建用户的OU，不用包含baseDN做后缀，使用空串时表示根目录。
例子 : "string"

string

name
可选

dn组织的名称，冗余保存仅用于显示
例子 : "string"

string

teamId
可选

当前OU新创建的用户自动加入的团队，为null时不加入团队。当LdapSyncConfigVo.joinTeam=true时生效
例子 : 0

integer(int64)

4.109. LdapSyncConfigVo

名称说明架构

addUserWhenCreated
可选

AD域新增用户时，是否创建相应的行云管家用户
例子 : false

boolean

baseDn
可选

Base DN
例子 : "string"

string

dnTeamList
可选

限定特定OU下的用户新增时，同步创建行云管家用户，当addUserWhenCreated=true时生效
例子 : [ "LdapDnTeamVo" ]

< LdapDnTeamVo > array

enabled
可选

是否开启定时同步
例子 : false

boolean

firstSyncTime
可选

首次同步时间
例子 : "string"

string(date-time)

interval
可选

执行间隔时间
例子 : 0

integer(int32)

intervalUnit
可选

间隔时间的单位
例子 : "string"

enum (month, week, day, hour, minute, second)

joinTeam
可选

新创建的行云管家用户，是否加入到指定团队
例子 : false

boolean

strategyWhenDeleted
可选

AD域用户删除时，行云管家处理用户的策略：delete，block
例子 : "string"

enum (delete, block)

syncUserWhenChanged
可选

AD域用户信息变化时，是否同步到行云管家
例子 : false

boolean

4.110. LdapSyncConfigVoList

名称说明架构

ldapSyncConfigs
可选

例子 : [ "LdapSyncConfigVo" ]

< LdapSyncConfigVo > array

requestId
可选

请求ID
例子 : "string"

string

4.111. ListCloudsResult

名称说明架构

clouds
可选

例子 : [ "CloudVo" ]

< CloudVo > array

4.112. ListCredentialsResult

名称说明架构

credentials
可选

例子 : [ "CredentialVo" ]

< CredentialVo > array

requestId
可选

请求ID
例子 : "string"

string

4.113. ListDbGroupResult

名称说明架构

dbGroups
可选

分组列表
例子 : [ "DbGroupVo" ]

< DbGroupVo > array

requestId
可选

请求ID
例子 : "string"

string

teamId
可选

所属团队ID
例子 : 0

integer(int64)

4.114. ListDbResult

名称说明架构

dbs
可选

分组列表
例子 : [ "DbVo" ]

< DbVo > array

requestId
可选

请求ID
例子 : "string"

string

teamId
可选

所属团队ID
例子 : 0

integer(int64)

4.115. ListTagResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

tags
可选

标签列表
例子 : [ "TagVo" ]

< TagVo > array

teamId
可选

所属团队ID
例子 : 0

integer(int64)

4.116. ListVpcsResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

vpcs
可选

VPC列表
例子 : [ "VpcVo" ]

< VpcVo > array

4.117. ListZStackIpRangesResult

名称说明架构

ipRanges
可选

zstack网络地址范围列表
例子 : [ "IpRangeInventory" ]

< IpRangeInventory > array

requestId
可选

请求ID
例子 : "string"

string

4.118. ListZStackL2NetworksResult

名称说明架构

l2Networks
可选

zstack二层网络列表
例子 : [ "L2NetworkInventory" ]

< L2NetworkInventory > array

requestId
可选

请求ID
例子 : "string"

string

4.119. ListZStackL2VLanNetworksResult

名称说明架构

l2VLanNetworks
可选

zstack二层VLan网络列表
例子 : [ "L2VlanNetworkInventory" ]

< L2VlanNetworkInventory > array

requestId
可选

请求ID
例子 : "string"

string

4.120. ListZStackL2VxLanNetworksResult

名称说明架构

l2VxLanNetworks
可选

zstack二层VxLan网络列表
例子 : [ "L2VxlanNetworkInventory" ]

< L2VxlanNetworkInventory > array

requestId
可选

请求ID
例子 : "string"

string

4.121. ListZStackL2VxLanPoolsResult

名称说明架构

l2VxLanPools
可选

zstack二层VxLan网络池列表
例子 : [ "L2VxlanNetworkPoolInventory" ]

< L2VxlanNetworkPoolInventory > array

requestId
可选

请求ID
例子 : "string"

string

4.122. ListZStackL3NetworkIpStatisticResult

名称说明架构

l3NetworkIpStatistics
可选

zstack三层网络Ip统计信息列表
例子 : [ "ZStackL3NetworkIpStatistic" ]

< ZStackL3NetworkIpStatistic > array

requestId
可选

请求ID
例子 : "string"

string

4.123. ListZStackL3NetworksResult

名称说明架构

l3Networks
可选

zstack三层网络列表
例子 : [ "L3NetworkInventory" ]

< L3NetworkInventory > array

requestId
可选

请求ID
例子 : "string"

string

4.124. ListZStackNetworkServiceProvidersResult

名称说明架构

networkServiceProviders
可选

zstack网络服务列表
例子 : [ "NetworkServiceProviderInventory" ]

< NetworkServiceProviderInventory > array

requestId
可选

请求ID
例子 : "string"

string

4.125. ListZStackVirtualRouterOfferingsResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

virtualRouterOfferings
可选

zstack云路由规格列表
例子 : [ "VirtualRouterOfferingInventory" ]

< VirtualRouterOfferingInventory > array

4.126. ListZStackVpcRoutersResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

vpcRouters
可选

zstackVpc路由器列表
例子 : [ "VpcRouterVmInventory" ]

< VpcRouterVmInventory > array

4.127. LogResult

名称说明架构

logs
可选

例子 : [ "LogVo" ]

< LogVo > array

page
可选

当前第几页
例子 : 0

integer(int32)

requestId
可选

请求ID
例子 : "string"

string

size
可选

每页记录条数
例子 : 0

integer(int32)

total
可选

总共多少条记录
例子 : 0

integer(int32)

4.128. LogVo

名称说明架构

action
可选

操作名称
例子 : "string"

string

actionSource
可选

事件源
例子 : "string"

string

actor
可选

操作人
例子 : "Actor"

Actor

cluster
可选

日志分类
例子 : "string"

string

createTime
可选

创建时间
例子 : "string"

string(date-time)

errorCode
可选

错误码
例子 : "string"

string

errorMsg
可选

错误信息
例子 : "string"

string

extendMap
可选

扩展信息
例子 : "object"

object

extraInfo
可选

额外信息
例子 : "object"

object

id
可选

日志的ID
例子 : "string"

string

remoteIp
可选

操作人远程IP
例子 : "string"

string

status
可选

日志状态
例子 : "string"

string

teamId
可选

所属团队ID
例子 : 0

integer(int64)

teamName
可选

所属团队名称
例子 : "string"

string

4.129. MetricSingletonMap

名称说明架构

metricDataMap
可选

例子 : { "string" : "SingletonResultList" }

< string, SingletonResultList > map

requestId
可选

请求ID
例子 : "string"

string

4.130. ModuleTermListResult

名称说明架构

moduleTermVos
可选

例子 : [ "ModuleTermVo" ]

< ModuleTermVo > array

requestId
可选

请求ID
例子 : "string"

string

4.131. ModuleTermVo

名称说明架构

moduleEditionCode
可选

例子 : "string"

string

moduleTerm
可选

例子 : 0

integer(int32)

4.132. ModuleVo

名称说明架构

editionCode
可选

版本代码
例子 : "string"

string

editionName
可选

版本名称
例子 : "string"

string

expiredTime
可选

过期时间
例子 : "string"

string(date-time)

moduleCode
可选

模块代码
例子 : "string"

string

moduleName
可选

模块名称
例子 : "string"

string

quotas
可选

配额
例子 : [ "QuotaUsedItemVo" ]

< QuotaUsedItemVo > array

requestId
可选

请求ID
例子 : "string"

string

4.133. NetworkServiceProviderInventory

名称说明架构

attachedL2NetworkUuids
可选

例子 : [ "object" ]

< object > array

createDate
可选

例子 : "Timestamp"

description
可选

例子 : "string"

string

lastOpDate
可选

例子 : "Timestamp"

name
可选

例子 : "string"

string

networkServiceTypes
可选

例子 : [ "object" ]

< object > array

type
可选

例子 : "string"

string

uuid
可选

例子 : "string"

string

4.134. NoticeAttachmentVo

名称说明架构

contentType
可选

例子 : "string"

string

cover
可选

封面(true)或附件（false）
例子 : false

boolean

createTime
可选

例子 : "string"

string(date-time)

downloadUrl
可选

下载地址
例子 : "string"

string

id
可选

例子 : 0

integer(int64)

name
可选

例子 : "string"

string

noticeId
可选

公告ID
例子 : 0

integer(int64)

size
可选

文件大小
例子 : 0

integer(int64)

4.135. NoticeDetailVo

名称说明架构

attachments
可选

例子 : [ "NoticeAttachmentVo" ]

< NoticeAttachmentVo > array

content
可选

例子 : "string"

string

cover
可选

例子 : "NoticeAttachmentVo"

NoticeAttachmentVo

createTime
可选

例子 : "string"

string(date-time)

id
可选

例子 : 0

integer(int64)

publishTime
可选

例子 : "string"

string(date-time)

sourceUrl
可选

例子 : "string"

string

status
可选

例子 : "string"

enum (Unpublished, Published)

tag
可选

例子 : "NoticeTagVo"

NoticeTagVo

tagId
可选

例子 : 0

integer(int64)

title
可选

例子 : "string"

string

4.136. NoticeInfo

名称说明架构

enabled
可选

是否开启公告栏
例子 : false

boolean

notices
可选

已发布公告栏文章数目
例子 : 0

integer(int32)

requestId
可选

请求ID
例子 : "string"

string

4.137. NoticeListResult

名称说明架构

notices
可选

例子 : [ "NoticeDetailVo" ]

< NoticeDetailVo > array

page
可选

当前第几页
例子 : 0

integer(int32)

requestId
可选

请求ID
例子 : "string"

string

size
可选

每页记录条数
例子 : 0

integer(int32)

total
可选

总共多少条记录
例子 : 0

integer(int32)

4.138. NoticeTagResult

名称说明架构

noticeTags
可选

例子 : [ "NoticeTagVo" ]

< NoticeTagVo > array

requestId
可选

请求ID
例子 : "string"

string

4.139. NoticeTagVo

名称说明架构

color
可选

颜色，形如#f3ad4c
例子 : "string"

string

createTime
可选

创建时间
例子 : "string"

string(date-time)

id
可选

ID
例子 : 0

integer(int64)

name
可选

名称
例子 : "string"

string

4.140. NoticeVo

名称说明架构

content
可选

例子 : "string"

string

createTime
可选

例子 : "string"

string(date-time)

id
可选

例子 : 0

integer(int64)

publishTime
可选

例子 : "string"

string(date-time)

sourceUrl
可选

例子 : "string"

string

status
可选

例子 : "string"

enum (Unpublished, Published)

tagId
可选

例子 : 0

integer(int64)

title
可选

例子 : "string"

string

4.141. OAuthUrlResult

名称说明架构

expiredSeconds
可选

例子 : 0

integer(int64)

url
可选

授权URL
例子 : "string"

string

4.142. OpenapiResponse

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

4.143. OpsPolicyDetailVo

名称说明架构

departmentIds
可选

授权组织单元ID列表
例子 : [ 0 ]

< integer(int64) > array

description
可选

子策略描述
例子 : "string"

string

id
可选

子策略ID
例子 : 0

integer(int64)

memberIds
可选

授权成员ID列表
例子 : [ 0 ]

< integer(int64) > array

name
可选

子策略名称
例子 : "string"

string

priority
可选

子策略优先级,取值越小越高，最小值:1
例子 : 0

integer(int32)

requestId
可选

请求ID
例子 : "string"

string

roleIds
可选

授权角色ID列表
例子 : [ 0 ]

< integer(int64) > array

sourceId
可选

云账户或者策略组ID
例子 : 0

integer(int64)

sourceType
可选

子策略类型：云账户或者策略组
例子 : "string"

enum (PolicyGroup, Cloud)

4.144. OpsPolicyGroupDetailVo

名称说明架构

createTime
可选

创建时间
例子 : "string"

string(date-time)

creator
可选

创建人
例子 : 0

integer(int64)

hosts
可选

例子 : [ 0 ]

< integer(int64) > array

id
可选

策略组ID
例子 : 0

integer(int64)

policyName
可选

策略组名称
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

teamId
可选

所属团队
例子 : 0

integer(int64)

updateTime
可选

更新时间
例子 : "string"

string(date-time)

4.145. OpsPolicyGroupResult

名称说明架构

policyGroups
可选

例子 : [ "OpsPolicyGroupVo" ]

< OpsPolicyGroupVo > array

requestId
可选

请求ID
例子 : "string"

string

4.146. OpsPolicyGroupVo

名称说明架构

createTime
可选

创建时间
例子 : "string"

string(date-time)

creator
可选

创建人
例子 : 0

integer(int64)

id
可选

策略组ID
例子 : 0

integer(int64)

policyName
可选

策略组名称
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

teamId
可选

所属团队
例子 : 0

integer(int64)

updateTime
可选

更新时间
例子 : "string"

string(date-time)

4.147. OpsPolicyItemResult

名称说明架构

policyItems
可选

策略项目
例子 : [ "OpsPolicyItemVo" ]

< OpsPolicyItemVo > array

4.148. OpsPolicyItemVo

策略条目

名称说明架构

category
可选

策略条目的分类
例子 : "string"

string

defaultValue
可选

策略条目的默认值
例子 : "object"

object

description
可选

策略条目的描述
例子 : "string"

string

domainEntityType
可选

策略条目取值关联的实体名称，目前仅：WorkflowTemplate(工单模版)
例子 : "string"

string

key
可选

策略条目的Key
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

value
可选

策略条目当前值
例子 : "object"

object

valueType
可选

策略条目的取值类型
例子 : "string"

string

4.149. OpsPolicyResult

名称说明架构

policies
可选

子策略列表
例子 : [ "OpsPolicyVo" ]

< OpsPolicyVo > array

requestId
可选

请求ID
例子 : "string"

string

4.150. OpsPolicyVo

子策略

名称说明架构

description
可选

子策略描述
例子 : "string"

string

id
可选

子策略ID
例子 : 0

integer(int64)

name
可选

子策略名称
例子 : "string"

string

priority
可选

子策略优先级,取值越小越高，最小值:1
例子 : 0

integer(int32)

requestId
可选

请求ID
例子 : "string"

string

sourceId
可选

云账户或者策略组ID
例子 : 0

integer(int64)

sourceType
可选

子策略类型：云账户或者策略组
例子 : "string"

enum (PolicyGroup, Cloud)

4.151. OptimizedAdviceItem

名称说明架构

adviceLevel
可选

优化级别：升级、降级、维持现有配置
例子 : "string"

enum (UPGRADE, DOWNGRADE, OK)

adviceTarget
可选

建议的目标
例子 : "string"

enum (INSTANCE, BANDWIDTH, FREE_DISK, FREE_EIP, FREE_SNAPSHOT)

description
可选

优化建议描述
例子 : "string"

string

hostId
可选

主机ID
例子 : 0

integer(int64)

optimizedAdviceId
可选

优化建议ID
例子 : 0

integer(int64)

saveMoney
可选

节省的钱，以人民币计费，为负数时表示升级配置的花费
例子 : 0.0

number(double)

4.152. OptimizedAdviceResult

名称说明架构

optimizedAdvices
可选

例子 : [ "OptimizedAdviceItem" ]

< OptimizedAdviceItem > array

requestId
可选

请求ID
例子 : "string"

string

4.153. OrderDetailVo

名称说明架构

amount
可选

金额
例子 : 0.0

number

editionCode
可选

套餐Code
例子 : "string"

string

editionName
可选

套餐名称
例子 : "string"

string

expireTime
可选

到期时间
例子 : "string"

string(date-time)

moduleCode
可选

模块Code
例子 : "string"

string

moduleName
可选

模块名称
例子 : "string"

string

orderNumber
可选

订单号
例子 : "string"

string

productId
可选

产品ID
例子 : "string"

string

productTerm
可选

购买时长
例子 : 0

integer(int32)

quotas
可选

配额
例子 : [ "QuotaVo" ]

< QuotaVo > array

4.154. OrderListResult

名称说明架构

orders
可选

例子 : [ "OrderVo" ]

< OrderVo > array

requestId
可选

请求ID
例子 : "string"

string

4.155. OrderVo

名称说明架构

cancelReason
可选

订单作废原因
例子 : "string"

string

createTime
可选

创建时间
例子 : "string"

string(date-time)

details
可选

订单详情，批量续费的订单会有多条记录
例子 : [ "OrderDetailVo" ]

< OrderDetailVo > array

orderNumber
可选

订单号
例子 : "string"

string

orderType
可选

订单类型，团队服务订单或者个人充值订单
例子 : "string"

enum (TEAM, DEPOSIT)

payAccountId
可选

支付者ID
例子 : 0

integer(int64)

payMethod
可选

支付方式
例子 : "string"

enum (alipay, wechatpay, voucher, bank, remaining)

payStatus
可选

支付状态
例子 : "string"

enum (UNPAID, PAID, CANCELED, WAIT_CONFIRM)

payTime
可选

支付时间
例子 : "string"

string(date-time)

payTransactionNo
可选

支付宝或者微信交易号
例子 : "string"

string

payablePay
可选

应付金额(扣除代金券和余额支付的钱)
例子 : 0.0

number

productInfo
可选

产品信息
例子 : "string"

string

productTerm
可选

购买时长
例子 : 0

integer(int32)

realPay
可选

实付金额
例子 : 0.0

number

scope
可选

订单来源
例子 : "string"

enum (Console, Portal)

serveType
可选

服务类型，包含开通、续费、变更、变更并续费、试用5种类型
例子 : "string"

enum (NEW_PURCHASE, RENEW, CHANGE, CHANGE_RENEW, TRIAL, OFFICIAL)

teamId
可选

团队ID
例子 : 0

integer(int64)

teamName
可选

团队名称
例子 : "string"

string

totalPrice
可选

总金额
例子 : 0.0

number

userId
可选

创建者ID
例子 : 0

integer(int64)

workflowInstanceId
可选

工单ID
例子 : 0

integer(int64)

4.156. PagedOrderListResult

名称说明架构

orders
可选

例子 : [ "OrderVo" ]

< OrderVo > array

page
可选

当前第几页
例子 : 0

integer(int32)

requestId
可选

请求ID
例子 : "string"

string

size
可选

当前页的记录数
例子 : 0

integer(int32)

total
可选

订单总数
例子 : 0

integer(int32)

4.157. PagedRoleListResult

名称说明架构

page
可选

当前第几页
例子 : 0

integer(int32)

requestId
可选

请求ID
例子 : "string"

string

roles
可选

例子 : [ "RoleVo" ]

< RoleVo > array

size
可选

每页记录条数
例子 : 0

integer(int32)

total
可选

总共多少条记录
例子 : 0

integer(int32)

4.158. PagedUserListResult

名称说明架构

page
可选

当前第几页
例子 : 0

integer(int32)

requestId
可选

请求ID
例子 : "string"

string

size
可选

当前页的记录数
例子 : 0

integer(int32)

total
可选

用户总数
例子 : 0

integer(int32)

users
可选

例子 : [ "UserVo" ]

< UserVo > array

4.159. PermissionQuota

名称说明架构

permission
可选

例子 : "string"

enum (SmsAccessOld, SmsAccess, IntlSmsAccess, EmailAccess, WxTemplateMsgAccess, UserAccess, TeamAccess, HostAccess, OAuthLogin, GetProxyScript, LogWrite, CreateCasServer)

quotaType
可选

例子 : "string"

enum (ByTraffic, PerYear, PerMonth, PerDay, PerHour)

time
可选

例子 : "string"

string(date-time)

total
可选

例子 : 0

integer(int64)

used
可选

例子 : 0

integer(int64)

4.160. PermissionQuotaResult

名称说明架构

quotaList
可选

例子 : [ "PermissionQuota" ]

< PermissionQuota > array

requestId
可选

请求ID
例子 : "string"

string

4.161. ProjectVo

云账户的项目

名称说明架构

projectId
可选

项目ID
例子 : "string"

string

projectName
可选

项目名称
例子 : "string"

string

regionId
可选

区域ID
例子 : "string"

string

4.162. PublicIpHostVo

有公网ip的主机

名称说明架构

creationTime
可选

创建时间
例子 : "string"

string(date-time)

innerIp
可选

内网IP地址
例子 : "string"

string

instanceId
可选

主机实例Id
例子 : "string"

string

instanceName
可选

主机实例名称
例子 : "string"

string

provider
可选

云厂商
例子 : "string"

string

publicIp
可选

公网IP地址
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

teamId
可选

团队Id
例子 : 0

integer(int64)

4.163. PublicIpHostsResult

有公网ip的主机列表

名称说明架构

hosts
可选

主机列表
例子 : [ "PublicIpHostVo" ]

< PublicIpHostVo > array

requestId
可选

请求ID
例子 : "string"

string

4.164. QuotaItemResult

名称说明架构

quotaItems
可选

例子 : [ "QuotaItemVo" ]

< QuotaItemVo > array

requestId
可选

请求ID
例子 : "string"

string

4.165. QuotaItemVo

名称说明架构

code
可选

配额代码
例子 : "string"

string

external
可选

是否是外部配额
例子 : false

boolean

name
可选

配额名称
例子 : "string"

string

tenantId
可选

所属Tenant
例子 : 0

integer(int64)

unit
可选

配额单位
例子 : "string"

string

unitPrice
可选

配额单价
例子 : 0.0

number(double)

4.166. QuotaUsedItemResult

名称说明架构

quotaItems
可选

例子 : [ "QuotaUsedItemVo" ]

< QuotaUsedItemVo > array

requestId
可选

请求ID
例子 : "string"

string

4.167. QuotaUsedItemVo

名称说明架构

code
可选

配额代码
例子 : "string"

string

external
可选

是否是外部配额
例子 : false

boolean

name
可选

配额名称
例子 : "string"

string

quota
可选

实际配额
例子 : 0

integer(int64)

tenantId
可选

所属Tenant
例子 : 0

integer(int64)

unit
可选

配额单位
例子 : "string"

string

unitPrice
可选

配额单价
例子 : 0.0

number(double)

used
可选

已用配额
例子 : 0

integer(int64)

4.168. QuotaVo

名称说明架构

quota
可选

配额
例子 : 0

integer(int64)

quotaCode
可选

配额Code
例子 : "string"

string

quotaName
可选

配额名称
例子 : "string"

string

unit
可选

单位
例子 : "string"

string

4.169. RegionVo

公有云区域

名称说明架构

regionId
可选

区域ID
例子 : "string"

string

regionName
可选

区域名称
例子 : "string"

string

zones
可选

可用区
例子 : [ "ZoneVo" ]

< ZoneVo > array

4.170. ResourceResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

resources
可选

例子 : [ "ResourceVo" ]

< ResourceVo > array

4.171. ResourceVo

名称说明架构

id
可选

资源ID
例子 : 0

integer(int64)

type
可选

资源类型
例子 : "string"

4.172. RoleDetailResult

名称说明架构

functionCodes
可选

角色权限代码列表
例子 : [ "string" ]

< string > array

members
可选

角色成员ID列表
例子 : [ 0 ]

< integer(int64) > array

requestId
可选

请求ID
例子 : "string"

string

role
可选

角色信息
例子 : "RoleVo"

RoleVo

4.173. RoleListResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

roles
可选

角色列表
例子 : [ "RoleVo" ]

< RoleVo > array

4.174. RoleTemplateVo

名称说明架构

functions
可选

功能权限code列表
例子 : [ "string" ]

< string > array

name
可选

角色名称
例子 : "string"

string

4.175. RoleVo

名称说明架构

code
可选

角色标识，系统角色(私有部署版包括通过roles_template.json配置）才有标识，例如TEAM_CREATOR,TEAM_ADMINER,TEAM_MEMBER分别表示团队拥有者、管理员、所有成员。
例子 : "string"

string

description
可选

角色描述，2-128个字符
例子 : "string"

string

id
可选

角色ID
例子 : 0

integer(int64)

locked
可选

角色的权限是否不允许更改
例子 : false

boolean

name
可选

角色名称，2-32个字符
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

roleType
可选

角色类型：0，普通角色；1，系统角色；2，部门角色
例子 : 0

integer(int32)

system
可选

是否系统角色，系统角色无法删除
例子 : false

boolean

teamId
可选

所属团队
例子 : 0

integer(int64)

4.176. ScriptExecutingHost

名称说明架构

credentialId
可选

主机的登录凭证ID，可选。如果不设置，将用Agent执行脚本
例子 : 0

integer(int64)

hostId
可选

主机ID
例子 : 0

integer(int64)

4.177. ScriptExecutingHostsInfo

名称说明架构

executingHosts
可选

例子 : [ "ScriptExecutingHost" ]

< ScriptExecutingHost > array

operatorId
可选

操作者用户ID
例子 : 0

integer(int64)

parameter
可选

脚本参数，不设置时使用脚本默认参数
例子 : "string"

string

timeout
可选

脚本超时，不设置时使用默认超时
例子 : 0

integer(int32)

4.178. ScriptLibraryListResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

scriptLibraries
可选

例子 : [ "ScriptLibraryVo" ]

< ScriptLibraryVo > array

4.179. ScriptLibraryVo

名称说明架构

createTime
可选

脚本库创建时间
例子 : "string"

string(date-time)

creator
可选

脚本库创建人ID
例子 : 0

integer(int64)

description
可选

脚本库描述
例子 : "string"

string

id
可选

脚本库ID
例子 : 0

integer(int64)

name
可选

脚本库名称
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

4.180. ScriptListResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

scripts
可选

例子 : [ "ScriptVo" ]

< ScriptVo > array

4.181. ScriptOutputLineVo

名称说明架构

line
可选

输出的一行内容
例子 : "string"

string

type
可选

输出内容的类型
例子 : "string"

enum (INFO, ERR)

4.182. ScriptRunResult

名称说明架构

cancelled
可选

执行被取消的主机数
例子 : 0

integer(int32)

completed
可选

执行成功的主机数
例子 : 0

integer(int32)

done
可选

例子 : true

boolean

fails
可选

执行失败的主机数
例子 : 0

integer(int32)

id
可选

异步任务ID
例子 : 0

integer(int64)

lastCompleteTime
可选

任务最后完成时间
例子 : "string"

string(date-time)

operatorId
可选

操作者ID
例子 : 0

integer(int64)

pending
可选

处于等待的主机数
例子 : 0

integer(int32)

requestId
可选

请求ID
例子 : "string"

string

running
可选

处于执行中的主机数
例子 : 0

integer(int32)

scriptId
可选

脚本ID
例子 : 0

integer(int64)

scriptRuns
可选

每台主机执行结果
例子 : [ "ScriptRunVo" ]

< ScriptRunVo > array

total
可选

执行主机总数
例子 : 0

integer(int32)

4.183. ScriptRunVo

名称说明架构

completeTime
可选

主机结束执行脚本时间
例子 : "string"

string(date-time)

exitCode
可选

退出码，-999表示脚本未执行过或者还未执行完毕
例子 : 0

integer(int32)

hostId
可选

执行主机ID
例子 : 0

integer(int64)

id
可选

scriptRun的ID
例子 : 0

integer(int64)

outputLength
可选

当前输出的总长度（按字节计算）
例子 : 0

integer(int64)

outputLines
可选

脚本的输出，按照输入先后排序
例子 : [ "ScriptOutputLineVo" ]

< ScriptOutputLineVo > array

outputSize
可选

当前获取到的输出的长度（按字节计算）
例子 : 0

integer(int64)

result
可选

执行结果的简易描述
例子 : "string"

string

startTime
可选

主机开始执行脚本时间
例子 : "string"

string(date-time)

status
可选

执行状态
例子 : "string"

enum (PENDING, RUNNING, SUCCESS, PARAM_ERROR, FAIL, TIMEOUT, CANCELLED, UNKNOWN)

4.184. ScriptVo

名称说明架构

content
可选

脚本内容
例子 : "string"

string

createTime
可选

创建时间
例子 : "string"

string(date-time)

creator
可选

创建者ID
例子 : 0

integer(int64)

description
可选

脚本描述
例子 : "string"

string

id
可选

脚本ID
例子 : 0

integer(int64)

language
可选

脚本语言
例子 : "string"

enum (shell, python, powershell, perl, node, cmd)

libraryId
可选

所属脚本库ID
例子 : 0

integer(int64)

modifyTime
可选

修改时间
例子 : "string"

string(date-time)

name
可选

脚本名称
例子 : "string"

string

parameter
可选

脚本参数
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

timeout
可选

默认超时,单位：秒
例子 : 0

integer(int32)

4.185. SecurityGroupResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

securityGroups
可选

安全组列表
例子 : [ "SecurityGroupVo" ]

< SecurityGroupVo > array

4.186. SecurityGroupRuleResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

securityGroupRules
可选

安全组规则列表
例子 : [ "SecurityGroupRuleVo" ]

< SecurityGroupRuleVo > array

4.187. SecurityGroupRuleVo

名称说明架构

destCidrIp
可选

目标IP地址段，用于出方向授权，direction为egress时该变量有值
例子 : "string"

string

direction
可选

安全组规则授权方向，egress：安全组出方向，ingress：安全组入方向
例子 : "string"

enum (ingress, egress)

ipProtocol
可选

传输层协议，tcp|udp|all
例子 : "string"

enum (tcp, udp, all)

nicType
可选

经典网络取值internet和intranet，VPC取值只能为intranet
例子 : "string"

enum (intranet, internet)

policy
可选

访问权限，accept|drop
例子 : "string"

enum (accept, drop)

portRange
可选

端口范围，连接端口范围：开始端口/结束端口，如1/200 ；单个端口如22/22 ；多个端口如23/23,80/80；IpProtocol取值为all：-1/-1
例子 : "string"

string

priority
可选

规则优先级
例子 : "string"

string

securityGroupId
可选

安全组ID
例子 : "string"

string

sourceCidrIp
可选

源IP地址段，用于入方向授权，direction为ingress时该变量有值
例子 : "string"

string

4.188. SecurityGroupVo

名称说明架构

description
可选

安全组描述
例子 : "string"

string

regionId
可选

区域ID
例子 : "string"

string

securityGroupId
可选

安全组ID
例子 : "string"

string

securityGroupName
可选

安全组名称
例子 : "string"

string

securityGroupRules
可选

安全组规则
例子 : [ "SecurityGroupRuleVo" ]

< SecurityGroupRuleVo > array

vpcId
可选

安全组所在的VPC，腾讯云没有该字段
例子 : "string"

string

4.189. SessionOpenResult

名称说明架构

deskType
可选

例子 : 0

integer(int32)

errorMsg
可选

例子 : "string"

string

sessionId
可选

例子 : 0

integer(int64)

success
可选

例子 : true

boolean

websocketUrl
可选

例子 : "string"

string

4.190. SetZStackL2VLanIdsResult

名称说明架构

l2VLanIds
可选

zstack二层VLanId列表
例子 : [ 0 ]

< integer(int32) > array

requestId
可选

请求ID
例子 : "string"

string

4.191. ShortcutVo

名称说明架构

createTime
可选

快捷方式创建时间
例子 : "string"

string(date-time)

creatorId
可选

快捷方式创建者ID
例子 : 0

integer(int64)

creatorName
可选

快捷方式创建者昵称
例子 : "string"

string

desktopType
可选

快捷方式协议类型,比如SSH、RDP,等等
例子 : "string"

string

hostId
可选

主机ID
例子 : 0

integer(int64)

id
可选

主机快捷方式ID
例子 : 0

integer(int64)

loginAccount
可选

快捷方式登录账户
例子 : "string"

string

name
可选

快捷方式名称
例子 : "string"

string

passwordOrKeySet
可选

快捷方式是否设置了密码或者密钥
例子 : false

boolean

requestId
可选

请求ID
例子 : "string"

string

updateTime
可选

快捷方式修改时间
例子 : "string"

string(date-time)

4.192. SimpleUserVo

名称说明架构

account
可选

登录账号
例子 : "string"

string

email
可选

邮箱
例子 : "string"

string

nickname
可选

用户昵称
例子 : "string"

string

phone
可选

手机号
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

thirdPartyUserId
可选

第三方用户账号
例子 : "string"

string

userId
可选

用户ID
例子 : 0

integer(int64)

4.193. SingletonData

名称说明架构

dimensionName
可选

例子 : "string"

string

func
可选

数据点的统计函数
例子 : "Func"

Func

measurement
可选

数据点的监控项名
例子 : "string"

string

tags
可选

数据点的标签。例如hostId=xx,diskname=C:，等等
例子 : "object"

object

time
可选

数据点所处的时间。如果函数不支持，则为null
例子 : "string"

string(date-time)

unit
可选

单位
例子 : "string"

string

unitEn
可选

英文单位
例子 : "string"

string

value
可选

数据点的值
例子 : 0.0

number(double)

4.194. SingletonResultList

名称说明架构

dataPoints
可选

例子 : [ "SingletonData" ]

< SingletonData > array

4.195. SmsRequest

名称说明架构

parameters
必填

模版参数
例子 : [ "string" ]

< string > array

phones
必填

手机号列表
例子 : [ "string" ]

< string > array

template
必填

短信模版
例子 : "string"

enum (VerifyCode, UnbindVerifyCode, Session2FA, SystemUpgrade, MonitorAlert, CostAlert, AlertRecover, LoginCmdAudit, RemoteLogin, PendingTask, PendingTaskWithoutCode, SessionInvite, SaaSSessionInvite, scannerInsufficientQuota, scannerBuyOverlayPackageForTimes, scannerBuyOverlayPackageForTask, scannerGenerateReport, scannerFindAttack, scannerStartScanning, monitorGenerateReport, monitorSiteCannotAccess, monitorSiteCannotResolve, monitorSiteCannotResolve_dns, monitorSiteCannotResolve_authorityDns, monitorSiteRecovered, edrAlert)

4.196. SmsResult

名称说明架构

resultSet
可选

例子 : { "string" : "SmsResult" }

< string, SmsResult > map

statusCode
可选

例子 : "string"

string

statusMsg
可选

例子 : "string"

string

success
可选

例子 : true

boolean

4.197. SmsResultV2

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

resultMap
可选

例子 : { "string" : "SmsResult" }

< string, SmsResult > map

4.198. SqlLog

名称说明架构

actorId
可选

操作用户ID
例子 : 0

integer(int64)

actorName
可选

操作用户昵称
例子 : "string"

string

dbId
可选

数据库ID
例子 : 0

integer(int64)

dbType
可选

数据库类型
例子 : "string"

enum (RDS, MYSQL, SQLSERVER, ORACLE, POSTGRESQL, HIVE, VERTICA, REDIS, REDSHIFT, MONGODB, GAUSSDB)

errorCode
可选

错误代码
例子 : "string"

string

errorMessage
可选

错误信息
例子 : "string"

string

query
可选

sql语句
例子 : "string"

string

queryEnd
可选

查询结束时间戳
例子 : 0

integer(int64)

queryStart
可选

查询开始时间戳
例子 : 0

integer(int64)

rowCount
可选

SQL返回记录行数
例子 : 0

integer(int64)

sessionId
可选

会话ID
例子 : 0

integer(int64)

sqlState
可选

SQL状态
例子 : "string"

string

success
可选

是否成功
例子 : false

boolean

teamId
可选

团队ID
例子 : 0

integer(int64)

4.199. SubnetVo

名称说明架构

availableIpAddressCount
可选

可用IP数
例子 : 0

integer(int64)

requestId
可选

请求ID
例子 : "string"

string

subnetCidr
可选

子网CIDR
例子 : "string"

string

subnetId
可选

子网ID
例子 : "string"

string

subnetName
可选

子网名称
例子 : "string"

string

vpcId
可选

VPC ID
例子 : "string"

string

zoneId
可选

可用区ID
例子 : "string"

string

zoneName
可选

可用区名称
例子 : "string"

string

4.200. SystemDiskVo

名称说明架构

category
必填

磁盘类型
例子 : "string"

string

diskId
可选

磁盘ID
例子 : "string"

string

size
必填

磁盘大小，单位为G
例子 : 0

integer(int32)

4.201. TagDetailResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

tag
可选

创建的tag
例子 : "TagVo"

TagVo

4.202. TagValueVo

名称说明架构

id
可选

标签值Id
例子 : 0

integer(int64)

tagId
可选

标签名Id
例子 : 0

integer(int64)

value
可选

标签值，可能为null
例子 : "string"

string

4.203. TagVo

名称说明架构

id
可选

标签名称Id
例子 : 0

integer(int64)

name
可选

标签名称
例子 : "string"

string

tagValueList
可选

标签值列表
例子 : [ "TagValueVo" ]

< TagValueVo > array

teamId
可选

团队Id
例子 : 0

integer(int64)

4.204. TeamBriefResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

teamIds
可选

例子 : [ 0 ]

< integer(int64) > array

4.205. TeamListResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

teams
可选

团队列表
例子 : [ "TeamVo" ]

< TeamVo > array

4.206. TeamVo

名称说明架构

code
可选

团队标识
例子 : "string"

string

createTime
可选

团队创建时间
例子 : "string"

string(date-time)

creator
可选

团队创建者ID
例子 : 0

integer(int64)

name
可选

团队名称
例子 : "string"

string

quotaExceed
可选

配额是否超限
例子 : false

boolean

serveEndTime
可选

专业版到期时间
例子 : "string"

string(date-time)

teamId
可选

团队ID
例子 : 0

integer(int64)

teamType
可选

团队类型
例子 : "string"

enum (BASIC, PRO, ADV_PRO, ENT, ULTIMATE)

tenantId
可选

租户ID
例子 : 0

integer(int64)

4.207. Timestamp

名称说明架构

date
可选

例子 : 0

integer(int32)

day
可选

例子 : 0

integer(int32)

hours
可选

例子 : 0

integer(int32)

minutes
可选

例子 : 0

integer(int32)

month
可选

例子 : 0

integer(int32)

nanos
可选

例子 : 0

integer(int32)

seconds
可选

例子 : 0

integer(int32)

time
可选

例子 : 0

integer(int64)

timezoneOffset
可选

例子 : 0

integer(int32)

year
可选

例子 : 0

integer(int32)

4.208. TransitServerResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

transitServers
可选

中转服务列表
例子 : [ "TransitServerVo" ]

< TransitServerVo > array

4.209. TransitServerVo

名称说明架构

code
可选

例子 : "string"

string

endpoints
可选

例子 : "string"

string

id
可选

例子 : 0

integer(int64)

ip
可选

例子 : "string"

string

name
可选

例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

4.210. URI

名称说明架构

absolute
可选

例子 : true

boolean

authority
可选

例子 : "string"

string

fragment
可选

例子 : "string"

string

host
可选

例子 : "string"

string

opaque
可选

例子 : true

boolean

path
可选

例子 : "string"

string

port
可选

例子 : 0

integer(int32)

query
可选

例子 : "string"

string

rawAuthority
可选

例子 : "string"

string

rawFragment
可选

例子 : "string"

string

rawPath
可选

例子 : "string"

string

rawQuery
可选

例子 : "string"

string

rawSchemeSpecificPart
可选

例子 : "string"

string

rawUserInfo
可选

例子 : "string"

string

scheme
可选

例子 : "string"

string

schemeSpecificPart
可选

例子 : "string"

string

userInfo
可选

例子 : "string"

string

4.211. URL

名称说明架构

authority
可选

例子 : "string"

string

content
可选

例子 : "object"

object

defaultPort
可选

例子 : 0

integer(int32)

file
可选

例子 : "string"

string

host
可选

例子 : "string"

string

path
可选

例子 : "string"

string

port
可选

例子 : 0

integer(int32)

protocol
可选

例子 : "string"

string

query
可选

例子 : "string"

string

ref
可选

例子 : "string"

string

userInfo
可选

例子 : "string"

string

4.212. UpdateUserVo

名称说明架构

address
可选

地址
例子 : "string"

string

gender
必填

性别：0:未知；1,：男；2：女
最小值 : 0
最大值 : 2
例子 : 0

integer(int32)

introduce
可选

用户签名
例子 : "string"

string

name
必填

用户昵称
例子 : "string"

string

4.213. UrlResult

名称说明架构

url
可选

例子 : "string"

string

4.214. UserBriefResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

userIds
可选

例子 : [ 0 ]

< integer(int64) > array

4.215. UserExtendParamResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

userExtendParams
可选

用户扩展属性
例子 : [ "UserExtendParamVo" ]

< UserExtendParamVo > array

4.216. UserExtendParamVo

名称说明架构

createTime
可选

创建时间
例子 : "string"

string(date-time)

description
可选

描述
例子 : "string"

string

paramName
可选

参数名
例子 : "string"

string

paramValue
可选

参数值
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

updateTime
可选

更新时间
例子 : "string"

string(date-time)

userId
可选

用户ID
例子 : 0

integer(int64)

4.217. UserListResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

users
可选

例子 : [ "UserVo" ]

< UserVo > array

4.218. UserVo

名称说明架构

account
可选

用户账号，可以作为用户相关API请求的关键字。
例子 : "string"

string

address
可选

地址
例子 : "string"

string

authMethod
可选

认证方式
例子 : "string"

enum (PLAIN, LDAP, RADIUS, OIDC, CAS, ACC)

blockedTime
可选

开始禁用的时间（如果禁用了）
例子 : "string"

string(date-time)

blockingSeconds
可选

禁用持续的时间（单位秒），=0表示永久禁用
例子 : 0

integer(int32)

delete
可选

是否已删除用户
例子 : false

boolean

email
可选

邮箱
例子 : "string"

string

gender
可选

性别:0:未知；1：男；2：女
例子 : 0

integer(int32)

id
可选

用户ID。可以作为用户相关API请求的关键字。
例子 : 0

integer(int64)

importTime
可选

导入时间
例子 : "string"

string(date-time)

introduce
可选

用户签名，4.10新增冗余字段
例子 : "string"

string

lastLoginTime
可选

最后登录时间
例子 : "string"

string(date-time)

ldapAttr
可选

账号映射LDAP用户的属性名
例子 : "string"

string

ldapBaseDn
可选

LDAP认证的baseDn
例子 : "string"

string

loginCount
可选

登录次数
例子 : 0

integer(int32)

name
可选

用户昵称，4.10新增冗余字段
例子 : "string"

string

nickname
可选

用户昵称
例子 : "string"

string

online
可选

是否在线
例子 : false

boolean

phone
可选

手机号
例子 : "string"

string

signature
可选

用户签名
例子 : "string"

string

status
可选

用户状态
例子 : "string"

enum (INACTIVE, ACTIVE, BLOCK, DELETED)

tenantId
可选

租户ID
例子 : 0

integer(int64)

uid
可选

用户UID，在审计日志和录像中用到。
例子 : "string"

string

userId
可选

用户ID。冗余字段
例子 : 0

integer(int64)

4.219. VipInventory

名称说明架构

createDate
可选

例子 : "Timestamp"

description
可选

例子 : "string"

string

gateway
可选

例子 : "string"

string

ip
可选

例子 : "string"

string

l3NetworkUuid
可选

例子 : "string"

string

lastOpDate
可选

例子 : "Timestamp"

name
可选

例子 : "string"

string

netmask
可选

例子 : "string"

string

peerL3NetworkUuids
可选

例子 : [ "object" ]

< object > array

prefixLen
可选

例子 : 0

integer(int32)

serviceProvider
可选

例子 : "string"

string

servicesRefs
可选

例子 : [ "object" ]

< object > array

state
可选

例子 : "string"

string

system
可选

例子 : true

boolean

useFor
可选

例子 : "string"

string

uuid
可选

例子 : "string"

string

4.220. VirtualGroupDetailVo

名称说明架构

buckets
可选

包含Bucket列表
例子 : [ "BucketVo" ]

< BucketVo > array

cnds
可选

包含CDN列表
例子 : [ "CdnVo" ]

< CdnVo > array

createTime
可选

虚拟分组创建时间
例子 : "string"

string(date-time)

hosts
可选

包含主机列表
例子 : [ "HostVo" ]

< HostVo > array

id
可选

虚拟分组ID
例子 : 0

integer(int64)

name
可选

虚拟分组名称
例子 : "string"

string

parentVgId
可选

父级分组ID
例子 : 0

integer(int64)

requestId
可选

请求ID
例子 : "string"

string

teamId
可选

所属团队ID
例子 : 0

integer(int64)

4.221. VirtualGroupResult

名称说明架构

requestId
可选

请求ID
例子 : "string"

string

vgs
可选

例子 : [ "VirtualGroupVo" ]

< VirtualGroupVo > array

4.222. VirtualGroupVo

名称说明架构

createTime
可选

虚拟分组创建时间
例子 : "string"

string(date-time)

id
可选

虚拟分组ID
例子 : 0

integer(int64)

name
可选

虚拟分组名称
例子 : "string"

string

parentVgId
可选

父级分组ID
例子 : 0

integer(int64)

requestId
可选

请求ID
例子 : "string"

string

teamId
可选

所属团队ID
例子 : 0

integer(int64)

4.223. VirtualRouterOfferingInventory

名称说明架构

allocatorStrategy
可选

例子 : "string"

string

cpuNum
可选

例子 : 0

integer(int32)

cpuSpeed
可选

例子 : 0

integer(int32)

createDate
可选

例子 : "Timestamp"

description
可选

例子 : "string"

string

imageUuid
可选

例子 : "string"

string

isDefault
可选

例子 : true

boolean

lastOpDate
可选

例子 : "Timestamp"

managementNetworkUuid
可选

例子 : "string"

string

memorySize
可选

例子 : 0

integer(int64)

name
可选

例子 : "string"

string

publicNetworkUuid
可选

例子 : "string"

string

sortKey
可选

例子 : 0

integer(int32)

state
可选

例子 : "string"

string

type
可选

例子 : "string"

string

uuid
可选

例子 : "string"

string

zoneUuid
可选

例子 : "string"

string

4.224. VirtualRouterVmInventory

名称说明架构

agentPort
可选

例子 : 0

integer(int32)

allVolumes
可选

例子 : [ "object" ]

< object > array

allocatorStrategy
可选

例子 : "string"

string

applianceVmType
可选

例子 : "string"

string

clusterUuid
可选

例子 : "string"

string

cpuNum
可选

例子 : 0

integer(int32)

cpuSpeed
可选

例子 : 0

integer(int64)

createDate
可选

例子 : "Timestamp"

defaultL3NetworkUuid
可选

例子 : "string"

string

defaultRouteL3NetworkUuid
可选

例子 : "string"

string

description
可选

例子 : "string"

string

haStatus
可选

例子 : "string"

string

hostUuid
可选

例子 : "string"

string

hypervisorType
可选

例子 : "string"

string

imageUuid
可选

例子 : "string"

string

instanceOfferingUuid
可选

例子 : "string"

string

lastHostUuid
可选

例子 : "string"

string

lastOpDate
可选

例子 : "Timestamp"

managementNetworkUuid
可选

例子 : "string"

string

memorySize
可选

例子 : 0

integer(int64)

name
可选

例子 : "string"

string

platform
可选

例子 : "string"

string

publicNetworkUuid
可选

例子 : "string"

string

rootVolumeUuid
可选

例子 : "string"

string

state
可选

例子 : "string"

string

status
可选

例子 : "string"

string

type
可选

例子 : "string"

string

uuid
可选

例子 : "string"

string

virtualRouterVips
可选

例子 : [ "object" ]

< object > array

vmCdRoms
可选

例子 : [ "object" ]

< object > array

vmNics
可选

例子 : [ "object" ]

< object > array

zoneUuid
可选

例子 : "string"

string

4.225. VmInstanceInventory

名称说明架构

allVolumes
可选

例子 : [ "object" ]

< object > array

allocatorStrategy
可选

例子 : "string"

string

clusterUuid
可选

例子 : "string"

string

cpuNum
可选

例子 : 0

integer(int32)

cpuSpeed
可选

例子 : 0

integer(int64)

createDate
可选

例子 : "Timestamp"

defaultL3NetworkUuid
可选

例子 : "string"

string

description
可选

例子 : "string"

string

hostUuid
可选

例子 : "string"

string

hypervisorType
可选

例子 : "string"

string

imageUuid
可选

例子 : "string"

string

instanceOfferingUuid
可选

例子 : "string"

string

lastHostUuid
可选

例子 : "string"

string

lastOpDate
可选

例子 : "Timestamp"

memorySize
可选

例子 : 0

integer(int64)

name
可选

例子 : "string"

string

platform
可选

例子 : "string"

string

rootVolumeUuid
可选

例子 : "string"

string

state
可选

例子 : "string"

string

type
可选

例子 : "string"

string

uuid
可选

例子 : "string"

string

vmCdRoms
可选

例子 : [ "object" ]

< object > array

vmNics
可选

例子 : [ "object" ]

< object > array

zoneUuid
可选

例子 : "string"

string

4.226. VmNicInventory

名称说明架构

createDate
可选

例子 : "Timestamp"

deviceId
可选

例子 : 0

integer(int32)

gateway
可选

例子 : "string"

string

hypervisorType
可选

例子 : "string"

string

ip
可选

例子 : "string"

string

ipVersion
可选

例子 : 0

integer(int32)

l3NetworkUuid
可选

例子 : "string"

string

lastOpDate
可选

例子 : "Timestamp"

mac
可选

例子 : "string"

string

metaData
可选

例子 : "string"

string

netmask
可选

例子 : "string"

string

usedIps
可选

例子 : [ "object" ]

< object > array

uuid
可选

例子 : "string"

string

vmInstanceUuid
可选

例子 : "string"

string

4.227. VpcRouterVmInventory

名称说明架构

agentPort
可选

例子 : 0

integer(int32)

allVolumes
可选

例子 : [ "object" ]

< object > array

allocatorStrategy
可选

例子 : "string"

string

applianceVmType
可选

例子 : "string"

string

clusterUuid
可选

例子 : "string"

string

cpuNum
可选

例子 : 0

integer(int32)

cpuSpeed
可选

例子 : 0

integer(int64)

createDate
可选

例子 : "Timestamp"

defaultL3NetworkUuid
可选

例子 : "string"

string

defaultRouteL3NetworkUuid
可选

例子 : "string"

string

description
可选

例子 : "string"

string

dns
可选

例子 : [ "object" ]

< object > array

haRef
可选

例子 : [ "object" ]

< object > array

haStatus
可选

例子 : "string"

string

hostUuid
可选

例子 : "string"

string

hypervisorType
可选

例子 : "string"

string

imageUuid
可选

例子 : "string"

string

instanceOfferingUuid
可选

例子 : "string"

string

lastHostUuid
可选

例子 : "string"

string

lastOpDate
可选

例子 : "Timestamp"

managementNetworkUuid
可选

例子 : "string"

string

memorySize
可选

例子 : 0

integer(int64)

name
可选

例子 : "string"

string

platform
可选

例子 : "string"

string

publicNetworkUuid
可选

例子 : "string"

string

rootVolumeUuid
可选

例子 : "string"

string

state
可选

例子 : "string"

string

status
可选

例子 : "string"

string

type
可选

例子 : "string"

string

uuid
可选

例子 : "string"

string

virtualRouterVips
可选

例子 : [ "object" ]

< object > array

vmCdRoms
可选

例子 : [ "object" ]

< object > array

vmNics
可选

例子 : [ "object" ]

< object > array

zoneUuid
可选

例子 : "string"

string

4.228. VpcVo

名称说明架构

regionId
可选

区域ID
例子 : "string"

string

requestId
可选

请求ID
例子 : "string"

string

subnets
可选

子网
例子 : [ "SubnetVo" ]

< SubnetVo > array

vpcCidr
可选

VPC CIDR
例子 : "string"

string

vpcId
可选

VPC ID
例子 : "string"

string

vpcName
可选

VPC名称
例子 : "string"

string

4.229. WorkTaskVo

名称说明架构

action
可选

操作人动作：如果未处理，则为null
例子 : "string"

enum (start, assign, approve, deny, completed, cancel, fail, error, timeout, giveup, close, approveByCode, failByCode)

applicantAccount
可选

发起人账号
例子 : "string"

string

applicantId
可选

发起人ID
例子 : 0

integer(int64)

applicantName
可选

发起人名称
例子 : "string"

string

applicantTeamId
可选

发起人所属团队ID
例子 : 0

integer(int64)

createTime
可选

工作项创建时间
例子 : "string"

string(date-time)

finishTime
可选

工作项完成时间
例子 : "string"

string(date-time)

id
可选

工作项ID
例子 : 0

integer(int64)

instanceDescription
可选

流程实例的描述
例子 : "string"

string

instanceId
可选

流程实例ID
例子 : 0

integer(int64)

instanceSubject
可选

流程实例的主题
例子 : "string"

string

operatorAccount
可选

操作人账号
例子 : "string"

string

operatorId
可选

操作人ID
例子 : 0

integer(int64)

operatorName
可选

操作人名称
例子 : "string"

string

operatorTeamId
可选

操作人所属团队ID
例子 : 0

integer(int64)

result
可选

工作项处理结果
例子 : "string"

string

stage
可选

操作人参与类型
例子 : "string"

enum (MyStarted, MyPending, MyDone)

startTime
可选

工作项开始时间
例子 : "string"

string(date-time)

status
可选

工作项状态
例子 : "string"

enum (Pending, Handing, Approved, Completed, Denied, Canceled, Failed, Invalid, Timeout, Closed)

subject
可选

工作项主题
例子 : "string"

string

templateId
可选

流程模版ID
例子 : 0

integer(int64)

templateName
可选

流程模版名称
例子 : "string"

string

updateTime
可选

工作项更新时间
例子 : "string"

string(date-time)

workNodeName
可选

工作节点名称
例子 : "string"

string

workType
可选

工作项类型
例子 : "string"

enum (Common, ApplyProduct, HostAccessAudit, CommandAudit, CustomService, CreateHost, AllocateHost, RunScriptAudit, FileTransferAudit)

4.230. WorkTaskVoResult

名称说明架构

size
可选

当前记录数
例子 : 0

integer(int32)

tasks
可选

例子 : [ "WorkTaskVo" ]

< WorkTaskVo > array

total
可选

总记录数
例子 : 0

integer(int64)

4.231. WorkflowInstanceVo

名称说明架构

closed
可选

流程是否已经结束
例子 : false

boolean

createTime
可选

流程发起时间
例子 : "string"

string(date-time)

creatorId
可选

流程发起人ID
例子 : 0

integer(int64)

creatorName
可选

流程发起人昵称
例子 : "string"

string

description
可选

流程内容
例子 : "string"

string

id
可选

流程ID
例子 : 0

integer(int64)

result
可选

流程当前处理结果
例子 : "string"

string

status
可选

流程当前状态
例子 : "string"

enum (Pending, Handing, Approved, Completed, Denied, Canceled, Failed, Invalid, Timeout, Closed)

subject
可选

流程主题
例子 : "string"

string

teamId
可选

流程所属团队
例子 : 0

integer(int64)

templateId
可选

流程模版ID
例子 : 0

integer(int64)

timeout
可选

流程超时时间
例子 : 0

integer(int32)

updateTime
可选

流程的更新时间
例子 : "string"

string(date-time)

workType
可选

业务类型
例子 : "string"

enum (Common, ApplyProduct, HostAccessAudit, CommandAudit, CustomService, CreateHost, AllocateHost, RunScriptAudit, FileTransferAudit)

4.232. WorkflowInstanceVoResult

名称说明架构

page
可选

当前第几页
例子 : 0

integer(int32)

requestId
可选

请求ID
例子 : "string"

string

size
可选

每页记录条数
例子 : 0

integer(int32)

total
可选

总共多少条记录
例子 : 0

integer(int32)

workflowInstances
可选

例子 : [ "WorkflowInstanceVo" ]

< WorkflowInstanceVo > array

4.233. ZStackHostSpecListResult

名称说明架构

hostSpecs
可选

zstack计算规格列表
例子 : [ "ZStackHostSpecVo" ]

< ZStackHostSpecVo > array

requestId
可选

请求ID
例子 : "string"

string

4.234. ZStackHostSpecVo

名称说明架构

allocatorStrategy
可选

物理机分配策略
例子 : "string"

string

cpuNum
可选

cpu数量
例子 : 0

integer(int32)

createDate
可选

创建时间
例子 : "string"

string(date-time)

description
可选

描述
例子 : "string"

string

id
可选

uuid
例子 : "string"

string

memorySizeInMb
可选

内存大小(Mb)
例子 : 0

integer(int64)

name
可选

名称
例子 : "string"

string

state
可选

状态
例子 : "string"

string

4.235. ZStackL3NetworkIpStatistic

名称说明架构

createDate
可选

例子 : "Timestamp"