1. 概观
1.3. 标签
-
1 user api : 用户操作API
-
2 team api : 团队操作API
-
3 cloud api : 云账户操作API
-
4 host api : 主机操作API
-
5 log api : 日志API
-
6 role api : 角色管理API
-
7 tag api : 标签操作API
-
8 virtual group api : 虚拟分组API
-
9 job api : 异步任务API
-
11 script api : 脚本API
-
12 monitor api : 监控API
-
13 database api : 数据库API
-
14 notice api : 公告栏API
-
15 department api : 部门管理API
-
16 system api : 系统管理API
-
17 workflow api : 工单API
-
18 key pair api : 密钥对API
-
19 ops policy api : 运维策略API
-
20 quota api : 配额API
-
20 session api : 会话API
-
21 ops policy api v2 : 运维策略API v2
-
22 authorization api : 授权API
-
23 cas server api : SSO服务端API
-
24 order api : 订单API
-
25 message api : 发送消息API
-
26 network api : 网络API
-
27 image api : 镜像操作API
-
29 image host api : 镜像类主机操作API
-
Credential api : 登录凭证API
-
other api : 其他API
2. 资源
2.1. 1 User Api
用户操作API
2.1.1. 获取用户在团队中的权限列表
GET /functions/byJwt
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
teamId |
团队ID |
integer(int64) |
Query |
jwt |
用户jwt |
string |
Query |
module |
模块 |
string |
Query |
type |
校验类型 |
enum (FUNCTION_CODE, API_PATH, BUSINESS_ROLE) |
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) |
2.1.3. 导入用户
POST /user
说明
设置joinTeam或joinTeamCode可以自动加入新建用户到团队;参数roles用逗号连接多个角色id,如果是系统角色,可以用RoleCode。例如:roles='12,TEAM_ADMINER’表示id=12的角色和团队管理员角色。
HTTP请求示例
请求 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
} ]
}
2.1.4. 获取用户信息(根据账号)
GET /user/byAccount/{account}
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}
2.1.7. 修改或清理用户登录账号(根据账号)
PUT /user/byAccount/{account}/account
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
account |
用户账号 |
string |
Query |
newAccount |
账号,不能与现有系统重复。设置为空或者不设置时,系统生成随机账号。 |
string |
2.1.8. 锁定用户(按账号)
PUT /user/byAccount/{account}/blocked
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Path |
account |
用户账号 |
string |
|
Query |
blockingSeconds |
锁定时间,单位秒,为0时永久锁定 |
integer(int32) |
|
Query |
description |
锁定原因 |
string |
2.1.9. 修改或删除用户邮箱(根据账号)
PUT /user/byAccount/{account}/email
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
account |
用户账号 |
string |
Query |
email |
邮箱,不能跟系统中的已有的邮箱重复。不设置或者为空串时,删除用户的邮箱 |
string |
2.1.10. 查询用户授予的角色列表(按账户)
GET /user/byAccount/{account}/joinedRoles
2.1.11. 查询用户加入的团队列表
GET /user/byAccount/{account}/joinedTeams
2.1.12. 修改用户登录密码
PUT /user/byAccount/{account}/password
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
account |
用户账号 |
string |
Query |
password |
登录密码,长度4~40个字符,不校验复杂性 |
string |
Query |
sendEmail |
是否发送通知邮件,可选。默认为false,只有用户设置了email才会生效。4.11新增属性。 |
boolean |
2.1.14. 获取用户信息(根据邮箱)
GET /user/byEmail/{email}
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
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}
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) |
|
Query |
size |
条数 |
integer(int32) |
|
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 |
2.1.19. 创建或者更新用户扩展属性
POST /user/deleteUserExtendParam
2.1.21. 查询用户扩展属性
GET /user/getUserExtendParams
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
userId |
用户ID |
integer(int64) |
Query |
paramName |
属性名 |
string |
Query |
paramValue |
属性值 |
string |
2.1.22. 根据扩展属性查询用户
GET /user/getUserListByExtendParam
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}
2.1.25. 根据第三方用户标识查询用户
POST /user/queryByThirdPartyUserId
2.1.26. 创建或者更新用户扩展属性
POST /user/saveOrUpdateUserExtendParam
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
userId |
用户ID |
integer(int64) |
Query |
paramName |
属性名 |
string |
Query |
paramValue |
属性值 |
string |
Query |
description |
描述信息 |
string |
2.1.29. 获取用户信息
GET /user/{id}
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}
2.1.31. 修改或清理用户登录账号
PUT /user/{id}/account
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
id |
用户ID或者账号 |
integer(int64) |
Query |
account |
账号,不能与现有系统中的账号重复。设置为空或者不设置时,系统生成随机账号。 |
string |
2.1.32. 锁定用户
PUT /user/{id}/blocked
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Path |
id |
用户ID |
integer(int64) |
|
Query |
blockingSeconds |
锁定时间,单位秒,缺省为0,为0时永久锁定 |
integer(int32) |
|
Query |
description |
锁定原因 |
string |
2.1.33. 修改或删除用户邮箱
PUT /user/{id}/email
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
id |
用户ID或者账号 |
integer(int64) |
Query |
email |
邮箱,不能跟系统中的已有的邮箱重复。不设置或者为空串时,删除用户的邮箱 |
string |
2.1.36. 修改用户登录密码
PUT /user/{id}/password
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
id |
用户ID |
integer(int64) |
Query |
password |
登录密码,长度4~40个字符,不校验复杂性 |
string |
Query |
sendEmail |
是否发送通知邮件,可选。默认为false,只有用户设置了email才会生效。4.11新增属性。 |
boolean |
2.1.38. 导入单个用户
POST /userV2
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
name |
用户昵称,必填。 |
string |
|
Query |
introduce |
用户签名,可选。用户自定义描述 |
string |
|
Query |
gender |
性别,可选。0:未知;1,:男;2:女。不填时默认值为0。 |
integer(int32) |
|
Query |
address |
地址,可选。 |
string |
|
Query |
forceUpdate |
首次登录强制修改密码,可选。默认为false。4.8新增属性。 |
boolean |
|
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 |
2.1.39. 分页获取用户信息
GET /users
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
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
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
{
"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
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
cursorId |
游标,即用户ID值的下限 |
integer(int64) |
|
Query |
size |
请求记录数,默认20 |
integer(int32) |
|
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
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
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.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。
2.2.3. 修改团队名称和所有者(根据团队code)
PUT /team/byCode/{code}
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
code |
团队code |
string |
Query |
name |
团队名称,可选。如果设置,不能与当前ISV的其他团队重名。私有部署环境必须全局唯一。 |
string |
Query |
creatorAccount |
团队创建者账号,可选。如果设置,必须是当前ISV有权限的用户,私有部署环境可以是任何用户。修改团队创建者会进行转移身份操作。 |
string |
2.2.4. 删除一个团队(根据团队code)
DELETE /team/byCode/{code}
2.2.5. 获取团队所有成员信息(根据团队code)
GET /team/byCode/{code}/members
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Path |
code |
团队code |
string |
|
Query |
page |
页码 |
integer(int32) |
|
Query |
size |
条数 |
integer(int32) |
|
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}
2.2.7. 删除一个团队成员(根据团队code和用户账号)
DELETE /team/byCode/{code}/members/{account}
2.2.8. 获取团队配额信息(根据团队code)
GET /team/byCode/{code}/quota
Caution
|
operation.deprecated |
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
{
"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) |
2.2.14. 修改团队名称和所有者
PUT /team/{id}
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
id |
团队ID |
integer(int64) |
Query |
name |
团队名称,可选。如果设置,不能与当前ISV的其他团队重名。私有部署环境必须全局唯一。 |
string |
Query |
creator |
团队创建者用户ID,可选。如果设置,必须是当前ISV有权限的用户,私有部署环境可以是任何用户。修改团队创建者会进行转移身份操作。 |
integer(int32) |
2.2.15. 修改团队code
PUT /team/{id}/code
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
id |
团队ID |
integer(int64) |
Query |
code |
团队code,必须是字符数字下划线的组合,即[A-Za-z0-9_],全局唯一,不能与保留字段相同 |
string |
2.2.16. 获取团队在线成员数
GET /team/{id}/countOnlineMembers
2.2.17. 获取团队所有成员信息
GET /team/{id}/members
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Path |
id |
团队ID |
integer(int64) |
|
Query |
page |
页码 |
integer(int32) |
|
Query |
size |
条数 |
integer(int32) |
|
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.19. 删除团队成员
DELETE /team/{id}/members/{userIds}
2.2.20. 获取团队配额信息
GET /team/{id}/quota
Caution
|
operation.deprecated |
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 |
说明
仅在私有部署环境使用。返回更新后的配额信息。注意:成员配额不能超过License总配额,因为用户可以加入多个团队,所以团队的成员数仅受License用户数限制。而资源数配额必须满足所有团队资源总配额不能超过License资源配额。
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
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
{
"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.3. 3 Cloud Api
云账户操作API
2.3.1. 批量创建局域网云账户
POST /cloud
2.3.2. 获取区域下可售卖的磁盘规格
GET /cloud/availableDiskTypes
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
cloudId |
云账户ID |
integer(int64) |
Query |
regionId |
区域ID |
string |
Query |
zoneId |
可用区ID |
string |
Query |
instanceType |
实例规格 |
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) |
|
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) |
|
2.3.6. 查询团队所有云账户列表(根据teamCode)
GET /cloud/byTeamCode/{teamCode}
2.3.7. 根据ID查询云账户详情
GET /cloud/detail
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
cloudId |
云账户ID |
integer(int64) |
|
Query |
scope |
云账户来源 |
enum (Console, Portal) |
|
2.3.8. 创建一个Openstack云账号
POST /cloud/openstack
说明
参数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 |
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) |
|
2.3.10. 创建一个公有云云账户,不包括Azure
POST /cloud/public
说明
参数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 |
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) |
|
2.3.11. 获取Proxy安装脚本
GET /cloud/{cloudId}/proxyScript
2.3.14. 修改云账户
PUT /cloud/{id}
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
id |
云账户id |
integer(int64) |
Query |
name |
云账户名称 |
string |
Query |
roles |
新的角色授权 |
string |
2.3.15. 修改(局域网)云账户网段划分规则
PUT /cloud/{id}/cidrRule
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
id |
云账户id |
integer(int64) |
Query |
cidrRule |
网段划分方式 |
enum (auto, manual) |
Query |
cidrs |
cidr串。在cidrRule=manual时必须指定cidr网段 |
string |
2.3.17. 修改云账户内网连接方式
PUT /cloud/{id}/intranetAccessType
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
id |
云账户id |
integer(int64) |
Query |
intranetAccessType |
内网连接方式 |
enum (directly, proxy) |
2.3.21. 创建一个局域网云账户
POST /cloudV2
说明
1,参数roles用逗号连接多个角色id,如果是系统角色,可以用RoleCode。例如:roles='12,TEAM_ADMINER’表示id=12的角色和团队管理员角色。roles不能设置为TEAM_CREATOR。私有部署版包括通过role_templates.json配置的系统角色.。<br/> 2,网段划分方式:4.18新增,默认是auto(自动按C网段划分)。manual:按设定的CIDR划分;cidr串:手工(cidrRule=manual)指定cidr网段,4.18新增,用逗号连接。<br/>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) |
|
Query |
cidrRule |
网段划分方式 |
enum (auto, manual) |
|
Query |
cidrs |
cidr串 |
string |
|
Query |
referencedPolicyId |
参考运维子策略ID |
integer(int64) |
2.4. 4 Host Api
主机操作API
2.4.3. 批量导入局域网主机
POST /host
说明
可以根据vgIds参数选择是否默认把新建主机加入到虚拟分组中,vgIds代表的虚拟分组必须属于当前团队。4.8版本以后,导入主机时创建的物理分组将不再默认授权给所有成员。资源授权请使用虚拟分组API。
2.4.4. 获取云账户主机成本优化建议
GET /host/advice/byCloud/{cloudId}
2.4.5. 获取团队主机成本优化建议
GET /host/advice/byTeam/{teamId}
2.4.7. 获取云账户中所有主机
GET /host/byCloud/{cloudId}
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Path |
cloudId |
云账户id |
integer(int64) |
|
Query |
page |
页码 |
integer(int32) |
|
Query |
size |
条数 |
integer(int32) |
|
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) |
|
Query |
size |
条数 |
integer(int32) |
|
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) |
|
Query |
size |
条数 |
integer(int32) |
|
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}
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
teamId |
所属团队ID |
integer(int64) |
Path |
userId |
用户ID |
integer(int64) |
Query |
cloudId |
云账户ID |
integer(int64) |
Query |
groupId |
物理分组ID |
integer(int64) |
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}
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}
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.15. 查询云账户主机成品评估明细(csv文件下载URL)
GET /host/costCsvUrl/byCloud/{cloudId}
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Path |
cloudId |
所属云账户ID |
integer(int64) |
|
Query |
lang |
表格语言,目前支持:zh,en |
string |
|
Query |
oneoff |
是否一次有效 |
boolean |
|
Query |
expireSeconds |
链接超时时间,单位:秒,取值范围[5min,24hr] |
integer(int64) |
|
2.4.16. 查询团队主机成品评估明细(csv文件下载URL)
GET /host/costCsvUrl/byTeam/{teamId}
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Path |
teamId |
所属团队ID |
integer(int64) |
|
Query |
lang |
表格语言,目前支持:zh,en |
string |
|
Query |
oneoff |
是否一次有效 |
boolean |
|
Query |
expireSeconds |
链接超时时间,单位:秒,取值范围[5min,24hr] |
integer(int64) |
|
2.4.17. 根据内网和公网IP获取主机信息
GET /host/findByInnerIpAndPublicIp
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
teamId |
团队ID |
integer(int64) |
Query |
cloudId |
云账户id |
integer(int64) |
Query |
innerIp |
内网IP |
string |
Query |
publicIp |
公网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.18. 根据instanceId获取主机信息
GET /host/findByInstanceId
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
teamId |
团队ID |
integer(int64) |
Query |
cloudId |
云账户id |
integer(int64) |
Query |
instanceId |
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
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
teamId |
团队ID |
integer(int64) |
Query |
cloudId |
云账户id |
integer(int64) |
Query |
ip |
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
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
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.24. 导入一台公有云主机,不支持Azure
POST /host/public
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
cloudId |
云账户ID |
integer(int64) |
Query |
regionId |
云厂商区域ID |
string |
Query |
instanceId |
云主机instanceId |
string |
Query |
creatorId |
导入主机的用户ID,不设置时,是团队所有者 |
integer(int64) |
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 |
2.4.30. 获取主机详情
GET /host/{id}
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}
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 |
2.4.34. 获取主机所有快捷方式
GET /host/{id}/shortcuts
2.4.36. 获取主机一个用户的访问串信息
GET /hostAccessAuth/byHost/{hostId}
2.4.37. 删除主机一个用户的访问串
DELETE /hostAccessAuth/byHost/{hostId}
2.4.38. 给指定用户生成指定主机的访问串
POST /hostAccessAuth/{hostId}/{userId}/{credentialId}
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
hostId |
主机ID |
integer(int64) |
Path |
userId |
用户ID |
integer(int64) |
Path |
credentialId |
登陆凭证ID |
integer(int64) |
2.4.41. 添加主机的部门授权
POST /hostDepartmentAuth/{hostId}
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) |
|
Query |
memory |
内存,单位MB |
integer(int32) |
|
Query |
status |
主机状态 |
enum (Unknown, Stopped, Running, Expired, Pending, Starting) |
|
Query |
vgIds |
默认加入的虚拟分组 |
string |
2.4.45. 批量导入公有云主机,不支持Azure
POST /hosts/public
2.5. 5 Log Api
日志API
2.5.1. 插入一条日志记录
POST /log
2.5.2. 查询日志
GET /log
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
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) |
|
Query |
page |
页码 |
integer(int32) |
|
Query |
size |
条数,不超过1000 |
integer(int32) |
|
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) |
|
Query |
size |
条数 |
integer(int32) |
|
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) |
|
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) |
|
Query |
size |
条数 |
integer(int32) |
|
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 |
|
Query |
order |
排序规则,按创建时间排序 |
enum (DESC, ASC) |
|
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.2. 创建角色
POST /role
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
teamId |
所属团队ID |
integer(int64) |
Query |
name |
角色名称 |
string |
Query |
description |
角色描述 |
string |
Query |
functionCodes |
权限code列表,可选,用逗号连接 |
string |
2.6.4. 获取团队中系统角色
GET /role/byCode/{code}
说明
只有系统内置角色才有code,而且同一个code的角色有且只有一个,目前系统内置三个角色:TEAM_CREATOR(团队创建者)、TEAM_ADMINER(管理员)、TEAM_MEMBER(所有成员)。私有部署版可以通过role_templates.json定义系统角色。
2.6.5. 获取团队中系统角色(根据团队code)
GET /role/byRoleAndTeamCode
说明
只有系统内置角色才有code,而且同一个code的角色有且只有一个,目前系统内置三个角色:TEAM_CREATOR(团队创建者)、TEAM_ADMINER(管理员)、TEAM_MEMBER(所有成员)。私有部署版可以通过role_templates.json定义系统角色。
2.6.6. 获取团队所有角色(根据团队code)
GET /role/byTeamCode/{teamCode}
2.6.7. 获取用户在团队中加入的角色列表
GET /role/byTeamCodeAndUserAccount
2.6.9. 更新角色的名称和描述
PUT /role/{id}
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
id |
角色ID |
integer(int64) |
Query |
name |
角色名称 |
string |
Query |
description |
角色描述 |
string |
2.6.10. 获取角色详情
GET /role/{roleId}
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
roleId |
角色ID |
integer(int64) |
Query |
includeMembers |
是否获取成员列表 |
boolean |
Query |
includeFunctionCodes |
是否获取权限代码列表 |
boolean |
2.6.26. 获取角色可见的资源列表
GET /role/{roleId}/resources
Caution
|
operation.deprecated |
2.6.30. 分页获取团队角色列表
GET /roles
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
teamId |
所属团队ID |
integer(int64) |
|
Query |
page |
页码 |
integer(int32) |
|
Query |
size |
条数 |
integer(int32) |
|
2.6.35. 分页获取团队角色列表(根据团队code)
GET /roles/byTeamCode/{teamCode}
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Path |
teamCode |
所属团队code |
string |
|
Query |
page |
页码 |
integer(int32) |
|
Query |
size |
条数 |
integer(int32) |
|
2.7. 7 Tag Api
标签操作API
2.7.1. 新增标签
POST /tag
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
teamId |
所属团队ID |
integer(int64) |
Query |
name |
标签名,如果包含':'字符,则会解析成’标签名称:标签值’的映射;如果没有包含':'字符,则会认为值为null |
string |
2.7.2. 按照标签名给主机打标签
POST /tag/attachToHostByName/{hostIds}
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
teamId |
所属团队ID |
integer(int64) |
Path |
hostIds |
主机id列表,用','连接 |
string |
Query |
name |
标签名称 |
string |
2.7.3. 根据标签名称删除主机的某个标签
DELETE /tag/detachFromHostByName/{hostIds}
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
teamId |
所属团队ID |
integer(int64) |
Path |
hostIds |
主机id列表,用','连接 |
string |
Query |
name |
标签名称,如果包含值,则用':'连接 |
string |
2.7.8. 查询标签下的主机详情列表
GET /tag/{tagId}/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.11. 修改标签名称和标签值
PUT /tag/{tagValueId}
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
tagValueId |
标签值ID |
integer(int64) |
Query |
newName |
新名称 |
string |
Query |
newValue |
新值,如果不设置,则设置为null |
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 |
2.8.3. 获取团队虚拟分组
GET /vg/byTeam/{teamId}
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
teamId |
团队ID |
integer(int64) |
Query |
parentVgId |
父级分组ID,未设置时查询所有分组 |
integer(int64) |
2.8.4. 获取团队虚拟分组(根据团队code)
GET /vg/byTeamCode/{teamCode}
2.8.6. 获取虚拟分组详情
GET /vg/{id}
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 |
2.8.15. 授权分组给组织单元
PUT /vg/{id}/departments
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
id |
虚拟分组id |
integer(int64) |
Query |
departments |
新的组织单元ID列表,用逗号连接,使用空串时删除所有组织单元授权 |
string |
2.9. 9 Job Api
异步任务API
2.10. 11 Script Api
脚本API
2.10.1. 获取预设脚本库的子库
GET /preInstalledLibrary/{libraryId}/subLibrary
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) |
|
Query |
creator |
创建人ID,不设置时是团队拥有者 |
integer(int64) |
2.10.4. 获取脚本库中的脚本
GET /script/byLibrary/{id}
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Path |
id |
脚本库ID |
integer(int64) |
|
Query |
includeContent |
是否包含脚本内容 |
boolean |
|
Query |
page |
页码 |
integer(int32) |
|
Query |
size |
条数 |
integer(int32) |
|
2.10.6. 根据脚本名称查询脚本信息
GET /script/byName
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
libraryId |
脚本库ID |
integer(int64) |
|
Query |
name |
脚本名称 |
string |
|
Query |
includeContent |
是否包含脚本内容 |
boolean |
|
2.10.7. 获取预设脚本库的脚本
GET /script/byPreInstalledLibrary/{libraryId}
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Path |
libraryId |
脚本库ID |
integer(int64) |
|
Query |
includeContent |
是否包含脚本内容 |
boolean |
|
Query |
page |
页码 |
integer(int32) |
|
Query |
size |
条数 |
integer(int32) |
|
2.10.8. 通过Agent执行脚本命令
POST /script/executeCommandWithAgent
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
hostIds |
主机ID列表 |
string |
|
Query |
platform |
平台,linux或者windows |
string |
|
Query |
command |
脚本内容 |
string |
2.10.9. 获取脚本任务执行信息
GET /script/job/{jobId}
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Path |
jobId |
jobId |
integer(int64) |
|
Query |
includeOutput |
是否包含脚本输出 |
boolean |
|
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}
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.12. 创建脚本库
POST /script/library
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
teamId |
所属团队ID |
integer(int64) |
Query |
name |
脚本库名称 |
string |
Query |
description |
脚本库说明 |
string |
Query |
creator |
创建人ID,不设置时是团队拥有者 |
integer(int64) |
2.10.14. 根据名称获取脚本库
GET /script/library/byName
2.10.19. 修改脚本信息
PUT /script/{id}
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
id |
脚本ID |
integer(int64) |
Query |
name |
脚本名称 |
string |
Query |
timeout |
脚本超时 |
integer(int32) |
Query |
description |
脚本描述 |
string |
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 |
2.11.2. 获取主机特定监控项的最后一个数据点
GET /monitor/hostLast/{hostId}
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
hostId |
主机ID |
integer(int64) |
Query |
metrics |
主机监控项(MonitorMetric),用逗号连接 |
string |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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请求示例
请求 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) |
|
Query |
size |
数量 |
integer(int32) |
|
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}
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
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.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 |
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 |
|
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 |
2.13.2. 查询公告列表
GET /notice
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
tagId |
按标签过滤 |
integer(int64) |
|
Query |
status |
状态 |
enum (Unpublished, Published) |
|
Query |
title |
标题 |
string |
|
Query |
sortField |
排序字段:publishTime,createTime,title |
string |
|
Query |
sortOrder |
顺序顺序 |
enum (desc, asc) |
|
Query |
page |
页码:从1开始 |
integer(int32) |
|
Query |
size |
条数 |
integer(int32) |
|
Query |
includeAttachments |
是否包含附件 |
boolean |
|
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.10. 查询公告详情
GET /notice/{id}
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 |
2.13.12. 上传附件(http表单)
POST /notice/{id}/attachment
2.13.13. 修改公告的封面(http表单)
PUT /notice/{id}/coverImg
2.13.14. 发布公告
PUT /notice/{id}/publish
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
id |
公告id |
integer(int64) |
Query |
publishTime |
发布时间,UTC时间,格式"yyyy-MM-dd’T’HH:mm:ss’Z'",不设置时取当前时间 |
string |
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) |
2.14.2. 获取部门结构树
GET /department
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
teamId |
所属团队ID |
integer(int64) |
|
Query |
includeMembers |
是否包含成员 |
boolean |
|
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
{
"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.5. 获取部门信息(不含下级部门,含成员)
GET /department/{departmentId}
2.14.6. 更新部门
PUT /department/{departmentId}
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
departmentId |
部门ID |
integer(int64) |
Query |
name |
部门名称 |
string |
Query |
description |
部门描述 |
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 |
2.15.2. 添加一条LDAP/AD配置
POST /ldap/config
HTTP请求示例
请求 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
HTTP请求示例
请求 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.5. 更新LDAP/AD配置的BaseDn
PUT /ldap/config/baseDn
2.15.6. 获取系统LDAP/AD配置列表
GET /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
HTTP请求示例
请求 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
{
"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未设置时,将生成随机账号,可以设置原来的账号,相当于保留账号,如果设置其他账号,不能与现有用户重复;<br/>newPassword设置时,将按照系统的复杂度规则进行校验,未设置时,不会修改原有用户的本地密码;<br/>generatePassword=true和newPassword不要同时设置;<br/>forceUpdatePwd,emailNewPassword的默认取值:false,当newPassword设置时或者generatePassword=true时,emailNewPassword=true才会生效
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
userId |
用户ID |
integer(int64) |
|
Query |
newAccount |
解绑后的新账号。可选 |
string |
|
Query |
newPassword |
解绑后的新密码。可选 |
string |
|
Query |
generatePassword |
解绑后生成随机密码。默认false |
boolean |
|
Query |
forceUpdatePwd |
下一次登录强制改密码 |
boolean |
|
Query |
emailNewPassword |
是否邮件通知用户(如果设置了邮箱) |
boolean |
|
2.16. 17 Workflow Api
工单API
2.16.1. 查询流程工作项(按创建时间)
GET /workTasks/byCreateTime
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
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
{
"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
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
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) |
|
Query |
size |
请求记录数,默认20 |
integer(int32) |
|
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
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
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
{
"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) |
|
Query |
size |
每页记录数,默认20 |
integer(int32) |
|
Query |
sortField |
排序字段:createTime、status |
string |
|
Query |
sortOrder |
顺序:desc,asc |
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 |
2.17.3. 修改密钥对名称和描述
PUT /keyPair/{id}
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
id |
密钥对ID |
integer(int64) |
Query |
name |
密钥对名称(团队唯一) |
string |
Query |
description |
密钥对描述 |
string |
2.18. 19 Ops Policy Api
运维策略API
2.18.1. 获取策略组子策略列表
GET /opsPolicies/byGroup/{groupId}
Caution
|
operation.deprecated |
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 |
2.18.3. 获取云账户的子策略
GET /opsPolicy/byCloud/{cloudId}
Caution
|
operation.deprecated |
2.18.8. 获取子策略的条目
GET /opsPolicy/{id}/item/{identity}
2.18.10. 修改子策略的条目
PUT /opsPolicy/{id}/items
说明
注意:1,定义策略条目的identity:{category}.{key};<br/>2,更新请求的参数名是条目的identity,参数值是条目取值的字符串形式;<br/>3,当前接口目前仅支持单一取值策略;<br/>4,无法找到identity的参数,都会被忽略掉;<br/>5,返回被修改过的策略条目
2.18.13. 创建策略组
POST /opsPolicyGroup
Caution
|
operation.deprecated |
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
teamId |
团队ID |
integer(int64) |
Query |
name |
策略组名称 |
string |
Query |
hosts |
关联主机ID列表 |
string |
2.18.14. 获取策略组详情
GET /opsPolicyGroup/{id}
Caution
|
operation.deprecated |
2.18.16. 添加主机到策略组
POST /opsPolicyGroup/{id}/hosts
Caution
|
operation.deprecated |
2.18.17. 修改策略组关联主机
PUT /opsPolicyGroup/{id}/hosts
Caution
|
operation.deprecated |
2.18.18. 删除策略组关联的主机
DELETE /opsPolicyGroup/{id}/hosts
Caution
|
operation.deprecated |
2.19. 20 Quota Api
配额API
2.19.1. 获取某个模块的所有购买时长
GET /moduleTerms/{moduleCode}
2.19.3. 获取团队某个模块信息
GET /team/{id}/module/{code}
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.5. 用追加的方式修改团队外部配额的已用(v6)
POST /team/{id}/quota/{code}/increment
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
id |
团队ID |
integer(int64) |
Path |
code |
配额代码 |
string |
Query |
increment |
已用配额的增量 |
integer(int64) |
2.19.6. 更新团队外部配额的已用(v6)
PUT /team/{id}/quota/{code}/used
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
id |
团队ID |
integer(int64) |
Path |
code |
配额代码 |
string |
Query |
used |
已用 |
integer(int64) |
2.20. 20 Session Api
会话API
2.20.2. 根据某个访问串获取唤醒本地工具的url
GET /getOpenNativeUrl
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
account |
访问串用户名 |
string |
Query |
password |
会话账户密码 |
string |
Query |
transitId |
中转服务ID |
integer(int64) |
Query |
endpoint |
中转服务endpoint |
string |
2.20.3. 获取自动打开主机会话的授权URL
GET /oauthSession
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
userId |
登录用户的ID |
integer(int64) |
|
Query |
oneoff |
是否一次有效 |
boolean |
|
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) |
|
Query |
account |
会话账户,SSH/RDP会话是必须的 |
string |
|
Query |
password |
会话账户密码 |
string |
|
Query |
privateKey |
会话账户密钥 |
string |
|
Query |
privateKeyPass |
密钥的加密密码 |
string |
|
Query |
credentialId |
用户有权限的登录凭证ID,与上面的密码、密钥不要同时使用 |
integer(int64) |
|
Query |
screenResolution |
设置RDP分辨率(默认值1024x768)不设置时取默认值 |
string |
2.20.4. 根据分享code生成某个会话的分享链接url
GET /oauthSessionShare
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
userId |
被分享的用户ID,如果为空则表明要创建临时用户 |
integer(int64) |
Query |
shareCode |
会话分享Code |
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) |
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 |
2.21.2. 获取云账户的策略
GET /v2/opsPolicy/byCloud/{cloudId}
2.21.9. 获取策略条目
GET /v2/opsPolicy/{id}/item/{identity}
2.21.11. 修改策略的条目
PUT /v2/opsPolicy/{id}/items
说明
注意:1,定义策略条目的identity:{category}.{key};<br/>2,更新请求的参数名是条目的identity,参数值是条目取值的字符串形式;<br/>3,当前接口目前仅支持单一取值策略;<br/>4,无法找到identity的参数,都会被忽略掉;<br/>5,返回被修改过的策略条目
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 |
2.22.2. 获取某个资源的授权信息
GET /resource/{type}/{id}/authorization
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
teamId |
团队ID |
integer(int64) |
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) |
2.22.3. 更新某个资源的授权信息
PUT /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 |
2.22.4. 撤销某个资源的授权信息
DELETE /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 |
2.22.5. 获取用户有权限访问的所有资源
GET /resources/{type}/byUser/{userId}
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
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) |
Query |
teamId |
团队ID |
integer(int64) |
Path |
userId |
用户ID |
integer(int64) |
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) |
|
Query |
teamId |
指定所属团队 |
integer(int64) |
|
Query |
logoutType |
SLO单点登出方式,默认是back channel |
enum (back, front) |
|
Query |
logoutUrl |
指定app全局的登录URL,如果未指定,将使用SSO过程中的service参数发起注销 |
string |
|
Query |
evaluationOrder |
匹配服务ID的顺序 |
integer(int32) |
|
Query |
forceLogout |
注销CasServer强制注销SSO会话 |
boolean |
|
2.24. 24 Order Api
订单API
2.24.1. 查询团队某个模块的所有订单
GET /order/byModule
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
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) |
|
Query |
size |
条数 |
integer(int32) |
|
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) |
|
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 |
|
Query |
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
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) |
|
Query |
size |
条数 |
integer(int32) |
|
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 |
2.25.2. 发送短信消息
POST /message/sms
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
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 |
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
{
"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 |
2.26.3. 把主机加入到安全组中
POST /network/joinHostToSecurityGroup
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
cloudId |
云账户ID |
integer(int64) |
Query |
hostId |
主机ID |
integer(int64) |
Query |
securityGroupId |
安全组ID |
string |
2.26.4. 从安全组中移除主机
POST /network/removeHostFromSecurityGroup
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
cloudId |
云账户ID |
integer(int64) |
Query |
hostId |
主机ID |
integer(int64) |
Query |
securityGroupId |
安全组ID |
string |
2.26.5. 列出安全组的所有规则
GET /network/securityGroupRules
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
cloudId |
云账户ID |
integer(int64) |
Query |
regionId |
区域ID |
string |
Query |
securityGroupId |
安全组ID |
string |
2.26.6. 列出云账户的某个VPC下的所有安全组
GET /network/securityGroups
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Query |
cloudId |
云账户ID |
integer(int64) |
Query |
regionId |
区域ID |
string |
Query |
vpcId |
VPC ID,腾讯云没有该参数 |
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
{
"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) |
|
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 |
|
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请求示例
请求 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"
}
2.26.9. 删除zstack虚拟网络
DELETE /network/zstack/virtualNetwork/{l3NetworkId}
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
clientToken |
保证请求幂等性 |
string |
|
Query |
cloudId |
云账户ID |
integer(int64) |
|
Query |
scope |
云账户来源 |
enum (Console, Portal) |
|
Path |
l3NetworkId |
L3网络Id |
string |
|
Query |
safeDeleteL2Network |
是否同时删除二层网络 |
boolean |
2.26.10. 向ZStack三层网络通过cidr方式添加IP地址范围
POST /network/zstackAddIpRangeByCidrToL3Network/{l3networkId}
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
clientToken |
保证请求幂等性 |
string |
|
Query |
cloudId |
云账户ID |
integer(int64) |
|
Query |
scope |
云账户来源 |
enum (Console, Portal) |
|
Path |
l3networkId |
三层网络Id |
string |
|
Query |
name |
ip地址范围名称 |
string |
|
Query |
cidr |
网络CIDR |
string |
|
Query |
dhcpIp |
DHCP服务IP |
string |
|
Query |
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) |
|
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
{
"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) |
|
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
{
"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) |
|
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
{
"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) |
|
Path |
dns |
dns地址 |
string |
|
Path |
l3networkId |
三层网络Id |
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) |
|
Path |
dns |
dns地址 |
string |
|
Path |
l3networkId |
三层网络Id |
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) |
|
Query |
l3networkIds |
所属三层网络Id |
< string > array(multi) |
|
Query |
ipRangeIds |
ip范围Id列表 |
< string > array(multi) |
2.26.17. 删除ZStackIP地址范围
DELETE /network/zstackIpRange/{ipRangeId}
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
clientToken |
保证请求幂等性 |
string |
|
Query |
cloudId |
云账户ID |
integer(int64) |
|
Query |
scope |
云账户来源 |
enum (Console, Portal) |
|
Path |
ipRangeId |
ip范围Id |
string |
|
Query |
deleteMode |
删除方式 |
enum (Permissive, Enforcing) |
2.26.18. 列出zstackIP地址范围
GET /network/zstackIpRanges
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
cloudId |
云账户ID |
integer(int64) |
|
Query |
scope |
云账户来源 |
enum (Console, Portal) |
|
Query |
ipRangeIds |
ip范围Id列表 |
< string > array(multi) |
|
Query |
l2networkId |
所属二层网络Id |
string |
|
Query |
l3networkId |
所属三层网络Id |
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) |
|
Path |
l3NetworkId |
三层网络Id |
string |
|
Query |
ipResourceType |
ip资源类型 |
enum (Vip, VM) |
|
Query |
ipAddress |
ip地址 |
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) |
|
2.26.21. 查询所有zstackL2网络
GET /network/zstackL2/networks
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
cloudId |
云账户ID |
integer(int64) |
|
Query |
scope |
云账户来源 |
enum (Console, Portal) |
|
Query |
networkIds |
二层网络Id列表 |
< string > array(multi) |
|
Query |
physicalInterface |
物理网卡 |
string |
|
Query |
startIp |
起始ip |
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) |
|
Query |
name |
二层网络名称 |
string |
|
Query |
physicalInterface |
物理网卡(eth1, eno1) |
string |
|
Query |
description |
二层网络的详细描述 |
string |
|
Query |
clusterId |
加入到的集群Id |
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) |
|
Query |
name |
二层网络名称 |
string |
|
Query |
vLanId |
VLanId |
integer(int32) |
|
Query |
physicalInterface |
物理网卡(eth1, eno1) |
string |
|
Query |
description |
二层网络的详细描述 |
string |
|
Query |
clusterId |
加入到的集群Id |
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) |
|
Query |
networkIds |
二层网络Id列表 |
< string > array(multi) |
|
Query |
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) |
|
Query |
name |
二层网络名称 |
string |
|
Query |
vxLanPoolId |
VxLan池Id |
string |
|
Query |
description |
二层网络的详细描述 |
string |
|
Query |
vni |
vni |
integer(int32) |
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) |
|
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
{
"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) |
|
Query |
networkIds |
二层网络Id列表 |
< string > array(multi) |
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) |
|
Query |
networkIds |
二层网络Id列表 |
< string > array(multi) |
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) |
|
Path |
networkId |
L2网络Id |
string |
|
Query |
deleteMode |
删除方式 |
enum (Permissive, Enforcing) |
2.26.30. 将zstack二层网络加入集群
POST /network/zstackL2/{networkId}/attachTo/{clusterId}
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
clientToken |
保证请求幂等性 |
string |
|
Query |
cloudId |
云账户ID |
integer(int64) |
|
Query |
scope |
云账户来源 |
enum (Console, Portal) |
|
Path |
networkId |
二层网络Id |
string |
|
Path |
clusterId |
加入到的集群Id |
string |
|
Query |
cidr |
VTEP 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) |
|
Query |
networkIds |
L3网络Id |
< string > array(multi) |
|
Query |
deleteMode |
删除方式 |
enum (Permissive, Enforcing) |
2.26.32. 查询所有zstackL3网络
GET /network/zstackL3/networks
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
cloudId |
云账户ID |
integer(int64) |
|
Query |
scope |
云账户来源 |
enum (Console, 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
{
"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) |
|
Query |
l2NetworkId |
二层网络Id |
string |
|
Query |
name |
三层网络名称 |
string |
|
Query |
description |
三层网络描述 |
string |
|
Query |
dnsDomain |
DNS域 |
string |
|
Query |
mirrorNetworkId |
镜像网络Id |
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) |
|
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
{
"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) |
|
Query |
l2NetworkId |
二层网络Id |
string |
|
Query |
name |
三层网络名称 |
string |
|
Query |
description |
三层网络描述 |
string |
|
Query |
dnsDomain |
DNS域 |
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) |
|
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) |
|
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
{
"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) |
|
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
{
"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) |
|
Query |
vpcRouterId |
vpc路由Id |
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) |
|
Path |
vpcRouterId |
vpc路由Id |
string |
|
Path |
dns |
DNS |
string |
|
Query |
action |
操作(添加/删除) |
enum (add, remove) |
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) |
|
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
{
"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) |
|
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请求示例
请求 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 |
2.27.2. 查询zstack镜像列表
GET /image/cloud/{cloudId}/zstackList
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Path |
cloudId |
云账户ID |
integer(int64) |
|
Query |
scope |
云账户来源 |
enum (Console, Portal) |
|
Query |
imageId |
镜像Id |
string |
|
Query |
status |
镜像状态 |
enum (Ready, Creating, Downloading) |
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) |
|
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 |
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) |
|
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) |
|
HTTP请求示例
请求 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) |
|
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) |
|
2.28.4. 创建ZStack计算规格
POST /imageHost/cloud/{cloudId}/zstackSpec
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
clientToken |
保证请求幂等性 |
string |
|
Path |
cloudId |
云账户ID |
integer(int64) |
|
Query |
scope |
云账户来源 |
enum (Console, Portal) |
|
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请求示例
请求 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"
}
2.28.5. 查询ZStack计算规格
GET /imageHost/cloud/{cloudId}/zstackSpecs
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Path |
cloudId |
云账户ID |
integer(int64) |
|
Query |
scope |
云账户来源 |
enum (Console, Portal) |
|
Query |
instanceOfferingIds |
计算规格Id列表 |
< string > array(multi) |
|
Query |
name |
计算规格名 |
string |
|
Query |
cpuNum |
cpu核数(大于等于) |
integer(int32) |
|
Query |
memorySizeInMb |
内存大小(Mb)(大于等于) |
integer(int64) |
|
Query |
allocatorStrategy |
物理机分配策略 |
enum (DefaultHostAllocatorStrategy, LeastVmPreferredHostAllocatorStrategy, MinimumCPUUsageHostAllocatorStrategy, MinimumMemoryUsageHostAllocatorStrategy, MaxInstancePerHostHostAllocatorStrategy, LastHostPreferredAllocatorStrategy) |
|
Query |
usingState |
使用状态 |
enum (Enabled, Disabled, Maintenance) |
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) |
|
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) |
|
Query |
instanceChargeType |
实例收费类型 |
enum (PrePaid, PostPaid) |
|
Query |
internetChargeType |
网络类型 |
enum (PayByBandwidth, PayByTraffic) |
|
Query |
internetMaxBandwidthOut |
最大公网出口带宽 |
integer(int32) |
|
Query |
period |
购买时长 |
integer(int32) |
|
Query |
periodUnit |
时长单位 |
enum (Hour, Week, Month, Year) |
|
Query |
systemDisk |
系统盘,格式如{"category" : "SSD", "size" : 10} |
string |
|
Query |
dataDisks |
数据盘,格式如[{"category" : "SSD", "size" : 10, "deleteWithInstance" : true}] |
string |
HTTP请求示例
请求 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.8. 查询购买虚拟机每个月的预估费用
POST /imageHost/inquiryPriceMonthly
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
vendor |
供应商 |
string |
|
Query |
cloudId |
云账户ID |
integer(int64) |
|
Query |
scope |
云账户来源 |
enum (Console, 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) |
|
Query |
instanceChargeType |
实例收费类型 |
enum (PrePaid, PostPaid) |
|
Query |
internetChargeType |
网络类型 |
enum (PayByBandwidth, PayByTraffic) |
|
Query |
internetMaxBandwidthOut |
最大公网出口带宽 |
integer(int32) |
|
Query |
period |
购买时长 |
integer(int32) |
|
Query |
periodUnit |
时长单位 |
enum (Hour, Week, Month, Year) |
|
Query |
systemDisk |
系统盘,格式如{"category" : "SSD", "size" : 10} |
string |
|
Query |
dataDisks |
数据盘,格式如[{"category" : "SSD", "size" : 10, "deleteWithInstance" : true}] |
string |
HTTP请求示例
请求 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"
}
2.28.9. 更改zstack实例规格状态
PUT /imageHost/zstackInstanceOffering/{instanceOfferingId}
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
clientToken |
保证请求幂等性 |
string |
|
Query |
cloudId |
云账户ID |
integer(int64) |
|
Query |
scope |
云账户来源 |
enum (Console, Portal) |
|
Path |
instanceOfferingId |
实例规格Id |
string |
|
Query |
stateEvent |
状态(启用/停用) |
enum (enable, disable) |
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) |
|
Path |
instanceOfferingId |
实例规格Id |
string |
|
Query |
deleteMode |
删除方式 |
enum (Permissive, Enforcing) |
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) |
|
Path |
instanceId |
实例Id |
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.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
{
"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
{
"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
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
Path |
hostId |
主机ID |
integer(int64) |
Query |
metrics |
主机监控项(MonitorMetric),用逗号连接 |
string |
2.28.16. 续费虚拟机
POST /imageHost/{hostId}/renew
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
clientToken |
保证请求幂等性,最大值不超过64个ASCII字符 |
string |
|
Path |
hostId |
主机ID |
integer(int64) |
|
Query |
period |
包年包月续费时长 |
integer(int32) |
|
Query |
periodUnit |
续费时长的时间单位 |
enum (Week, Month, Year) |
|
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) |
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
{
"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 |
2.28.23. 获取主机详情
GET /imageHost/{id}
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配置的系统角色
响应
HTTP代码 | 说明 | 架构 |
---|---|---|
200 |
OK |
|
201 |
Credential created successfully |
|
400 |
parameter error |
无内容 |
409 |
credential name conflict |
无内容 |
HTTP请求示例
请求 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
}
2.29.2. 获取主机登录凭证列表
GET /credential/byHost/{hostId}
2.29.3. 获取团队登录凭证列表(根据团队teamId)
GET /credential/byTeam/{teamId}
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Path |
teamId |
团队ID |
integer(int64) |
|
Query |
page |
页码 |
integer(int32) |
|
Query |
size |
条数 |
integer(int32) |
|
2.29.4. 获取团队登录凭证列表(根据团队code)
GET /credential/byTeamCode/{teamCode}
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Path |
teamCode |
团队code |
string |
|
Query |
page |
页码 |
integer(int32) |
|
Query |
size |
条数 |
integer(int32) |
|
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 |
2.29.7. 获取登录凭证主机列表
GET /credential/{credentialId}/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
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 |
2.30. Other Api
其他API
2.30.3. 获取OAuth Token(客户端不需要认证)
GET /oauth
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
accessKeyId |
accessKeyId |
string |
|
Query |
accessKeySecret |
accessKeySecret |
string |
|
Query |
expireSeconds |
超时时间,单位秒,取值范围:[120,86400] |
integer(int32) |
|
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 |
2.30.5. 获取自动登的录授权URL
GET /oauthLogin
参数
类型 | 名称 | 说明 | 架构 | 默认列 |
---|---|---|---|---|
Query |
userId |
登录用户的ID |
integer(int64) |
|
Query |
oneoff |
是否一次有效 |
boolean |
|
Query |
expireSeconds |
链接超时时间,单位:秒,取值范围[5min,24hr] |
integer(int64) |
|
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) |
|
Query |
workflowInstanceId |
如果设置了,登录后重定向到对应的工单流程 |
integer(int64) |
|
Query |
redirectUrl |
重定向URL。如果设置了,登录后打开特定URL,优先级比page和hostId高 |
string |
2.30.10. 查询系统配额以及使用情况
GET /quota
Caution
|
operation.deprecated |
2.30.11. 发送短信
POST /sms
2.30.12. 发送短信,支持国际手机号
POST /smsV2
4. 定义
4.1. AccessAuthResult
名称 | 说明 | 架构 |
---|---|---|
account |
账号 |
string |
credentialId |
登陆凭证ID |
integer(int64) |
hostId |
主机ID |
integer(int64) |
id |
访问串ID |
integer(int64) |
password |
密码 |
string |
port |
服务端口 |
integer(int32) |
requestId |
请求ID |
string |
serverAddr |
跳板机地址 |
string |
userId |
用户ID |
integer(int64) |
4.2. Actor
名称 | 说明 | 架构 |
---|---|---|
avatar |
操作人头像地址 |
string |
id |
操作人用户ID |
integer(int64) |
name |
操作人账号 |
string |
nickname |
操作人昵称 |
string |
teamNickname |
操作人团队昵称 |
string |
uid |
操作人UID |
string |
4.3. AddLdapConfigRequest
名称 | 说明 | 架构 |
---|---|---|
accountAttr |
账号映射属性:LDAP/AD用户的某个属性,映射到门户用户的账号。取值全局唯一。对于AD域建议使用userPrincipalName |
string |
accountSuffix |
导入门户后的账号的后缀。可选。在多个LDAP server的账号映射无法唯一时使用 |
string |
baseDn |
Base DN |
string |
connectTimeout |
连接超时 |
integer(int32) |
emailAttr |
邮箱映射属性,可选。 |
string |
filterOrgUnit |
部门过滤器,默认是objectClass=organizationalUnit |
string |
filterPerson |
用户过滤器,默认是objectClass=person |
string |
genderAttr |
性别映射属性,可选。 |
string |
ip |
LDAP协议连接的IP |
string |
nicknameAttr |
昵称映射属性:LDAP/AD用户的某个属性,映射到门户用户的昵称。对于AD域建议使用cn |
string |
password |
LDAP Server的管理员密码 |
string |
phoneAttr |
手机号映射属性,可选。 |
string |
port |
LDAP协议连接的端口 |
integer(int32) |
userName |
LDAP Server的管理员账号 |
string |
4.4. AddLogRequest
名称 | 说明 | 架构 |
---|---|---|
action |
操作名称 |
string |
actionSource |
事件源 |
string |
actorId |
操作人 |
integer(int64) |
cluster |
日志分类,以EXT_开头 |
string |
createTime |
创建时间,UTC时间,格式"yyyy-MM-dd’T’HH:mm:ss’Z'" |
string |
errorCode |
错误码 |
string |
errorMsg |
错误信息 |
string |
extraInfo |
额外信息 |
object |
remoteIp |
操作人远程IP |
string |
status |
日志状态 |
string |
teamId |
所属团队ID |
integer(int64) |
4.6. AggregationData
名称 | 说明 | 架构 |
---|---|---|
dataPoints |
聚合函数的数据点。{funcName=>value} |
< string, number(double) > map |
4.7. AkAccessToken
名称 | 说明 | 架构 |
---|---|---|
expireTime |
Token超时时间 |
string(date-time) |
requestId |
请求ID |
string |
token |
登录的token |
string |
4.8. AuthorizationInfo
名称 | 说明 | 架构 |
---|---|---|
departments |
授权的部门 |
< integer(int64) > array |
members |
授权的团队成员 |
< integer(int64) > array |
roles |
授权的角色 |
< integer(int64) > array |
4.9. BatchHostAggregationData
名称 | 说明 | 架构 |
---|---|---|
batchDataPoints |
批量主机聚合函数值,{hostId=>AggregationData} |
< string, AggregationData > map |
requestId |
请求ID |
string |
4.13. BucketVo
名称 | 说明 | 架构 |
---|---|---|
bucketId |
对象存储ID |
integer(int64) |
cloudId |
所属云账户 |
integer(int64) |
createTime |
导入时间 |
string(date-time) |
importTime |
导入时间 |
string(date-time) |
provider |
所属云厂商 |
string |
regionId |
区域id |
string |
requestId |
请求ID |
string |
teamId |
所属团队 |
integer(int64) |
4.14. CasAppVo
名称 | 说明 | 架构 |
---|---|---|
createTime |
创建时间 |
string(date-time) |
evaluationOrder |
匹配服务ID的顺序 |
integer(int32) |
forceLogout |
注销CasServer强制注销SSO会话 |
boolean |
id |
应用ID |
integer(int64) |
logoutType |
SLO单点登出方式,默认是back |
enum (back, front) |
logoutUrl |
logoutType=back时调用的注销URL |
string |
module |
产品所属模块 |
string |
name |
应用名称 |
string |
requestId |
请求ID |
string |
serviceId |
服务ID,全局唯一 |
string |
serviceType |
服务ID的匹配规则,默认是Identical,即完全相同 |
enum (Identical, Regex) |
teamId |
应用所属团队,为null时是全局应用 |
integer(int64) |
4.15. CdnVo
名称 | 说明 | 架构 |
---|---|---|
cdnId |
CDN ID |
integer(int64) |
cloudId |
云账户ID |
integer(int64) |
createTime |
创建时间 |
string(date-time) |
domainName |
域名 |
string |
importTime |
导入时间 |
string(date-time) |
provider |
所属云厂商 |
string |
requestId |
请求ID |
string |
sourceType |
源类型 |
string |
sources |
域名的源 |
string |
sslProtocol |
是否开启ssl |
boolean |
status |
域名状态 |
string |
teamId |
所属团队ID |
integer(int64) |
4.16. CheckJwtResult
名称 | 说明 | 架构 |
---|---|---|
expireTime |
例子 : |
string(date-time) |
jwtTokenId |
例子 : |
string |
msg |
例子 : |
string |
nickName |
例子 : |
string |
requestId |
请求ID |
string |
success |
该jwt是否有效,如果无效,msg解析原因 |
boolean |
userId |
例子 : |
integer(int64) |
4.17. CloudHostResult
名称 | 说明 | 架构 |
---|---|---|
hosts |
主机列表 |
< CloudHostVo > array |
jobId |
任务ID |
integer(int64) |
4.18. CloudHostVo
名称 | 说明 | 架构 |
---|---|---|
agentStatus |
Agent的状态:STOPPED,READY |
string |
cloudId |
云账户ID |
integer(int64) |
cloudName |
云账号名称 |
string |
dataDisks |
数据盘 |
< DataDiskVo > array |
description |
主机描述 |
string |
groupId |
主机所在组ID |
integer(int64) |
hostId |
例子 : |
integer(int64) |
hostName |
例子 : |
string |
importTime |
例子 : |
string(date-time) |
innerIp |
例子 : |
string |
installedAgent |
是否安装了Agent |
boolean |
instanceId |
例子 : |
string |
instanceName |
主机名称 |
string |
jobId |
任务ID |
integer(int64) |
macAddr |
MAC地址 |
string |
memory |
例子 : |
integer(int32) |
operatingSystem |
例子 : |
string |
platform |
例子 : |
string |
processorCores |
例子 : |
integer(int32) |
provider |
云厂商 |
string |
proxyHostId |
主机能够访问的Proxy所在主机的ID |
integer(int64) |
proxyInnerIp |
主机能够访问的Proxy内网IP |
string |
proxyInstalledAgent |
主机能够访问的Proxy所在主机的是否已安装Agent |
boolean |
proxyInstanceName |
主机能够访问的Proxy所在主机的实例名称 |
string |
proxyPublicIp |
主机能够访问的Proxy公网IP |
string |
publicIp |
例子 : |
string |
regionId |
区域ID |
string |
scope |
云账户来源,门户:Portal|管理控制台:Console |
enum (Console, Portal) |
status |
主机状态 |
string |
systemDisk |
系统盘 |
|
teamId |
例子 : |
integer(int64) |
zoneId |
可用区ID |
string |
4.19. CloudImageListResult
名称 | 说明 | 架构 |
---|---|---|
images |
镜像列表 |
< CloudImageVo > array |
requestId |
请求ID |
string |
4.20. CloudImageVo
名称 | 说明 | 架构 |
---|---|---|
creationTime |
例子 : |
string(date-time) |
description |
例子 : |
string |
imageId |
例子 : |
string |
imageName |
例子 : |
string |
imageType |
例子 : |
string |
osName |
例子 : |
string |
platform |
例子 : |
string |
regionId |
例子 : |
string |
share |
例子 : |
boolean |
status |
例子 : |
string |
4.21. CloudVo
名称 | 说明 | 架构 |
---|---|---|
accountId |
账号ID |
string |
cloudIntranetAccessType |
内网连接方式 |
enum (directly, proxy) |
createTime |
创建时间 |
string(date-time) |
id |
云账户ID |
integer(int64) |
name |
云账户名称 |
string |
provider |
云账户厂商,比如阿里云:aliyun;腾讯云:qcloud;局域网:private |
string |
requestId |
请求ID |
string |
scope |
云账户来源,门户:Portal|管理控制台:Console |
enum (Console, Portal) |
teamId |
所属团队ID |
integer(int64) |
4.23. CreateCloudRequest
名称 | 说明 | 架构 |
---|---|---|
clouds |
云账户信息列表 |
< CreateCloudVo > array |
4.24. CreateCloudResult
名称 | 说明 | 架构 |
---|---|---|
cloudIds |
例子 : |
< integer(int64) > array |
requestId |
请求ID |
string |
4.25. CreateCloudVo
名称 | 说明 | 架构 |
---|---|---|
cidrRule |
网段划分方式,4.18新增,默认是auto(自动按C网段划分)。manual:按设定的CIDR划分 |
enum (auto, manual) |
cidrs |
手工(cidrRule=manual)指定cidr网段,4.18新增。用逗号连接 |
string |
creatorId |
创建者,未设置时使用团队创建者 |
integer(int64) |
intranetAccessType |
内网连接方式,4.18新增,SAAS必须设置为proxy |
enum (directly, proxy) |
name |
云账户名称,团队内唯一 |
string |
referencedPolicyId |
指定团队内的一个运维子策略ID,新建的云账户的运维策略将引用这个策略中的条目设置默认值,4.18新增 |
integer(int64) |
roles |
4.8新增属性。给云账户授权的角色,用逗号连接多个角色id,如果是系统角色,可以用RoleCode。例如:roles='12,TEAM_ADMINER’表示id=12的角色和团队管理员角色。为了兼容旧API,如果不设置时,默认值是TEAM_MEMBER,而不是空值,即云账户对团队所有用户可见。roles不能设置为TEAM_CREATOR |
string |
teamId |
所属团队ID |
integer(int64) |
4.26. CreateCredentialRequest
名称 | 说明 | 架构 |
---|---|---|
account |
登录账号,VCN协议不需要,但是RDP和SSH需要设置 |
string |
authType |
凭证类型:密码和密钥 |
enum (PASSWORD, KEY_FILE) |
creator |
创建者,默认是团队拥有者 |
integer(int64) |
desktopType |
协议类型:RDP,SSH,VNC |
enum (SSH, RDP, TELNET, APP, VNC, SFTP, FTP, SCP, ALIYUN_VNC, SHELL) |
hosts |
加入主机列表 |
< CredentialHostVo > array |
key |
登录密钥,可选。当authType=KEY_FILE可以设置。与参数password不要同时设置。当CredentialHostVo没有设置时,会使用这个值做默认值。 |
string |
name |
凭证名称,团队唯一。 |
string |
password |
登录密码,可选。当authType=PASSWORD可以设置。与参数key不要同时设置。当CredentialHostVo没有设置时,会使用这个值做默认值。 |
string |
port |
访问端口,未设置时,使用协议默认端口,即SSH:22,RDP:3389,等。 |
integer(int32) |
roles |
授权角色,默认是团队拥有者。用逗号连接多个角色id,如果是系统角色,可以用RoleCode。 |
string |
sshKeyId |
登录密钥对ID,可选。当authType=KEY_FILE可以设置。与参数password和key不要同时设置。当CredentialHostVo没有设置时,会使用这个值做默认值。v4.18添加 |
integer(int64) |
suCommand |
切换用户使用的命令,可选。v4.13新增属性 |
string |
suPassword |
切换用户的密码,可选。v4.13新增属性 |
string |
suUser |
切换用户名,可选。v4.13新增属性 |
string |
teamId |
团队ID |
integer(int64) |
4.27. CreateRoleResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
roleId |
角色id |
integer(int64) |
4.28. CreateZStackL2NoVLanNetworkResult
名称 | 说明 | 架构 |
---|---|---|
l2NoVLanNetwork |
zstack二层网络NoVLan列表 |
|
requestId |
请求ID |
string |
4.29. CreateZStackL2VLanNetworkResult
名称 | 说明 | 架构 |
---|---|---|
l2VLanNetworkInventory |
zstack二层VLan网络 |
|
requestId |
请求ID |
string |
4.30. CreateZStackL2VxLanNetworkResult
名称 | 说明 | 架构 |
---|---|---|
l2VxLanNetwork |
zstack二层VxLan网络 |
|
requestId |
请求ID |
string |
4.31. CreateZStackL2VxLanPoolResult
名称 | 说明 | 架构 |
---|---|---|
l2VxlanPool |
zstack二层VxlanPool网络 |
|
requestId |
请求ID |
string |
4.32. CredentialHostBrief
名称 | 说明 | 架构 |
---|---|---|
authType |
认证方式 |
enum (PASSWORD, KEY_FILE) |
hostId |
主机ID |
integer(int64) |
keySet |
是否设置了密钥 |
boolean |
passwordSet |
是否设置了密码 |
boolean |
port |
访问端口 |
integer(int32) |
suPasswordSet |
是否设置了切换用户的密码 |
boolean |
suSet |
是否设置了切换用户 |
boolean |
4.33. CredentialHostVo
名称 | 说明 | 架构 |
---|---|---|
hostId |
主机ID |
integer(int64) |
key |
当前主机登录密钥,未设置时,使用CreateCredentialRequest中的默认值 |
string |
password |
当前主机登录密码,未设置时,使用CreateCredentialRequest中的默认值 |
string |
port |
访问端口 |
integer(int32) |
sshKeyId |
登录密钥对ID,可选。与参数password和key不要同时设置。v4.18添加 |
integer(int64) |
suPassword |
切换用户的密码,可选。v4.13新增属性。未设置时,使用CreateCredentialRequest中的默认值 |
string |
4.34. CredentialHostsResult
名称 | 说明 | 架构 |
---|---|---|
credential |
例子 : |
|
hosts |
例子 : |
< CredentialHostBrief > array |
requestId |
请求ID |
string |
4.35. CredentialRolesResult
名称 | 说明 | 架构 |
---|---|---|
credential |
例子 : |
|
requestId |
请求ID |
string |
roles |
例子 : |
< RoleVo > array |
4.36. CredentialVo
名称 | 说明 | 架构 |
---|---|---|
authType |
凭证类型:密码或密钥 |
enum (PASSWORD, KEY_FILE) |
createTime |
创建时间 |
string(date-time) |
creatorId |
创建者ID |
integer(int64) |
desktopType |
登录协议,SSH,RDP,等等 |
string |
id |
登录凭证ID |
integer(int64) |
name |
登录凭证名称 |
string |
suCommand |
切换用户的命令 |
string |
suUser |
切换的用户 |
string |
user |
登录账号 |
string |
4.37. DataDiskVo
名称 | 说明 | 架构 |
---|---|---|
category |
磁盘类型 |
string |
deleteWithInstance |
磁盘是否随虚拟机一起销毁 |
boolean |
diskId |
磁盘ID |
string |
diskName |
磁盘名称 |
string |
jobId |
任务ID |
integer(int64) |
size |
磁盘大小,单位为G |
integer(int32) |
4.38. DbGroupVo
名称 | 说明 | 架构 |
---|---|---|
createTime |
创建时间 |
string(date-time) |
id |
分组列表 |
integer(int64) |
name |
名称 |
string |
4.39. DbSqlLogResult
名称 | 说明 | 架构 |
---|---|---|
logs |
例子 : |
< SqlLog > array |
page |
当前第几页 |
integer(int32) |
requestId |
请求ID |
string |
size |
每页记录条数 |
integer(int32) |
total |
总共多少条记录 |
integer(int32) |
4.40. DbVo
名称 | 说明 | 架构 |
---|---|---|
cluseterUri |
DB集群连接串 |
string |
cluster |
例子 : |
boolean |
creatorId |
创建者ID |
integer(int64) |
dbGroupId |
所在分组ID |
integer(int64) |
dbInstance |
DB实例 |
string |
dbPassword |
DB密码 |
string |
dbType |
数据库类型 |
enum (RDS, MYSQL, SQLSERVER, ORACLE, POSTGRESQL, HIVE, VERTICA, REDIS, REDSHIFT, MONGODB, GAUSSDB) |
dbUser |
DB用户名 |
string |
description |
DB描述 |
string |
hostId |
DB宿主机ID,RDS时为null |
integer(int64) |
id |
数据库ID |
integer(int64) |
inner |
例子 : |
boolean |
ip |
DB连接IP |
string |
jumpServerId |
跳板机ID(中转或Proxy) |
integer(int64) |
jumpServerPort |
跳板机端口 |
integer(int32) |
jumpServerType |
跳板机类型(中转或Proxy) |
enum (Proxy, Transit) |
location |
DB位置:主机、RDS |
enum (Host, RDS) |
name |
数据库名称 |
string |
port |
DB连接端口 |
integer(int32) |
teamId |
所属团队 |
integer(int64) |
4.41. DeleteCredentialHostResult
名称 | 说明 | 架构 |
---|---|---|
deleted |
是否存在且删除成功,如果false,则表示主机不在登录凭证中 |
boolean |
requestId |
请求ID |
string |
4.42. DeleteEntitiesResult
名称 | 说明 | 架构 |
---|---|---|
count |
被删除的记录个数 |
integer(int32) |
requestId |
请求ID |
string |
4.43. DepartmentTreeVo
名称 | 说明 | 架构 |
---|---|---|
description |
部门描述 |
string |
id |
部门ID |
integer(int64) |
memberIds |
部门成员列表 |
< integer(int64) > array |
name |
部门名称 |
string |
parentId |
上级部门ID,顶级部门的上级部门ID=0 |
integer(int64) |
requestId |
请求ID |
string |
roleId |
部门关联角色Id |
integer(int64) |
subDepartments |
下级部门 |
< DepartmentTreeVo > array |
teamId |
所属团队ID |
integer(int64) |
4.44. DepartmentVo
名称 | 说明 | 架构 |
---|---|---|
description |
部门描述 |
string |
id |
部门ID |
integer(int64) |
memberIds |
部门成员列表 |
< integer(int64) > array |
name |
部门名称 |
string |
parentId |
上级部门ID,顶级部门的上级部门ID=0 |
integer(int64) |
requestId |
请求ID |
string |
roleId |
部门关联角色Id |
integer(int64) |
teamId |
所属团队ID |
integer(int64) |
4.45. DiskTypeResult
名称 | 说明 | 架构 |
---|---|---|
diskTypes |
磁盘规格 |
< DiskTypeVo > array |
requestId |
请求ID |
string |
4.46. DiskTypeVo
名称 | 说明 | 架构 |
---|---|---|
categories |
磁盘规格 |
< string > array |
regionId |
区域 |
string |
zoneId |
可用区 |
string |
4.47. DoubleResponse
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
value |
数值 |
number(double) |
4.48. File
名称 | 说明 | 架构 |
---|---|---|
absolute |
例子 : |
boolean |
absoluteFile |
例子 : |
|
absolutePath |
例子 : |
string |
canonicalFile |
例子 : |
|
canonicalPath |
例子 : |
string |
directory |
例子 : |
boolean |
file |
例子 : |
boolean |
freeSpace |
例子 : |
integer(int64) |
hidden |
例子 : |
boolean |
name |
例子 : |
string |
parent |
例子 : |
string |
parentFile |
例子 : |
|
path |
例子 : |
string |
totalSpace |
例子 : |
integer(int64) |
usableSpace |
例子 : |
integer(int64) |
4.49. FlatDepartmentInfo
名称 | 说明 | 架构 |
---|---|---|
departments |
部门列表 |
< DepartmentVo > array |
membersMap |
部门成员关系:部门->成员列表 |
< string, < integer(int64) > array > map |
relationshipMap |
部门关系:父部门->子部门 |
< string, < integer(int64) > array > map |
requestId |
请求ID |
string |
4.50. Func
名称 | 说明 | 架构 |
---|---|---|
name |
函数名 |
enum (mean, median, stddev, first, last, max, min, sum, percentile) |
4.51. FunctionVo
功能权限信息,简称权限
名称 | 说明 | 架构 |
---|---|---|
businessRole |
业务角色 |
string |
code |
权限项代码 |
string |
description |
描述 |
string |
module |
所属分类模块 |
string |
name |
权限项名称 |
string |
path |
权限请求路径 |
string |
roleCode |
如果非空,表示某个角色的专有功能 |
string |
sortNumber |
排序 |
integer(int32) |
type |
校验类型 |
enum (FUNCTION_CODE, API_PATH, BUSINESS_ROLE) |
4.52. GetAgentScriptResult
名称 | 说明 | 架构 |
---|---|---|
cloudId |
云账户ID |
integer(int64) |
hostId |
主机ID |
integer(int64) |
linuxInstallScript |
linux安装脚本(shell) |
string |
requestId |
请求ID |
string |
windowsBatScript |
windows安装脚本(bat) |
string |
windowsScript |
windows安装脚本(powershell) |
string |
4.53. GetCredentialListResult
名称 | 说明 | 架构 |
---|---|---|
credentials |
登录凭证列表 |
< CredentialVo > array |
page |
当前页码 |
integer(int32) |
requestId |
请求ID |
string |
size |
当前页的记录数 |
integer(int32) |
total |
总记录数 |
integer(int32) |
4.54. GetFunctionResult
名称 | 说明 | 架构 |
---|---|---|
functions |
例子 : |
< FunctionVo > array |
requestId |
请求ID |
string |
4.56. GetHostsStatusResult
名称 | 说明 | 架构 |
---|---|---|
statusMap |
ID=>status |
< string, string > map |
4.57. GetIpAddressCapacityResult
名称 | 说明 | 架构 |
---|---|---|
availableCapacity |
例子 : |
integer(int64) |
totalCapacity |
例子 : |
integer(int64) |
usedIpAddressNumber |
例子 : |
integer(int64) |
4.58. GetModuleResult
名称 | 说明 | 架构 |
---|---|---|
modules |
模块 |
< ModuleVo > array |
requestId |
请求ID |
string |
4.59. GetProjectResult
名称 | 说明 | 架构 |
---|---|---|
projects |
项目 |
< ProjectVo > array |
requestId |
请求ID |
string |
4.60. GetProxyScriptResult
名称 | 说明 | 架构 |
---|---|---|
cloudId |
云账户ID |
integer(int64) |
linuxInstallScript |
linux安装脚本(shell) |
string |
requestId |
请求ID |
string |
windowsBatScript |
windows安装脚本(bat) |
string |
windowsScript |
windows安装脚本(powershell) |
string |
4.61. GetQuotaResult
名称 | 说明 | 架构 |
---|---|---|
buckets |
系统Bucket数 |
integer(int32) |
cdns |
系统CDN数 |
integer(int32) |
dbs |
系统DB数 |
integer(int32) |
hosts |
系统HOST数 |
integer(int32) |
maxResources |
最大资源数 |
integer(int32) |
maxTeams |
最大团队数 |
integer(int32) |
maxUsers |
最大用户数 |
integer(int32) |
requestId |
请求ID |
string |
resources |
资源总数,包括:HOST,CDN,BUCKET,DB |
integer(int32) |
teams |
系统团队数 |
integer(int32) |
users |
系统用户数 |
integer(int32) |
4.62. GetRegionResult
名称 | 说明 | 架构 |
---|---|---|
provider |
云厂商 |
string |
regions |
区域 |
< RegionVo > array |
requestId |
请求ID |
string |
4.63. GetRoleResourcesResult
名称 | 说明 | 架构 |
---|---|---|
bucketIds |
当前角色可见bucket列表 |
< integer(int64) > array |
cdnIds |
当前角色可见CDN列表 |
< integer(int64) > array |
hostIds |
当前角色可见主机列表 |
< integer(int64) > array |
requestId |
请求ID |
string |
roleId |
角色ID |
integer(int64) |
4.64. GetRoleTemplatesResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
roleTemplates |
role code => Tempalte |
< string, RoleTemplateVo > map |
4.65. GetShortcutsResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
shortcuts |
例子 : |
< ShortcutVo > array |
4.66. GetTeamListResult
名称 | 说明 | 架构 |
---|---|---|
page |
当前第几页 |
integer(int32) |
requestId |
请求ID |
string |
size |
当前页的记录数 |
integer(int32) |
teams |
团队列表 |
< TeamVo > array |
total |
团队总数 |
integer(int32) |
4.67. GetTeamQuotaResult
名称 | 说明 | 架构 |
---|---|---|
buckets |
团队Bucket数 |
integer(int32) |
cdns |
团队CDN数 |
integer(int32) |
clouds |
团队云账户数 |
integer(int32) |
dbs |
团队DB数 |
integer(int32) |
fileKeepDuration |
文件传输冗余文件保留时长 |
integer(int32) |
hosts |
团队HOST数 |
integer(int32) |
logKeepDuration |
日志保留天数 |
integer(int32) |
maxCdnResources |
最大CDN数 |
integer(int32) |
maxClouds |
最大云账户数 |
integer(int32) |
maxDbResources |
最大DB数 |
integer(int32) |
maxHostResources |
最大主机数 |
integer(int32) |
maxMembers |
最大成员数 |
integer(int32) |
maxOssResources |
最大OSS数 |
integer(int32) |
maxResources |
最大云资源数(包括主机、对象存储、CDN、DB) |
integer(int32) |
maxScriptRuns |
最大并发脚本执行数 |
integer(int32) |
maxSessions |
最大并发会话数量 |
integer(int32) |
members |
团队成员数 |
integer(int32) |
netDiskMaxCapability |
网盘容量限额,byte |
integer(int64) |
netDiskMaxFileSize |
上传单个文件尺寸允许最大值,byte |
integer(int64) |
requestId |
请求ID |
string |
resources |
团队资源数 |
integer(int32) |
teamId |
团队ID |
integer(int64) |
4.68. GetTeamResult
名称 | 说明 | 架构 |
---|---|---|
code |
团队标识 |
string |
createTime |
团队创建时间 |
string(date-time) |
creator |
团队创建者ID |
integer(int64) |
departmentEnabled |
是否开启了组织架构视图,v4.17新增 |
boolean |
memberAccounts |
团队成员用户ID与用户账户的映射。includeMembers=true时返回 |
< string, string > map |
members |
团队成员,includeMembers=true时返回 |
< integer(int64) > array |
name |
团队名称 |
string |
quotaExceed |
配额是否超限 |
boolean |
requestId |
请求ID |
string |
serveEndTime |
专业版到期时间 |
string(date-time) |
teamId |
团队ID |
integer(int64) |
teamType |
团队类型 |
enum (BASIC, PRO, ADV_PRO, ENT, ULTIMATE) |
4.69. HostAccessAuthResult
名称 | 说明 | 架构 |
---|---|---|
accessAuthResults |
访问串列表 |
< AccessAuthResult > array |
count |
访问串总数 |
integer(int32) |
requestId |
请求ID |
string |
4.70. HostCostItem
名称 | 说明 | 架构 |
---|---|---|
bandwidthCost |
带宽(元/月) |
number(double) |
chargeType |
计费类型 |
enum (UNKNOWN, PrePaid, PostPaid) |
diskCost |
磁盘(元/月) |
number(double) |
id |
主机ID |
integer(int64) |
instanceCost |
实例(元/月) |
number(double) |
instanceId |
实例ID |
string |
instanceName |
实例名称 |
string |
platform |
操作系统 |
string |
snapshotCost |
快照(元/月) |
number(double) |
totalCost |
小计(元/月) |
number(double) |
4.71. HostCostResult
名称 | 说明 | 架构 |
---|---|---|
bandwidthCost |
带宽(元/月) |
number(double) |
diskCost |
磁盘(元/月) |
number(double) |
hostCosts |
例子 : |
< HostCostItem > array |
instanceCost |
实例(元/月) |
number(double) |
requestId |
请求ID |
string |
snapshotCost |
快照(元/月) |
number(double) |
totalCost |
小计(元/月) |
number(double) |
4.72. HostDetailListResult
名称 | 说明 | 架构 |
---|---|---|
hosts |
主机详情列表 |
< HostDetailVo > array |
requestId |
请求ID |
string |
4.73. HostDetailVo
名称 | 说明 | 架构 |
---|---|---|
agentStatus |
Agent的状态:STOPPED,READY |
string |
cloudId |
云账户ID |
integer(int64) |
groupId |
主机物理分组ID |
integer(int64) |
hostId |
主机ID |
integer(int64) |
hostName |
主机hostName |
string |
importTime |
导入时间 |
string(date-time) |
innerIp |
内网IP |
string |
installedAgent |
是否安装了Agent |
boolean |
instanceId |
主机实例ID,在云账户中唯一 |
string |
instanceName |
主机名称 |
string |
memory |
内存(MB) |
integer(int32) |
operatingSystem |
主机操作系统 |
string |
platform |
主机平台 |
string |
processorCores |
CPU核数 |
integer(int32) |
publicIp |
公网IP |
string |
requestId |
请求ID |
string |
scope |
云账户来源,门户:Portal|管理控制台:Console |
enum (Console, Portal) |
status |
主机状态 |
string |
teamId |
所属团队 |
integer(int64) |
4.74. HostGroupVo
名称 | 说明 | 架构 |
---|---|---|
cloudId |
所属云账户ID |
integer(int64) |
id |
主机分组ID |
integer(int64) |
name |
主机分组名称 |
string |
networkType |
网络类型:class,vpc,lan,分别表示云主机的经典网络、VPC和局域网网络 |
string |
regionId |
区域:云主机的区域id或者局域网主机的子网 |
string |
requestId |
请求ID |
string |
teamId |
所属团队ID |
integer(int64) |
4.75. HostGroupVoResult
物理网络列表
名称 | 说明 | 架构 |
---|---|---|
hostgroups |
主机分组列表 |
< HostGroupVo > array |
4.76. HostLog
名称 | 说明 | 架构 |
---|---|---|
accessIp |
操作者IP |
string |
accessUserAgent |
操作者浏览器UserAgent |
string |
action |
操作类型 |
enum (ACCESS, ADD, REMOVE, START, STOP, RESTART, RESET_PWD, MODIFY, RESET_MCONSOLE_PWD, CHANGE_SNAPSHOT_POLICY, ALLOCATE) |
actionSource |
操作者的位置 |
string |
actorId |
操作者ID |
integer(int64) |
actorName |
操作者昵称 |
string |
cloudId |
目标主机所属云账户 |
integer(int64) |
cloudName |
目标主机所属云账户名称 |
string |
cloudProvider |
云主机分类 |
string |
createTime |
操作时间 |
string(date-time) |
extraInfo |
会话日志额外信息 |
object |
hostDeleted |
主机是否已经删除 |
boolean |
hostGroupId |
目标主机所在的组 |
integer(int64) |
hostId |
目标主机ID |
integer(int64) |
hostInnerIp |
目标主机内网IP |
string |
hostInstanceId |
目标主机实例ID |
string |
hostName |
目标主机名称 |
string |
hostPlatform |
目标主机平台 |
string |
hostPublicIp |
目标主机公网IP |
string |
id |
例子 : |
string |
status |
操作的结果 |
enum (FAIL, SUCCESS, RUNNING, UNKNOWN) |
teamId |
所属团队 |
integer(int64) |
4.77. HostLogResult
名称 | 说明 | 架构 |
---|---|---|
logs |
日志记录数组 |
< HostLog > array |
page |
当前第几页 |
integer(int32) |
requestId |
请求ID |
string |
size |
每页记录条数 |
integer(int32) |
total |
总共多少条记录 |
integer(int32) |
4.78. HostVo
名称 | 说明 | 架构 |
---|---|---|
cloudId |
云账户ID |
integer(int64) |
groupId |
主机物理分组ID |
integer(int64) |
hostId |
主机ID |
integer(int64) |
hostName |
主机hostName |
string |
importTime |
导入时间 |
string(date-time) |
innerIp |
内网IP |
string |
instanceId |
主机实例ID,在云账户中唯一 |
string |
instanceName |
主机名称 |
string |
memory |
内存(MB) |
integer(int32) |
operatingSystem |
主机操作系统 |
string |
platform |
主机平台 |
string |
processorCores |
CPU核数 |
integer(int32) |
publicIp |
公网IP |
string |
requestId |
请求ID |
string |
scope |
云账户来源,门户:Portal|管理控制台:Console |
enum (Console, Portal) |
status |
主机状态 |
string |
teamId |
所属团队 |
integer(int64) |
4.79. ImportHostRequest
名称 | 说明 | 架构 |
---|---|---|
cloudId |
所属云账户ID |
integer(int64) |
hosts |
主机信息列表 |
< ImportHostVo > array |
teamId |
所属团队id |
integer(int64) |
vgIds |
4.8添加的属性:导入主机默认加入的虚拟分组的ID列表。默认不添加到任何虚拟分组 |
< integer(int64) > array |
4.80. ImportHostResult
名称 | 说明 | 架构 |
---|---|---|
cloudId |
例子 : |
integer(int64) |
groupId |
例子 : |
integer(int64) |
hostIds |
例子 : |
< integer(int64) > array |
teamId |
例子 : |
integer(int64) |
4.81. ImportHostVo
名称 | 说明 | 架构 |
---|---|---|
defaultVgIds |
可选。主机默认加入的虚拟分组。会与ImportHostRequest.vgIds合并生效 |
< integer(int64) > array |
description |
描述信息 |
string |
innerIp |
内网地址 |
string |
instanceId |
厂商提供的ID,在云账户中唯一,不设置时系统自动生成 |
string |
memory |
内存,单位MB |
integer(int32) |
name |
主机名称 |
string |
operatingSystem |
操作系统 |
string |
processor |
CPU核数 |
integer(int32) |
publicIp |
公网地址 |
string |
status |
状态,可取值Stopped,Running,Unknown,Expired,Pending,Starting等,后面3种主要来自云主机 |
string |
4.82. ImportPublicHostRequest
名称 | 说明 | 架构 |
---|---|---|
cloudId |
所属云账户ID |
integer(int64) |
creatorId |
创建者ID,不设置时是团队所有者 |
integer(int64) |
instanceRegionMap |
实例ID=>RegionId映射 |
< string, string > map |
4.83. ImportTeamRequest
名称 | 说明 | 架构 |
---|---|---|
teams |
团队信息列表 |
< ImportTeamVo > array |
4.84. ImportTeamResult
名称 | 说明 | 架构 |
---|---|---|
teamCodes |
团队ID=>团队code |
< string, string > map |
4.85. ImportTeamVo
名称 | 说明 | 架构 |
---|---|---|
code |
团队code,可选。只能是数字、字母、下划线,即满足正则:[A-Za-z0-9_]。保证全局唯一,不设置时由系统自动生成,是访问团队资源的URL context path。注意:code字段不能设置为保留字。4.10新增属性。 |
string |
creator |
创建者用户ID,与creatorAccount必填其中一个。必须是当前ISV有权限操作的用户,私有部署环境可以是任何用户。 |
integer(int64) |
creatorAccount |
创建者用户账号,与creator必填其中一个。必须是当前ISV有权限操作的用户,私有部署环境可以是任何用户。如果设置了creatorAccount,会忽略creator。4.10新增参数。 |
string |
memberAccounts |
默认添加的团队成员账号列表,可选。必须是ISV有权限操作的用户,私有部署环境可以是任何用户。与members不要同时设置,如果memberAccounts非空,会忽略members。4。10新增属性。 |
< string > array |
memberQuota |
设置团队的成员数配额,可选。默认值:SAAS环境是ISV用户配额;私有部署环境是License的用户配额。注意不能超过配额。需要控制团队成员规模时,通过这个参数指定。 |
integer(int32) |
members |
默认添加的团队成员列表,可选。必须是ISV有权限操作的用户,私有部署环境可以是任何用户。 |
< integer(int64) > array |
name |
团队名称,必填。 |
string |
4.86. ImportUserRequest
导入用户请求
名称 | 说明 | 架构 |
---|---|---|
users |
用户信息列表 |
< ImportUserVo > array |
4.87. ImportUserResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
userAccounts |
用户ID=>用户账号 |
< string, string > map |
userIds |
新导入的用户ID列表 |
< integer(int64) > array |
4.88. ImportUserVo
名称 | 说明 | 架构 |
---|---|---|
account |
登录账户,可选。需保证全局唯一,未设置时,将由系统自动生成。4.8新增属性,只能在私有部署版中设置,SAAS版的Openapi不支持设置登录账户。账号不能包含逗号','。 |
string |
address |
地址,可选。 |
string |
email |
登录邮箱,可选。需保证全局唯一。4.9新增属性,只能在私有部署版中设置,SAAS用户的邮箱需要通过验证码绑定。 |
string |
expirationDate |
用户在团队中的有效期,可选。如果设置,会在到期后自动退出团队,如果不设置,则是永久成员。日期格式:yyyy-MM-dd。4.8新增属性。 |
string |
forceUpdate |
首次登录强制修改密码,可选。默认为false。4.8新增属性。 |
boolean |
gender |
性别,可选。0:未知;1:男;2:女。不填时默认值为0。 |
integer(int32) |
introduce |
用户签名,可选。用户自定义描述 |
string |
joinTeam |
默认加入的团队,可选。团队ID。4.8新增属性。 |
integer(int64) |
joinTeamCode |
默认加入的团队,可选。团队code,与joinTeam不要同时设置,如果设置了joinTeamCode,会忽略joinTeam。4.10新加字段。 |
string |
name |
用户昵称,必填。 |
string |
password |
登录密码,可选。长度4~40个字符,即使设置了用户密码策略也不校验复杂性。4.8新增属性。 |
string |
roles |
在加入团队中默认授权的角色,可选。必须设置joinTeam或者joinTeamIdOrCode才可以设置roles。格式:用逗号','连接的角色ID或者code,code可以设定私有部署环境roles_template.json定义的系统角色。 |
string |
sendEmail |
是否发送通知邮件,可选。默认为false,只有设置了email才会生效。4.11新增属性。 |
boolean |
4.90. InputStreamResource
名称 | 说明 | 架构 |
---|---|---|
description |
例子 : |
string |
file |
例子 : |
|
filename |
例子 : |
string |
inputStream |
例子 : |
|
open |
例子 : |
boolean |
readable |
例子 : |
boolean |
uri |
例子 : |
|
url |
例子 : |
4.91. InstanceOfferingInventory
名称 | 说明 | 架构 |
---|---|---|
allocatorStrategy |
例子 : |
string |
cpuNum |
例子 : |
integer(int32) |
cpuSpeed |
例子 : |
integer(int32) |
createDate |
例子 : |
|
description |
例子 : |
string |
lastOpDate |
例子 : |
|
memorySize |
例子 : |
integer(int64) |
name |
例子 : |
string |
sortKey |
例子 : |
integer(int32) |
state |
例子 : |
string |
type |
例子 : |
string |
uuid |
例子 : |
string |
4.92. InstanceTypeConfigVo
名称 | 说明 | 架构 |
---|---|---|
cpu |
cpu个数 |
integer(int32) |
instanceType |
实例规格 |
string |
instanceTypeFamily |
实例规格簇 |
string |
memoryInMB |
内存大小 |
integer(int32) |
4.93. InstanceTypeResult
名称 | 说明 | 架构 |
---|---|---|
instanceTypes |
实例规格 |
< InstanceTypeVo > array |
requestId |
请求ID |
string |
4.94. InstanceTypeVo
名称 | 说明 | 架构 |
---|---|---|
instanceTypes |
实例规格配置信息 |
< InstanceTypeConfigVo > array |
regionId |
区域 |
string |
zoneId |
可用区 |
string |
4.95. IpRangeInventory
名称 | 说明 | 架构 |
---|---|---|
addressMode |
例子 : |
string |
createDate |
例子 : |
|
description |
例子 : |
string |
endIp |
例子 : |
string |
gateway |
例子 : |
string |
ipVersion |
例子 : |
integer(int32) |
l3NetworkUuid |
例子 : |
string |
lastOpDate |
例子 : |
|
name |
例子 : |
string |
netmask |
例子 : |
string |
networkCidr |
例子 : |
string |
prefixLen |
例子 : |
integer(int32) |
startIp |
例子 : |
string |
uuid |
例子 : |
string |
4.96. JobInfoVo
名称 | 说明 | 架构 |
---|---|---|
completed |
任务完成量 |
integer(int64) |
createTime |
创建时间 |
string(date-time) |
description |
任务描述 |
string |
done |
例子 : |
boolean |
finishTime |
结束时间 |
string(date-time) |
id |
异步任务ID |
integer(int64) |
meta |
任务扩展属性 |
object |
requestId |
请求ID |
string |
startTime |
启动时间 |
string(date-time) |
status |
任务状态 |
enum (AUDITING, PENDING, RUNNING, SUCCESS, PARAM_ERROR, FAIL, TIMEOUT, CANCELLED, UNKNOWN) |
success |
例子 : |
boolean |
targetId |
任务关联的目标ID,可能为null |
integer(int64) |
teamId |
所属团队ID |
integer(int64) |
total |
任务总量,如果为0表示当前任务不支持进度 |
integer(int64) |
type |
任务类型 |
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.98. KeyPairDetailVo
名称 | 说明 | 架构 |
---|---|---|
comment |
SSH公钥的注释 |
string |
createTime |
创建时间 |
string(date-time) |
creator |
密钥对的创建人 |
integer(int64) |
departmentIds |
授权组织单元ID列表 |
< integer(int64) > array |
description |
描述 |
string |
id |
密钥对ID |
integer(int64) |
memberIds |
授权成员ID列表 |
< integer(int64) > array |
name |
密钥对名称 |
string |
publicKey |
SSH公钥 |
string |
requestId |
请求ID |
string |
roleIds |
授权角色ID列表 |
< integer(int64) > array |
teamId |
所属团队ID |
integer(int64) |
4.99. KeyPairListResult
名称 | 说明 | 架构 |
---|---|---|
keyPars |
例子 : |
< KeyPairVo > array |
requestId |
请求ID |
string |
4.100. KeyPairVo
名称 | 说明 | 架构 |
---|---|---|
comment |
SSH公钥的注释 |
string |
createTime |
创建时间 |
string(date-time) |
creator |
密钥对的创建人 |
integer(int64) |
description |
描述 |
string |
id |
密钥对ID |
integer(int64) |
name |
密钥对名称 |
string |
publicKey |
SSH公钥 |
string |
requestId |
请求ID |
string |
teamId |
所属团队ID |
integer(int64) |
4.101. L2NetworkInventory
名称 | 说明 | 架构 |
---|---|---|
attachedClusterUuids |
例子 : |
< object > array |
createDate |
例子 : |
|
description |
例子 : |
string |
lastOpDate |
例子 : |
|
name |
例子 : |
string |
physicalInterface |
例子 : |
string |
type |
例子 : |
string |
uuid |
例子 : |
string |
zoneUuid |
例子 : |
string |
4.102. L2VlanNetworkInventory
名称 | 说明 | 架构 |
---|---|---|
attachedClusterUuids |
例子 : |
< object > array |
createDate |
例子 : |
|
description |
例子 : |
string |
lastOpDate |
例子 : |
|
name |
例子 : |
string |
physicalInterface |
例子 : |
string |
type |
例子 : |
string |
uuid |
例子 : |
string |
vlan |
例子 : |
integer(int32) |
zoneUuid |
例子 : |
string |
4.103. L2VxlanNetworkInventory
名称 | 说明 | 架构 |
---|---|---|
attachedClusterUuids |
例子 : |
< object > array |
createDate |
例子 : |
|
description |
例子 : |
string |
lastOpDate |
例子 : |
|
name |
例子 : |
string |
physicalInterface |
例子 : |
string |
poolUuid |
例子 : |
string |
type |
例子 : |
string |
uuid |
例子 : |
string |
vni |
例子 : |
integer(int32) |
zoneUuid |
例子 : |
string |
4.104. L2VxlanNetworkPoolInventory
名称 | 说明 | 架构 |
---|---|---|
attachedCidrs |
例子 : |
object |
attachedClusterUuids |
例子 : |
< object > array |
attachedVniRanges |
例子 : |
< object > array |
attachedVtepRefs |
例子 : |
< object > array |
attachedVxlanNetworkRefs |
例子 : |
< object > array |
createDate |
例子 : |
|
description |
例子 : |
string |
lastOpDate |
例子 : |
|
name |
例子 : |
string |
physicalInterface |
例子 : |
string |
type |
例子 : |
string |
uuid |
例子 : |
string |
zoneUuid |
例子 : |
string |
4.105. L3NetworkInventory
名称 | 说明 | 架构 |
---|---|---|
category |
例子 : |
string |
createDate |
例子 : |
|
description |
例子 : |
string |
dns |
例子 : |
< object > array |
dnsDomain |
例子 : |
string |
hostRoute |
例子 : |
< object > array |
ipRanges |
例子 : |
< object > array |
ipVersion |
例子 : |
integer(int32) |
l2NetworkUuid |
例子 : |
string |
lastOpDate |
例子 : |
|
name |
例子 : |
string |
networkServices |
例子 : |
< object > array |
state |
例子 : |
string |
system |
例子 : |
boolean |
type |
例子 : |
string |
uuid |
例子 : |
string |
zoneUuid |
例子 : |
string |
4.106. LdapConfigVo
名称 | 说明 | 架构 |
---|---|---|
accountAttr |
账号映射属性:LDAP/AD用户的某个属性,映射到门户用户的账号。取值全局唯一。对于AD域建议使用userPrincipalName |
string |
accountSuffix |
导入门户后的账号的后缀。可选。在多个LDAP server的账号映射无法唯一时使用 |
string |
baseDn |
Base DN |
string |
connectTimeout |
连接超时 |
integer(int32) |
emailAttr |
邮箱映射属性,可选。 |
string |
filterOrgUnit |
部门过滤器,默认是objectClass=organizationalUnit |
string |
filterPerson |
用户过滤器,默认是objectClass=person |
string |
genderAttr |
性别映射属性,可选。 |
string |
ip |
LDAP协议连接的IP |
string |
nicknameAttr |
昵称映射属性:LDAP/AD用户的某个属性,映射到门户用户的昵称。对于AD域建议使用cn |
string |
phoneAttr |
手机号映射属性,可选。 |
string |
port |
LDAP协议连接的端口 |
integer(int32) |
userName |
LDAP Server的管理员账号 |
string |
4.107. LdapConfigVoList
名称 | 说明 | 架构 |
---|---|---|
ldapConfigs |
例子 : |
< LdapConfigVo > array |
requestId |
请求ID |
string |
4.108. LdapDnTeamVo
名称 | 说明 | 架构 |
---|---|---|
dn |
需要同步创建用户的OU,不用包含baseDN做后缀,使用空串时表示根目录。 |
string |
name |
dn组织的名称,冗余保存仅用于显示 |
string |
teamId |
当前OU新创建的用户自动加入的团队,为null时不加入团队。当LdapSyncConfigVo.joinTeam=true时生效 |
integer(int64) |
4.109. LdapSyncConfigVo
名称 | 说明 | 架构 |
---|---|---|
addUserWhenCreated |
AD域新增用户时,是否创建相应的行云管家用户 |
boolean |
baseDn |
Base DN |
string |
dnTeamList |
限定特定OU下的用户新增时,同步创建行云管家用户,当addUserWhenCreated=true时生效 |
< LdapDnTeamVo > array |
enabled |
是否开启定时同步 |
boolean |
firstSyncTime |
首次同步时间 |
string(date-time) |
interval |
执行间隔时间 |
integer(int32) |
intervalUnit |
间隔时间的单位 |
enum (month, week, day, hour, minute, second) |
joinTeam |
新创建的行云管家用户,是否加入到指定团队 |
boolean |
strategyWhenDeleted |
AD域用户删除时,行云管家处理用户的策略:delete,block |
enum (delete, block) |
syncUserWhenChanged |
AD域用户信息变化时,是否同步到行云管家 |
boolean |
4.110. LdapSyncConfigVoList
名称 | 说明 | 架构 |
---|---|---|
ldapSyncConfigs |
例子 : |
< LdapSyncConfigVo > array |
requestId |
请求ID |
string |
4.112. ListCredentialsResult
名称 | 说明 | 架构 |
---|---|---|
credentials |
例子 : |
< CredentialVo > array |
requestId |
请求ID |
string |
4.113. ListDbGroupResult
名称 | 说明 | 架构 |
---|---|---|
dbGroups |
分组列表 |
< DbGroupVo > array |
requestId |
请求ID |
string |
teamId |
所属团队ID |
integer(int64) |
4.114. ListDbResult
名称 | 说明 | 架构 |
---|---|---|
dbs |
分组列表 |
< DbVo > array |
requestId |
请求ID |
string |
teamId |
所属团队ID |
integer(int64) |
4.115. ListTagResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
tags |
标签列表 |
< TagVo > array |
teamId |
所属团队ID |
integer(int64) |
4.116. ListVpcsResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
vpcs |
VPC列表 |
< VpcVo > array |
4.117. ListZStackIpRangesResult
名称 | 说明 | 架构 |
---|---|---|
ipRanges |
zstack网络地址范围列表 |
< IpRangeInventory > array |
requestId |
请求ID |
string |
4.118. ListZStackL2NetworksResult
名称 | 说明 | 架构 |
---|---|---|
l2Networks |
zstack二层网络列表 |
< L2NetworkInventory > array |
requestId |
请求ID |
string |
4.119. ListZStackL2VLanNetworksResult
名称 | 说明 | 架构 |
---|---|---|
l2VLanNetworks |
zstack二层VLan网络列表 |
< L2VlanNetworkInventory > array |
requestId |
请求ID |
string |
4.120. ListZStackL2VxLanNetworksResult
名称 | 说明 | 架构 |
---|---|---|
l2VxLanNetworks |
zstack二层VxLan网络列表 |
< L2VxlanNetworkInventory > array |
requestId |
请求ID |
string |
4.121. ListZStackL2VxLanPoolsResult
名称 | 说明 | 架构 |
---|---|---|
l2VxLanPools |
zstack二层VxLan网络池列表 |
< L2VxlanNetworkPoolInventory > array |
requestId |
请求ID |
string |
4.122. ListZStackL3NetworkIpStatisticResult
名称 | 说明 | 架构 |
---|---|---|
l3NetworkIpStatistics |
zstack三层网络Ip统计信息列表 |
< ZStackL3NetworkIpStatistic > array |
requestId |
请求ID |
string |
4.123. ListZStackL3NetworksResult
名称 | 说明 | 架构 |
---|---|---|
l3Networks |
zstack三层网络列表 |
< L3NetworkInventory > array |
requestId |
请求ID |
string |
4.124. ListZStackNetworkServiceProvidersResult
名称 | 说明 | 架构 |
---|---|---|
networkServiceProviders |
zstack网络服务列表 |
< NetworkServiceProviderInventory > array |
requestId |
请求ID |
string |
4.125. ListZStackVirtualRouterOfferingsResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
virtualRouterOfferings |
zstack云路由规格列表 |
< VirtualRouterOfferingInventory > array |
4.126. ListZStackVpcRoutersResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
vpcRouters |
zstackVpc路由器列表 |
< VpcRouterVmInventory > array |
4.127. LogResult
名称 | 说明 | 架构 |
---|---|---|
logs |
例子 : |
< LogVo > array |
page |
当前第几页 |
integer(int32) |
requestId |
请求ID |
string |
size |
每页记录条数 |
integer(int32) |
total |
总共多少条记录 |
integer(int32) |
4.128. LogVo
名称 | 说明 | 架构 |
---|---|---|
action |
操作名称 |
string |
actionSource |
事件源 |
string |
actor |
操作人 |
|
cluster |
日志分类 |
string |
createTime |
创建时间 |
string(date-time) |
errorCode |
错误码 |
string |
errorMsg |
错误信息 |
string |
extendMap |
扩展信息 |
object |
extraInfo |
额外信息 |
object |
id |
日志的ID |
string |
remoteIp |
操作人远程IP |
string |
status |
日志状态 |
string |
teamId |
所属团队ID |
integer(int64) |
teamName |
所属团队名称 |
string |
4.129. MetricSingletonMap
名称 | 说明 | 架构 |
---|---|---|
metricDataMap |
例子 : |
< string, SingletonResultList > map |
requestId |
请求ID |
string |
4.130. ModuleTermListResult
名称 | 说明 | 架构 |
---|---|---|
moduleTermVos |
例子 : |
< ModuleTermVo > array |
requestId |
请求ID |
string |
4.131. ModuleTermVo
名称 | 说明 | 架构 |
---|---|---|
moduleEditionCode |
例子 : |
string |
moduleTerm |
例子 : |
integer(int32) |
4.132. ModuleVo
名称 | 说明 | 架构 |
---|---|---|
editionCode |
版本代码 |
string |
editionName |
版本名称 |
string |
expiredTime |
过期时间 |
string(date-time) |
moduleCode |
模块代码 |
string |
moduleName |
模块名称 |
string |
quotas |
配额 |
< QuotaUsedItemVo > array |
requestId |
请求ID |
string |
4.133. NetworkServiceProviderInventory
名称 | 说明 | 架构 |
---|---|---|
attachedL2NetworkUuids |
例子 : |
< object > array |
createDate |
例子 : |
|
description |
例子 : |
string |
lastOpDate |
例子 : |
|
name |
例子 : |
string |
networkServiceTypes |
例子 : |
< object > array |
type |
例子 : |
string |
uuid |
例子 : |
string |
4.134. NoticeAttachmentVo
名称 | 说明 | 架构 |
---|---|---|
contentType |
例子 : |
string |
cover |
封面(true)或附件(false) |
boolean |
createTime |
例子 : |
string(date-time) |
downloadUrl |
下载地址 |
string |
id |
例子 : |
integer(int64) |
name |
例子 : |
string |
noticeId |
公告ID |
integer(int64) |
size |
文件大小 |
integer(int64) |
4.135. NoticeDetailVo
名称 | 说明 | 架构 |
---|---|---|
attachments |
例子 : |
< NoticeAttachmentVo > array |
content |
例子 : |
string |
cover |
例子 : |
|
createTime |
例子 : |
string(date-time) |
id |
例子 : |
integer(int64) |
publishTime |
例子 : |
string(date-time) |
sourceUrl |
例子 : |
string |
status |
例子 : |
enum (Unpublished, Published) |
tag |
例子 : |
|
tagId |
例子 : |
integer(int64) |
title |
例子 : |
string |
4.136. NoticeInfo
名称 | 说明 | 架构 |
---|---|---|
enabled |
是否开启公告栏 |
boolean |
notices |
已发布公告栏文章数目 |
integer(int32) |
requestId |
请求ID |
string |
4.137. NoticeListResult
名称 | 说明 | 架构 |
---|---|---|
notices |
例子 : |
< NoticeDetailVo > array |
page |
当前第几页 |
integer(int32) |
requestId |
请求ID |
string |
size |
每页记录条数 |
integer(int32) |
total |
总共多少条记录 |
integer(int32) |
4.138. NoticeTagResult
名称 | 说明 | 架构 |
---|---|---|
noticeTags |
例子 : |
< NoticeTagVo > array |
requestId |
请求ID |
string |
4.139. NoticeTagVo
名称 | 说明 | 架构 |
---|---|---|
color |
颜色,形如#f3ad4c |
string |
createTime |
创建时间 |
string(date-time) |
id |
ID |
integer(int64) |
name |
名称 |
string |
4.140. NoticeVo
名称 | 说明 | 架构 |
---|---|---|
content |
例子 : |
string |
createTime |
例子 : |
string(date-time) |
id |
例子 : |
integer(int64) |
publishTime |
例子 : |
string(date-time) |
sourceUrl |
例子 : |
string |
status |
例子 : |
enum (Unpublished, Published) |
tagId |
例子 : |
integer(int64) |
title |
例子 : |
string |
4.141. OAuthUrlResult
名称 | 说明 | 架构 |
---|---|---|
expiredSeconds |
例子 : |
integer(int64) |
url |
授权URL |
string |
4.143. OpsPolicyDetailVo
名称 | 说明 | 架构 |
---|---|---|
departmentIds |
授权组织单元ID列表 |
< integer(int64) > array |
description |
子策略描述 |
string |
id |
子策略ID |
integer(int64) |
memberIds |
授权成员ID列表 |
< integer(int64) > array |
name |
子策略名称 |
string |
priority |
子策略优先级,取值越小越高,最小值:1 |
integer(int32) |
requestId |
请求ID |
string |
roleIds |
授权角色ID列表 |
< integer(int64) > array |
sourceId |
云账户或者策略组ID |
integer(int64) |
sourceType |
子策略类型:云账户或者策略组 |
enum (PolicyGroup, Cloud) |
4.144. OpsPolicyGroupDetailVo
名称 | 说明 | 架构 |
---|---|---|
createTime |
创建时间 |
string(date-time) |
creator |
创建人 |
integer(int64) |
hosts |
例子 : |
< integer(int64) > array |
id |
策略组ID |
integer(int64) |
policyName |
策略组名称 |
string |
requestId |
请求ID |
string |
teamId |
所属团队 |
integer(int64) |
updateTime |
更新时间 |
string(date-time) |
4.145. OpsPolicyGroupResult
名称 | 说明 | 架构 |
---|---|---|
policyGroups |
例子 : |
< OpsPolicyGroupVo > array |
requestId |
请求ID |
string |
4.146. OpsPolicyGroupVo
名称 | 说明 | 架构 |
---|---|---|
createTime |
创建时间 |
string(date-time) |
creator |
创建人 |
integer(int64) |
id |
策略组ID |
integer(int64) |
policyName |
策略组名称 |
string |
requestId |
请求ID |
string |
teamId |
所属团队 |
integer(int64) |
updateTime |
更新时间 |
string(date-time) |
4.147. OpsPolicyItemResult
名称 | 说明 | 架构 |
---|---|---|
policyItems |
策略项目 |
< OpsPolicyItemVo > array |
4.148. OpsPolicyItemVo
策略条目
名称 | 说明 | 架构 |
---|---|---|
category |
策略条目的分类 |
string |
defaultValue |
策略条目的默认值 |
object |
description |
策略条目的描述 |
string |
domainEntityType |
策略条目取值关联的实体名称,目前仅:WorkflowTemplate(工单模版) |
string |
key |
策略条目的Key |
string |
requestId |
请求ID |
string |
value |
策略条目当前值 |
object |
valueType |
策略条目的取值类型 |
string |
4.149. OpsPolicyResult
名称 | 说明 | 架构 |
---|---|---|
policies |
子策略列表 |
< OpsPolicyVo > array |
requestId |
请求ID |
string |
4.150. OpsPolicyVo
子策略
名称 | 说明 | 架构 |
---|---|---|
description |
子策略描述 |
string |
id |
子策略ID |
integer(int64) |
name |
子策略名称 |
string |
priority |
子策略优先级,取值越小越高,最小值:1 |
integer(int32) |
requestId |
请求ID |
string |
sourceId |
云账户或者策略组ID |
integer(int64) |
sourceType |
子策略类型:云账户或者策略组 |
enum (PolicyGroup, Cloud) |
4.151. OptimizedAdviceItem
名称 | 说明 | 架构 |
---|---|---|
adviceLevel |
优化级别:升级、降级、维持现有配置 |
enum (UPGRADE, DOWNGRADE, OK) |
adviceTarget |
建议的目标 |
enum (INSTANCE, BANDWIDTH, FREE_DISK, FREE_EIP, FREE_SNAPSHOT) |
description |
优化建议描述 |
string |
hostId |
主机ID |
integer(int64) |
optimizedAdviceId |
优化建议ID |
integer(int64) |
saveMoney |
节省的钱,以人民币计费,为负数时表示升级配置的花费 |
number(double) |
4.152. OptimizedAdviceResult
名称 | 说明 | 架构 |
---|---|---|
optimizedAdvices |
例子 : |
< OptimizedAdviceItem > array |
requestId |
请求ID |
string |
4.153. OrderDetailVo
名称 | 说明 | 架构 |
---|---|---|
amount |
金额 |
number |
editionCode |
套餐Code |
string |
editionName |
套餐名称 |
string |
expireTime |
到期时间 |
string(date-time) |
moduleCode |
模块Code |
string |
moduleName |
模块名称 |
string |
orderNumber |
订单号 |
string |
productId |
产品ID |
string |
productTerm |
购买时长 |
integer(int32) |
quotas |
配额 |
< QuotaVo > array |
4.154. OrderListResult
名称 | 说明 | 架构 |
---|---|---|
orders |
例子 : |
< OrderVo > array |
requestId |
请求ID |
string |
4.155. OrderVo
名称 | 说明 | 架构 |
---|---|---|
cancelReason |
订单作废原因 |
string |
createTime |
创建时间 |
string(date-time) |
details |
订单详情,批量续费的订单会有多条记录 |
< OrderDetailVo > array |
orderNumber |
订单号 |
string |
orderType |
订单类型,团队服务订单或者个人充值订单 |
enum (TEAM, DEPOSIT) |
payAccountId |
支付者ID |
integer(int64) |
payMethod |
支付方式 |
enum (alipay, wechatpay, voucher, bank, remaining) |
payStatus |
支付状态 |
enum (UNPAID, PAID, CANCELED, WAIT_CONFIRM) |
payTime |
支付时间 |
string(date-time) |
payTransactionNo |
支付宝或者微信交易号 |
string |
payablePay |
应付金额(扣除代金券和余额支付的钱) |
number |
productInfo |
产品信息 |
string |
productTerm |
购买时长 |
integer(int32) |
realPay |
实付金额 |
number |
scope |
订单来源 |
enum (Console, Portal) |
serveType |
服务类型,包含开通、续费、变更、变更并续费、试用5种类型 |
enum (NEW_PURCHASE, RENEW, CHANGE, CHANGE_RENEW, TRIAL, OFFICIAL) |
teamId |
团队ID |
integer(int64) |
teamName |
团队名称 |
string |
totalPrice |
总金额 |
number |
userId |
创建者ID |
integer(int64) |
workflowInstanceId |
工单ID |
integer(int64) |
4.156. PagedOrderListResult
名称 | 说明 | 架构 |
---|---|---|
orders |
例子 : |
< OrderVo > array |
page |
当前第几页 |
integer(int32) |
requestId |
请求ID |
string |
size |
当前页的记录数 |
integer(int32) |
total |
订单总数 |
integer(int32) |
4.157. PagedRoleListResult
名称 | 说明 | 架构 |
---|---|---|
page |
当前第几页 |
integer(int32) |
requestId |
请求ID |
string |
roles |
例子 : |
< RoleVo > array |
size |
每页记录条数 |
integer(int32) |
total |
总共多少条记录 |
integer(int32) |
4.158. PagedUserListResult
名称 | 说明 | 架构 |
---|---|---|
page |
当前第几页 |
integer(int32) |
requestId |
请求ID |
string |
size |
当前页的记录数 |
integer(int32) |
total |
用户总数 |
integer(int32) |
users |
例子 : |
< UserVo > array |
4.159. PermissionQuota
名称 | 说明 | 架构 |
---|---|---|
permission |
例子 : |
enum (SmsAccessOld, SmsAccess, IntlSmsAccess, EmailAccess, WxTemplateMsgAccess, UserAccess, TeamAccess, HostAccess, OAuthLogin, GetProxyScript, LogWrite, CreateCasServer) |
quotaType |
例子 : |
enum (ByTraffic, PerYear, PerMonth, PerDay, PerHour) |
time |
例子 : |
string(date-time) |
total |
例子 : |
integer(int64) |
used |
例子 : |
integer(int64) |
4.160. PermissionQuotaResult
名称 | 说明 | 架构 |
---|---|---|
quotaList |
例子 : |
< PermissionQuota > array |
requestId |
请求ID |
string |
4.161. ProjectVo
云账户的项目
名称 | 说明 | 架构 |
---|---|---|
projectId |
项目ID |
string |
projectName |
项目名称 |
string |
regionId |
区域ID |
string |
4.162. PublicIpHostVo
有公网ip的主机
名称 | 说明 | 架构 |
---|---|---|
creationTime |
创建时间 |
string(date-time) |
innerIp |
内网IP地址 |
string |
instanceId |
主机实例Id |
string |
instanceName |
主机实例名称 |
string |
provider |
云厂商 |
string |
publicIp |
公网IP地址 |
string |
requestId |
请求ID |
string |
teamId |
团队Id |
integer(int64) |
4.163. PublicIpHostsResult
有公网ip的主机列表
名称 | 说明 | 架构 |
---|---|---|
hosts |
主机列表 |
< PublicIpHostVo > array |
requestId |
请求ID |
string |
4.164. QuotaItemResult
名称 | 说明 | 架构 |
---|---|---|
quotaItems |
例子 : |
< QuotaItemVo > array |
requestId |
请求ID |
string |
4.165. QuotaItemVo
名称 | 说明 | 架构 |
---|---|---|
code |
配额代码 |
string |
external |
是否是外部配额 |
boolean |
name |
配额名称 |
string |
tenantId |
所属Tenant |
integer(int64) |
unit |
配额单位 |
string |
unitPrice |
配额单价 |
number(double) |
4.166. QuotaUsedItemResult
名称 | 说明 | 架构 |
---|---|---|
quotaItems |
例子 : |
< QuotaUsedItemVo > array |
requestId |
请求ID |
string |
4.167. QuotaUsedItemVo
名称 | 说明 | 架构 |
---|---|---|
code |
配额代码 |
string |
external |
是否是外部配额 |
boolean |
name |
配额名称 |
string |
quota |
实际配额 |
integer(int64) |
tenantId |
所属Tenant |
integer(int64) |
unit |
配额单位 |
string |
unitPrice |
配额单价 |
number(double) |
used |
已用配额 |
integer(int64) |
4.168. QuotaVo
名称 | 说明 | 架构 |
---|---|---|
quota |
配额 |
integer(int64) |
quotaCode |
配额Code |
string |
quotaName |
配额名称 |
string |
unit |
单位 |
string |
4.169. RegionVo
公有云区域
名称 | 说明 | 架构 |
---|---|---|
regionId |
区域ID |
string |
regionName |
区域名称 |
string |
zones |
可用区 |
< ZoneVo > array |
4.170. ResourceResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
resources |
例子 : |
< ResourceVo > array |
4.171. ResourceVo
名称 | 说明 | 架构 |
---|---|---|
id |
资源ID |
integer(int64) |
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) |
4.172. RoleDetailResult
名称 | 说明 | 架构 |
---|---|---|
functionCodes |
角色权限代码列表 |
< string > array |
members |
角色成员ID列表 |
< integer(int64) > array |
requestId |
请求ID |
string |
role |
角色信息 |
4.173. RoleListResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
roles |
角色列表 |
< RoleVo > array |
4.174. RoleTemplateVo
名称 | 说明 | 架构 |
---|---|---|
functions |
功能权限code列表 |
< string > array |
name |
角色名称 |
string |
4.175. RoleVo
名称 | 说明 | 架构 |
---|---|---|
code |
角色标识,系统角色(私有部署版包括通过roles_template.json配置)才有标识,例如TEAM_CREATOR,TEAM_ADMINER,TEAM_MEMBER分别表示团队拥有者、管理员、所有成员。 |
string |
description |
角色描述,2-128个字符 |
string |
id |
角色ID |
integer(int64) |
locked |
角色的权限是否不允许更改 |
boolean |
name |
角色名称,2-32个字符 |
string |
requestId |
请求ID |
string |
roleType |
角色类型:0,普通角色;1,系统角色;2,部门角色 |
integer(int32) |
system |
是否系统角色,系统角色无法删除 |
boolean |
teamId |
所属团队 |
integer(int64) |
4.176. ScriptExecutingHost
名称 | 说明 | 架构 |
---|---|---|
credentialId |
主机的登录凭证ID,可选。如果不设置,将用Agent执行脚本 |
integer(int64) |
hostId |
主机ID |
integer(int64) |
4.177. ScriptExecutingHostsInfo
名称 | 说明 | 架构 |
---|---|---|
executingHosts |
例子 : |
< ScriptExecutingHost > array |
operatorId |
操作者用户ID |
integer(int64) |
parameter |
脚本参数,不设置时使用脚本默认参数 |
string |
timeout |
脚本超时,不设置时使用默认超时 |
integer(int32) |
4.178. ScriptLibraryListResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
scriptLibraries |
例子 : |
< ScriptLibraryVo > array |
4.179. ScriptLibraryVo
名称 | 说明 | 架构 |
---|---|---|
createTime |
脚本库创建时间 |
string(date-time) |
creator |
脚本库创建人ID |
integer(int64) |
description |
脚本库描述 |
string |
id |
脚本库ID |
integer(int64) |
name |
脚本库名称 |
string |
requestId |
请求ID |
string |
4.180. ScriptListResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
scripts |
例子 : |
< ScriptVo > array |
4.181. ScriptOutputLineVo
名称 | 说明 | 架构 |
---|---|---|
line |
输出的一行内容 |
string |
type |
输出内容的类型 |
enum (INFO, ERR) |
4.182. ScriptRunResult
名称 | 说明 | 架构 |
---|---|---|
cancelled |
执行被取消的主机数 |
integer(int32) |
completed |
执行成功的主机数 |
integer(int32) |
done |
例子 : |
boolean |
fails |
执行失败的主机数 |
integer(int32) |
id |
异步任务ID |
integer(int64) |
lastCompleteTime |
任务最后完成时间 |
string(date-time) |
operatorId |
操作者ID |
integer(int64) |
pending |
处于等待的主机数 |
integer(int32) |
requestId |
请求ID |
string |
running |
处于执行中的主机数 |
integer(int32) |
scriptId |
脚本ID |
integer(int64) |
scriptRuns |
每台主机执行结果 |
< ScriptRunVo > array |
total |
执行主机总数 |
integer(int32) |
4.183. ScriptRunVo
名称 | 说明 | 架构 |
---|---|---|
completeTime |
主机结束执行脚本时间 |
string(date-time) |
exitCode |
退出码,-999表示脚本未执行过或者还未执行完毕 |
integer(int32) |
hostId |
执行主机ID |
integer(int64) |
id |
scriptRun的ID |
integer(int64) |
outputLength |
当前输出的总长度(按字节计算) |
integer(int64) |
outputLines |
脚本的输出,按照输入先后排序 |
< ScriptOutputLineVo > array |
outputSize |
当前获取到的输出的长度(按字节计算) |
integer(int64) |
result |
执行结果的简易描述 |
string |
startTime |
主机开始执行脚本时间 |
string(date-time) |
status |
执行状态 |
enum (PENDING, RUNNING, SUCCESS, PARAM_ERROR, FAIL, TIMEOUT, CANCELLED, UNKNOWN) |
4.184. ScriptVo
名称 | 说明 | 架构 |
---|---|---|
content |
脚本内容 |
string |
createTime |
创建时间 |
string(date-time) |
creator |
创建者ID |
integer(int64) |
description |
脚本描述 |
string |
id |
脚本ID |
integer(int64) |
language |
脚本语言 |
enum (shell, python, powershell, perl, node, cmd) |
libraryId |
所属脚本库ID |
integer(int64) |
modifyTime |
修改时间 |
string(date-time) |
name |
脚本名称 |
string |
parameter |
脚本参数 |
string |
requestId |
请求ID |
string |
timeout |
默认超时,单位:秒 |
integer(int32) |
4.185. SecurityGroupResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
securityGroups |
安全组列表 |
< SecurityGroupVo > array |
4.186. SecurityGroupRuleResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
securityGroupRules |
安全组规则列表 |
< SecurityGroupRuleVo > array |
4.187. SecurityGroupRuleVo
名称 | 说明 | 架构 |
---|---|---|
destCidrIp |
目标IP地址段,用于出方向授权,direction为egress时该变量有值 |
string |
direction |
安全组规则授权方向,egress:安全组出方向,ingress:安全组入方向 |
enum (ingress, egress) |
ipProtocol |
传输层协议,tcp|udp|all |
enum (tcp, udp, all) |
nicType |
经典网络取值internet和intranet,VPC取值只能为intranet |
enum (intranet, internet) |
policy |
访问权限,accept|drop |
enum (accept, drop) |
portRange |
端口范围,连接端口范围:开始端口/结束端口,如1/200 ;单个端口如22/22 ;多个端口如23/23,80/80;IpProtocol取值为all:-1/-1 |
string |
priority |
规则优先级 |
string |
securityGroupId |
安全组ID |
string |
sourceCidrIp |
源IP地址段,用于入方向授权,direction为ingress时该变量有值 |
string |
4.188. SecurityGroupVo
名称 | 说明 | 架构 |
---|---|---|
description |
安全组描述 |
string |
regionId |
区域ID |
string |
securityGroupId |
安全组ID |
string |
securityGroupName |
安全组名称 |
string |
securityGroupRules |
安全组规则 |
< SecurityGroupRuleVo > array |
vpcId |
安全组所在的VPC,腾讯云没有该字段 |
string |
4.189. SessionOpenResult
名称 | 说明 | 架构 |
---|---|---|
deskType |
例子 : |
integer(int32) |
errorMsg |
例子 : |
string |
sessionId |
例子 : |
integer(int64) |
success |
例子 : |
boolean |
websocketUrl |
例子 : |
string |
4.190. SetZStackL2VLanIdsResult
名称 | 说明 | 架构 |
---|---|---|
l2VLanIds |
zstack二层VLanId列表 |
< integer(int32) > array |
requestId |
请求ID |
string |
4.191. ShortcutVo
名称 | 说明 | 架构 |
---|---|---|
createTime |
快捷方式创建时间 |
string(date-time) |
creatorId |
快捷方式创建者ID |
integer(int64) |
creatorName |
快捷方式创建者昵称 |
string |
desktopType |
快捷方式协议类型,比如SSH、RDP,等等 |
string |
hostId |
主机ID |
integer(int64) |
id |
主机快捷方式ID |
integer(int64) |
loginAccount |
快捷方式登录账户 |
string |
name |
快捷方式名称 |
string |
passwordOrKeySet |
快捷方式是否设置了密码或者密钥 |
boolean |
requestId |
请求ID |
string |
updateTime |
快捷方式修改时间 |
string(date-time) |
4.192. SimpleUserVo
名称 | 说明 | 架构 |
---|---|---|
account |
登录账号 |
string |
email |
邮箱 |
string |
nickname |
用户昵称 |
string |
phone |
手机号 |
string |
requestId |
请求ID |
string |
thirdPartyUserId |
第三方用户账号 |
string |
userId |
用户ID |
integer(int64) |
4.193. SingletonData
名称 | 说明 | 架构 |
---|---|---|
dimensionName |
例子 : |
string |
func |
数据点的统计函数 |
|
measurement |
数据点的监控项名 |
string |
tags |
数据点的标签。例如hostId=xx,diskname=C:,等等 |
object |
time |
数据点所处的时间。如果函数不支持,则为null |
string(date-time) |
unit |
单位 |
string |
unitEn |
英文单位 |
string |
value |
数据点的值 |
number(double) |
4.194. SingletonResultList
名称 | 说明 | 架构 |
---|---|---|
dataPoints |
例子 : |
< SingletonData > array |
4.195. SmsRequest
名称 | 说明 | 架构 |
---|---|---|
parameters |
模版参数 |
< string > array |
phones |
手机号列表 |
< string > array |
template |
短信模版 |
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 > map |
statusCode |
例子 : |
string |
statusMsg |
例子 : |
string |
success |
例子 : |
boolean |
4.197. SmsResultV2
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
resultMap |
例子 : |
< string, SmsResult > map |
4.198. SqlLog
名称 | 说明 | 架构 |
---|---|---|
actorId |
操作用户ID |
integer(int64) |
actorName |
操作用户昵称 |
string |
dbId |
数据库ID |
integer(int64) |
dbType |
数据库类型 |
enum (RDS, MYSQL, SQLSERVER, ORACLE, POSTGRESQL, HIVE, VERTICA, REDIS, REDSHIFT, MONGODB, GAUSSDB) |
errorCode |
错误代码 |
string |
errorMessage |
错误信息 |
string |
query |
sql语句 |
string |
queryEnd |
查询结束时间戳 |
integer(int64) |
queryStart |
查询开始时间戳 |
integer(int64) |
rowCount |
SQL返回记录行数 |
integer(int64) |
sessionId |
会话ID |
integer(int64) |
sqlState |
SQL状态 |
string |
success |
是否成功 |
boolean |
teamId |
团队ID |
integer(int64) |
4.199. SubnetVo
名称 | 说明 | 架构 |
---|---|---|
availableIpAddressCount |
可用IP数 |
integer(int64) |
requestId |
请求ID |
string |
subnetCidr |
子网CIDR |
string |
subnetId |
子网ID |
string |
subnetName |
子网名称 |
string |
vpcId |
VPC ID |
string |
zoneId |
可用区ID |
string |
zoneName |
可用区名称 |
string |
4.200. SystemDiskVo
名称 | 说明 | 架构 |
---|---|---|
category |
磁盘类型 |
string |
diskId |
磁盘ID |
string |
size |
磁盘大小,单位为G |
integer(int32) |
4.201. TagDetailResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
tag |
创建的tag |
4.202. TagValueVo
名称 | 说明 | 架构 |
---|---|---|
id |
标签值Id |
integer(int64) |
tagId |
标签名Id |
integer(int64) |
value |
标签值,可能为null |
string |
4.203. TagVo
名称 | 说明 | 架构 |
---|---|---|
id |
标签名称Id |
integer(int64) |
name |
标签名称 |
string |
tagValueList |
标签值列表 |
< TagValueVo > array |
teamId |
团队Id |
integer(int64) |
4.204. TeamBriefResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
teamIds |
例子 : |
< integer(int64) > array |
4.205. TeamListResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
teams |
团队列表 |
< TeamVo > array |
4.206. TeamVo
名称 | 说明 | 架构 |
---|---|---|
code |
团队标识 |
string |
createTime |
团队创建时间 |
string(date-time) |
creator |
团队创建者ID |
integer(int64) |
name |
团队名称 |
string |
quotaExceed |
配额是否超限 |
boolean |
serveEndTime |
专业版到期时间 |
string(date-time) |
teamId |
团队ID |
integer(int64) |
teamType |
团队类型 |
enum (BASIC, PRO, ADV_PRO, ENT, ULTIMATE) |
tenantId |
租户ID |
integer(int64) |
4.207. Timestamp
名称 | 说明 | 架构 |
---|---|---|
date |
例子 : |
integer(int32) |
day |
例子 : |
integer(int32) |
hours |
例子 : |
integer(int32) |
minutes |
例子 : |
integer(int32) |
month |
例子 : |
integer(int32) |
nanos |
例子 : |
integer(int32) |
seconds |
例子 : |
integer(int32) |
time |
例子 : |
integer(int64) |
timezoneOffset |
例子 : |
integer(int32) |
year |
例子 : |
integer(int32) |
4.208. TransitServerResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
transitServers |
中转服务列表 |
< TransitServerVo > array |
4.209. TransitServerVo
名称 | 说明 | 架构 |
---|---|---|
code |
例子 : |
string |
endpoints |
例子 : |
string |
id |
例子 : |
integer(int64) |
ip |
例子 : |
string |
name |
例子 : |
string |
requestId |
请求ID |
string |
4.210. URI
名称 | 说明 | 架构 |
---|---|---|
absolute |
例子 : |
boolean |
authority |
例子 : |
string |
fragment |
例子 : |
string |
host |
例子 : |
string |
opaque |
例子 : |
boolean |
path |
例子 : |
string |
port |
例子 : |
integer(int32) |
query |
例子 : |
string |
rawAuthority |
例子 : |
string |
rawFragment |
例子 : |
string |
rawPath |
例子 : |
string |
rawQuery |
例子 : |
string |
rawSchemeSpecificPart |
例子 : |
string |
rawUserInfo |
例子 : |
string |
scheme |
例子 : |
string |
schemeSpecificPart |
例子 : |
string |
userInfo |
例子 : |
string |
4.211. URL
名称 | 说明 | 架构 |
---|---|---|
authority |
例子 : |
string |
content |
例子 : |
object |
defaultPort |
例子 : |
integer(int32) |
file |
例子 : |
string |
host |
例子 : |
string |
path |
例子 : |
string |
port |
例子 : |
integer(int32) |
protocol |
例子 : |
string |
query |
例子 : |
string |
ref |
例子 : |
string |
userInfo |
例子 : |
string |
4.212. UpdateUserVo
名称 | 说明 | 架构 |
---|---|---|
address |
地址 |
string |
gender |
性别:0:未知;1,:男;2:女 |
integer(int32) |
introduce |
用户签名 |
string |
name |
用户昵称 |
string |
4.214. UserBriefResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
userIds |
例子 : |
< integer(int64) > array |
4.215. UserExtendParamResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
userExtendParams |
用户扩展属性 |
< UserExtendParamVo > array |
4.216. UserExtendParamVo
名称 | 说明 | 架构 |
---|---|---|
createTime |
创建时间 |
string(date-time) |
description |
描述 |
string |
paramName |
参数名 |
string |
paramValue |
参数值 |
string |
requestId |
请求ID |
string |
updateTime |
更新时间 |
string(date-time) |
userId |
用户ID |
integer(int64) |
4.217. UserListResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
users |
例子 : |
< UserVo > array |
4.218. UserVo
名称 | 说明 | 架构 |
---|---|---|
account |
用户账号,可以作为用户相关API请求的关键字。 |
string |
address |
地址 |
string |
authMethod |
认证方式 |
enum (PLAIN, LDAP, RADIUS, OIDC, CAS, ACC) |
blockedTime |
开始禁用的时间(如果禁用了) |
string(date-time) |
blockingSeconds |
禁用持续的时间(单位秒),=0表示永久禁用 |
integer(int32) |
delete |
是否已删除用户 |
boolean |
email |
邮箱 |
string |
gender |
性别:0:未知;1:男;2:女 |
integer(int32) |
id |
用户ID。可以作为用户相关API请求的关键字。 |
integer(int64) |
importTime |
导入时间 |
string(date-time) |
introduce |
用户签名,4.10新增冗余字段 |
string |
lastLoginTime |
最后登录时间 |
string(date-time) |
ldapAttr |
账号映射LDAP用户的属性名 |
string |
ldapBaseDn |
LDAP认证的baseDn |
string |
loginCount |
登录次数 |
integer(int32) |
name |
用户昵称,4.10新增冗余字段 |
string |
nickname |
用户昵称 |
string |
online |
是否在线 |
boolean |
phone |
手机号 |
string |
signature |
用户签名 |
string |
status |
用户状态 |
enum (INACTIVE, ACTIVE, BLOCK, DELETED) |
tenantId |
租户ID |
integer(int64) |
uid |
用户UID,在审计日志和录像中用到。 |
string |
userId |
用户ID。冗余字段 |
integer(int64) |
4.219. VipInventory
名称 | 说明 | 架构 |
---|---|---|
createDate |
例子 : |
|
description |
例子 : |
string |
gateway |
例子 : |
string |
ip |
例子 : |
string |
l3NetworkUuid |
例子 : |
string |
lastOpDate |
例子 : |
|
name |
例子 : |
string |
netmask |
例子 : |
string |
peerL3NetworkUuids |
例子 : |
< object > array |
prefixLen |
例子 : |
integer(int32) |
serviceProvider |
例子 : |
string |
servicesRefs |
例子 : |
< object > array |
state |
例子 : |
string |
system |
例子 : |
boolean |
useFor |
例子 : |
string |
uuid |
例子 : |
string |
4.220. VirtualGroupDetailVo
名称 | 说明 | 架构 |
---|---|---|
buckets |
包含Bucket列表 |
< BucketVo > array |
cnds |
包含CDN列表 |
< CdnVo > array |
createTime |
虚拟分组创建时间 |
string(date-time) |
hosts |
包含主机列表 |
< HostVo > array |
id |
虚拟分组ID |
integer(int64) |
name |
虚拟分组名称 |
string |
parentVgId |
父级分组ID |
integer(int64) |
requestId |
请求ID |
string |
teamId |
所属团队ID |
integer(int64) |
4.221. VirtualGroupResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
vgs |
例子 : |
< VirtualGroupVo > array |
4.222. VirtualGroupVo
名称 | 说明 | 架构 |
---|---|---|
createTime |
虚拟分组创建时间 |
string(date-time) |
id |
虚拟分组ID |
integer(int64) |
name |
虚拟分组名称 |
string |
parentVgId |
父级分组ID |
integer(int64) |
requestId |
请求ID |
string |
teamId |
所属团队ID |
integer(int64) |
4.223. VirtualRouterOfferingInventory
名称 | 说明 | 架构 |
---|---|---|
allocatorStrategy |
例子 : |
string |
cpuNum |
例子 : |
integer(int32) |
cpuSpeed |
例子 : |
integer(int32) |
createDate |
例子 : |
|
description |
例子 : |
string |
imageUuid |
例子 : |
string |
isDefault |
例子 : |
boolean |
lastOpDate |
例子 : |
|
managementNetworkUuid |
例子 : |
string |
memorySize |
例子 : |
integer(int64) |
name |
例子 : |
string |
publicNetworkUuid |
例子 : |
string |
sortKey |
例子 : |
integer(int32) |
state |
例子 : |
string |
type |
例子 : |
string |
uuid |
例子 : |
string |
zoneUuid |
例子 : |
string |
4.224. VirtualRouterVmInventory
名称 | 说明 | 架构 |
---|---|---|
agentPort |
例子 : |
integer(int32) |
allVolumes |
例子 : |
< object > array |
allocatorStrategy |
例子 : |
string |
applianceVmType |
例子 : |
string |
clusterUuid |
例子 : |
string |
cpuNum |
例子 : |
integer(int32) |
cpuSpeed |
例子 : |
integer(int64) |
createDate |
例子 : |
|
defaultL3NetworkUuid |
例子 : |
string |
defaultRouteL3NetworkUuid |
例子 : |
string |
description |
例子 : |
string |
haStatus |
例子 : |
string |
hostUuid |
例子 : |
string |
hypervisorType |
例子 : |
string |
imageUuid |
例子 : |
string |
instanceOfferingUuid |
例子 : |
string |
lastHostUuid |
例子 : |
string |
lastOpDate |
例子 : |
|
managementNetworkUuid |
例子 : |
string |
memorySize |
例子 : |
integer(int64) |
name |
例子 : |
string |
platform |
例子 : |
string |
publicNetworkUuid |
例子 : |
string |
rootVolumeUuid |
例子 : |
string |
state |
例子 : |
string |
status |
例子 : |
string |
type |
例子 : |
string |
uuid |
例子 : |
string |
virtualRouterVips |
例子 : |
< object > array |
vmCdRoms |
例子 : |
< object > array |
vmNics |
例子 : |
< object > array |
zoneUuid |
例子 : |
string |
4.225. VmInstanceInventory
名称 | 说明 | 架构 |
---|---|---|
allVolumes |
例子 : |
< object > array |
allocatorStrategy |
例子 : |
string |
clusterUuid |
例子 : |
string |
cpuNum |
例子 : |
integer(int32) |
cpuSpeed |
例子 : |
integer(int64) |
createDate |
例子 : |
|
defaultL3NetworkUuid |
例子 : |
string |
description |
例子 : |
string |
hostUuid |
例子 : |
string |
hypervisorType |
例子 : |
string |
imageUuid |
例子 : |
string |
instanceOfferingUuid |
例子 : |
string |
lastHostUuid |
例子 : |
string |
lastOpDate |
例子 : |
|
memorySize |
例子 : |
integer(int64) |
name |
例子 : |
string |
platform |
例子 : |
string |
rootVolumeUuid |
例子 : |
string |
state |
例子 : |
string |
type |
例子 : |
string |
uuid |
例子 : |
string |
vmCdRoms |
例子 : |
< object > array |
vmNics |
例子 : |
< object > array |
zoneUuid |
例子 : |
string |
4.226. VmNicInventory
名称 | 说明 | 架构 |
---|---|---|
createDate |
例子 : |
|
deviceId |
例子 : |
integer(int32) |
gateway |
例子 : |
string |
hypervisorType |
例子 : |
string |
ip |
例子 : |
string |
ipVersion |
例子 : |
integer(int32) |
l3NetworkUuid |
例子 : |
string |
lastOpDate |
例子 : |
|
mac |
例子 : |
string |
metaData |
例子 : |
string |
netmask |
例子 : |
string |
usedIps |
例子 : |
< object > array |
uuid |
例子 : |
string |
vmInstanceUuid |
例子 : |
string |
4.227. VpcRouterVmInventory
名称 | 说明 | 架构 |
---|---|---|
agentPort |
例子 : |
integer(int32) |
allVolumes |
例子 : |
< object > array |
allocatorStrategy |
例子 : |
string |
applianceVmType |
例子 : |
string |
clusterUuid |
例子 : |
string |
cpuNum |
例子 : |
integer(int32) |
cpuSpeed |
例子 : |
integer(int64) |
createDate |
例子 : |
|
defaultL3NetworkUuid |
例子 : |
string |
defaultRouteL3NetworkUuid |
例子 : |
string |
description |
例子 : |
string |
dns |
例子 : |
< object > array |
haRef |
例子 : |
< object > array |
haStatus |
例子 : |
string |
hostUuid |
例子 : |
string |
hypervisorType |
例子 : |
string |
imageUuid |
例子 : |
string |
instanceOfferingUuid |
例子 : |
string |
lastHostUuid |
例子 : |
string |
lastOpDate |
例子 : |
|
managementNetworkUuid |
例子 : |
string |
memorySize |
例子 : |
integer(int64) |
name |
例子 : |
string |
platform |
例子 : |
string |
publicNetworkUuid |
例子 : |
string |
rootVolumeUuid |
例子 : |
string |
state |
例子 : |
string |
status |
例子 : |
string |
type |
例子 : |
string |
uuid |
例子 : |
string |
virtualRouterVips |
例子 : |
< object > array |
vmCdRoms |
例子 : |
< object > array |
vmNics |
例子 : |
< object > array |
zoneUuid |
例子 : |
string |
4.228. VpcVo
名称 | 说明 | 架构 |
---|---|---|
regionId |
区域ID |
string |
requestId |
请求ID |
string |
subnets |
子网 |
< SubnetVo > array |
vpcCidr |
VPC CIDR |
string |
vpcId |
VPC ID |
string |
vpcName |
VPC名称 |
string |
4.229. WorkTaskVo
名称 | 说明 | 架构 |
---|---|---|
action |
操作人动作:如果未处理,则为null |
enum (start, assign, approve, deny, completed, cancel, fail, error, timeout, giveup, close, approveByCode, failByCode) |
applicantAccount |
发起人账号 |
string |
applicantId |
发起人ID |
integer(int64) |
applicantName |
发起人名称 |
string |
applicantTeamId |
发起人所属团队ID |
integer(int64) |
createTime |
工作项创建时间 |
string(date-time) |
finishTime |
工作项完成时间 |
string(date-time) |
id |
工作项ID |
integer(int64) |
instanceDescription |
流程实例的描述 |
string |
instanceId |
流程实例ID |
integer(int64) |
instanceSubject |
流程实例的主题 |
string |
operatorAccount |
操作人账号 |
string |
operatorId |
操作人ID |
integer(int64) |
operatorName |
操作人名称 |
string |
operatorTeamId |
操作人所属团队ID |
integer(int64) |
result |
工作项处理结果 |
string |
stage |
操作人参与类型 |
enum (MyStarted, MyPending, MyDone) |
startTime |
工作项开始时间 |
string(date-time) |
status |
工作项状态 |
enum (Pending, Handing, Approved, Completed, Denied, Canceled, Failed, Invalid, Timeout, Closed) |
subject |
工作项主题 |
string |
templateId |
流程模版ID |
integer(int64) |
templateName |
流程模版名称 |
string |
updateTime |
工作项更新时间 |
string(date-time) |
workNodeName |
工作节点名称 |
string |
workType |
工作项类型 |
enum (Common, ApplyProduct, HostAccessAudit, CommandAudit, CustomService, CreateHost, AllocateHost, RunScriptAudit, FileTransferAudit) |
4.230. WorkTaskVoResult
名称 | 说明 | 架构 |
---|---|---|
size |
当前记录数 |
integer(int32) |
tasks |
例子 : |
< WorkTaskVo > array |
total |
总记录数 |
integer(int64) |
4.231. WorkflowInstanceVo
名称 | 说明 | 架构 |
---|---|---|
closed |
流程是否已经结束 |
boolean |
createTime |
流程发起时间 |
string(date-time) |
creatorId |
流程发起人ID |
integer(int64) |
creatorName |
流程发起人昵称 |
string |
description |
流程内容 |
string |
id |
流程ID |
integer(int64) |
result |
流程当前处理结果 |
string |
status |
流程当前状态 |
enum (Pending, Handing, Approved, Completed, Denied, Canceled, Failed, Invalid, Timeout, Closed) |
subject |
流程主题 |
string |
teamId |
流程所属团队 |
integer(int64) |
templateId |
流程模版ID |
integer(int64) |
timeout |
流程超时时间 |
integer(int32) |
updateTime |
流程的更新时间 |
string(date-time) |
workType |
业务类型 |
enum (Common, ApplyProduct, HostAccessAudit, CommandAudit, CustomService, CreateHost, AllocateHost, RunScriptAudit, FileTransferAudit) |
4.232. WorkflowInstanceVoResult
名称 | 说明 | 架构 |
---|---|---|
page |
当前第几页 |
integer(int32) |
requestId |
请求ID |
string |
size |
每页记录条数 |
integer(int32) |
total |
总共多少条记录 |
integer(int32) |
workflowInstances |
例子 : |
< WorkflowInstanceVo > array |
4.233. ZStackHostSpecListResult
名称 | 说明 | 架构 |
---|---|---|
hostSpecs |
zstack计算规格列表 |
< ZStackHostSpecVo > array |
requestId |
请求ID |
string |
4.234. ZStackHostSpecVo
名称 | 说明 | 架构 |
---|---|---|
allocatorStrategy |
物理机分配策略 |
string |
cpuNum |
cpu数量 |
integer(int32) |
createDate |
创建时间 |
string(date-time) |
description |
描述 |
string |
id |
uuid |
string |
memorySizeInMb |
内存大小(Mb) |
integer(int64) |
name |
名称 |
string |
state |
状态 |
string |
4.235. ZStackL3NetworkIpStatistic
名称 | 说明 | 架构 |
---|---|---|
createDate |
例子 : |
|
ip |
例子 : |
string |
ownerName |
例子 : |
string |
resourceTypes |
例子 : |
< object > array |
state |
例子 : |
string |
useFor |
例子 : |
string |
vip |
例子 : |
|
vipName |
例子 : |
string |
vipUuid |
例子 : |
string |
vm |
例子 : |
|
vmDefaultIp |
例子 : |
string |
vmInstanceName |
例子 : |
string |
vmInstanceType |
例子 : |
string |
vmInstanceUuid |
例子 : |
string |
vpc |
例子 : |
4.236. ZStackPhysicalHostListResult
名称 | 说明 | 架构 |
---|---|---|
physicalHosts |
zstack物理主机列表 |
< ZStackPhysicalHostVo > array |
requestId |
请求ID |
string |
4.237. ZStackPhysicalHostVo
名称 | 说明 | 架构 |
---|---|---|
availableCpuCapacity |
可用CPU核数 |
integer(int64) |
availableMemoryCapacity |
可用内存 |
integer(int64) |
clusterId |
集群Id |
string |
cpuNum |
主机cpu核数 |
integer(int32) |
cpuSockets |
cpu插槽 |
integer(int32) |
createDate |
创建日期 |
string(date-time) |
description |
描述 |
string |
hypervisorType |
虚拟化技术 |
string |
id |
Id |
string |
lastOpDate |
最后修改日期 |
string(date-time) |
managementIp |
管理网络Ip |
string |
name |
主机名称 |
string |
state |
可用状态 |
string |
status |
连接状态 |
string |
totalCpuCapacity |
总CPU核数 |
integer(int64) |
totalMemoryCapacity |
总内存 |
integer(int64) |
zoneId |
可用区Id |
string |
4.238. ZStackPhysicalResourceSummary
名称 | 说明 | 架构 |
---|---|---|
availableCpu |
剩余可用cpu |
integer(int64) |
availableMemoryInGB |
剩余可用内存 |
number(double) |
availableStorageInGB |
剩余可用存储容量 |
number(double) |
requestId |
请求ID |
string |
4.239. ZStackVirtualNetworkCreateResult
名称 | 说明 | 架构 |
---|---|---|
requestId |
请求ID |
string |
virtualNetworkId |
zstack虚拟网络Id |
string |
4.240. ZStackVmNicInfoResult
名称 | 说明 | 架构 |
---|---|---|
defaultL3NetworkId |
zstack虚拟机默认L3网络Uuid |
string |
defaultL3NetworkName |
zstack虚拟机默认L3网络名称 |
string |
instanceId |
zstack虚拟机Uuid |
string |
l3Networks |
zstack虚拟机L3网络<Uuid, 名称>映射 |
< string, string > map |
requestId |
请求ID |
string |
vmNics |
zstack虚拟机网络详细信息列表 |
< VmNicInventory > array |