mirror of
https://github.com/yunionio/cloudpods.git
synced 2026-08-28 19:45:07 +08:00
屈轩
5340 lines
209 KiB
YAML
5340 lines
209 KiB
YAML
basePath: /
|
||
consumes:
|
||
- application/json
|
||
definitions:
|
||
CloudgroupAddUserInput:
|
||
properties:
|
||
clouduser_id:
|
||
description: 用户Id
|
||
type: string
|
||
x-go-name: ClouduserId
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
CloudgroupAttachPolicyInput:
|
||
properties:
|
||
cloudpolicy_id:
|
||
description: 权限Id
|
||
type: string
|
||
x-go-name: CloudpolicyId
|
||
cloudpolicy_ids:
|
||
description: 权限Id列表
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: CloudpolicyIds
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
CloudgroupCreateInput:
|
||
properties:
|
||
__meta__:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签列表,最多支持20个
|
||
example:
|
||
user:rd: op
|
||
type: object
|
||
x-go-name: Metadata
|
||
cloudpolicy_ids:
|
||
description: 权限Id列表, 权限provider必须和权限组provider一致
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: CloudpolicyIds
|
||
description:
|
||
description: 资源描述
|
||
example: test create network
|
||
type: string
|
||
x-go-name: Description
|
||
dry_run:
|
||
default: false
|
||
description: 预检验参数,若为true则仅检查参数,并不真正创建变更
|
||
type: boolean
|
||
x-go-name: DryRun
|
||
generate_name:
|
||
description: |-
|
||
生成资源名称的模板，如果name为空，则为必填项
|
||
description: generated resource name, given a pattern to generate name, required if name is not given
|
||
example: test###
|
||
type: string
|
||
x-go-name: GenerateName
|
||
is_emulated:
|
||
description: |-
|
||
资源是否为模拟资源
|
||
description: the resource is an emulated resource
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
is_public:
|
||
description: 是否共享
|
||
type: boolean
|
||
x-go-name: IsPublic
|
||
manager_id:
|
||
description: 子账号Id
|
||
type: string
|
||
x-go-name: ManagerId
|
||
name:
|
||
description: |-
|
||
资源名称，如果generate_name为空，则为必填项
|
||
description: resource name, required if generated_name is not given
|
||
example: test-network
|
||
type: string
|
||
uniqueItems: true
|
||
x-go-name: Name
|
||
project_domain_id:
|
||
description: 指定项目归属域名称或ID
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
public_scope:
|
||
description: 共享范围
|
||
type: string
|
||
x-go-name: PublicScope
|
||
status:
|
||
description: 用来存储资源的状态
|
||
type: string
|
||
x-go-name: Status
|
||
required:
|
||
- name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
CloudgroupDetachPolicyInput:
|
||
properties:
|
||
cloudpolicy_id:
|
||
description: 权限Id
|
||
type: string
|
||
x-go-name: CloudpolicyId
|
||
cloudpolicy_ids:
|
||
description: 权限Id列表
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: CloudpolicyIds
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
CloudgroupDetails:
|
||
properties:
|
||
brand:
|
||
description: 品牌信息
|
||
type: string
|
||
x-go-name: Brand
|
||
can_delete:
|
||
description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
|
||
example: true
|
||
type: boolean
|
||
x-go-name: CanDelete
|
||
can_update:
|
||
description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
|
||
example: true
|
||
type: boolean
|
||
x-go-name: CanUpdate
|
||
cloudaccount:
|
||
description: 云账号名称
|
||
type: string
|
||
x-go-name: Cloudaccount
|
||
cloudaccount_id:
|
||
description: 云账号Id
|
||
type: string
|
||
x-go-name: CloudaccountId
|
||
cloudpolicies:
|
||
items:
|
||
$ref: '#/definitions/SCloudIdBaseResource'
|
||
type: array
|
||
x-go-name: Cloudpolicies
|
||
cloudpolicy_count:
|
||
description: 权限数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: CloudpolicyCount
|
||
clouduser_count:
|
||
description: 公有云子用户数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: ClouduserCount
|
||
cloudusers:
|
||
items:
|
||
$ref: '#/definitions/SCloudIdBaseResource'
|
||
type: array
|
||
x-go-name: Cloudusers
|
||
created_at:
|
||
description: 资源创建时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: CreatedAt
|
||
delete_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
deleted:
|
||
description: 资源是否被删除
|
||
type: boolean
|
||
x-go-name: Deleted
|
||
deleted_at:
|
||
description: 资源删除时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: DeletedAt
|
||
description:
|
||
description: 资源描述信息
|
||
type: string
|
||
x-go-name: Description
|
||
domain_id:
|
||
description: 域Id
|
||
type: string
|
||
x-go-name: DomainId
|
||
domain_src:
|
||
description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
|
||
example: local
|
||
type: string
|
||
x-go-name: DomainSrc
|
||
external_id:
|
||
description: 云上Id, 对应云上资源自身Id
|
||
type: string
|
||
x-go-name: ExternalId
|
||
iam_login_url:
|
||
description: 公有云账号登录地址
|
||
type: string
|
||
x-go-name: IamLoginUrl
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
imported_at:
|
||
description: 资源导入时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: ImportedAt
|
||
is_emulated:
|
||
description: |-
|
||
是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
|
||
list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
is_public:
|
||
description: 是否共享
|
||
type: boolean
|
||
x-go-name: IsPublic
|
||
manager:
|
||
description: 云订阅名称
|
||
type: string
|
||
x-go-name: Manager
|
||
manager_id:
|
||
description: 子订阅Id
|
||
type: string
|
||
x-go-name: ManagerId
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
org_node_md5:
|
||
description: 用以组织架构变更通知其他服务权限变更
|
||
type: string
|
||
x-go-name: OrgNodeMd5
|
||
progress:
|
||
description: 操作进度0-100
|
||
format: float
|
||
type: number
|
||
x-go-name: Progress
|
||
project_domain:
|
||
description: 资源归属项目的域名称
|
||
type: string
|
||
x-go-name: ProjectDomain
|
||
provider:
|
||
description: 平台信息
|
||
type: string
|
||
x-go-name: Provider
|
||
public_scope:
|
||
description: 默认共享范围
|
||
type: string
|
||
x-go-name: PublicScope
|
||
public_src:
|
||
description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来'
|
||
example: local
|
||
type: string
|
||
x-go-name: PublicSrc
|
||
shared_domains:
|
||
description: 共享的域列表
|
||
items:
|
||
$ref: '#/definitions/SharedDomain'
|
||
type: array
|
||
x-go-name: SharedDomains
|
||
shared_projects:
|
||
description: 共享的项目列表
|
||
items:
|
||
$ref: '#/definitions/SharedProject'
|
||
type: array
|
||
x-go-name: SharedProjects
|
||
source:
|
||
description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目'
|
||
type: string
|
||
x-go-name: Source
|
||
status:
|
||
description: 资源状态
|
||
type: string
|
||
x-go-name: Status
|
||
update_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
update_version:
|
||
description: 资源被更新次数
|
||
format: int64
|
||
type: integer
|
||
x-go-name: UpdateVersion
|
||
updated_at:
|
||
description: 资源更新时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: UpdatedAt
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
CloudgroupRemoveUserInput:
|
||
properties:
|
||
clouduser_id:
|
||
description: 用户Id
|
||
type: string
|
||
x-go-name: ClouduserId
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
CloudgroupSetPoliciesInput:
|
||
properties:
|
||
cloudpolicy_ids:
|
||
description: 权限Ids
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: CloudpolicyIds
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
CloudgroupSetUsersInput:
|
||
properties:
|
||
clouduser_ids:
|
||
description: 公有云子账号Ids
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: ClouduserIds
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
CloudgroupSyncstatusInput:
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
CloudgroupUpdateInput:
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
CloudpolicyDetails:
|
||
properties:
|
||
brand:
|
||
description: 品牌信息
|
||
type: string
|
||
x-go-name: Brand
|
||
can_delete:
|
||
description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
|
||
example: true
|
||
type: boolean
|
||
x-go-name: CanDelete
|
||
can_update:
|
||
description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
|
||
example: true
|
||
type: boolean
|
||
x-go-name: CanUpdate
|
||
cloudaccount:
|
||
description: 云账号名称
|
||
type: string
|
||
x-go-name: Cloudaccount
|
||
cloudaccount_id:
|
||
description: 云账号Id
|
||
type: string
|
||
x-go-name: CloudaccountId
|
||
cloudgroup_count:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: CloudgroupCount
|
||
clouduser_count:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: ClouduserCount
|
||
created_at:
|
||
description: 资源创建时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: CreatedAt
|
||
delete_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
deleted:
|
||
description: 资源是否被删除
|
||
type: boolean
|
||
x-go-name: Deleted
|
||
deleted_at:
|
||
description: 资源删除时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: DeletedAt
|
||
description:
|
||
description: 资源描述信息
|
||
type: string
|
||
x-go-name: Description
|
||
document:
|
||
description: 策略内容
|
||
type: object
|
||
x-go-name: Document
|
||
domain_id:
|
||
description: 域Id
|
||
type: string
|
||
x-go-name: DomainId
|
||
domain_src:
|
||
description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
|
||
example: local
|
||
type: string
|
||
x-go-name: DomainSrc
|
||
external_id:
|
||
description: 云上Id, 对应云上资源自身Id
|
||
type: string
|
||
x-go-name: ExternalId
|
||
iam_login_url:
|
||
description: 公有云账号登录地址
|
||
type: string
|
||
x-go-name: IamLoginUrl
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
imported_at:
|
||
description: 资源导入时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: ImportedAt
|
||
is_emulated:
|
||
description: |-
|
||
是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
|
||
list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
is_public:
|
||
description: 是否共享
|
||
type: boolean
|
||
x-go-name: IsPublic
|
||
manager:
|
||
description: 云订阅名称
|
||
type: string
|
||
x-go-name: Manager
|
||
manager_id:
|
||
description: 子订阅Id
|
||
type: string
|
||
x-go-name: ManagerId
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
org_node_md5:
|
||
description: 用以组织架构变更通知其他服务权限变更
|
||
type: string
|
||
x-go-name: OrgNodeMd5
|
||
policy_type:
|
||
description: |-
|
||
权限类型
|
||
权限类型 | 说明 |
|
||
---------------|----------------------|
|
||
system | 平台内置权限 |
|
||
custom | 用户自定义权限 |
|
||
type: string
|
||
x-go-name: PolicyType
|
||
progress:
|
||
description: 操作进度0-100
|
||
format: float
|
||
type: number
|
||
x-go-name: Progress
|
||
project_domain:
|
||
description: 资源归属项目的域名称
|
||
type: string
|
||
x-go-name: ProjectDomain
|
||
provider:
|
||
description: 平台信息
|
||
type: string
|
||
x-go-name: Provider
|
||
public_scope:
|
||
description: 默认共享范围
|
||
type: string
|
||
x-go-name: PublicScope
|
||
public_src:
|
||
description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来'
|
||
example: local
|
||
type: string
|
||
x-go-name: PublicSrc
|
||
shared_domains:
|
||
description: 共享的域列表
|
||
items:
|
||
$ref: '#/definitions/SharedDomain'
|
||
type: array
|
||
x-go-name: SharedDomains
|
||
shared_projects:
|
||
description: 共享的项目列表
|
||
items:
|
||
$ref: '#/definitions/SharedProject'
|
||
type: array
|
||
x-go-name: SharedProjects
|
||
source:
|
||
description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目'
|
||
type: string
|
||
x-go-name: Source
|
||
status:
|
||
description: 资源状态
|
||
type: string
|
||
x-go-name: Status
|
||
update_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
update_version:
|
||
description: 资源被更新次数
|
||
format: int64
|
||
type: integer
|
||
x-go-name: UpdateVersion
|
||
updated_at:
|
||
description: 资源更新时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: UpdatedAt
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
CloudroleDetails:
|
||
properties:
|
||
brand:
|
||
description: 品牌信息
|
||
type: string
|
||
x-go-name: Brand
|
||
can_delete:
|
||
description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
|
||
example: true
|
||
type: boolean
|
||
x-go-name: CanDelete
|
||
can_update:
|
||
description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
|
||
example: true
|
||
type: boolean
|
||
x-go-name: CanUpdate
|
||
cloudaccount:
|
||
description: 云账号名称
|
||
type: string
|
||
x-go-name: Cloudaccount
|
||
cloudaccount_id:
|
||
description: 云账号Id
|
||
type: string
|
||
x-go-name: CloudaccountId
|
||
cloudgroup_id:
|
||
type: string
|
||
x-go-name: CloudgroupId
|
||
created_at:
|
||
description: 资源创建时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: CreatedAt
|
||
delete_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
deleted:
|
||
description: 资源是否被删除
|
||
type: boolean
|
||
x-go-name: Deleted
|
||
deleted_at:
|
||
description: 资源删除时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: DeletedAt
|
||
description:
|
||
description: 资源描述信息
|
||
type: string
|
||
x-go-name: Description
|
||
document:
|
||
type: object
|
||
x-go-name: Document
|
||
domain_id:
|
||
description: 域Id
|
||
type: string
|
||
x-go-name: DomainId
|
||
domain_src:
|
||
description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
|
||
example: local
|
||
type: string
|
||
x-go-name: DomainSrc
|
||
enabled:
|
||
description: 资源是否启用
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
external_id:
|
||
description: 云上Id, 对应云上资源自身Id
|
||
type: string
|
||
x-go-name: ExternalId
|
||
iam_login_url:
|
||
description: 公有云账号登录地址
|
||
type: string
|
||
x-go-name: IamLoginUrl
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
imported_at:
|
||
description: 资源导入时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: ImportedAt
|
||
is_emulated:
|
||
description: |-
|
||
是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
|
||
list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
is_public:
|
||
description: 是否共享
|
||
type: boolean
|
||
x-go-name: IsPublic
|
||
manager:
|
||
description: 云订阅名称
|
||
type: string
|
||
x-go-name: Manager
|
||
manager_id:
|
||
description: 子订阅Id
|
||
type: string
|
||
x-go-name: ManagerId
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
org_node_md5:
|
||
description: 用以组织架构变更通知其他服务权限变更
|
||
type: string
|
||
x-go-name: OrgNodeMd5
|
||
progress:
|
||
description: 操作进度0-100
|
||
format: float
|
||
type: number
|
||
x-go-name: Progress
|
||
project_domain:
|
||
description: 资源归属项目的域名称
|
||
type: string
|
||
x-go-name: ProjectDomain
|
||
provider:
|
||
description: 平台信息
|
||
type: string
|
||
x-go-name: Provider
|
||
public_scope:
|
||
description: 默认共享范围
|
||
type: string
|
||
x-go-name: PublicScope
|
||
public_src:
|
||
description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来'
|
||
example: local
|
||
type: string
|
||
x-go-name: PublicSrc
|
||
saml_provider_id:
|
||
type: string
|
||
x-go-name: SAMLProviderId
|
||
shared_domains:
|
||
description: 共享的域列表
|
||
items:
|
||
$ref: '#/definitions/SharedDomain'
|
||
type: array
|
||
x-go-name: SharedDomains
|
||
shared_projects:
|
||
description: 共享的项目列表
|
||
items:
|
||
$ref: '#/definitions/SharedProject'
|
||
type: array
|
||
x-go-name: SharedProjects
|
||
source:
|
||
description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目'
|
||
type: string
|
||
x-go-name: Source
|
||
status:
|
||
description: 资源状态
|
||
type: string
|
||
x-go-name: Status
|
||
update_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
update_version:
|
||
description: 资源被更新次数
|
||
format: int64
|
||
type: integer
|
||
x-go-name: UpdateVersion
|
||
updated_at:
|
||
description: 资源更新时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: UpdatedAt
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
ClouduserAttachPolicyInput:
|
||
properties:
|
||
cloudpolicy_id:
|
||
description: |-
|
||
权限Id
|
||
|
||
|
||
|
||
云平台 | 说明 |
|
||
----------|---------------------------------------------|
|
||
Google | 支持 |
|
||
Aliyun | 支持 |
|
||
Huawei | 不支持 |
|
||
Azure | 支持 |
|
||
腾讯云 | 支持 |
|
||
type: string
|
||
x-go-name: CloudpolicyId
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
ClouduserChangeOwnerInput:
|
||
properties:
|
||
user_id:
|
||
description: 本地用户Id
|
||
type: string
|
||
x-go-name: UserId
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
ClouduserCreateAccessKeyInput:
|
||
properties:
|
||
name:
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
ClouduserCreateInput:
|
||
properties:
|
||
__meta__:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签列表,最多支持20个
|
||
example:
|
||
user:rd: op
|
||
type: object
|
||
x-go-name: Metadata
|
||
cloudaccount_id:
|
||
description: |-
|
||
云账号ID
|
||
Azure云账号需要有User administrator权限，否则删操作会出现Insufficient privileges to complete the operation错误信息
|
||
type: string
|
||
x-go-name: CloudaccountId
|
||
cloudgroup_ids:
|
||
description: 初始化权限组Id列表, 权限组必须和云账号平台属性相同
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: CloudgroupIds
|
||
cloudpolicy_ids:
|
||
description: |-
|
||
初始的权限Id列表, 权限必须属于指定的云账号
|
||
|
||
|
||
|
||
云平台 | 说明 |
|
||
----------|---------------------------------------------|
|
||
Google | 至少需要一个初始权限 |
|
||
Aliyun | 支持 |
|
||
Huawei | 不支持 |
|
||
Azure | 支持 |
|
||
腾讯云 | 支持 |
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: CloudpolicyIds
|
||
description:
|
||
description: 资源描述
|
||
example: test create network
|
||
type: string
|
||
x-go-name: Description
|
||
dry_run:
|
||
default: false
|
||
description: 预检验参数,若为true则仅检查参数,并不真正创建变更
|
||
type: boolean
|
||
x-go-name: DryRun
|
||
email:
|
||
description: 邮箱地址
|
||
example: test@example.com
|
||
type: string
|
||
x-go-name: Email
|
||
generate_name:
|
||
description: |-
|
||
生成资源名称的模板，如果name为空，则为必填项
|
||
description: generated resource name, given a pattern to generate name, required if name is not given
|
||
example: test###
|
||
type: string
|
||
x-go-name: GenerateName
|
||
is_console_login:
|
||
default: false
|
||
description: 是否可控制台登录
|
||
type: boolean
|
||
x-go-name: IsConsoleLogin
|
||
is_emulated:
|
||
description: |-
|
||
资源是否为模拟资源
|
||
description: the resource is an emulated resource
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
manager_id:
|
||
description: 云订阅ID
|
||
type: string
|
||
x-go-name: ManagerId
|
||
mobile_phone:
|
||
description: 手机号码
|
||
example: 86-1868888****
|
||
type: string
|
||
x-go-name: MobilePhone
|
||
name:
|
||
description: |-
|
||
资源名称，如果generate_name为空，则为必填项
|
||
description: resource name, required if generated_name is not given
|
||
example: test-network
|
||
type: string
|
||
uniqueItems: true
|
||
x-go-name: Name
|
||
notify:
|
||
default: false
|
||
description: 是否发送邮件通知(仅设置email不为空生效)
|
||
type: boolean
|
||
x-go-name: Notify
|
||
owner_id:
|
||
description: 本地用户Id，若为空则使用当前用户Id作为此参数值
|
||
type: string
|
||
x-go-name: OwnerId
|
||
password:
|
||
description: |-
|
||
用户密码, 若is_console_login = true时, 此参数不传时会生成12位随机密码
|
||
|
||
|
||
|
||
云平台 | 说明 |
|
||
----------|---------------------------------------------|
|
||
Google | 不支持此参数 |
|
||
Aliyun | 支持 |
|
||
Huawei | 支持 |
|
||
Azure | 支持 |
|
||
腾讯云 | 支持 |
|
||
type: string
|
||
x-go-name: Password
|
||
project_domain_id:
|
||
description: 指定项目归属域名称或ID
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
status:
|
||
description: 用来存储资源的状态
|
||
type: string
|
||
x-go-name: Status
|
||
required:
|
||
- name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
ClouduserDeleteAccessKeyInput:
|
||
properties:
|
||
access_key:
|
||
type: string
|
||
x-go-name: AccessKey
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
ClouduserDetachPolicyInput:
|
||
properties:
|
||
cloudpolicy_id:
|
||
description: |-
|
||
权限Id
|
||
|
||
|
||
|
||
云平台 | 说明 |
|
||
----------|---------------------------------------------|
|
||
Google | 支持，但最少需要保留一个权限 |
|
||
Aliyun | 支持 |
|
||
Huawei | 不支持 |
|
||
Azure | 不支持 |
|
||
腾讯云 | 支持 |
|
||
type: string
|
||
x-go-name: CloudpolicyId
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
ClouduserDetails:
|
||
properties:
|
||
brand:
|
||
description: 品牌信息
|
||
type: string
|
||
x-go-name: Brand
|
||
can_delete:
|
||
description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
|
||
example: true
|
||
type: boolean
|
||
x-go-name: CanDelete
|
||
can_update:
|
||
description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
|
||
example: true
|
||
type: boolean
|
||
x-go-name: CanUpdate
|
||
cloudaccount:
|
||
description: 云账号名称
|
||
type: string
|
||
x-go-name: Cloudaccount
|
||
cloudaccount_id:
|
||
description: 云账号Id
|
||
type: string
|
||
x-go-name: CloudaccountId
|
||
cloudgroup_count:
|
||
description: 权限组数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: CloudgroupCount
|
||
cloudgroups:
|
||
items:
|
||
$ref: '#/definitions/SCloudIdBaseResource'
|
||
type: array
|
||
x-go-name: Cloudgroups
|
||
cloudpolicies:
|
||
items:
|
||
$ref: '#/definitions/SCloudIdBaseResource'
|
||
type: array
|
||
x-go-name: Cloudpolicies
|
||
cloudpolicy_count:
|
||
description: 权限数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: CloudpolicyCount
|
||
created_at:
|
||
description: 资源创建时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: CreatedAt
|
||
delete_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
deleted:
|
||
description: 资源是否被删除
|
||
type: boolean
|
||
x-go-name: Deleted
|
||
deleted_at:
|
||
description: 资源删除时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: DeletedAt
|
||
description:
|
||
description: 资源描述信息
|
||
type: string
|
||
x-go-name: Description
|
||
domain_id:
|
||
description: 域Id
|
||
type: string
|
||
x-go-name: DomainId
|
||
domain_src:
|
||
description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
|
||
example: local
|
||
type: string
|
||
x-go-name: DomainSrc
|
||
email:
|
||
description: 邮箱地址
|
||
type: string
|
||
x-go-name: Email
|
||
external_id:
|
||
description: 云上Id, 对应云上资源自身Id
|
||
type: string
|
||
x-go-name: ExternalId
|
||
iam_login_url:
|
||
description: 公有云账号登录地址
|
||
type: string
|
||
x-go-name: IamLoginUrl
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
imported_at:
|
||
description: 资源导入时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: ImportedAt
|
||
is_console_login:
|
||
description: 是否可以控制台登录
|
||
type: boolean
|
||
x-go-name: IsConsoleLogin
|
||
is_emulated:
|
||
description: |-
|
||
是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
|
||
list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
manager:
|
||
description: 云订阅名称
|
||
type: string
|
||
x-go-name: Manager
|
||
manager_id:
|
||
description: 子订阅Id
|
||
type: string
|
||
x-go-name: ManagerId
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
mobile_phone:
|
||
description: 手机号码
|
||
type: string
|
||
x-go-name: MobilePhone
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
org_node_md5:
|
||
description: 用以组织架构变更通知其他服务权限变更
|
||
type: string
|
||
x-go-name: OrgNodeMd5
|
||
owner_id:
|
||
description: 本地用户Id
|
||
type: string
|
||
x-go-name: OwnerId
|
||
owner_name:
|
||
description: 用户名称
|
||
type: string
|
||
x-go-name: OwnerName
|
||
progress:
|
||
description: 操作进度0-100
|
||
format: float
|
||
type: number
|
||
x-go-name: Progress
|
||
project_domain:
|
||
description: 资源归属项目的域名称
|
||
type: string
|
||
x-go-name: ProjectDomain
|
||
provider:
|
||
description: 平台信息
|
||
type: string
|
||
x-go-name: Provider
|
||
secret:
|
||
type: string
|
||
x-go-name: Secret
|
||
source:
|
||
description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目'
|
||
type: string
|
||
x-go-name: Source
|
||
status:
|
||
description: 资源状态
|
||
type: string
|
||
x-go-name: Status
|
||
update_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
update_version:
|
||
description: 资源被更新次数
|
||
format: int64
|
||
type: integer
|
||
x-go-name: UpdateVersion
|
||
updated_at:
|
||
description: 资源更新时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: UpdatedAt
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
ClouduserJoinGroupInput:
|
||
properties:
|
||
cloudgroup_id:
|
||
description: 权限组Id
|
||
type: string
|
||
x-go-name: CloudgroupId
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
ClouduserLeaveGroupInput:
|
||
properties:
|
||
cloudgroup_id:
|
||
description: 权限组Id
|
||
type: string
|
||
x-go-name: CloudgroupId
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
ClouduserResetPasswordInput:
|
||
properties:
|
||
password:
|
||
description: |-
|
||
若此参数为空, 默认会生成随机12位密码
|
||
|
||
|
||
|
||
云平台 | 说明 |
|
||
----------|---------------------------------------------|
|
||
Google | 不支持 |
|
||
Aliyun | 支持 |
|
||
Huawei | 支持 |
|
||
Azure | 支持 |
|
||
腾讯云 | 支持 |
|
||
type: string
|
||
x-go-name: Password
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
ClouduserSetGroupsInput:
|
||
properties:
|
||
cloudgroup_ids:
|
||
description: 权限组Ids
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: CloudgroupIds
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
ClouduserSetPoliciesInput:
|
||
properties:
|
||
cloudpolicy_ids:
|
||
description: 权限Ids
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: CloudpolicyIds
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
ClouduserSyncstatusInput:
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
EnabledStatusInfrasResourceBaseUpdateInput:
|
||
properties:
|
||
description:
|
||
description: 资源描述
|
||
type: string
|
||
x-go-name: Description
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
Error:
|
||
properties:
|
||
class:
|
||
type: string
|
||
x-go-name: Class
|
||
code:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Code
|
||
details:
|
||
type: string
|
||
x-go-name: Details
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/httperrors
|
||
GetCloudaccountSamlOutput:
|
||
properties:
|
||
entity_id:
|
||
description: cloudaccount SAML ServiceProvider entity ID
|
||
type: string
|
||
x-go-name: EntityId
|
||
init_login_url:
|
||
description: initial SAML SSO login URL for this cloudaccount
|
||
type: string
|
||
x-go-name: InitLoginUrl
|
||
metadata_url:
|
||
description: metadata URL for this cloudaccount
|
||
type: string
|
||
x-go-name: MetadataUrl
|
||
redirect_login_url:
|
||
description: redirect login URL for this cloudaccount
|
||
type: string
|
||
x-go-name: RedirectLoginUrl
|
||
redirect_logout_url:
|
||
description: redirect logout URL for this cloudaccount
|
||
type: string
|
||
x-go-name: RedirectLogoutUrl
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
GetDetailsStatusOutput:
|
||
properties:
|
||
status:
|
||
description: 状态
|
||
type: string
|
||
x-go-name: Status
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
PerformChangeDomainOwnerInput:
|
||
properties:
|
||
project_domain_id:
|
||
description: 指定项目归属域名称或ID
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
PerformDisableInput:
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
PerformEnableInput:
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
PerformPrivateInput:
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
PerformPublicDomainInput:
|
||
properties:
|
||
scope:
|
||
description: 共享项目资源的共享范围，可能的值为：project, domain和system
|
||
pattern: project|domain|system
|
||
type: string
|
||
x-go-name: Scope
|
||
shared_domain_ids:
|
||
description: 如果共享范围为域，则在此列表中指定共享的目标域
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: SharedDomainIds
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
SAMLProviderDetails:
|
||
properties:
|
||
auth_url:
|
||
type: string
|
||
x-go-name: AuthUrl
|
||
brand:
|
||
description: 品牌信息
|
||
type: string
|
||
x-go-name: Brand
|
||
can_delete:
|
||
description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
|
||
example: true
|
||
type: boolean
|
||
x-go-name: CanDelete
|
||
can_update:
|
||
description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
|
||
example: true
|
||
type: boolean
|
||
x-go-name: CanUpdate
|
||
cloudaccount:
|
||
description: 云账号名称
|
||
type: string
|
||
x-go-name: Cloudaccount
|
||
cloudaccount_id:
|
||
description: 云账号Id
|
||
type: string
|
||
x-go-name: CloudaccountId
|
||
created_at:
|
||
description: 资源创建时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: CreatedAt
|
||
delete_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
deleted:
|
||
description: 资源是否被删除
|
||
type: boolean
|
||
x-go-name: Deleted
|
||
deleted_at:
|
||
description: 资源删除时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: DeletedAt
|
||
description:
|
||
description: 资源描述信息
|
||
type: string
|
||
x-go-name: Description
|
||
domain_id:
|
||
description: 域Id
|
||
type: string
|
||
x-go-name: DomainId
|
||
domain_src:
|
||
description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
|
||
example: local
|
||
type: string
|
||
x-go-name: DomainSrc
|
||
entity_id:
|
||
type: string
|
||
x-go-name: EntityId
|
||
external_id:
|
||
description: 云上Id, 对应云上资源自身Id
|
||
type: string
|
||
x-go-name: ExternalId
|
||
iam_login_url:
|
||
description: 公有云账号登录地址
|
||
type: string
|
||
x-go-name: IamLoginUrl
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
imported_at:
|
||
description: 资源导入时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: ImportedAt
|
||
is_emulated:
|
||
description: |-
|
||
是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
|
||
list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
is_public:
|
||
description: 是否共享
|
||
type: boolean
|
||
x-go-name: IsPublic
|
||
manager_id:
|
||
description: 子订阅Id
|
||
type: string
|
||
x-go-name: ManagerId
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
metadata_document:
|
||
type: string
|
||
x-go-name: MetadataDocument
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
org_node_md5:
|
||
description: 用以组织架构变更通知其他服务权限变更
|
||
type: string
|
||
x-go-name: OrgNodeMd5
|
||
progress:
|
||
description: 操作进度0-100
|
||
format: float
|
||
type: number
|
||
x-go-name: Progress
|
||
project_domain:
|
||
description: 资源归属项目的域名称
|
||
type: string
|
||
x-go-name: ProjectDomain
|
||
provider:
|
||
description: 平台信息
|
||
type: string
|
||
x-go-name: Provider
|
||
public_scope:
|
||
description: 默认共享范围
|
||
type: string
|
||
x-go-name: PublicScope
|
||
public_src:
|
||
description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来'
|
||
example: local
|
||
type: string
|
||
x-go-name: PublicSrc
|
||
shared_domains:
|
||
description: 共享的域列表
|
||
items:
|
||
$ref: '#/definitions/SharedDomain'
|
||
type: array
|
||
x-go-name: SharedDomains
|
||
shared_projects:
|
||
description: 共享的项目列表
|
||
items:
|
||
$ref: '#/definitions/SharedProject'
|
||
type: array
|
||
x-go-name: SharedProjects
|
||
source:
|
||
description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目'
|
||
type: string
|
||
x-go-name: Source
|
||
status:
|
||
description: 资源状态
|
||
type: string
|
||
x-go-name: Status
|
||
update_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
update_version:
|
||
description: 资源被更新次数
|
||
format: int64
|
||
type: integer
|
||
x-go-name: UpdateVersion
|
||
updated_at:
|
||
description: 资源更新时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: UpdatedAt
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
SCloudIdBaseResource:
|
||
properties:
|
||
id:
|
||
type: string
|
||
x-go-name: Id
|
||
name:
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
STag:
|
||
properties:
|
||
key:
|
||
description: 标签Kye
|
||
type: string
|
||
x-go-name: Key
|
||
value:
|
||
description: 标签Value
|
||
type: string
|
||
x-go-name: Value
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
|
||
SamluserCreateInput:
|
||
properties:
|
||
__meta__:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签列表,最多支持20个
|
||
example:
|
||
user:rd: op
|
||
type: object
|
||
x-go-name: Metadata
|
||
cloudaccount_id:
|
||
description: 权限组和账号必须是同一平台
|
||
type: string
|
||
x-go-name: CloudaccountId
|
||
cloudgroup_id:
|
||
description: 权限组和账号必须是同一平台
|
||
type: string
|
||
x-go-name: CloudgroupId
|
||
description:
|
||
description: 资源描述
|
||
example: test create network
|
||
type: string
|
||
x-go-name: Description
|
||
dry_run:
|
||
default: false
|
||
description: 预检验参数,若为true则仅检查参数,并不真正创建变更
|
||
type: boolean
|
||
x-go-name: DryRun
|
||
email:
|
||
type: string
|
||
x-go-name: Email
|
||
generate_name:
|
||
description: |-
|
||
生成资源名称的模板，如果name为空，则为必填项
|
||
description: generated resource name, given a pattern to generate name, required if name is not given
|
||
example: test###
|
||
type: string
|
||
x-go-name: GenerateName
|
||
is_emulated:
|
||
description: |-
|
||
资源是否为模拟资源
|
||
description: the resource is an emulated resource
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
name:
|
||
description: |-
|
||
资源名称，如果generate_name为空，则为必填项
|
||
description: resource name, required if generated_name is not given
|
||
example: test-network
|
||
type: string
|
||
uniqueItems: true
|
||
x-go-name: Name
|
||
owner_id:
|
||
description: 本地用户Id，若为空则使用当前用户Id作为此参数值
|
||
type: string
|
||
x-go-name: OwnerId
|
||
project_domain_id:
|
||
description: 指定项目归属域名称或ID
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
status:
|
||
description: 用来存储资源的状态
|
||
type: string
|
||
x-go-name: Status
|
||
required:
|
||
- name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
SamluserDetails:
|
||
properties:
|
||
brand:
|
||
description: 品牌信息
|
||
type: string
|
||
x-go-name: Brand
|
||
can_delete:
|
||
description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
|
||
example: true
|
||
type: boolean
|
||
x-go-name: CanDelete
|
||
can_update:
|
||
description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
|
||
example: true
|
||
type: boolean
|
||
x-go-name: CanUpdate
|
||
cloudaccount:
|
||
description: 云账号名称
|
||
type: string
|
||
x-go-name: Cloudaccount
|
||
cloudaccount_id:
|
||
type: string
|
||
x-go-name: CloudaccountId
|
||
cloudgroup:
|
||
description: 公有云用户名称
|
||
type: string
|
||
x-go-name: Cloudgroup
|
||
cloudgroup_id:
|
||
type: string
|
||
x-go-name: CloudgroupId
|
||
cloudrole_id:
|
||
type: string
|
||
x-go-name: CloudroleId
|
||
created_at:
|
||
description: 资源创建时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: CreatedAt
|
||
delete_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
deleted:
|
||
description: 资源是否被删除
|
||
type: boolean
|
||
x-go-name: Deleted
|
||
deleted_at:
|
||
description: 资源删除时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: DeletedAt
|
||
description:
|
||
description: 资源描述信息
|
||
type: string
|
||
x-go-name: Description
|
||
domain_id:
|
||
description: 域Id
|
||
type: string
|
||
x-go-name: DomainId
|
||
domain_src:
|
||
description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
|
||
example: local
|
||
type: string
|
||
x-go-name: DomainSrc
|
||
email:
|
||
description: 邮箱地址
|
||
type: string
|
||
x-go-name: Email
|
||
iam_login_url:
|
||
description: 公有云账号登录地址
|
||
type: string
|
||
x-go-name: IamLoginUrl
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
is_emulated:
|
||
description: |-
|
||
是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
|
||
list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
manager:
|
||
type: string
|
||
x-go-name: Manager
|
||
manager_id:
|
||
type: string
|
||
x-go-name: ManagerId
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
org_node_md5:
|
||
description: 用以组织架构变更通知其他服务权限变更
|
||
type: string
|
||
x-go-name: OrgNodeMd5
|
||
owner_id:
|
||
description: 本地用户Id
|
||
type: string
|
||
x-go-name: OwnerId
|
||
owner_name:
|
||
description: 用户名称
|
||
type: string
|
||
x-go-name: OwnerName
|
||
progress:
|
||
description: 操作进度0-100
|
||
format: float
|
||
type: number
|
||
x-go-name: Progress
|
||
project_domain:
|
||
description: 资源归属项目的域名称
|
||
type: string
|
||
x-go-name: ProjectDomain
|
||
provider:
|
||
description: 平台信息
|
||
type: string
|
||
x-go-name: Provider
|
||
status:
|
||
description: 资源状态
|
||
type: string
|
||
x-go-name: Status
|
||
update_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
update_version:
|
||
description: 资源被更新次数
|
||
format: int64
|
||
type: integer
|
||
x-go-name: UpdateVersion
|
||
updated_at:
|
||
description: 资源更新时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: UpdatedAt
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
SharedDomain:
|
||
properties:
|
||
id:
|
||
type: string
|
||
x-go-name: Id
|
||
name:
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
SharedProject:
|
||
properties:
|
||
domain:
|
||
type: string
|
||
x-go-name: Domain
|
||
domain_id:
|
||
type: string
|
||
x-go-name: DomainId
|
||
id:
|
||
type: string
|
||
x-go-name: Id
|
||
name:
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
StatusDomainLevelResourceBaseUpdateInput:
|
||
properties:
|
||
description:
|
||
description: 资源描述
|
||
type: string
|
||
x-go-name: Description
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
StatusInfrasResourceBaseCreateInput:
|
||
properties:
|
||
__meta__:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签列表,最多支持20个
|
||
example:
|
||
user:rd: op
|
||
type: object
|
||
x-go-name: Metadata
|
||
description:
|
||
description: 资源描述
|
||
example: test create network
|
||
type: string
|
||
x-go-name: Description
|
||
dry_run:
|
||
default: false
|
||
description: 预检验参数,若为true则仅检查参数,并不真正创建变更
|
||
type: boolean
|
||
x-go-name: DryRun
|
||
generate_name:
|
||
description: |-
|
||
生成资源名称的模板，如果name为空，则为必填项
|
||
description: generated resource name, given a pattern to generate name, required if name is not given
|
||
example: test###
|
||
type: string
|
||
x-go-name: GenerateName
|
||
is_emulated:
|
||
description: |-
|
||
资源是否为模拟资源
|
||
description: the resource is an emulated resource
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
is_public:
|
||
description: 是否共享
|
||
type: boolean
|
||
x-go-name: IsPublic
|
||
name:
|
||
description: |-
|
||
资源名称，如果generate_name为空，则为必填项
|
||
description: resource name, required if generated_name is not given
|
||
example: test-network
|
||
type: string
|
||
uniqueItems: true
|
||
x-go-name: Name
|
||
project_domain_id:
|
||
description: 指定项目归属域名称或ID
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
public_scope:
|
||
description: 共享范围
|
||
type: string
|
||
x-go-name: PublicScope
|
||
status:
|
||
description: 用来存储资源的状态
|
||
type: string
|
||
x-go-name: Status
|
||
required:
|
||
- name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
StatusInfrasResourceBaseUpdateInput:
|
||
properties:
|
||
description:
|
||
description: 资源描述
|
||
type: string
|
||
x-go-name: Description
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
TTagSet:
|
||
items:
|
||
$ref: '#/definitions/STag'
|
||
type: array
|
||
x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
|
||
TTagSetList:
|
||
items:
|
||
$ref: '#/definitions/TTagSet'
|
||
type: array
|
||
x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
|
||
host: '"127.0.0.1:8889"'
|
||
info:
|
||
contact:
|
||
email: lizexi@yunion.cn
|
||
name: Zexi Li
|
||
description: Cloudid API
|
||
license:
|
||
name: Apache 2.0
|
||
url: http://www.apache.org/licenses/LICENSE-2.0.html
|
||
version: "1.0"
|
||
paths:
|
||
/cloudgroups:
|
||
get:
|
||
description: 列表
|
||
operationId: cloudgroup_ListItemFilter
|
||
parameters:
|
||
- default: 20
|
||
description: 查询限制量
|
||
format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
- default: 0
|
||
description: 查询偏移量
|
||
format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: order_by
|
||
type: array
|
||
x-go-name: OrderBy
|
||
- description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。
|
||
example: desc|asc
|
||
in: query
|
||
name: order
|
||
type: string
|
||
x-go-name: Order
|
||
- description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。
|
||
in: query
|
||
name: details
|
||
type: boolean
|
||
x-go-name: Details
|
||
- description: 模糊搜索所有字段
|
||
in: query
|
||
name: search
|
||
type: string
|
||
x-go-name: Search
|
||
- description: |-
|
||
指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test')
|
||
支持的操作符如下：
|
||
|
||
操作符 | 参数个数 | 举例 | 说明 |
|
||
---------------|----------|------------------------------------------------|-----------------------------|
|
||
in | > 0 | name.in("test", "good") | 在给定数组中 |
|
||
notin | > 0 | name.notin('test') | 不在给定数组中 |
|
||
between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
|
||
ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
|
||
gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
|
||
le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
|
||
lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
|
||
like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
|
||
contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
|
||
startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
|
||
endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
|
||
equals | > 0 | name.equals('test') | 等于任意一个给定值 |
|
||
notequals | 1 | name.notequals('test') | 不等于给定值 |
|
||
isnull | 0 | name.isnull() | 值为SQL的NULL |
|
||
isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
|
||
isempty | 0 | name.isempty('test') | 值为空字符串 |
|
||
isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
|
||
isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: filter
|
||
type: array
|
||
x-go-name: Filter
|
||
- description: |-
|
||
指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同，
|
||
和其他表关联的语法如下：
|
||
joint_resources.related_key(origin_key).filter_col.filter_ops(values)
|
||
其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为
|
||
关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值
|
||
举例：
|
||
guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: joint_filter
|
||
type: array
|
||
x-go-name: JointFilter
|
||
- description: 如果filter_any为true，则查询所有filter的并集，否则为交集
|
||
in: query
|
||
name: filter_any
|
||
type: boolean
|
||
x-go-name: FilterAny
|
||
- description: 返回结果只包含指定的字段
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: field
|
||
type: array
|
||
x-go-name: Field
|
||
- description: 用于数据导出，指定导出的数据字段
|
||
in: query
|
||
name: export_keys
|
||
type: string
|
||
x-go-name: ExportKeys
|
||
- description: 返回结果携带delete_fail_reason和update_fail_reason字段
|
||
in: query
|
||
name: show_fail_reason
|
||
type: boolean
|
||
x-go-name: ShowFailReason
|
||
- description: 是否返回状态统计信息，默认为False
|
||
in: query
|
||
name: summary_stats
|
||
type: boolean
|
||
x-go-name: SummaryStats
|
||
- $ref: '#/definitions/TTagSet'
|
||
description: 通过标签过滤（包含这些标签）
|
||
in: query
|
||
name: tags
|
||
x-go-name: Tags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: 通过一组标签过滤（还包含这些标签，OR的关系）
|
||
in: query
|
||
name: obj_tags
|
||
x-go-name: ObjTags
|
||
- $ref: '#/definitions/TTagSet'
|
||
description: 通过标签过滤（不包含这些标签）
|
||
in: query
|
||
name: no_tags
|
||
x-go-name: NoTags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: 通过一组标签过滤（还不包含这些标签，AND的关系）
|
||
in: query
|
||
name: no_obj_tags
|
||
x-go-name: NoObjTags
|
||
- description: 通过标签排序
|
||
in: query
|
||
name: order_by_tag
|
||
type: string
|
||
x-go-name: OrderByTag
|
||
- description: |-
|
||
deprecated
|
||
返回资源的标签不包含用户标签
|
||
in: query
|
||
name: without_user_meta
|
||
type: boolean
|
||
x-go-name: WithoutUserMeta
|
||
- description: 返回包含用户标签的资源
|
||
in: query
|
||
name: with_user_meta
|
||
type: boolean
|
||
x-go-name: WithUserMeta
|
||
- description: 返回包含外部标签的资源
|
||
in: query
|
||
name: with_cloud_meta
|
||
type: boolean
|
||
x-go-name: WithCloudMeta
|
||
- description: 返回包含任意标签的资源
|
||
in: query
|
||
name: with_any_meta
|
||
type: boolean
|
||
x-go-name: WithAnyMeta
|
||
- description: 返回列表数据中包含资源的标签数据（Metadata）
|
||
in: query
|
||
name: with_meta
|
||
type: boolean
|
||
x-go-name: WithMeta
|
||
- description: 显示所有的资源，包括模拟的资源
|
||
in: query
|
||
name: show_emulated
|
||
type: boolean
|
||
x-go-name: ShowEmulated
|
||
- description: 以资源ID过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: id
|
||
type: array
|
||
x-go-name: Ids
|
||
- description: 以资源名称过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: name
|
||
type: array
|
||
x-go-name: Names
|
||
- description: 指定查询的权限范围，可能值为project, domain or system
|
||
in: query
|
||
name: scope
|
||
type: string
|
||
x-go-name: Scope
|
||
- description: 指定项目归属域名称或ID
|
||
in: query
|
||
name: project_domain_id
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
- description: 对具有域属性的资源，严格匹配域ID
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: project_domain_ids
|
||
type: array
|
||
x-go-name: ProjectDomainIds
|
||
- description: 按domain名称排序，可能值为asc|desc
|
||
in: query
|
||
name: order_by_domain
|
||
pattern: asc|desc
|
||
type: string
|
||
x-go-name: OrderByDomain
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: filter by domain tags
|
||
in: query
|
||
name: domain_tags
|
||
x-go-name: DomainTags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: filter by domain tags
|
||
in: query
|
||
name: no_domain_tags
|
||
x-go-name: NoDomainTags
|
||
- description: 以资源是否共享过滤列表
|
||
in: query
|
||
name: is_public
|
||
type: boolean
|
||
x-go-name: IsPublic
|
||
- description: 根据资源的共享范围过滤列表，可能值为：system, domain, project
|
||
in: query
|
||
name: public_scope
|
||
type: string
|
||
x-go-name: PublicScope
|
||
- description: 以资源的状态过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: status
|
||
type: array
|
||
x-go-name: Status
|
||
- description: 根据平台过滤
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: provider
|
||
type: array
|
||
x-go-name: Provider
|
||
- in: query
|
||
name: cloudaccount_id
|
||
type: string
|
||
x-go-name: CloudaccountId
|
||
- description: 根据云订阅过滤资源
|
||
in: query
|
||
name: manager_id
|
||
type: string
|
||
x-go-name: ManagerId
|
||
- description: 过滤子账号所在的权限组
|
||
in: query
|
||
name: clouduser_id
|
||
type: string
|
||
x-go-name: ClouduserId
|
||
- description: 根据权限过滤权限组
|
||
in: query
|
||
name: cloudpolicy_id
|
||
type: string
|
||
x-go-name: CloudpolicyId
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_ListItemFilterOutput'
|
||
summary: 权限组列表
|
||
tags:
|
||
- cloudgroup
|
||
post:
|
||
description: 新建
|
||
operationId: cloudgroup_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/CloudgroupCreateInput'
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_ValidateCreateDataOutput'
|
||
summary: 创建权限组
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: cloudgroup_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of cloudgroup
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_CustomizeDeleteOutput'
|
||
summary: 删除权限组
|
||
tags:
|
||
- cloudgroup
|
||
get:
|
||
description: 获取详情
|
||
operationId: cloudgroup_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of cloudgroup
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_FetchCustomizeColumnsOutput'
|
||
summary: 获取权限组详情
|
||
tags:
|
||
- cloudgroup
|
||
put:
|
||
description: 更新
|
||
operationId: cloudgroup_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of cloudgroup
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/CloudgroupUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_ValidateUpdateDataOutput'
|
||
summary: 更新权限组
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/{id}/add-user:
|
||
post:
|
||
description: '权限组状态必须为: available'
|
||
operationId: cloudgroup_PerformAddUser
|
||
parameters:
|
||
- description: The Id or Name of cloudgroup
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/CloudgroupAddUserInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_PerformAddUserOutput'
|
||
summary: 向权限组加入用户
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/{id}/attach-policy:
|
||
post:
|
||
description: '权限组状态必须为: available'
|
||
operationId: cloudgroup_PerformAttachPolicy
|
||
parameters:
|
||
- description: The Id or Name of cloudgroup
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/CloudgroupAttachPolicyInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_PerformAttachPolicyOutput'
|
||
summary: 向权限组添加权限
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/{id}/change-owner:
|
||
post:
|
||
description: 执行操作ChangeOwner
|
||
operationId: cloudgroup_PerformChangeOwner
|
||
parameters:
|
||
- description: The Id or Name of cloudgroup
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/PerformChangeDomainOwnerInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_PerformChangeOwnerOutput'
|
||
summary: 执行操作ChangeOwner
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/{id}/detach-policy:
|
||
post:
|
||
description: '权限组状态必须为: available'
|
||
operationId: cloudgroup_PerformDetachPolicy
|
||
parameters:
|
||
- description: The Id or Name of cloudgroup
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/CloudgroupDetachPolicyInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_PerformDetachPolicyOutput'
|
||
summary: 从权限组移除权限
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: cloudgroup_GetDetailsMetadata
|
||
parameters:
|
||
- description: |-
|
||
指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签
|
||
标签分为
|
||
|
||
类型 | 说明 |
|
||
----------|---------------------------------------------|
|
||
系统标签 | 平台定义的标签 |
|
||
用户标签 | key以user:为前缀，用户自定义标签 |
|
||
外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 |
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: field
|
||
type: array
|
||
x-go-name: Field
|
||
- description: 按标签前缀过滤
|
||
in: query
|
||
name: prefix
|
||
type: string
|
||
x-go-name: Prefix
|
||
- description: The Id or Name of cloudgroup
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签（元数据）
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/{id}/private:
|
||
post:
|
||
description: 执行操作Private
|
||
operationId: cloudgroup_PerformPrivate
|
||
parameters:
|
||
- description: The Id or Name of cloudgroup
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/PerformPrivateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_PerformPrivateOutput'
|
||
summary: 执行操作Private
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/{id}/public:
|
||
post:
|
||
description: 执行操作Public
|
||
operationId: cloudgroup_PerformPublic
|
||
parameters:
|
||
- description: The Id or Name of cloudgroup
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/PerformPublicDomainInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_PerformPublicOutput'
|
||
summary: 执行操作Public
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/{id}/remove-user:
|
||
post:
|
||
description: '权限组状态必须为: available'
|
||
operationId: cloudgroup_PerformRemoveUser
|
||
parameters:
|
||
- description: The Id or Name of cloudgroup
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/CloudgroupRemoveUserInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_PerformRemoveUserOutput'
|
||
summary: 从权限组移除用户
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/{id}/saml:
|
||
get:
|
||
description: 获取指定信息Saml
|
||
operationId: cloudgroup_GetDetailsSaml
|
||
parameters:
|
||
- description: The Id or Name of cloudgroup
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_GetDetailsSamlOutput'
|
||
summary: 获取指定信息Saml
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/{id}/set-policies:
|
||
post:
|
||
description: '权限组状态必须为: available'
|
||
operationId: cloudgroup_PerformSetPolicies
|
||
parameters:
|
||
- description: The Id or Name of cloudgroup
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/CloudgroupSetPoliciesInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_PerformSetPoliciesOutput'
|
||
summary: 设置权限组添权限(全量覆盖)
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/{id}/set-users:
|
||
post:
|
||
description: '权限组状态必须为: available'
|
||
operationId: cloudgroup_PerformSetUsers
|
||
parameters:
|
||
- description: The Id or Name of cloudgroup
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/CloudgroupSetUsersInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_PerformSetUsersOutput'
|
||
summary: 设置权限组用户(全量覆盖)
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/{id}/status:
|
||
get:
|
||
description: 获取指定信息Status
|
||
operationId: cloudgroup_GetDetailsStatus
|
||
parameters:
|
||
- description: The Id or Name of cloudgroup
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_GetDetailsStatusOutput'
|
||
summary: 获取资源状态
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/{id}/syncstatus:
|
||
post:
|
||
description: 执行操作Syncstatus
|
||
operationId: cloudgroup_PerformSyncstatus
|
||
parameters:
|
||
- description: The Id or Name of cloudgroup
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/CloudgroupSyncstatusInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_PerformSyncstatusOutput'
|
||
summary: 恢复权限组状态
|
||
tags:
|
||
- cloudgroup
|
||
/cloudpolicies:
|
||
get:
|
||
description: 列表
|
||
operationId: cloudpolicy_ListItemFilter
|
||
parameters:
|
||
- default: 20
|
||
description: 查询限制量
|
||
format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
- default: 0
|
||
description: 查询偏移量
|
||
format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: order_by
|
||
type: array
|
||
x-go-name: OrderBy
|
||
- description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。
|
||
example: desc|asc
|
||
in: query
|
||
name: order
|
||
type: string
|
||
x-go-name: Order
|
||
- description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。
|
||
in: query
|
||
name: details
|
||
type: boolean
|
||
x-go-name: Details
|
||
- description: 模糊搜索所有字段
|
||
in: query
|
||
name: search
|
||
type: string
|
||
x-go-name: Search
|
||
- description: |-
|
||
指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test')
|
||
支持的操作符如下：
|
||
|
||
操作符 | 参数个数 | 举例 | 说明 |
|
||
---------------|----------|------------------------------------------------|-----------------------------|
|
||
in | > 0 | name.in("test", "good") | 在给定数组中 |
|
||
notin | > 0 | name.notin('test') | 不在给定数组中 |
|
||
between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
|
||
ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
|
||
gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
|
||
le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
|
||
lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
|
||
like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
|
||
contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
|
||
startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
|
||
endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
|
||
equals | > 0 | name.equals('test') | 等于任意一个给定值 |
|
||
notequals | 1 | name.notequals('test') | 不等于给定值 |
|
||
isnull | 0 | name.isnull() | 值为SQL的NULL |
|
||
isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
|
||
isempty | 0 | name.isempty('test') | 值为空字符串 |
|
||
isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
|
||
isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: filter
|
||
type: array
|
||
x-go-name: Filter
|
||
- description: |-
|
||
指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同，
|
||
和其他表关联的语法如下：
|
||
joint_resources.related_key(origin_key).filter_col.filter_ops(values)
|
||
其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为
|
||
关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值
|
||
举例：
|
||
guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: joint_filter
|
||
type: array
|
||
x-go-name: JointFilter
|
||
- description: 如果filter_any为true，则查询所有filter的并集，否则为交集
|
||
in: query
|
||
name: filter_any
|
||
type: boolean
|
||
x-go-name: FilterAny
|
||
- description: 返回结果只包含指定的字段
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: field
|
||
type: array
|
||
x-go-name: Field
|
||
- description: 用于数据导出，指定导出的数据字段
|
||
in: query
|
||
name: export_keys
|
||
type: string
|
||
x-go-name: ExportKeys
|
||
- description: 返回结果携带delete_fail_reason和update_fail_reason字段
|
||
in: query
|
||
name: show_fail_reason
|
||
type: boolean
|
||
x-go-name: ShowFailReason
|
||
- description: 是否返回状态统计信息，默认为False
|
||
in: query
|
||
name: summary_stats
|
||
type: boolean
|
||
x-go-name: SummaryStats
|
||
- $ref: '#/definitions/TTagSet'
|
||
description: 通过标签过滤（包含这些标签）
|
||
in: query
|
||
name: tags
|
||
x-go-name: Tags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: 通过一组标签过滤（还包含这些标签，OR的关系）
|
||
in: query
|
||
name: obj_tags
|
||
x-go-name: ObjTags
|
||
- $ref: '#/definitions/TTagSet'
|
||
description: 通过标签过滤（不包含这些标签）
|
||
in: query
|
||
name: no_tags
|
||
x-go-name: NoTags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: 通过一组标签过滤（还不包含这些标签，AND的关系）
|
||
in: query
|
||
name: no_obj_tags
|
||
x-go-name: NoObjTags
|
||
- description: 通过标签排序
|
||
in: query
|
||
name: order_by_tag
|
||
type: string
|
||
x-go-name: OrderByTag
|
||
- description: |-
|
||
deprecated
|
||
返回资源的标签不包含用户标签
|
||
in: query
|
||
name: without_user_meta
|
||
type: boolean
|
||
x-go-name: WithoutUserMeta
|
||
- description: 返回包含用户标签的资源
|
||
in: query
|
||
name: with_user_meta
|
||
type: boolean
|
||
x-go-name: WithUserMeta
|
||
- description: 返回包含外部标签的资源
|
||
in: query
|
||
name: with_cloud_meta
|
||
type: boolean
|
||
x-go-name: WithCloudMeta
|
||
- description: 返回包含任意标签的资源
|
||
in: query
|
||
name: with_any_meta
|
||
type: boolean
|
||
x-go-name: WithAnyMeta
|
||
- description: 返回列表数据中包含资源的标签数据（Metadata）
|
||
in: query
|
||
name: with_meta
|
||
type: boolean
|
||
x-go-name: WithMeta
|
||
- description: 显示所有的资源，包括模拟的资源
|
||
in: query
|
||
name: show_emulated
|
||
type: boolean
|
||
x-go-name: ShowEmulated
|
||
- description: 以资源ID过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: id
|
||
type: array
|
||
x-go-name: Ids
|
||
- description: 以资源名称过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: name
|
||
type: array
|
||
x-go-name: Names
|
||
- description: 指定查询的权限范围，可能值为project, domain or system
|
||
in: query
|
||
name: scope
|
||
type: string
|
||
x-go-name: Scope
|
||
- description: 指定项目归属域名称或ID
|
||
in: query
|
||
name: project_domain_id
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
- description: 对具有域属性的资源，严格匹配域ID
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: project_domain_ids
|
||
type: array
|
||
x-go-name: ProjectDomainIds
|
||
- description: 按domain名称排序，可能值为asc|desc
|
||
in: query
|
||
name: order_by_domain
|
||
pattern: asc|desc
|
||
type: string
|
||
x-go-name: OrderByDomain
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: filter by domain tags
|
||
in: query
|
||
name: domain_tags
|
||
x-go-name: DomainTags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: filter by domain tags
|
||
in: query
|
||
name: no_domain_tags
|
||
x-go-name: NoDomainTags
|
||
- description: 以资源是否共享过滤列表
|
||
in: query
|
||
name: is_public
|
||
type: boolean
|
||
x-go-name: IsPublic
|
||
- description: 根据资源的共享范围过滤列表，可能值为：system, domain, project
|
||
in: query
|
||
name: public_scope
|
||
type: string
|
||
x-go-name: PublicScope
|
||
- description: 以资源的状态过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: status
|
||
type: array
|
||
x-go-name: Status
|
||
- in: query
|
||
name: cloudaccount_id
|
||
type: string
|
||
x-go-name: CloudaccountId
|
||
- description: 根据平台过滤
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: provider
|
||
type: array
|
||
x-go-name: Provider
|
||
- description: 根据子账号过滤权限
|
||
in: query
|
||
name: clouduser_id
|
||
type: string
|
||
x-go-name: ClouduserId
|
||
- description: 根据权限组过滤权限
|
||
in: query
|
||
name: cloudgroup_id
|
||
type: string
|
||
x-go-name: CloudgroupId
|
||
- description: 根据订阅过滤权限
|
||
in: query
|
||
name: manager_id
|
||
type: string
|
||
x-go-name: ManagerId
|
||
- description: |-
|
||
权限类型
|
||
|
||
|
||
类型 | 说明 |
|
||
---------| ------------ |
|
||
system | 过滤系统权限 |
|
||
custom | 过滤自定义权限 |
|
||
in: query
|
||
name: policy_type
|
||
type: string
|
||
x-go-name: PolicyType
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_ListItemFilterOutput'
|
||
summary: 公有云权限列表
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: cloudpolicy_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of cloudpolicy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- cloudpolicy
|
||
get:
|
||
description: 获取详情
|
||
operationId: cloudpolicy_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of cloudpolicy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_FetchCustomizeColumnsOutput'
|
||
summary: 获取公有云权限详情
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/{id}/change-owner:
|
||
post:
|
||
description: 执行操作ChangeOwner
|
||
operationId: cloudpolicy_PerformChangeOwner
|
||
parameters:
|
||
- description: The Id or Name of cloudpolicy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudpolicy:
|
||
$ref: '#/definitions/PerformChangeDomainOwnerInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_PerformChangeOwnerOutput'
|
||
summary: 执行操作ChangeOwner
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: cloudpolicy_GetDetailsMetadata
|
||
parameters:
|
||
- description: |-
|
||
指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签
|
||
标签分为
|
||
|
||
类型 | 说明 |
|
||
----------|---------------------------------------------|
|
||
系统标签 | 平台定义的标签 |
|
||
用户标签 | key以user:为前缀，用户自定义标签 |
|
||
外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 |
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: field
|
||
type: array
|
||
x-go-name: Field
|
||
- description: 按标签前缀过滤
|
||
in: query
|
||
name: prefix
|
||
type: string
|
||
x-go-name: Prefix
|
||
- description: The Id or Name of cloudpolicy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签（元数据）
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/{id}/private:
|
||
post:
|
||
description: 执行操作Private
|
||
operationId: cloudpolicy_PerformPrivate
|
||
parameters:
|
||
- description: The Id or Name of cloudpolicy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudpolicy:
|
||
$ref: '#/definitions/PerformPrivateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_PerformPrivateOutput'
|
||
summary: 执行操作Private
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/{id}/public:
|
||
post:
|
||
description: 执行操作Public
|
||
operationId: cloudpolicy_PerformPublic
|
||
parameters:
|
||
- description: The Id or Name of cloudpolicy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudpolicy:
|
||
$ref: '#/definitions/PerformPublicDomainInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_PerformPublicOutput'
|
||
summary: 执行操作Public
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/{id}/status:
|
||
get:
|
||
description: 获取指定信息Status
|
||
operationId: cloudpolicy_GetDetailsStatus
|
||
parameters:
|
||
- description: The Id or Name of cloudpolicy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_GetDetailsStatusOutput'
|
||
summary: 获取资源状态
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudroles:
|
||
get:
|
||
description: 列表
|
||
operationId: cloudrole_ListItemFilter
|
||
parameters:
|
||
- default: 20
|
||
description: 查询限制量
|
||
format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
- default: 0
|
||
description: 查询偏移量
|
||
format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: order_by
|
||
type: array
|
||
x-go-name: OrderBy
|
||
- description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。
|
||
example: desc|asc
|
||
in: query
|
||
name: order
|
||
type: string
|
||
x-go-name: Order
|
||
- description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。
|
||
in: query
|
||
name: details
|
||
type: boolean
|
||
x-go-name: Details
|
||
- description: 模糊搜索所有字段
|
||
in: query
|
||
name: search
|
||
type: string
|
||
x-go-name: Search
|
||
- description: |-
|
||
指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test')
|
||
支持的操作符如下：
|
||
|
||
操作符 | 参数个数 | 举例 | 说明 |
|
||
---------------|----------|------------------------------------------------|-----------------------------|
|
||
in | > 0 | name.in("test", "good") | 在给定数组中 |
|
||
notin | > 0 | name.notin('test') | 不在给定数组中 |
|
||
between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
|
||
ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
|
||
gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
|
||
le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
|
||
lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
|
||
like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
|
||
contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
|
||
startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
|
||
endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
|
||
equals | > 0 | name.equals('test') | 等于任意一个给定值 |
|
||
notequals | 1 | name.notequals('test') | 不等于给定值 |
|
||
isnull | 0 | name.isnull() | 值为SQL的NULL |
|
||
isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
|
||
isempty | 0 | name.isempty('test') | 值为空字符串 |
|
||
isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
|
||
isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: filter
|
||
type: array
|
||
x-go-name: Filter
|
||
- description: |-
|
||
指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同，
|
||
和其他表关联的语法如下：
|
||
joint_resources.related_key(origin_key).filter_col.filter_ops(values)
|
||
其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为
|
||
关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值
|
||
举例：
|
||
guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: joint_filter
|
||
type: array
|
||
x-go-name: JointFilter
|
||
- description: 如果filter_any为true，则查询所有filter的并集，否则为交集
|
||
in: query
|
||
name: filter_any
|
||
type: boolean
|
||
x-go-name: FilterAny
|
||
- description: 返回结果只包含指定的字段
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: field
|
||
type: array
|
||
x-go-name: Field
|
||
- description: 用于数据导出，指定导出的数据字段
|
||
in: query
|
||
name: export_keys
|
||
type: string
|
||
x-go-name: ExportKeys
|
||
- description: 返回结果携带delete_fail_reason和update_fail_reason字段
|
||
in: query
|
||
name: show_fail_reason
|
||
type: boolean
|
||
x-go-name: ShowFailReason
|
||
- description: 是否返回状态统计信息，默认为False
|
||
in: query
|
||
name: summary_stats
|
||
type: boolean
|
||
x-go-name: SummaryStats
|
||
- $ref: '#/definitions/TTagSet'
|
||
description: 通过标签过滤（包含这些标签）
|
||
in: query
|
||
name: tags
|
||
x-go-name: Tags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: 通过一组标签过滤（还包含这些标签，OR的关系）
|
||
in: query
|
||
name: obj_tags
|
||
x-go-name: ObjTags
|
||
- $ref: '#/definitions/TTagSet'
|
||
description: 通过标签过滤（不包含这些标签）
|
||
in: query
|
||
name: no_tags
|
||
x-go-name: NoTags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: 通过一组标签过滤（还不包含这些标签，AND的关系）
|
||
in: query
|
||
name: no_obj_tags
|
||
x-go-name: NoObjTags
|
||
- description: 通过标签排序
|
||
in: query
|
||
name: order_by_tag
|
||
type: string
|
||
x-go-name: OrderByTag
|
||
- description: |-
|
||
deprecated
|
||
返回资源的标签不包含用户标签
|
||
in: query
|
||
name: without_user_meta
|
||
type: boolean
|
||
x-go-name: WithoutUserMeta
|
||
- description: 返回包含用户标签的资源
|
||
in: query
|
||
name: with_user_meta
|
||
type: boolean
|
||
x-go-name: WithUserMeta
|
||
- description: 返回包含外部标签的资源
|
||
in: query
|
||
name: with_cloud_meta
|
||
type: boolean
|
||
x-go-name: WithCloudMeta
|
||
- description: 返回包含任意标签的资源
|
||
in: query
|
||
name: with_any_meta
|
||
type: boolean
|
||
x-go-name: WithAnyMeta
|
||
- description: 返回列表数据中包含资源的标签数据（Metadata）
|
||
in: query
|
||
name: with_meta
|
||
type: boolean
|
||
x-go-name: WithMeta
|
||
- description: 显示所有的资源，包括模拟的资源
|
||
in: query
|
||
name: show_emulated
|
||
type: boolean
|
||
x-go-name: ShowEmulated
|
||
- description: 以资源ID过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: id
|
||
type: array
|
||
x-go-name: Ids
|
||
- description: 以资源名称过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: name
|
||
type: array
|
||
x-go-name: Names
|
||
- description: 指定查询的权限范围，可能值为project, domain or system
|
||
in: query
|
||
name: scope
|
||
type: string
|
||
x-go-name: Scope
|
||
- description: 指定项目归属域名称或ID
|
||
in: query
|
||
name: project_domain_id
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
- description: 对具有域属性的资源，严格匹配域ID
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: project_domain_ids
|
||
type: array
|
||
x-go-name: ProjectDomainIds
|
||
- description: 按domain名称排序，可能值为asc|desc
|
||
in: query
|
||
name: order_by_domain
|
||
pattern: asc|desc
|
||
type: string
|
||
x-go-name: OrderByDomain
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: filter by domain tags
|
||
in: query
|
||
name: domain_tags
|
||
x-go-name: DomainTags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: filter by domain tags
|
||
in: query
|
||
name: no_domain_tags
|
||
x-go-name: NoDomainTags
|
||
- description: 以资源是否共享过滤列表
|
||
in: query
|
||
name: is_public
|
||
type: boolean
|
||
x-go-name: IsPublic
|
||
- description: 根据资源的共享范围过滤列表，可能值为：system, domain, project
|
||
in: query
|
||
name: public_scope
|
||
type: string
|
||
x-go-name: PublicScope
|
||
- description: 以资源的状态过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: status
|
||
type: array
|
||
x-go-name: Status
|
||
- description: 根据平台过滤
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: provider
|
||
type: array
|
||
x-go-name: Provider
|
||
- in: query
|
||
name: cloudaccount_id
|
||
type: string
|
||
x-go-name: CloudaccountId
|
||
- description: 根据云订阅过滤资源
|
||
in: query
|
||
name: manager_id
|
||
type: string
|
||
x-go-name: ManagerId
|
||
- description: 根据权限组Id过滤资源
|
||
in: query
|
||
name: cloudgroup_id
|
||
type: string
|
||
x-go-name: CloudgroupId
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_ListItemFilterOutput'
|
||
summary: 公有云角色列表
|
||
tags:
|
||
- cloudrole
|
||
post:
|
||
description: 新建
|
||
operationId: cloudrole_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/StatusInfrasResourceBaseCreateInput'
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: cloudrole_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of cloudrole
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_CustomizeDeleteOutput'
|
||
summary: 删除公有云角色
|
||
tags:
|
||
- cloudrole
|
||
get:
|
||
description: 获取详情
|
||
operationId: cloudrole_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of cloudrole
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_FetchCustomizeColumnsOutput'
|
||
summary: 获取公有云角色详情
|
||
tags:
|
||
- cloudrole
|
||
put:
|
||
description: 更新
|
||
operationId: cloudrole_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of cloudrole
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/EnabledStatusInfrasResourceBaseUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/{id}/change-owner:
|
||
post:
|
||
description: 执行操作ChangeOwner
|
||
operationId: cloudrole_PerformChangeOwner
|
||
parameters:
|
||
- description: The Id or Name of cloudrole
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/PerformChangeDomainOwnerInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_PerformChangeOwnerOutput'
|
||
summary: 执行操作ChangeOwner
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/{id}/disable:
|
||
post:
|
||
description: 执行操作Disable
|
||
operationId: cloudrole_PerformDisable
|
||
parameters:
|
||
- description: The Id or Name of cloudrole
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/PerformDisableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_PerformDisableOutput'
|
||
summary: 禁用资源
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/{id}/enable:
|
||
post:
|
||
description: 执行操作Enable
|
||
operationId: cloudrole_PerformEnable
|
||
parameters:
|
||
- description: The Id or Name of cloudrole
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/PerformEnableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_PerformEnableOutput'
|
||
summary: 启用资源
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: cloudrole_GetDetailsMetadata
|
||
parameters:
|
||
- description: |-
|
||
指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签
|
||
标签分为
|
||
|
||
类型 | 说明 |
|
||
----------|---------------------------------------------|
|
||
系统标签 | 平台定义的标签 |
|
||
用户标签 | key以user:为前缀，用户自定义标签 |
|
||
外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 |
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: field
|
||
type: array
|
||
x-go-name: Field
|
||
- description: 按标签前缀过滤
|
||
in: query
|
||
name: prefix
|
||
type: string
|
||
x-go-name: Prefix
|
||
- description: The Id or Name of cloudrole
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签（元数据）
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/{id}/private:
|
||
post:
|
||
description: 执行操作Private
|
||
operationId: cloudrole_PerformPrivate
|
||
parameters:
|
||
- description: The Id or Name of cloudrole
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/PerformPrivateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_PerformPrivateOutput'
|
||
summary: 执行操作Private
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/{id}/public:
|
||
post:
|
||
description: 执行操作Public
|
||
operationId: cloudrole_PerformPublic
|
||
parameters:
|
||
- description: The Id or Name of cloudrole
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/PerformPublicDomainInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_PerformPublicOutput'
|
||
summary: 执行操作Public
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/{id}/status:
|
||
get:
|
||
description: 获取指定信息Status
|
||
operationId: cloudrole_GetDetailsStatus
|
||
parameters:
|
||
- description: The Id or Name of cloudrole
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_GetDetailsStatusOutput'
|
||
summary: 获取资源状态
|
||
tags:
|
||
- cloudrole
|
||
/cloudusers:
|
||
get:
|
||
description: 列表
|
||
operationId: clouduser_ListItemFilter
|
||
parameters:
|
||
- default: 20
|
||
description: 查询限制量
|
||
format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
- default: 0
|
||
description: 查询偏移量
|
||
format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: order_by
|
||
type: array
|
||
x-go-name: OrderBy
|
||
- description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。
|
||
example: desc|asc
|
||
in: query
|
||
name: order
|
||
type: string
|
||
x-go-name: Order
|
||
- description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。
|
||
in: query
|
||
name: details
|
||
type: boolean
|
||
x-go-name: Details
|
||
- description: 模糊搜索所有字段
|
||
in: query
|
||
name: search
|
||
type: string
|
||
x-go-name: Search
|
||
- description: |-
|
||
指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test')
|
||
支持的操作符如下：
|
||
|
||
操作符 | 参数个数 | 举例 | 说明 |
|
||
---------------|----------|------------------------------------------------|-----------------------------|
|
||
in | > 0 | name.in("test", "good") | 在给定数组中 |
|
||
notin | > 0 | name.notin('test') | 不在给定数组中 |
|
||
between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
|
||
ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
|
||
gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
|
||
le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
|
||
lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
|
||
like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
|
||
contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
|
||
startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
|
||
endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
|
||
equals | > 0 | name.equals('test') | 等于任意一个给定值 |
|
||
notequals | 1 | name.notequals('test') | 不等于给定值 |
|
||
isnull | 0 | name.isnull() | 值为SQL的NULL |
|
||
isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
|
||
isempty | 0 | name.isempty('test') | 值为空字符串 |
|
||
isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
|
||
isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: filter
|
||
type: array
|
||
x-go-name: Filter
|
||
- description: |-
|
||
指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同，
|
||
和其他表关联的语法如下：
|
||
joint_resources.related_key(origin_key).filter_col.filter_ops(values)
|
||
其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为
|
||
关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值
|
||
举例：
|
||
guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: joint_filter
|
||
type: array
|
||
x-go-name: JointFilter
|
||
- description: 如果filter_any为true，则查询所有filter的并集，否则为交集
|
||
in: query
|
||
name: filter_any
|
||
type: boolean
|
||
x-go-name: FilterAny
|
||
- description: 返回结果只包含指定的字段
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: field
|
||
type: array
|
||
x-go-name: Field
|
||
- description: 用于数据导出，指定导出的数据字段
|
||
in: query
|
||
name: export_keys
|
||
type: string
|
||
x-go-name: ExportKeys
|
||
- description: 返回结果携带delete_fail_reason和update_fail_reason字段
|
||
in: query
|
||
name: show_fail_reason
|
||
type: boolean
|
||
x-go-name: ShowFailReason
|
||
- description: 是否返回状态统计信息，默认为False
|
||
in: query
|
||
name: summary_stats
|
||
type: boolean
|
||
x-go-name: SummaryStats
|
||
- $ref: '#/definitions/TTagSet'
|
||
description: 通过标签过滤（包含这些标签）
|
||
in: query
|
||
name: tags
|
||
x-go-name: Tags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: 通过一组标签过滤（还包含这些标签，OR的关系）
|
||
in: query
|
||
name: obj_tags
|
||
x-go-name: ObjTags
|
||
- $ref: '#/definitions/TTagSet'
|
||
description: 通过标签过滤（不包含这些标签）
|
||
in: query
|
||
name: no_tags
|
||
x-go-name: NoTags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: 通过一组标签过滤（还不包含这些标签，AND的关系）
|
||
in: query
|
||
name: no_obj_tags
|
||
x-go-name: NoObjTags
|
||
- description: 通过标签排序
|
||
in: query
|
||
name: order_by_tag
|
||
type: string
|
||
x-go-name: OrderByTag
|
||
- description: |-
|
||
deprecated
|
||
返回资源的标签不包含用户标签
|
||
in: query
|
||
name: without_user_meta
|
||
type: boolean
|
||
x-go-name: WithoutUserMeta
|
||
- description: 返回包含用户标签的资源
|
||
in: query
|
||
name: with_user_meta
|
||
type: boolean
|
||
x-go-name: WithUserMeta
|
||
- description: 返回包含外部标签的资源
|
||
in: query
|
||
name: with_cloud_meta
|
||
type: boolean
|
||
x-go-name: WithCloudMeta
|
||
- description: 返回包含任意标签的资源
|
||
in: query
|
||
name: with_any_meta
|
||
type: boolean
|
||
x-go-name: WithAnyMeta
|
||
- description: 返回列表数据中包含资源的标签数据（Metadata）
|
||
in: query
|
||
name: with_meta
|
||
type: boolean
|
||
x-go-name: WithMeta
|
||
- description: 显示所有的资源，包括模拟的资源
|
||
in: query
|
||
name: show_emulated
|
||
type: boolean
|
||
x-go-name: ShowEmulated
|
||
- description: 以资源ID过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: id
|
||
type: array
|
||
x-go-name: Ids
|
||
- description: 以资源名称过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: name
|
||
type: array
|
||
x-go-name: Names
|
||
- description: 指定查询的权限范围，可能值为project, domain or system
|
||
in: query
|
||
name: scope
|
||
type: string
|
||
x-go-name: Scope
|
||
- description: 指定项目归属域名称或ID
|
||
in: query
|
||
name: project_domain_id
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
- description: 对具有域属性的资源，严格匹配域ID
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: project_domain_ids
|
||
type: array
|
||
x-go-name: ProjectDomainIds
|
||
- description: 按domain名称排序，可能值为asc|desc
|
||
in: query
|
||
name: order_by_domain
|
||
pattern: asc|desc
|
||
type: string
|
||
x-go-name: OrderByDomain
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: filter by domain tags
|
||
in: query
|
||
name: domain_tags
|
||
x-go-name: DomainTags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: filter by domain tags
|
||
in: query
|
||
name: no_domain_tags
|
||
x-go-name: NoDomainTags
|
||
- description: 以资源的状态过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: status
|
||
type: array
|
||
x-go-name: Status
|
||
- description: 查询指定的用户（ID或名称）拥有的资源
|
||
in: query
|
||
name: user_id
|
||
type: string
|
||
x-go-name: UserId
|
||
- description: 根据平台过滤
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: provider
|
||
type: array
|
||
x-go-name: Provider
|
||
- in: query
|
||
name: cloudaccount_id
|
||
type: string
|
||
x-go-name: CloudaccountId
|
||
- description: 根据云订阅过滤资源
|
||
in: query
|
||
name: manager_id
|
||
type: string
|
||
x-go-name: ManagerId
|
||
- description: 过滤绑定权限的子账号
|
||
in: query
|
||
name: cloudpolicy_id
|
||
type: string
|
||
x-go-name: CloudpolicyId
|
||
- description: 过滤属于指定权限组的子账号
|
||
in: query
|
||
name: cloudgroup_id
|
||
type: string
|
||
x-go-name: CloudgroupId
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_ListItemFilterOutput'
|
||
summary: 公有云用户列表
|
||
tags:
|
||
- clouduser
|
||
post:
|
||
description: 新建
|
||
operationId: clouduser_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/ClouduserCreateInput'
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_ValidateCreateDataOutput'
|
||
summary: 创建公有云用户
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: clouduser_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of clouduser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_CustomizeDeleteOutput'
|
||
summary: 删除公有云用户
|
||
tags:
|
||
- clouduser
|
||
get:
|
||
description: 获取详情
|
||
operationId: clouduser_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of clouduser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_FetchCustomizeColumnsOutput'
|
||
summary: 获取公有云用户详情
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/{id}/access-keys:
|
||
get:
|
||
description: 获取指定信息AccessKeys
|
||
operationId: clouduser_GetDetailsAccessKeys
|
||
parameters:
|
||
- description: The Id or Name of clouduser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_GetDetailsAccessKeysOutput'
|
||
summary: 获取指定信息AccessKeys
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/{id}/attach-policy:
|
||
post:
|
||
description: '用户状态必须为: available'
|
||
operationId: clouduser_PerformAttachPolicy
|
||
parameters:
|
||
- description: The Id or Name of clouduser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/ClouduserAttachPolicyInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_PerformAttachPolicyOutput'
|
||
summary: 绑定用户权限
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/{id}/change-owner:
|
||
post:
|
||
description: 执行操作ChangeOwner
|
||
operationId: clouduser_PerformChangeOwner
|
||
parameters:
|
||
- description: The Id or Name of clouduser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/ClouduserChangeOwnerInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_PerformChangeOwnerOutput'
|
||
summary: 变更子账号所属本地用户
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/{id}/create-access-key:
|
||
post:
|
||
description: 执行操作CreateAccessKey
|
||
operationId: clouduser_PerformCreateAccessKey
|
||
parameters:
|
||
- description: The Id or Name of clouduser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/ClouduserCreateAccessKeyInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_PerformCreateAccessKeyOutput'
|
||
summary: 执行操作CreateAccessKey
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/{id}/delete-access-key:
|
||
post:
|
||
description: 执行操作DeleteAccessKey
|
||
operationId: clouduser_PerformDeleteAccessKey
|
||
parameters:
|
||
- description: The Id or Name of clouduser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/ClouduserDeleteAccessKeyInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_PerformDeleteAccessKeyOutput'
|
||
summary: 执行操作DeleteAccessKey
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/{id}/detach-policy:
|
||
post:
|
||
description: '用户状态必须为: available'
|
||
operationId: clouduser_PerformDetachPolicy
|
||
parameters:
|
||
- description: The Id or Name of clouduser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/ClouduserDetachPolicyInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_PerformDetachPolicyOutput'
|
||
summary: 解绑用户权限
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/{id}/join-group:
|
||
post:
|
||
description: '用户状态必须为: available'
|
||
operationId: clouduser_PerformJoinGroup
|
||
parameters:
|
||
- description: The Id or Name of clouduser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/ClouduserJoinGroupInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_PerformJoinGroupOutput'
|
||
summary: 将用户加入权限组
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/{id}/leave-group:
|
||
post:
|
||
description: '用户状态必须为: available'
|
||
operationId: clouduser_PerformLeaveGroup
|
||
parameters:
|
||
- description: The Id or Name of clouduser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/ClouduserLeaveGroupInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_PerformLeaveGroupOutput'
|
||
summary: 将用户从权限组中移除
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: clouduser_GetDetailsMetadata
|
||
parameters:
|
||
- description: |-
|
||
指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签
|
||
标签分为
|
||
|
||
类型 | 说明 |
|
||
----------|---------------------------------------------|
|
||
系统标签 | 平台定义的标签 |
|
||
用户标签 | key以user:为前缀，用户自定义标签 |
|
||
外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 |
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: field
|
||
type: array
|
||
x-go-name: Field
|
||
- description: 按标签前缀过滤
|
||
in: query
|
||
name: prefix
|
||
type: string
|
||
x-go-name: Prefix
|
||
- description: The Id or Name of clouduser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签（元数据）
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/{id}/reset-password:
|
||
post:
|
||
description: '用户状态必须为: available'
|
||
operationId: clouduser_PerformResetPassword
|
||
parameters:
|
||
- description: The Id or Name of clouduser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/ClouduserResetPasswordInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_PerformResetPasswordOutput'
|
||
summary: 重置用户密码
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/{id}/set-groups:
|
||
post:
|
||
description: '用户状态必须为: available'
|
||
operationId: clouduser_PerformSetGroups
|
||
parameters:
|
||
- description: The Id or Name of clouduser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/ClouduserSetGroupsInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_PerformSetGroupsOutput'
|
||
summary: 设置用户权限组列表(全量覆盖)
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/{id}/set-policies:
|
||
post:
|
||
description: '用户状态必须为: available'
|
||
operationId: clouduser_PerformSetPolicies
|
||
parameters:
|
||
- description: The Id or Name of clouduser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/ClouduserSetPoliciesInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_PerformSetPoliciesOutput'
|
||
summary: 设置用户权限列表(全量覆盖)
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/{id}/status:
|
||
get:
|
||
description: 获取指定信息Status
|
||
operationId: clouduser_GetDetailsStatus
|
||
parameters:
|
||
- description: The Id or Name of clouduser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_GetDetailsStatusOutput'
|
||
summary: 获取资源状态
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/{id}/syncstatus:
|
||
post:
|
||
description: 执行操作Syncstatus
|
||
operationId: clouduser_PerformSyncstatus
|
||
parameters:
|
||
- description: The Id or Name of clouduser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/ClouduserSyncstatusInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_PerformSyncstatusOutput'
|
||
summary: 同步用户状态
|
||
tags:
|
||
- clouduser
|
||
/saml_providers:
|
||
get:
|
||
description: 列表
|
||
operationId: saml_provider_ListItemFilter
|
||
parameters:
|
||
- default: 20
|
||
description: 查询限制量
|
||
format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
- default: 0
|
||
description: 查询偏移量
|
||
format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: order_by
|
||
type: array
|
||
x-go-name: OrderBy
|
||
- description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。
|
||
example: desc|asc
|
||
in: query
|
||
name: order
|
||
type: string
|
||
x-go-name: Order
|
||
- description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。
|
||
in: query
|
||
name: details
|
||
type: boolean
|
||
x-go-name: Details
|
||
- description: 模糊搜索所有字段
|
||
in: query
|
||
name: search
|
||
type: string
|
||
x-go-name: Search
|
||
- description: |-
|
||
指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test')
|
||
支持的操作符如下：
|
||
|
||
操作符 | 参数个数 | 举例 | 说明 |
|
||
---------------|----------|------------------------------------------------|-----------------------------|
|
||
in | > 0 | name.in("test", "good") | 在给定数组中 |
|
||
notin | > 0 | name.notin('test') | 不在给定数组中 |
|
||
between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
|
||
ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
|
||
gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
|
||
le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
|
||
lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
|
||
like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
|
||
contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
|
||
startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
|
||
endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
|
||
equals | > 0 | name.equals('test') | 等于任意一个给定值 |
|
||
notequals | 1 | name.notequals('test') | 不等于给定值 |
|
||
isnull | 0 | name.isnull() | 值为SQL的NULL |
|
||
isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
|
||
isempty | 0 | name.isempty('test') | 值为空字符串 |
|
||
isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
|
||
isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: filter
|
||
type: array
|
||
x-go-name: Filter
|
||
- description: |-
|
||
指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同，
|
||
和其他表关联的语法如下：
|
||
joint_resources.related_key(origin_key).filter_col.filter_ops(values)
|
||
其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为
|
||
关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值
|
||
举例：
|
||
guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: joint_filter
|
||
type: array
|
||
x-go-name: JointFilter
|
||
- description: 如果filter_any为true，则查询所有filter的并集，否则为交集
|
||
in: query
|
||
name: filter_any
|
||
type: boolean
|
||
x-go-name: FilterAny
|
||
- description: 返回结果只包含指定的字段
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: field
|
||
type: array
|
||
x-go-name: Field
|
||
- description: 用于数据导出，指定导出的数据字段
|
||
in: query
|
||
name: export_keys
|
||
type: string
|
||
x-go-name: ExportKeys
|
||
- description: 返回结果携带delete_fail_reason和update_fail_reason字段
|
||
in: query
|
||
name: show_fail_reason
|
||
type: boolean
|
||
x-go-name: ShowFailReason
|
||
- description: 是否返回状态统计信息，默认为False
|
||
in: query
|
||
name: summary_stats
|
||
type: boolean
|
||
x-go-name: SummaryStats
|
||
- $ref: '#/definitions/TTagSet'
|
||
description: 通过标签过滤（包含这些标签）
|
||
in: query
|
||
name: tags
|
||
x-go-name: Tags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: 通过一组标签过滤（还包含这些标签，OR的关系）
|
||
in: query
|
||
name: obj_tags
|
||
x-go-name: ObjTags
|
||
- $ref: '#/definitions/TTagSet'
|
||
description: 通过标签过滤（不包含这些标签）
|
||
in: query
|
||
name: no_tags
|
||
x-go-name: NoTags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: 通过一组标签过滤（还不包含这些标签，AND的关系）
|
||
in: query
|
||
name: no_obj_tags
|
||
x-go-name: NoObjTags
|
||
- description: 通过标签排序
|
||
in: query
|
||
name: order_by_tag
|
||
type: string
|
||
x-go-name: OrderByTag
|
||
- description: |-
|
||
deprecated
|
||
返回资源的标签不包含用户标签
|
||
in: query
|
||
name: without_user_meta
|
||
type: boolean
|
||
x-go-name: WithoutUserMeta
|
||
- description: 返回包含用户标签的资源
|
||
in: query
|
||
name: with_user_meta
|
||
type: boolean
|
||
x-go-name: WithUserMeta
|
||
- description: 返回包含外部标签的资源
|
||
in: query
|
||
name: with_cloud_meta
|
||
type: boolean
|
||
x-go-name: WithCloudMeta
|
||
- description: 返回包含任意标签的资源
|
||
in: query
|
||
name: with_any_meta
|
||
type: boolean
|
||
x-go-name: WithAnyMeta
|
||
- description: 返回列表数据中包含资源的标签数据（Metadata）
|
||
in: query
|
||
name: with_meta
|
||
type: boolean
|
||
x-go-name: WithMeta
|
||
- description: 显示所有的资源，包括模拟的资源
|
||
in: query
|
||
name: show_emulated
|
||
type: boolean
|
||
x-go-name: ShowEmulated
|
||
- description: 以资源ID过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: id
|
||
type: array
|
||
x-go-name: Ids
|
||
- description: 以资源名称过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: name
|
||
type: array
|
||
x-go-name: Names
|
||
- description: 指定查询的权限范围，可能值为project, domain or system
|
||
in: query
|
||
name: scope
|
||
type: string
|
||
x-go-name: Scope
|
||
- description: 指定项目归属域名称或ID
|
||
in: query
|
||
name: project_domain_id
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
- description: 对具有域属性的资源，严格匹配域ID
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: project_domain_ids
|
||
type: array
|
||
x-go-name: ProjectDomainIds
|
||
- description: 按domain名称排序，可能值为asc|desc
|
||
in: query
|
||
name: order_by_domain
|
||
pattern: asc|desc
|
||
type: string
|
||
x-go-name: OrderByDomain
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: filter by domain tags
|
||
in: query
|
||
name: domain_tags
|
||
x-go-name: DomainTags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: filter by domain tags
|
||
in: query
|
||
name: no_domain_tags
|
||
x-go-name: NoDomainTags
|
||
- description: 以资源是否共享过滤列表
|
||
in: query
|
||
name: is_public
|
||
type: boolean
|
||
x-go-name: IsPublic
|
||
- description: 根据资源的共享范围过滤列表，可能值为：system, domain, project
|
||
in: query
|
||
name: public_scope
|
||
type: string
|
||
x-go-name: PublicScope
|
||
- description: 以资源的状态过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: status
|
||
type: array
|
||
x-go-name: Status
|
||
- description: 根据平台过滤
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: provider
|
||
type: array
|
||
x-go-name: Provider
|
||
- in: query
|
||
name: cloudaccount_id
|
||
type: string
|
||
x-go-name: CloudaccountId
|
||
- description: 根据云订阅过滤资源
|
||
in: query
|
||
name: manager_id
|
||
type: string
|
||
x-go-name: ManagerId
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_ListItemFilterOutput'
|
||
summary: 公有云身份提供商列表
|
||
tags:
|
||
- saml_provider
|
||
post:
|
||
description: 新建
|
||
operationId: saml_provider_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
saml_provider:
|
||
$ref: '#/definitions/StatusInfrasResourceBaseCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- saml_provider
|
||
/saml_providers/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: saml_provider_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of saml_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- saml_provider
|
||
get:
|
||
description: 获取详情
|
||
operationId: saml_provider_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of saml_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- saml_provider
|
||
put:
|
||
description: 更新
|
||
operationId: saml_provider_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of saml_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
$ref: '#/definitions/StatusInfrasResourceBaseUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- saml_provider
|
||
/saml_providers/{id}/change-owner:
|
||
post:
|
||
description: 执行操作ChangeOwner
|
||
operationId: saml_provider_PerformChangeOwner
|
||
parameters:
|
||
- description: The Id or Name of saml_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
$ref: '#/definitions/PerformChangeDomainOwnerInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_PerformChangeOwnerOutput'
|
||
summary: 执行操作ChangeOwner
|
||
tags:
|
||
- saml_provider
|
||
/saml_providers/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: saml_provider_GetDetailsMetadata
|
||
parameters:
|
||
- description: |-
|
||
指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签
|
||
标签分为
|
||
|
||
类型 | 说明 |
|
||
----------|---------------------------------------------|
|
||
系统标签 | 平台定义的标签 |
|
||
用户标签 | key以user:为前缀，用户自定义标签 |
|
||
外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 |
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: field
|
||
type: array
|
||
x-go-name: Field
|
||
- description: 按标签前缀过滤
|
||
in: query
|
||
name: prefix
|
||
type: string
|
||
x-go-name: Prefix
|
||
- description: The Id or Name of saml_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签（元数据）
|
||
tags:
|
||
- saml_provider
|
||
/saml_providers/{id}/private:
|
||
post:
|
||
description: 执行操作Private
|
||
operationId: saml_provider_PerformPrivate
|
||
parameters:
|
||
- description: The Id or Name of saml_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
$ref: '#/definitions/PerformPrivateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_PerformPrivateOutput'
|
||
summary: 执行操作Private
|
||
tags:
|
||
- saml_provider
|
||
/saml_providers/{id}/public:
|
||
post:
|
||
description: 执行操作Public
|
||
operationId: saml_provider_PerformPublic
|
||
parameters:
|
||
- description: The Id or Name of saml_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
$ref: '#/definitions/PerformPublicDomainInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_PerformPublicOutput'
|
||
summary: 执行操作Public
|
||
tags:
|
||
- saml_provider
|
||
/saml_providers/{id}/status:
|
||
get:
|
||
description: 获取指定信息Status
|
||
operationId: saml_provider_GetDetailsStatus
|
||
parameters:
|
||
- description: The Id or Name of saml_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_GetDetailsStatusOutput'
|
||
summary: 获取资源状态
|
||
tags:
|
||
- saml_provider
|
||
/samlusers:
|
||
get:
|
||
description: 列表
|
||
operationId: samluser_ListItemFilter
|
||
parameters:
|
||
- default: 20
|
||
description: 查询限制量
|
||
format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
- default: 0
|
||
description: 查询偏移量
|
||
format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: order_by
|
||
type: array
|
||
x-go-name: OrderBy
|
||
- description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。
|
||
example: desc|asc
|
||
in: query
|
||
name: order
|
||
type: string
|
||
x-go-name: Order
|
||
- description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。
|
||
in: query
|
||
name: details
|
||
type: boolean
|
||
x-go-name: Details
|
||
- description: 模糊搜索所有字段
|
||
in: query
|
||
name: search
|
||
type: string
|
||
x-go-name: Search
|
||
- description: |-
|
||
指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test')
|
||
支持的操作符如下：
|
||
|
||
操作符 | 参数个数 | 举例 | 说明 |
|
||
---------------|----------|------------------------------------------------|-----------------------------|
|
||
in | > 0 | name.in("test", "good") | 在给定数组中 |
|
||
notin | > 0 | name.notin('test') | 不在给定数组中 |
|
||
between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
|
||
ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
|
||
gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
|
||
le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
|
||
lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
|
||
like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
|
||
contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
|
||
startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
|
||
endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
|
||
equals | > 0 | name.equals('test') | 等于任意一个给定值 |
|
||
notequals | 1 | name.notequals('test') | 不等于给定值 |
|
||
isnull | 0 | name.isnull() | 值为SQL的NULL |
|
||
isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
|
||
isempty | 0 | name.isempty('test') | 值为空字符串 |
|
||
isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
|
||
isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: filter
|
||
type: array
|
||
x-go-name: Filter
|
||
- description: |-
|
||
指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同，
|
||
和其他表关联的语法如下：
|
||
joint_resources.related_key(origin_key).filter_col.filter_ops(values)
|
||
其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为
|
||
关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值
|
||
举例：
|
||
guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: joint_filter
|
||
type: array
|
||
x-go-name: JointFilter
|
||
- description: 如果filter_any为true，则查询所有filter的并集，否则为交集
|
||
in: query
|
||
name: filter_any
|
||
type: boolean
|
||
x-go-name: FilterAny
|
||
- description: 返回结果只包含指定的字段
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: field
|
||
type: array
|
||
x-go-name: Field
|
||
- description: 用于数据导出，指定导出的数据字段
|
||
in: query
|
||
name: export_keys
|
||
type: string
|
||
x-go-name: ExportKeys
|
||
- description: 返回结果携带delete_fail_reason和update_fail_reason字段
|
||
in: query
|
||
name: show_fail_reason
|
||
type: boolean
|
||
x-go-name: ShowFailReason
|
||
- description: 是否返回状态统计信息，默认为False
|
||
in: query
|
||
name: summary_stats
|
||
type: boolean
|
||
x-go-name: SummaryStats
|
||
- $ref: '#/definitions/TTagSet'
|
||
description: 通过标签过滤（包含这些标签）
|
||
in: query
|
||
name: tags
|
||
x-go-name: Tags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: 通过一组标签过滤（还包含这些标签，OR的关系）
|
||
in: query
|
||
name: obj_tags
|
||
x-go-name: ObjTags
|
||
- $ref: '#/definitions/TTagSet'
|
||
description: 通过标签过滤（不包含这些标签）
|
||
in: query
|
||
name: no_tags
|
||
x-go-name: NoTags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: 通过一组标签过滤（还不包含这些标签，AND的关系）
|
||
in: query
|
||
name: no_obj_tags
|
||
x-go-name: NoObjTags
|
||
- description: 通过标签排序
|
||
in: query
|
||
name: order_by_tag
|
||
type: string
|
||
x-go-name: OrderByTag
|
||
- description: |-
|
||
deprecated
|
||
返回资源的标签不包含用户标签
|
||
in: query
|
||
name: without_user_meta
|
||
type: boolean
|
||
x-go-name: WithoutUserMeta
|
||
- description: 返回包含用户标签的资源
|
||
in: query
|
||
name: with_user_meta
|
||
type: boolean
|
||
x-go-name: WithUserMeta
|
||
- description: 返回包含外部标签的资源
|
||
in: query
|
||
name: with_cloud_meta
|
||
type: boolean
|
||
x-go-name: WithCloudMeta
|
||
- description: 返回包含任意标签的资源
|
||
in: query
|
||
name: with_any_meta
|
||
type: boolean
|
||
x-go-name: WithAnyMeta
|
||
- description: 返回列表数据中包含资源的标签数据（Metadata）
|
||
in: query
|
||
name: with_meta
|
||
type: boolean
|
||
x-go-name: WithMeta
|
||
- description: 显示所有的资源，包括模拟的资源
|
||
in: query
|
||
name: show_emulated
|
||
type: boolean
|
||
x-go-name: ShowEmulated
|
||
- description: 以资源ID过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: id
|
||
type: array
|
||
x-go-name: Ids
|
||
- description: 以资源名称过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: name
|
||
type: array
|
||
x-go-name: Names
|
||
- description: 指定查询的权限范围，可能值为project, domain or system
|
||
in: query
|
||
name: scope
|
||
type: string
|
||
x-go-name: Scope
|
||
- description: 指定项目归属域名称或ID
|
||
in: query
|
||
name: project_domain_id
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
- description: 对具有域属性的资源，严格匹配域ID
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: project_domain_ids
|
||
type: array
|
||
x-go-name: ProjectDomainIds
|
||
- description: 按domain名称排序，可能值为asc|desc
|
||
in: query
|
||
name: order_by_domain
|
||
pattern: asc|desc
|
||
type: string
|
||
x-go-name: OrderByDomain
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: filter by domain tags
|
||
in: query
|
||
name: domain_tags
|
||
x-go-name: DomainTags
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: filter by domain tags
|
||
in: query
|
||
name: no_domain_tags
|
||
x-go-name: NoDomainTags
|
||
- description: 以资源的状态过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: status
|
||
type: array
|
||
x-go-name: Status
|
||
- description: 查询指定的用户（ID或名称）拥有的资源
|
||
in: query
|
||
name: user_id
|
||
type: string
|
||
x-go-name: UserId
|
||
- description: 根据权限组Id过滤资源
|
||
in: query
|
||
name: cloudgroup_id
|
||
type: string
|
||
x-go-name: CloudgroupId
|
||
- description: 根据平台过滤
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: provider
|
||
type: array
|
||
x-go-name: Provider
|
||
- in: query
|
||
name: cloudaccount_id
|
||
type: string
|
||
x-go-name: CloudaccountId
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_ListItemFilterOutput'
|
||
summary: SAML认证用户列表
|
||
tags:
|
||
- samluser
|
||
post:
|
||
description: 新建
|
||
operationId: samluser_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
samluser:
|
||
$ref: '#/definitions/SamluserCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_ValidateCreateDataOutput'
|
||
summary: 创建SAML认证用户
|
||
tags:
|
||
- samluser
|
||
/samlusers/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: samluser_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of samluser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- samluser
|
||
get:
|
||
description: 获取详情
|
||
operationId: samluser_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of samluser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- samluser
|
||
put:
|
||
description: 更新
|
||
operationId: samluser_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of samluser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
samluser:
|
||
$ref: '#/definitions/StatusDomainLevelResourceBaseUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- samluser
|
||
/samlusers/{id}/change-owner:
|
||
post:
|
||
description: 执行操作ChangeOwner
|
||
operationId: samluser_PerformChangeOwner
|
||
parameters:
|
||
- description: The Id or Name of samluser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
samluser:
|
||
$ref: '#/definitions/PerformChangeDomainOwnerInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_PerformChangeOwnerOutput'
|
||
summary: 更改项目
|
||
tags:
|
||
- samluser
|
||
/samlusers/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: samluser_GetDetailsMetadata
|
||
parameters:
|
||
- description: |-
|
||
指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签
|
||
标签分为
|
||
|
||
类型 | 说明 |
|
||
----------|---------------------------------------------|
|
||
系统标签 | 平台定义的标签 |
|
||
用户标签 | key以user:为前缀，用户自定义标签 |
|
||
外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 |
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: field
|
||
type: array
|
||
x-go-name: Field
|
||
- description: 按标签前缀过滤
|
||
in: query
|
||
name: prefix
|
||
type: string
|
||
x-go-name: Prefix
|
||
- description: The Id or Name of samluser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签（元数据）
|
||
tags:
|
||
- samluser
|
||
/samlusers/{id}/status:
|
||
get:
|
||
description: 获取指定信息Status
|
||
operationId: samluser_GetDetailsStatus
|
||
parameters:
|
||
- description: The Id or Name of samluser
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_GetDetailsStatusOutput'
|
||
summary: 获取资源状态
|
||
tags:
|
||
- samluser
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
cloudgroup_CustomizeDeleteOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/CloudgroupDetails'
|
||
type: object
|
||
cloudgroup_FetchCustomizeColumnsOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/CloudgroupDetails'
|
||
type: object
|
||
cloudgroup_GetDetailsMetadataOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
cloudgroup_GetDetailsSamlOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/GetCloudaccountSamlOutput'
|
||
type: object
|
||
cloudgroup_GetDetailsStatusOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/GetDetailsStatusOutput'
|
||
type: object
|
||
cloudgroup_ListItemFilterOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudgroups:
|
||
items:
|
||
$ref: '#/definitions/CloudgroupDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
cloudgroup_PerformAddUserOutput:
|
||
description: ""
|
||
cloudgroup_PerformAttachPolicyOutput:
|
||
description: ""
|
||
cloudgroup_PerformChangeOwnerOutput:
|
||
description: ""
|
||
cloudgroup_PerformDetachPolicyOutput:
|
||
description: ""
|
||
cloudgroup_PerformPrivateOutput:
|
||
description: ""
|
||
cloudgroup_PerformPublicOutput:
|
||
description: ""
|
||
cloudgroup_PerformRemoveUserOutput:
|
||
description: ""
|
||
cloudgroup_PerformSetPoliciesOutput:
|
||
description: ""
|
||
cloudgroup_PerformSetUsersOutput:
|
||
description: ""
|
||
cloudgroup_PerformSyncstatusOutput:
|
||
description: ""
|
||
cloudgroup_ValidateCreateDataOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/CloudgroupDetails'
|
||
type: object
|
||
cloudgroup_ValidateUpdateDataOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/CloudgroupDetails'
|
||
type: object
|
||
cloudpolicy_CustomizeDeleteOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudpolicy:
|
||
$ref: '#/definitions/CloudpolicyDetails'
|
||
type: object
|
||
cloudpolicy_FetchCustomizeColumnsOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudpolicy:
|
||
$ref: '#/definitions/CloudpolicyDetails'
|
||
type: object
|
||
cloudpolicy_GetDetailsMetadataOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudpolicy:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
cloudpolicy_GetDetailsStatusOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudpolicy:
|
||
$ref: '#/definitions/GetDetailsStatusOutput'
|
||
type: object
|
||
cloudpolicy_ListItemFilterOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudpolicies:
|
||
items:
|
||
$ref: '#/definitions/CloudpolicyDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
cloudpolicy_PerformChangeOwnerOutput:
|
||
description: ""
|
||
cloudpolicy_PerformPrivateOutput:
|
||
description: ""
|
||
cloudpolicy_PerformPublicOutput:
|
||
description: ""
|
||
cloudrole_CustomizeDeleteOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/CloudroleDetails'
|
||
type: object
|
||
cloudrole_FetchCustomizeColumnsOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/CloudroleDetails'
|
||
type: object
|
||
cloudrole_GetDetailsMetadataOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
cloudrole_GetDetailsStatusOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/GetDetailsStatusOutput'
|
||
type: object
|
||
cloudrole_ListItemFilterOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudroles:
|
||
items:
|
||
$ref: '#/definitions/CloudroleDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
cloudrole_PerformChangeOwnerOutput:
|
||
description: ""
|
||
cloudrole_PerformDisableOutput:
|
||
description: ""
|
||
cloudrole_PerformEnableOutput:
|
||
description: ""
|
||
cloudrole_PerformPrivateOutput:
|
||
description: ""
|
||
cloudrole_PerformPublicOutput:
|
||
description: ""
|
||
cloudrole_ValidateCreateDataOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/CloudroleDetails'
|
||
type: object
|
||
cloudrole_ValidateUpdateDataOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/CloudroleDetails'
|
||
type: object
|
||
clouduser_CustomizeDeleteOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/ClouduserDetails'
|
||
type: object
|
||
clouduser_FetchCustomizeColumnsOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/ClouduserDetails'
|
||
type: object
|
||
clouduser_GetDetailsAccessKeysOutput:
|
||
description: ""
|
||
clouduser_GetDetailsMetadataOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
clouduser_GetDetailsStatusOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/GetDetailsStatusOutput'
|
||
type: object
|
||
clouduser_ListItemFilterOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
cloudusers:
|
||
items:
|
||
$ref: '#/definitions/ClouduserDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
clouduser_PerformAttachPolicyOutput:
|
||
description: ""
|
||
clouduser_PerformChangeOwnerOutput:
|
||
description: ""
|
||
clouduser_PerformCreateAccessKeyOutput:
|
||
description: ""
|
||
clouduser_PerformDeleteAccessKeyOutput:
|
||
description: ""
|
||
clouduser_PerformDetachPolicyOutput:
|
||
description: ""
|
||
clouduser_PerformJoinGroupOutput:
|
||
description: ""
|
||
clouduser_PerformLeaveGroupOutput:
|
||
description: ""
|
||
clouduser_PerformResetPasswordOutput:
|
||
description: ""
|
||
clouduser_PerformSetGroupsOutput:
|
||
description: ""
|
||
clouduser_PerformSetPoliciesOutput:
|
||
description: ""
|
||
clouduser_PerformSyncstatusOutput:
|
||
description: ""
|
||
clouduser_ValidateCreateDataOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/ClouduserDetails'
|
||
type: object
|
||
saml_provider_CustomizeDeleteOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
$ref: '#/definitions/SAMLProviderDetails'
|
||
type: object
|
||
saml_provider_FetchCustomizeColumnsOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
$ref: '#/definitions/SAMLProviderDetails'
|
||
type: object
|
||
saml_provider_GetDetailsMetadataOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
saml_provider_GetDetailsStatusOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
$ref: '#/definitions/GetDetailsStatusOutput'
|
||
type: object
|
||
saml_provider_ListItemFilterOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
saml_providers:
|
||
items:
|
||
$ref: '#/definitions/SAMLProviderDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
saml_provider_PerformChangeOwnerOutput:
|
||
description: ""
|
||
saml_provider_PerformPrivateOutput:
|
||
description: ""
|
||
saml_provider_PerformPublicOutput:
|
||
description: ""
|
||
saml_provider_ValidateCreateDataOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
$ref: '#/definitions/SAMLProviderDetails'
|
||
type: object
|
||
saml_provider_ValidateUpdateDataOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
$ref: '#/definitions/SAMLProviderDetails'
|
||
type: object
|
||
samluser_CustomizeDeleteOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
samluser:
|
||
$ref: '#/definitions/SamluserDetails'
|
||
type: object
|
||
samluser_FetchCustomizeColumnsOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
samluser:
|
||
$ref: '#/definitions/SamluserDetails'
|
||
type: object
|
||
samluser_GetDetailsMetadataOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
samluser:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
samluser_GetDetailsStatusOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
samluser:
|
||
$ref: '#/definitions/GetDetailsStatusOutput'
|
||
type: object
|
||
samluser_ListItemFilterOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
samlusers:
|
||
items:
|
||
$ref: '#/definitions/SamluserDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
samluser_PerformChangeOwnerOutput:
|
||
description: ""
|
||
samluser_ValidateCreateDataOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
samluser:
|
||
$ref: '#/definitions/SamluserDetails'
|
||
type: object
|
||
samluser_ValidateUpdateDataOutput:
|
||
description: ""
|
||
schema:
|
||
properties:
|
||
samluser:
|
||
$ref: '#/definitions/SamluserDetails'
|
||
type: object
|
||
schemes:
|
||
- https
|
||
- http
|
||
securityDefinitions:
|
||
keystone:
|
||
in: header
|
||
name: X-Auth-Token
|
||
type: apiKey
|
||
swagger: "2.0"
|