mirror of
https://github.com/yunionio/cloudpods.git
synced 2026-06-20 10:22:22 +08:00
8810 lines
274 KiB
YAML
8810 lines
274 KiB
YAML
basePath: /
|
||
consumes:
|
||
- application/json
|
||
definitions:
|
||
ChangeOwnerCandidateDomainsOutput:
|
||
properties:
|
||
candidates:
|
||
items:
|
||
$ref: '#/definitions/SharedDomain'
|
||
type: array
|
||
x-go-name: Candidates
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
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
|
||
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
|
||
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
|
||
provider:
|
||
description: 平台, 目前支持Qcloud,Google,Azure,Aliyun,Huawei,Aws
|
||
type: string
|
||
x-go-name: Provider
|
||
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
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
CloudgroupDetails:
|
||
properties:
|
||
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
|
||
cloudgroupcache_count:
|
||
description: 公有云权限组缓存数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: CloudgroupcacheCount
|
||
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
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
is_emulated:
|
||
description: |-
|
||
是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
|
||
list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
is_public:
|
||
description: 是否共享
|
||
type: boolean
|
||
x-go-name: IsPublic
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
progress:
|
||
description: 操作进度0-100
|
||
format: float
|
||
type: number
|
||
x-go-name: Progress
|
||
project_domain:
|
||
description: 资源归属项目的域名称
|
||
type: string
|
||
x-go-name: ProjectDomain
|
||
provider:
|
||
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
|
||
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
|
||
CloudgroupcacheDetails:
|
||
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:
|
||
description: 用户组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
|
||
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
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
progress:
|
||
description: 操作进度0-100
|
||
format: float
|
||
type: number
|
||
x-go-name: Progress
|
||
provider:
|
||
description: 平台信息
|
||
type: string
|
||
x-go-name: Provider
|
||
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
|
||
CloudpolicyAssignGroupInput:
|
||
properties:
|
||
cloudgroup_id:
|
||
description: 权限组Id
|
||
type: string
|
||
x-go-name: CloudgroupId
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
CloudpolicyCacheInput:
|
||
properties:
|
||
manager_id:
|
||
description: 云订阅Id
|
||
type: string
|
||
x-go-name: ManagerId
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
CloudpolicyCreateInput:
|
||
properties:
|
||
__meta__:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签列表,最多支持20个
|
||
example:
|
||
user:rd: op
|
||
type: object
|
||
x-go-name: Metadata
|
||
cloud_env:
|
||
type: string
|
||
x-go-name: CloudEnv
|
||
description:
|
||
description: 资源描述
|
||
example: test create network
|
||
type: string
|
||
x-go-name: Description
|
||
document:
|
||
description: 策略详情
|
||
type: object
|
||
x-go-name: Document
|
||
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
|
||
policy_type:
|
||
default: custom
|
||
type: string
|
||
x-go-name: PolicyType
|
||
project_domain_id:
|
||
description: 指定项目归属域名称或ID
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
provider:
|
||
description: 平台
|
||
type: string
|
||
x-go-name: Provider
|
||
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
|
||
CloudpolicyDetails:
|
||
properties:
|
||
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
|
||
cloud_env:
|
||
type: string
|
||
x-go-name: CloudEnv
|
||
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
|
||
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
|
||
locked:
|
||
description: 是否锁定, 若锁定后, 此策略不允许被绑定到用户或权限组, 仅管理员可以设置是否锁定
|
||
type: boolean
|
||
x-go-name: Locked
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
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: "平台\n 云平台 | 说明 |\n----------|---------------------------------------------|\n
|
||
Google | 支持 |\n Aliyun | 支持\t\t\t\t\t\t\t\t\t\t|\n
|
||
Huawei | 支持 |\n Azure | 支持 |\n
|
||
腾讯云 | 支持 |"
|
||
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
|
||
CloudpolicyRevokeGroupInput:
|
||
properties:
|
||
cloudgroup_id:
|
||
description: 权限组Id
|
||
type: string
|
||
x-go-name: CloudgroupId
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
CloudpolicyUpdateInput:
|
||
properties:
|
||
description:
|
||
description: 资源描述
|
||
type: string
|
||
x-go-name: Description
|
||
document:
|
||
type: object
|
||
x-go-name: Document
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
CloudpolicycacheDetails:
|
||
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
|
||
cloudprovider:
|
||
description: 云订阅名称
|
||
type: string
|
||
x-go-name: Cloudprovider
|
||
delete_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
iam_login_url:
|
||
description: 公有云账号登录地址
|
||
type: string
|
||
x-go-name: IamLoginUrl
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
provider:
|
||
description: 平台信息
|
||
type: string
|
||
x-go-name: Provider
|
||
update_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
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
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
owner_id:
|
||
type: string
|
||
x-go-name: OwnerId
|
||
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
|
||
CloudrolePurgeInput:
|
||
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
|
||
cloudprovider_id:
|
||
description: 订阅Id, 向云账号赋予某个订阅的权限, 目前仅Google,Azure平台此参数生效
|
||
type: string
|
||
x-go-name: CloudproviderId
|
||
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
|
||
cloudprovider_id:
|
||
description: |-
|
||
云订阅ID, 若此参数为空, 则cloudpolicy_ids的权限会绑定到此账号的所有订阅, 若不为空则cloudpolicy_ids仅绑定的指定的订阅
|
||
此参数仅对Google,Azure生效
|
||
type: string
|
||
x-go-name: CloudproviderId
|
||
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
|
||
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
|
||
cloudprovider_id:
|
||
description: 订阅Id, 解绑云账号赋予某个订阅的权限, 目前仅Google,Azure平台此参数生效
|
||
type: string
|
||
x-go-name: CloudproviderId
|
||
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/ClouduserpolicyDetails'
|
||
type: array
|
||
x-go-name: Cloudpolicies
|
||
cloudpolicy_count:
|
||
description: 权限数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: CloudpolicyCount
|
||
cloudprovider:
|
||
description: 云订阅名称
|
||
type: string
|
||
x-go-name: Cloudprovider
|
||
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
|
||
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
|
||
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
|
||
cloudprovider_id:
|
||
description: 订阅Id, 设置云账号赋予某个订阅的权限, 目前仅Google,Azure平台此参数生效
|
||
type: string
|
||
x-go-name: CloudproviderId
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
|
||
ClouduserSyncInput:
|
||
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
|
||
ClouduserpolicyDetails:
|
||
properties:
|
||
cloudprovider_id:
|
||
description: 子订阅Id
|
||
type: string
|
||
x-go-name: CloudproviderId
|
||
id:
|
||
description: 权限Id
|
||
type: string
|
||
x-go-name: Id
|
||
manager:
|
||
description: 子订阅名称
|
||
type: string
|
||
x-go-name: Manager
|
||
name:
|
||
description: 权限名称
|
||
type: string
|
||
x-go-name: Name
|
||
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
|
||
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
|
||
PerformStatusInput:
|
||
properties:
|
||
host_id:
|
||
description: call from host id
|
||
type: string
|
||
x-go-name: HostId
|
||
power_states:
|
||
description: 电源状态
|
||
type: string
|
||
x-go-name: PowerStates
|
||
reason:
|
||
description: 更改状态的原因描述
|
||
type: string
|
||
x-go-name: Reason
|
||
status:
|
||
description: 更改的目标状态值
|
||
type: string
|
||
x-go-name: Status
|
||
required:
|
||
- status
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
PurgeSplitTableInput:
|
||
properties:
|
||
tables:
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Tables
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
SAMLProviderCreateInput:
|
||
properties:
|
||
__meta__:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签列表,最多支持20个
|
||
example:
|
||
user:rd: op
|
||
type: object
|
||
x-go-name: Metadata
|
||
cloudaccount_id:
|
||
type: string
|
||
x-go-name: CloudaccountId
|
||
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/cloudid
|
||
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
|
||
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
|
||
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:
|
||
description: 云账号Id
|
||
type: string
|
||
x-go-name: CloudaccountId
|
||
cloudgroup:
|
||
description: 公有云用户名称
|
||
type: string
|
||
x-go-name: Cloudgroup
|
||
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
|
||
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_emulated:
|
||
description: |-
|
||
是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
|
||
list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
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
|
||
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
|
||
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
|
||
StatusStandaloneResourceBaseUpdateInput:
|
||
properties:
|
||
description:
|
||
description: 资源描述
|
||
type: string
|
||
x-go-name: Description
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
progress:
|
||
format: float
|
||
type: number
|
||
x-go-name: Progress
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
StatusStandaloneResourceCreateInput:
|
||
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
|
||
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
|
||
status:
|
||
description: 用来存储资源的状态
|
||
type: string
|
||
x-go-name: Status
|
||
required:
|
||
- name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
StatusStatistic:
|
||
properties:
|
||
TotalCpuCount:
|
||
description: CPU总量
|
||
format: int64
|
||
type: integer
|
||
TotalDiskSizeMb:
|
||
description: 存储总量
|
||
format: int64
|
||
type: integer
|
||
TotalMemSizeMb:
|
||
description: 内存总量
|
||
format: int64
|
||
type: integer
|
||
status_info:
|
||
items:
|
||
$ref: '#/definitions/StatusStatisticStatusInfo'
|
||
type: array
|
||
x-go-name: StatusInfo
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
StatusStatisticStatusInfo:
|
||
properties:
|
||
Status:
|
||
type: string
|
||
pending_deleted_count:
|
||
description: |-
|
||
回收站数量
|
||
需要指定pending_delete=all
|
||
format: int64
|
||
type: integer
|
||
x-go-name: PendingDeletedCount
|
||
total_count:
|
||
description: 资源总数
|
||
format: int64
|
||
type: integer
|
||
x-go-name: TotalCount
|
||
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:
|
||
/cloudgroupcaches:
|
||
get:
|
||
description: 列表
|
||
operationId: cloudgroupcache_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
|
||
- $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: 以资源的状态过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: status
|
||
type: array
|
||
x-go-name: Status
|
||
- description: 根据云账号名称过滤资源
|
||
in: query
|
||
name: cloudaccount
|
||
type: string
|
||
x-go-name: Cloudaccount
|
||
- description: 根据平台过滤
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: provider
|
||
type: array
|
||
x-go-name: Provider
|
||
- description: 根据权限组过滤
|
||
in: query
|
||
name: cloudgroup_id
|
||
type: string
|
||
x-go-name: CloudgroupId
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroupcache_ListItemFilterOutput'
|
||
summary: 公有云权限组缓存
|
||
tags:
|
||
- cloudgroupcache
|
||
/cloudgroupcaches/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: cloudgroupcache_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of cloudgroupcache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroupcache_CustomizeDeleteOutput'
|
||
summary: 删除权限组缓存
|
||
tags:
|
||
- cloudgroupcache
|
||
get:
|
||
description: 获取详情
|
||
operationId: cloudgroupcache_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of cloudgroupcache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroupcache_FetchCustomizeColumnsOutput'
|
||
summary: 获取权限组缓存详情
|
||
tags:
|
||
- cloudgroupcache
|
||
/cloudgroupcaches/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: cloudgroupcache_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of cloudgroupcache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroupcache_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- cloudgroupcache
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: cloudgroupcache_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of cloudgroupcache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudgroupcache:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroupcache_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- cloudgroupcache
|
||
/cloudgroupcaches/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: cloudgroupcache_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 cloudgroupcache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroupcache_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- cloudgroupcache
|
||
/cloudgroupcaches/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: cloudgroupcache_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of cloudgroupcache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudgroupcache:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroupcache_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- cloudgroupcache
|
||
/cloudgroupcaches/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: cloudgroupcache_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of cloudgroupcache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudgroupcache:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroupcache_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- cloudgroupcache
|
||
/cloudgroupcaches/{id}/status:
|
||
get:
|
||
description: 获取指定信息Status
|
||
operationId: cloudgroupcache_GetDetailsStatus
|
||
parameters:
|
||
- description: The Id or Name of cloudgroupcache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroupcache_GetDetailsStatusOutput'
|
||
summary: 获取资源状态
|
||
tags:
|
||
- cloudgroupcache
|
||
post:
|
||
description: 执行操作Status
|
||
operationId: cloudgroupcache_PerformStatus
|
||
parameters:
|
||
- description: The Id or Name of cloudgroupcache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudgroupcache:
|
||
$ref: '#/definitions/PerformStatusInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroupcache_PerformStatusOutput'
|
||
summary: 更新资源状态
|
||
tags:
|
||
- cloudgroupcache
|
||
/cloudgroupcaches/{id}/syncstatus:
|
||
post:
|
||
description: 执行操作Syncstatus
|
||
operationId: cloudgroupcache_PerformSyncstatus
|
||
parameters:
|
||
- description: The Id or Name of cloudgroupcache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudgroupcache:
|
||
$ref: '#/definitions/CloudgroupSyncstatusInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroupcache_PerformSyncstatusOutput'
|
||
summary: 同步权限组缓存状态
|
||
tags:
|
||
- cloudgroupcache
|
||
/cloudgroupcaches/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: cloudgroupcache_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroupcache_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- cloudgroupcache
|
||
/cloudgroupcaches/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: cloudgroupcache_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudgroupcache:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroupcache_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- cloudgroupcache
|
||
/cloudgroupcaches/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: cloudgroupcache_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroupcache_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- cloudgroupcache
|
||
/cloudgroupcaches/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: cloudgroupcache_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroupcache_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- cloudgroupcache
|
||
/cloudgroupcaches/statistics:
|
||
get:
|
||
description: 获取指定资源类的信息Statistics
|
||
operationId: cloudgroupcache_GetPropertyStatistics
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroupcache_GetPropertyStatisticsOutput'
|
||
summary: 获取指定资源类的信息Statistics
|
||
tags:
|
||
- cloudgroupcache
|
||
/cloudgroupcaches/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: cloudgroupcache_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroupcache_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- cloudgroupcache
|
||
/cloudgroupcaches/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: cloudgroupcache_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroupcache_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- cloudgroupcache
|
||
/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
|
||
- $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
|
||
- description: 过滤子账号所在的权限组
|
||
in: query
|
||
name: clouduser_id
|
||
type: string
|
||
x-go-name: ClouduserId
|
||
- description: 根据权限过滤权限组
|
||
in: query
|
||
name: cloudpolicy_id
|
||
type: string
|
||
x-go-name: CloudpolicyId
|
||
- description: 是否可用
|
||
in: query
|
||
name: usable
|
||
type: boolean
|
||
x-go-name: Usable
|
||
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}/change-owner-candidate-domains:
|
||
get:
|
||
description: 获取指定信息ChangeOwnerCandidateDomains
|
||
operationId: cloudgroup_GetDetailsChangeOwnerCandidateDomains
|
||
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_GetDetailsChangeOwnerCandidateDomainsOutput'
|
||
summary: 获取指定信息ChangeOwnerCandidateDomains
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: cloudgroup_GetDetailsClassMetadata
|
||
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_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- cloudgroup
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: cloudgroup_PerformClassMetadata
|
||
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:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
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}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: cloudgroup_PerformSetClassMetadata
|
||
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:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
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-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: cloudgroup_PerformSetUserMetadata
|
||
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:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_PerformSetUserMetadataOutput'
|
||
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
|
||
post:
|
||
description: 执行操作Status
|
||
operationId: cloudgroup_PerformStatus
|
||
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/PerformStatusInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_PerformStatusOutput'
|
||
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
|
||
/cloudgroups/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: cloudgroup_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/domain-tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValuePairs
|
||
operationId: cloudgroup_GetPropertyDomainTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_GetPropertyDomainTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息DomainTagValuePairs
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/domain-tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValueTree
|
||
operationId: cloudgroup_GetPropertyDomainTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_GetPropertyDomainTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息DomainTagValueTree
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: cloudgroup_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: cloudgroup_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: cloudgroup_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/statistics:
|
||
get:
|
||
description: 获取指定资源类的信息Statistics
|
||
operationId: cloudgroup_GetPropertyStatistics
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_GetPropertyStatisticsOutput'
|
||
summary: 获取指定资源类的信息Statistics
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: cloudgroup_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- cloudgroup
|
||
/cloudgroups/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: cloudgroup_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudgroup_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
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
|
||
- $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
|
||
- 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: cloudprovider_id
|
||
type: string
|
||
x-go-name: CloudproviderId
|
||
- description: |-
|
||
权限类型
|
||
|
||
|
||
类型 | 说明 |
|
||
---------| ------------ |
|
||
system | 过滤系统权限 |
|
||
custom | 过滤自定义权限 |
|
||
in: query
|
||
name: policy_type
|
||
type: string
|
||
x-go-name: PolicyType
|
||
- description: 是否显示Locked的权限
|
||
in: query
|
||
name: locked
|
||
type: boolean
|
||
x-go-name: Locked
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_ListItemFilterOutput'
|
||
summary: 公有云权限列表
|
||
tags:
|
||
- cloudpolicy
|
||
post:
|
||
description: 新建
|
||
operationId: cloudpolicy_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudpolicy:
|
||
$ref: '#/definitions/CloudpolicyCreateInput'
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_ValidateCreateDataOutput'
|
||
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
|
||
put:
|
||
description: 更新
|
||
operationId: cloudpolicy_ValidateUpdateData
|
||
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/CloudpolicyUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_ValidateUpdateDataOutput'
|
||
summary: 更新策略(仅限自定义)
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/{id}/assign-group:
|
||
post:
|
||
description: 执行操作AssignGroup
|
||
operationId: cloudpolicy_PerformAssignGroup
|
||
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/CloudpolicyAssignGroupInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_PerformAssignGroupOutput'
|
||
summary: 将权限加入权限组
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/{id}/cache:
|
||
post:
|
||
description: 执行操作Cache
|
||
operationId: cloudpolicy_PerformCache
|
||
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/CloudpolicyCacheInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_PerformCacheOutput'
|
||
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}/change-owner-candidate-domains:
|
||
get:
|
||
description: 获取指定信息ChangeOwnerCandidateDomains
|
||
operationId: cloudpolicy_GetDetailsChangeOwnerCandidateDomains
|
||
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_GetDetailsChangeOwnerCandidateDomainsOutput'
|
||
summary: 获取指定信息ChangeOwnerCandidateDomains
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: cloudpolicy_GetDetailsClassMetadata
|
||
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_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- cloudpolicy
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: cloudpolicy_PerformClassMetadata
|
||
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:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/{id}/lock:
|
||
post:
|
||
description: 执行操作Lock
|
||
operationId: cloudpolicy_PerformLock
|
||
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/CloudpolicyAssignGroupInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_PerformLockOutput'
|
||
summary: 锁定权限(禁止使用此权限)
|
||
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}/revoke-group:
|
||
post:
|
||
description: 执行操作RevokeGroup
|
||
operationId: cloudpolicy_PerformRevokeGroup
|
||
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/CloudpolicyRevokeGroupInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_PerformRevokeGroupOutput'
|
||
summary: 将权限从权限组中移除
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: cloudpolicy_PerformSetClassMetadata
|
||
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:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: cloudpolicy_PerformSetUserMetadata
|
||
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:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
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
|
||
post:
|
||
description: 执行操作Status
|
||
operationId: cloudpolicy_PerformStatus
|
||
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/PerformStatusInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_PerformStatusOutput'
|
||
summary: 更新资源状态
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/{id}/syncstatus:
|
||
post:
|
||
description: 执行操作Syncstatus
|
||
operationId: cloudpolicy_PerformSyncstatus
|
||
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/CloudgroupSyncstatusInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_PerformSyncstatusOutput'
|
||
summary: 恢复权限组状态
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/{id}/unlock:
|
||
post:
|
||
description: 执行操作Unlock
|
||
operationId: cloudpolicy_PerformUnlock
|
||
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/CloudpolicyAssignGroupInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_PerformUnlockOutput'
|
||
summary: 解锁权限(允许使用此权限)
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: cloudpolicy_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/domain-tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValuePairs
|
||
operationId: cloudpolicy_GetPropertyDomainTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_GetPropertyDomainTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息DomainTagValuePairs
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/domain-tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValueTree
|
||
operationId: cloudpolicy_GetPropertyDomainTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_GetPropertyDomainTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息DomainTagValueTree
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: cloudpolicy_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudpolicy:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: cloudpolicy_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: cloudpolicy_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/statistics:
|
||
get:
|
||
description: 获取指定资源类的信息Statistics
|
||
operationId: cloudpolicy_GetPropertyStatistics
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_GetPropertyStatisticsOutput'
|
||
summary: 获取指定资源类的信息Statistics
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: cloudpolicy_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicies/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: cloudpolicy_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicy_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- cloudpolicy
|
||
/cloudpolicycaches:
|
||
get:
|
||
description: 列表
|
||
operationId: cloudpolicycache_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
|
||
- $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: 以资源的状态过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: status
|
||
type: array
|
||
x-go-name: Status
|
||
- description: 根据权限过滤
|
||
in: query
|
||
name: cloudpolicy_id
|
||
type: string
|
||
x-go-name: CloudpolicyId
|
||
- description: 根据云账号过滤
|
||
in: query
|
||
name: cloudaccount_id
|
||
type: string
|
||
x-go-name: CloudaccountId
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicycache_ListItemFilterOutput'
|
||
summary: 公有云权限缓存列表
|
||
tags:
|
||
- cloudpolicycache
|
||
post:
|
||
description: 新建
|
||
operationId: cloudpolicycache_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudpolicycache:
|
||
$ref: '#/definitions/StatusStandaloneResourceCreateInput'
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicycache_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- cloudpolicycache
|
||
/cloudpolicycaches/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: cloudpolicycache_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of cloudpolicycache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicycache_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- cloudpolicycache
|
||
get:
|
||
description: 获取详情
|
||
operationId: cloudpolicycache_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of cloudpolicycache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicycache_FetchCustomizeColumnsOutput'
|
||
summary: 获取公有云权限缓存详情
|
||
tags:
|
||
- cloudpolicycache
|
||
put:
|
||
description: 更新
|
||
operationId: cloudpolicycache_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of cloudpolicycache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudpolicycache:
|
||
$ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicycache_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- cloudpolicycache
|
||
/cloudpolicycaches/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: cloudpolicycache_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of cloudpolicycache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicycache_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- cloudpolicycache
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: cloudpolicycache_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of cloudpolicycache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudpolicycache:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicycache_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- cloudpolicycache
|
||
/cloudpolicycaches/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: cloudpolicycache_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 cloudpolicycache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicycache_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- cloudpolicycache
|
||
/cloudpolicycaches/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: cloudpolicycache_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of cloudpolicycache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudpolicycache:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicycache_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- cloudpolicycache
|
||
/cloudpolicycaches/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: cloudpolicycache_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of cloudpolicycache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudpolicycache:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicycache_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- cloudpolicycache
|
||
/cloudpolicycaches/{id}/status:
|
||
get:
|
||
description: 获取指定信息Status
|
||
operationId: cloudpolicycache_GetDetailsStatus
|
||
parameters:
|
||
- description: The Id or Name of cloudpolicycache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicycache_GetDetailsStatusOutput'
|
||
summary: 获取资源状态
|
||
tags:
|
||
- cloudpolicycache
|
||
post:
|
||
description: 执行操作Status
|
||
operationId: cloudpolicycache_PerformStatus
|
||
parameters:
|
||
- description: The Id or Name of cloudpolicycache
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudpolicycache:
|
||
$ref: '#/definitions/PerformStatusInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicycache_PerformStatusOutput'
|
||
summary: 更新资源状态
|
||
tags:
|
||
- cloudpolicycache
|
||
/cloudpolicycaches/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: cloudpolicycache_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicycache_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- cloudpolicycache
|
||
/cloudpolicycaches/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: cloudpolicycache_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudpolicycache:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicycache_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- cloudpolicycache
|
||
/cloudpolicycaches/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: cloudpolicycache_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicycache_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- cloudpolicycache
|
||
/cloudpolicycaches/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: cloudpolicycache_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicycache_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- cloudpolicycache
|
||
/cloudpolicycaches/statistics:
|
||
get:
|
||
description: 获取指定资源类的信息Statistics
|
||
operationId: cloudpolicycache_GetPropertyStatistics
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicycache_GetPropertyStatisticsOutput'
|
||
summary: 获取指定资源类的信息Statistics
|
||
tags:
|
||
- cloudpolicycache
|
||
/cloudpolicycaches/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: cloudpolicycache_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicycache_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- cloudpolicycache
|
||
/cloudpolicycaches/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: cloudpolicycache_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudpolicycache_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- cloudpolicycache
|
||
/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
|
||
- $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
|
||
name: cloudaccount
|
||
type: string
|
||
x-go-name: Cloudaccount
|
||
- description: 根据平台过滤
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: provider
|
||
type: array
|
||
x-go-name: Provider
|
||
- 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}/change-owner-candidate-domains:
|
||
get:
|
||
description: 获取指定信息ChangeOwnerCandidateDomains
|
||
operationId: cloudrole_GetDetailsChangeOwnerCandidateDomains
|
||
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_GetDetailsChangeOwnerCandidateDomainsOutput'
|
||
summary: 获取指定信息ChangeOwnerCandidateDomains
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: cloudrole_GetDetailsClassMetadata
|
||
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_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- cloudrole
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: cloudrole_PerformClassMetadata
|
||
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:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
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}/purge:
|
||
post:
|
||
description: 执行操作Purge
|
||
operationId: cloudrole_PerformPurge
|
||
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/CloudrolePurgeInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_PerformPurgeOutput'
|
||
summary: 清除角色(不删除云上资源)
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: cloudrole_PerformSetClassMetadata
|
||
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:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: cloudrole_PerformSetUserMetadata
|
||
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:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
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
|
||
post:
|
||
description: 执行操作Status
|
||
operationId: cloudrole_PerformStatus
|
||
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/PerformStatusInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_PerformStatusOutput'
|
||
summary: 更新资源状态
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: cloudrole_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/domain-tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValuePairs
|
||
operationId: cloudrole_GetPropertyDomainTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_GetPropertyDomainTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息DomainTagValuePairs
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/domain-tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValueTree
|
||
operationId: cloudrole_GetPropertyDomainTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_GetPropertyDomainTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息DomainTagValueTree
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: cloudrole_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: cloudrole_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: cloudrole_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/statistics:
|
||
get:
|
||
description: 获取指定资源类的信息Statistics
|
||
operationId: cloudrole_GetPropertyStatistics
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_GetPropertyStatisticsOutput'
|
||
summary: 获取指定资源类的信息Statistics
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: cloudrole_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- cloudrole
|
||
/cloudroles/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: cloudrole_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/cloudrole_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
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
|
||
- $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
|
||
name: cloudaccount
|
||
type: string
|
||
x-go-name: Cloudaccount
|
||
- description: 根据平台过滤
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: provider
|
||
type: array
|
||
x-go-name: Provider
|
||
- 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}/change-owner-candidate-domains:
|
||
get:
|
||
description: 获取指定信息ChangeOwnerCandidateDomains
|
||
operationId: clouduser_GetDetailsChangeOwnerCandidateDomains
|
||
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_GetDetailsChangeOwnerCandidateDomainsOutput'
|
||
summary: 获取指定信息ChangeOwnerCandidateDomains
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: clouduser_GetDetailsClassMetadata
|
||
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_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- clouduser
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: clouduser_PerformClassMetadata
|
||
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:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
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-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: clouduser_PerformSetClassMetadata
|
||
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:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
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}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: clouduser_PerformSetUserMetadata
|
||
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:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_PerformSetUserMetadataOutput'
|
||
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
|
||
post:
|
||
description: 执行操作Status
|
||
operationId: clouduser_PerformStatus
|
||
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/PerformStatusInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_PerformStatusOutput'
|
||
summary: 更新资源状态
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/{id}/sync:
|
||
post:
|
||
description: '用户状态必须为: available'
|
||
operationId: clouduser_PerformSync
|
||
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/ClouduserSyncInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_PerformSyncOutput'
|
||
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
|
||
/cloudusers/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: clouduser_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/domain-tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValuePairs
|
||
operationId: clouduser_GetPropertyDomainTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_GetPropertyDomainTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息DomainTagValuePairs
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/domain-tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValueTree
|
||
operationId: clouduser_GetPropertyDomainTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_GetPropertyDomainTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息DomainTagValueTree
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: clouduser_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: clouduser_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: clouduser_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: clouduser_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- clouduser
|
||
/cloudusers/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: clouduser_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/clouduser_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
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
|
||
- $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
|
||
name: cloudaccount
|
||
type: string
|
||
x-go-name: Cloudaccount
|
||
- description: 根据平台过滤
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: provider
|
||
type: array
|
||
x-go-name: Provider
|
||
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/SAMLProviderCreateInput'
|
||
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}/change-owner-candidate-domains:
|
||
get:
|
||
description: 获取指定信息ChangeOwnerCandidateDomains
|
||
operationId: saml_provider_GetDetailsChangeOwnerCandidateDomains
|
||
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_GetDetailsChangeOwnerCandidateDomainsOutput'
|
||
summary: 获取指定信息ChangeOwnerCandidateDomains
|
||
tags:
|
||
- saml_provider
|
||
/saml_providers/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: saml_provider_GetDetailsClassMetadata
|
||
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_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- saml_provider
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: saml_provider_PerformClassMetadata
|
||
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:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
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}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: saml_provider_PerformSetClassMetadata
|
||
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:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- saml_provider
|
||
/saml_providers/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: saml_provider_PerformSetUserMetadata
|
||
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:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
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
|
||
post:
|
||
description: 执行操作Status
|
||
operationId: saml_provider_PerformStatus
|
||
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/PerformStatusInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_PerformStatusOutput'
|
||
summary: 更新资源状态
|
||
tags:
|
||
- saml_provider
|
||
/saml_providers/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: saml_provider_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- saml_provider
|
||
/saml_providers/domain-tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValuePairs
|
||
operationId: saml_provider_GetPropertyDomainTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_GetPropertyDomainTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息DomainTagValuePairs
|
||
tags:
|
||
- saml_provider
|
||
/saml_providers/domain-tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValueTree
|
||
operationId: saml_provider_GetPropertyDomainTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_GetPropertyDomainTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息DomainTagValueTree
|
||
tags:
|
||
- saml_provider
|
||
/saml_providers/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: saml_provider_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- saml_provider
|
||
/saml_providers/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: saml_provider_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- saml_provider
|
||
/saml_providers/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: saml_provider_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- saml_provider
|
||
/saml_providers/statistics:
|
||
get:
|
||
description: 获取指定资源类的信息Statistics
|
||
operationId: saml_provider_GetPropertyStatistics
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_GetPropertyStatisticsOutput'
|
||
summary: 获取指定资源类的信息Statistics
|
||
tags:
|
||
- saml_provider
|
||
/saml_providers/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: saml_provider_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- saml_provider
|
||
/saml_providers/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: saml_provider_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/saml_provider_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
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
|
||
- $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
|
||
name: cloudaccount
|
||
type: string
|
||
x-go-name: Cloudaccount
|
||
- description: 根据平台过滤
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: provider
|
||
type: array
|
||
x-go-name: Provider
|
||
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: 执行操作ChangeOwner
|
||
tags:
|
||
- samluser
|
||
/samlusers/{id}/change-owner-candidate-domains:
|
||
get:
|
||
description: 获取指定信息ChangeOwnerCandidateDomains
|
||
operationId: samluser_GetDetailsChangeOwnerCandidateDomains
|
||
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_GetDetailsChangeOwnerCandidateDomainsOutput'
|
||
summary: 获取指定信息ChangeOwnerCandidateDomains
|
||
tags:
|
||
- samluser
|
||
/samlusers/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: samluser_GetDetailsClassMetadata
|
||
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_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- samluser
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: samluser_PerformClassMetadata
|
||
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:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
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}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: samluser_PerformSetClassMetadata
|
||
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:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- samluser
|
||
/samlusers/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: samluser_PerformSetUserMetadata
|
||
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:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_PerformSetUserMetadataOutput'
|
||
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
|
||
post:
|
||
description: 执行操作Status
|
||
operationId: samluser_PerformStatus
|
||
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/PerformStatusInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_PerformStatusOutput'
|
||
summary: 更新资源状态
|
||
tags:
|
||
- samluser
|
||
/samlusers/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: samluser_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- samluser
|
||
/samlusers/domain-tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValuePairs
|
||
operationId: samluser_GetPropertyDomainTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_GetPropertyDomainTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息DomainTagValuePairs
|
||
tags:
|
||
- samluser
|
||
/samlusers/domain-tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValueTree
|
||
operationId: samluser_GetPropertyDomainTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_GetPropertyDomainTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息DomainTagValueTree
|
||
tags:
|
||
- samluser
|
||
/samlusers/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: samluser_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
samluser:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- samluser
|
||
/samlusers/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: samluser_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- samluser
|
||
/samlusers/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: samluser_GetPropertySplitableExport
|
||
parameters:
|
||
- in: query
|
||
name: table
|
||
type: string
|
||
x-go-name: Table
|
||
- format: int64
|
||
in: query
|
||
name: offset
|
||
type: integer
|
||
x-go-name: Offset
|
||
- format: int64
|
||
in: query
|
||
name: limit
|
||
type: integer
|
||
x-go-name: Limit
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- samluser
|
||
/samlusers/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: samluser_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- samluser
|
||
/samlusers/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: samluser_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/samluser_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- samluser
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
cloudgroup_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/CloudgroupDetails'
|
||
type: object
|
||
cloudgroup_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/CloudgroupDetails'
|
||
type: object
|
||
cloudgroup_GetDetailsChangeOwnerCandidateDomainsOutput:
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/ChangeOwnerCandidateDomainsOutput'
|
||
type: object
|
||
cloudgroup_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
cloudgroup_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
cloudgroup_GetDetailsStatusOutput:
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/GetDetailsStatusOutput'
|
||
type: object
|
||
cloudgroup_GetPropertyDistinctFieldOutput: {}
|
||
cloudgroup_GetPropertyDomainTagValuePairsOutput: {}
|
||
cloudgroup_GetPropertyDomainTagValueTreeOutput: {}
|
||
cloudgroup_GetPropertySplitableExportOutput: {}
|
||
cloudgroup_GetPropertySplitableOutput: {}
|
||
cloudgroup_GetPropertyStatisticsOutput:
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/StatusStatistic'
|
||
type: object
|
||
cloudgroup_GetPropertyTagValuePairsOutput: {}
|
||
cloudgroup_GetPropertyTagValueTreeOutput: {}
|
||
cloudgroup_ListItemFilterOutput:
|
||
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: {}
|
||
cloudgroup_PerformAttachPolicyOutput: {}
|
||
cloudgroup_PerformChangeOwnerOutput: {}
|
||
cloudgroup_PerformClassMetadataOutput: {}
|
||
cloudgroup_PerformDetachPolicyOutput: {}
|
||
cloudgroup_PerformPrivateOutput: {}
|
||
cloudgroup_PerformPublicOutput: {}
|
||
cloudgroup_PerformPurgeSplitableOutput: {}
|
||
cloudgroup_PerformRemoveUserOutput: {}
|
||
cloudgroup_PerformSetClassMetadataOutput: {}
|
||
cloudgroup_PerformSetPoliciesOutput: {}
|
||
cloudgroup_PerformSetUserMetadataOutput: {}
|
||
cloudgroup_PerformSetUsersOutput: {}
|
||
cloudgroup_PerformStatusOutput: {}
|
||
cloudgroup_PerformSyncstatusOutput: {}
|
||
cloudgroup_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/CloudgroupDetails'
|
||
type: object
|
||
cloudgroup_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
cloudgroup:
|
||
$ref: '#/definitions/CloudgroupDetails'
|
||
type: object
|
||
cloudgroupcache_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
cloudgroupcache:
|
||
$ref: '#/definitions/CloudgroupcacheDetails'
|
||
type: object
|
||
cloudgroupcache_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
cloudgroupcache:
|
||
$ref: '#/definitions/CloudgroupcacheDetails'
|
||
type: object
|
||
cloudgroupcache_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
cloudgroupcache:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
cloudgroupcache_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
cloudgroupcache:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
cloudgroupcache_GetDetailsStatusOutput:
|
||
schema:
|
||
properties:
|
||
cloudgroupcache:
|
||
$ref: '#/definitions/GetDetailsStatusOutput'
|
||
type: object
|
||
cloudgroupcache_GetPropertyDistinctFieldOutput: {}
|
||
cloudgroupcache_GetPropertySplitableExportOutput: {}
|
||
cloudgroupcache_GetPropertySplitableOutput: {}
|
||
cloudgroupcache_GetPropertyStatisticsOutput:
|
||
schema:
|
||
properties:
|
||
cloudgroupcache:
|
||
$ref: '#/definitions/StatusStatistic'
|
||
type: object
|
||
cloudgroupcache_GetPropertyTagValuePairsOutput: {}
|
||
cloudgroupcache_GetPropertyTagValueTreeOutput: {}
|
||
cloudgroupcache_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
cloudgroupcaches:
|
||
items:
|
||
$ref: '#/definitions/CloudgroupcacheDetails'
|
||
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
|
||
cloudgroupcache_PerformClassMetadataOutput: {}
|
||
cloudgroupcache_PerformPurgeSplitableOutput: {}
|
||
cloudgroupcache_PerformSetClassMetadataOutput: {}
|
||
cloudgroupcache_PerformSetUserMetadataOutput: {}
|
||
cloudgroupcache_PerformStatusOutput: {}
|
||
cloudgroupcache_PerformSyncstatusOutput: {}
|
||
cloudpolicy_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
cloudpolicy:
|
||
$ref: '#/definitions/CloudpolicyDetails'
|
||
type: object
|
||
cloudpolicy_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
cloudpolicy:
|
||
$ref: '#/definitions/CloudpolicyDetails'
|
||
type: object
|
||
cloudpolicy_GetDetailsChangeOwnerCandidateDomainsOutput:
|
||
schema:
|
||
properties:
|
||
cloudpolicy:
|
||
$ref: '#/definitions/ChangeOwnerCandidateDomainsOutput'
|
||
type: object
|
||
cloudpolicy_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
cloudpolicy:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
cloudpolicy_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
cloudpolicy:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
cloudpolicy_GetDetailsStatusOutput:
|
||
schema:
|
||
properties:
|
||
cloudpolicy:
|
||
$ref: '#/definitions/GetDetailsStatusOutput'
|
||
type: object
|
||
cloudpolicy_GetPropertyDistinctFieldOutput: {}
|
||
cloudpolicy_GetPropertyDomainTagValuePairsOutput: {}
|
||
cloudpolicy_GetPropertyDomainTagValueTreeOutput: {}
|
||
cloudpolicy_GetPropertySplitableExportOutput: {}
|
||
cloudpolicy_GetPropertySplitableOutput: {}
|
||
cloudpolicy_GetPropertyStatisticsOutput:
|
||
schema:
|
||
properties:
|
||
cloudpolicy:
|
||
$ref: '#/definitions/StatusStatistic'
|
||
type: object
|
||
cloudpolicy_GetPropertyTagValuePairsOutput: {}
|
||
cloudpolicy_GetPropertyTagValueTreeOutput: {}
|
||
cloudpolicy_ListItemFilterOutput:
|
||
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_PerformAssignGroupOutput: {}
|
||
cloudpolicy_PerformCacheOutput: {}
|
||
cloudpolicy_PerformChangeOwnerOutput: {}
|
||
cloudpolicy_PerformClassMetadataOutput: {}
|
||
cloudpolicy_PerformLockOutput: {}
|
||
cloudpolicy_PerformPrivateOutput: {}
|
||
cloudpolicy_PerformPublicOutput: {}
|
||
cloudpolicy_PerformPurgeSplitableOutput: {}
|
||
cloudpolicy_PerformRevokeGroupOutput: {}
|
||
cloudpolicy_PerformSetClassMetadataOutput: {}
|
||
cloudpolicy_PerformSetUserMetadataOutput: {}
|
||
cloudpolicy_PerformStatusOutput: {}
|
||
cloudpolicy_PerformSyncstatusOutput: {}
|
||
cloudpolicy_PerformUnlockOutput: {}
|
||
cloudpolicy_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
cloudpolicy:
|
||
$ref: '#/definitions/CloudpolicyDetails'
|
||
type: object
|
||
cloudpolicy_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
cloudpolicy:
|
||
$ref: '#/definitions/CloudpolicyDetails'
|
||
type: object
|
||
cloudpolicycache_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
cloudpolicycache:
|
||
$ref: '#/definitions/CloudpolicycacheDetails'
|
||
type: object
|
||
cloudpolicycache_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
cloudpolicycache:
|
||
$ref: '#/definitions/CloudpolicycacheDetails'
|
||
type: object
|
||
cloudpolicycache_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
cloudpolicycache:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
cloudpolicycache_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
cloudpolicycache:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
cloudpolicycache_GetDetailsStatusOutput:
|
||
schema:
|
||
properties:
|
||
cloudpolicycache:
|
||
$ref: '#/definitions/GetDetailsStatusOutput'
|
||
type: object
|
||
cloudpolicycache_GetPropertyDistinctFieldOutput: {}
|
||
cloudpolicycache_GetPropertySplitableExportOutput: {}
|
||
cloudpolicycache_GetPropertySplitableOutput: {}
|
||
cloudpolicycache_GetPropertyStatisticsOutput:
|
||
schema:
|
||
properties:
|
||
cloudpolicycache:
|
||
$ref: '#/definitions/StatusStatistic'
|
||
type: object
|
||
cloudpolicycache_GetPropertyTagValuePairsOutput: {}
|
||
cloudpolicycache_GetPropertyTagValueTreeOutput: {}
|
||
cloudpolicycache_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
cloudpolicycaches:
|
||
items:
|
||
$ref: '#/definitions/CloudpolicycacheDetails'
|
||
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
|
||
cloudpolicycache_PerformClassMetadataOutput: {}
|
||
cloudpolicycache_PerformPurgeSplitableOutput: {}
|
||
cloudpolicycache_PerformSetClassMetadataOutput: {}
|
||
cloudpolicycache_PerformSetUserMetadataOutput: {}
|
||
cloudpolicycache_PerformStatusOutput: {}
|
||
cloudpolicycache_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
cloudpolicycache:
|
||
$ref: '#/definitions/CloudpolicycacheDetails'
|
||
type: object
|
||
cloudpolicycache_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
cloudpolicycache:
|
||
$ref: '#/definitions/CloudpolicycacheDetails'
|
||
type: object
|
||
cloudrole_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/CloudroleDetails'
|
||
type: object
|
||
cloudrole_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/CloudroleDetails'
|
||
type: object
|
||
cloudrole_GetDetailsChangeOwnerCandidateDomainsOutput:
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/ChangeOwnerCandidateDomainsOutput'
|
||
type: object
|
||
cloudrole_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
cloudrole_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
cloudrole_GetDetailsStatusOutput:
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/GetDetailsStatusOutput'
|
||
type: object
|
||
cloudrole_GetPropertyDistinctFieldOutput: {}
|
||
cloudrole_GetPropertyDomainTagValuePairsOutput: {}
|
||
cloudrole_GetPropertyDomainTagValueTreeOutput: {}
|
||
cloudrole_GetPropertySplitableExportOutput: {}
|
||
cloudrole_GetPropertySplitableOutput: {}
|
||
cloudrole_GetPropertyStatisticsOutput:
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/StatusStatistic'
|
||
type: object
|
||
cloudrole_GetPropertyTagValuePairsOutput: {}
|
||
cloudrole_GetPropertyTagValueTreeOutput: {}
|
||
cloudrole_ListItemFilterOutput:
|
||
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: {}
|
||
cloudrole_PerformClassMetadataOutput: {}
|
||
cloudrole_PerformDisableOutput: {}
|
||
cloudrole_PerformEnableOutput: {}
|
||
cloudrole_PerformPrivateOutput: {}
|
||
cloudrole_PerformPublicOutput: {}
|
||
cloudrole_PerformPurgeOutput: {}
|
||
cloudrole_PerformPurgeSplitableOutput: {}
|
||
cloudrole_PerformSetClassMetadataOutput: {}
|
||
cloudrole_PerformSetUserMetadataOutput: {}
|
||
cloudrole_PerformStatusOutput: {}
|
||
cloudrole_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/CloudroleDetails'
|
||
type: object
|
||
cloudrole_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
cloudrole:
|
||
$ref: '#/definitions/CloudroleDetails'
|
||
type: object
|
||
clouduser_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/ClouduserDetails'
|
||
type: object
|
||
clouduser_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/ClouduserDetails'
|
||
type: object
|
||
clouduser_GetDetailsAccessKeysOutput: {}
|
||
clouduser_GetDetailsChangeOwnerCandidateDomainsOutput:
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/ChangeOwnerCandidateDomainsOutput'
|
||
type: object
|
||
clouduser_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
clouduser_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
clouduser_GetDetailsStatusOutput:
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/GetDetailsStatusOutput'
|
||
type: object
|
||
clouduser_GetPropertyDistinctFieldOutput: {}
|
||
clouduser_GetPropertyDomainTagValuePairsOutput: {}
|
||
clouduser_GetPropertyDomainTagValueTreeOutput: {}
|
||
clouduser_GetPropertySplitableExportOutput: {}
|
||
clouduser_GetPropertySplitableOutput: {}
|
||
clouduser_GetPropertyTagValuePairsOutput: {}
|
||
clouduser_GetPropertyTagValueTreeOutput: {}
|
||
clouduser_ListItemFilterOutput:
|
||
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: {}
|
||
clouduser_PerformChangeOwnerOutput: {}
|
||
clouduser_PerformClassMetadataOutput: {}
|
||
clouduser_PerformCreateAccessKeyOutput: {}
|
||
clouduser_PerformDeleteAccessKeyOutput: {}
|
||
clouduser_PerformDetachPolicyOutput: {}
|
||
clouduser_PerformJoinGroupOutput: {}
|
||
clouduser_PerformLeaveGroupOutput: {}
|
||
clouduser_PerformPurgeSplitableOutput: {}
|
||
clouduser_PerformResetPasswordOutput: {}
|
||
clouduser_PerformSetClassMetadataOutput: {}
|
||
clouduser_PerformSetGroupsOutput: {}
|
||
clouduser_PerformSetPoliciesOutput: {}
|
||
clouduser_PerformSetUserMetadataOutput: {}
|
||
clouduser_PerformStatusOutput: {}
|
||
clouduser_PerformSyncOutput: {}
|
||
clouduser_PerformSyncstatusOutput: {}
|
||
clouduser_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
clouduser:
|
||
$ref: '#/definitions/ClouduserDetails'
|
||
type: object
|
||
saml_provider_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
$ref: '#/definitions/SAMLProviderDetails'
|
||
type: object
|
||
saml_provider_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
$ref: '#/definitions/SAMLProviderDetails'
|
||
type: object
|
||
saml_provider_GetDetailsChangeOwnerCandidateDomainsOutput:
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
$ref: '#/definitions/ChangeOwnerCandidateDomainsOutput'
|
||
type: object
|
||
saml_provider_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
saml_provider_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
saml_provider_GetDetailsStatusOutput:
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
$ref: '#/definitions/GetDetailsStatusOutput'
|
||
type: object
|
||
saml_provider_GetPropertyDistinctFieldOutput: {}
|
||
saml_provider_GetPropertyDomainTagValuePairsOutput: {}
|
||
saml_provider_GetPropertyDomainTagValueTreeOutput: {}
|
||
saml_provider_GetPropertySplitableExportOutput: {}
|
||
saml_provider_GetPropertySplitableOutput: {}
|
||
saml_provider_GetPropertyStatisticsOutput:
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
$ref: '#/definitions/StatusStatistic'
|
||
type: object
|
||
saml_provider_GetPropertyTagValuePairsOutput: {}
|
||
saml_provider_GetPropertyTagValueTreeOutput: {}
|
||
saml_provider_ListItemFilterOutput:
|
||
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: {}
|
||
saml_provider_PerformClassMetadataOutput: {}
|
||
saml_provider_PerformPrivateOutput: {}
|
||
saml_provider_PerformPublicOutput: {}
|
||
saml_provider_PerformPurgeSplitableOutput: {}
|
||
saml_provider_PerformSetClassMetadataOutput: {}
|
||
saml_provider_PerformSetUserMetadataOutput: {}
|
||
saml_provider_PerformStatusOutput: {}
|
||
saml_provider_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
$ref: '#/definitions/SAMLProviderDetails'
|
||
type: object
|
||
saml_provider_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
saml_provider:
|
||
$ref: '#/definitions/SAMLProviderDetails'
|
||
type: object
|
||
samluser_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
samluser:
|
||
$ref: '#/definitions/SamluserDetails'
|
||
type: object
|
||
samluser_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
samluser:
|
||
$ref: '#/definitions/SamluserDetails'
|
||
type: object
|
||
samluser_GetDetailsChangeOwnerCandidateDomainsOutput:
|
||
schema:
|
||
properties:
|
||
samluser:
|
||
$ref: '#/definitions/ChangeOwnerCandidateDomainsOutput'
|
||
type: object
|
||
samluser_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
samluser:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
samluser_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
samluser:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
samluser_GetDetailsStatusOutput:
|
||
schema:
|
||
properties:
|
||
samluser:
|
||
$ref: '#/definitions/GetDetailsStatusOutput'
|
||
type: object
|
||
samluser_GetPropertyDistinctFieldOutput: {}
|
||
samluser_GetPropertyDomainTagValuePairsOutput: {}
|
||
samluser_GetPropertyDomainTagValueTreeOutput: {}
|
||
samluser_GetPropertySplitableExportOutput: {}
|
||
samluser_GetPropertySplitableOutput: {}
|
||
samluser_GetPropertyTagValuePairsOutput: {}
|
||
samluser_GetPropertyTagValueTreeOutput: {}
|
||
samluser_ListItemFilterOutput:
|
||
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: {}
|
||
samluser_PerformClassMetadataOutput: {}
|
||
samluser_PerformPurgeSplitableOutput: {}
|
||
samluser_PerformSetClassMetadataOutput: {}
|
||
samluser_PerformSetUserMetadataOutput: {}
|
||
samluser_PerformStatusOutput: {}
|
||
samluser_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
samluser:
|
||
$ref: '#/definitions/SamluserDetails'
|
||
type: object
|
||
samluser_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
samluser:
|
||
$ref: '#/definitions/SamluserDetails'
|
||
type: object
|
||
schemes:
|
||
- https
|
||
- http
|
||
securityDefinitions:
|
||
keystone:
|
||
in: header
|
||
name: X-Auth-Token
|
||
type: apiKey
|
||
swagger: "2.0"
|