mirror of
https://hubproxy.babadafafafafa.cn/https://github.com/yunionio/cloudpods.git
synced 2026-09-21 00:24:07 +08:00
12692 lines
391 KiB
YAML
12692 lines
391 KiB
YAML
basePath: /
|
||
consumes:
|
||
- application/json
|
||
definitions:
|
||
CredentialCreateInput:
|
||
properties:
|
||
__meta__:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签列表,最多支持20个
|
||
example:
|
||
user:rd: op
|
||
type: object
|
||
x-go-name: Metadata
|
||
blob:
|
||
type: string
|
||
x-go-name: Blob
|
||
description:
|
||
description: 资源描述
|
||
example: test create network
|
||
type: string
|
||
x-go-name: Description
|
||
dry_run:
|
||
default: false
|
||
description: 预检验参数,若为true则仅检查参数,并不真正创建变更
|
||
type: boolean
|
||
x-go-name: DryRun
|
||
encrypted_blob:
|
||
description: Ignore
|
||
type: string
|
||
x-go-name: EncryptedBlob
|
||
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
|
||
key_hash:
|
||
description: Ignore
|
||
type: string
|
||
x-go-name: KeyHash
|
||
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_id:
|
||
type: string
|
||
x-go-name: ProjectId
|
||
type:
|
||
type: string
|
||
x-go-name: Type
|
||
user_id:
|
||
type: string
|
||
x-go-name: UserId
|
||
required:
|
||
- name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
CredentialDetails:
|
||
properties:
|
||
blob:
|
||
type: string
|
||
x-go-name: Blob
|
||
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
|
||
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:
|
||
type: string
|
||
x-go-name: Domain
|
||
domain_id:
|
||
type: string
|
||
x-go-name: DomainId
|
||
enabled:
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
encrypted_blob:
|
||
type: string
|
||
x-go-name: EncryptedBlob
|
||
extra:
|
||
type: object
|
||
x-go-name: Extra
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
is_emulated:
|
||
description: |-
|
||
是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
|
||
list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
key_hash:
|
||
type: string
|
||
x-go-name: KeyHash
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
project_id:
|
||
type: string
|
||
x-go-name: ProjectId
|
||
type:
|
||
type: string
|
||
x-go-name: Type
|
||
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
|
||
user:
|
||
type: string
|
||
x-go-name: User
|
||
user_id:
|
||
type: string
|
||
x-go-name: UserId
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
CredentialUpdateInput:
|
||
properties:
|
||
description:
|
||
description: 资源描述
|
||
type: string
|
||
x-go-name: Description
|
||
enabled:
|
||
description: enabled
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
DomainCreateInput:
|
||
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
|
||
displayname:
|
||
description: 显示名
|
||
type: string
|
||
x-go-name: Displayname
|
||
dry_run:
|
||
default: false
|
||
description: 预检验参数,若为true则仅检查参数,并不真正创建变更
|
||
type: boolean
|
||
x-go-name: DryRun
|
||
enabled:
|
||
description: 是否启用
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
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
|
||
required:
|
||
- name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
DomainDetails:
|
||
properties:
|
||
admin_id:
|
||
type: string
|
||
x-go-name: AdminId
|
||
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
|
||
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:
|
||
type: string
|
||
x-go-name: DomainId
|
||
enabled:
|
||
description: 改域是否启用
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
ext_resource:
|
||
additionalProperties:
|
||
format: int64
|
||
type: integer
|
||
description: 外部资源统计信息(资源类别:数量)
|
||
type: object
|
||
x-go-name: ExtResource
|
||
ext_resources_last_update:
|
||
description: 外部资源统计信息上次更新时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: ExtResourcesLastUpdate
|
||
ext_resources_next_update:
|
||
description: 外部资源统计信息下次更新时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: ExtResourcesNextUpdate
|
||
extra:
|
||
description: 额外信息
|
||
type: object
|
||
x-go-name: Extra
|
||
group_count:
|
||
description: 归属域的用户组数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: GroupCount
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
idp:
|
||
description: 认证源名称
|
||
type: string
|
||
x-go-name: Idp
|
||
idp_count:
|
||
description: 归属域的认证源数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: IdpCount
|
||
idp_driver:
|
||
description: 认证源类型, 例如sql, cas, ldap等
|
||
type: string
|
||
x-go-name: IdpDriver
|
||
idp_entity_id:
|
||
description: 该资源在认证源的原始ID
|
||
type: string
|
||
x-go-name: IdpEntityId
|
||
idp_id:
|
||
description: 认证源ID
|
||
type: string
|
||
x-go-name: IdpId
|
||
is_domain:
|
||
description: 是否为域
|
||
type: boolean
|
||
x-go-name: IsDomain
|
||
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
|
||
parent_id:
|
||
type: string
|
||
x-go-name: ParentId
|
||
policy_count:
|
||
description: 归属域的权限策略数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: PolicyCount
|
||
project_count:
|
||
description: 归属域的项目数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: ProjectCount
|
||
role_count:
|
||
description: 归属域的角色数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: RoleCount
|
||
template:
|
||
description: 认证源模板
|
||
type: string
|
||
x-go-name: Template
|
||
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
|
||
user_count:
|
||
description: 归属域的用户数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: UserCount
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
DomainUpdateInput:
|
||
properties:
|
||
description:
|
||
description: 资源描述
|
||
type: string
|
||
x-go-name: Description
|
||
displayname:
|
||
description: 显示名
|
||
type: string
|
||
x-go-name: Displayname
|
||
enabled:
|
||
description: 是否启用
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
EndpointDetails:
|
||
properties:
|
||
ca_certificate:
|
||
type: string
|
||
x-go-name: CaCertificate
|
||
ca_private_key:
|
||
type: string
|
||
x-go-name: CaPrivateKey
|
||
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
|
||
cert_id:
|
||
type: string
|
||
x-go-name: CertId
|
||
cert_name:
|
||
type: string
|
||
x-go-name: CertName
|
||
certificate:
|
||
type: string
|
||
x-go-name: Certificate
|
||
common_name:
|
||
type: string
|
||
x-go-name: CommonName
|
||
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
|
||
enabled:
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
extra:
|
||
type: object
|
||
x-go-name: Extra
|
||
fingerprint:
|
||
type: string
|
||
x-go-name: Fingerprint
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
interface:
|
||
type: string
|
||
x-go-name: Interface
|
||
is_emulated:
|
||
description: |-
|
||
是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
|
||
list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
legacy_endpoint_id:
|
||
type: string
|
||
x-go-name: LegacyEndpointId
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
not_after:
|
||
format: date-time
|
||
type: string
|
||
x-go-name: NotAfter
|
||
not_before:
|
||
format: date-time
|
||
type: string
|
||
x-go-name: NotBefore
|
||
private_key:
|
||
type: string
|
||
x-go-name: PrivateKey
|
||
public_key_algorithm:
|
||
description: derived attributes
|
||
type: string
|
||
x-go-name: PublicKeyAlgorithm
|
||
public_key_bit_len:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: PublicKeyBitLen
|
||
region_id:
|
||
type: string
|
||
x-go-name: RegionId
|
||
service_certificate_id:
|
||
type: string
|
||
x-go-name: ServiceCertificateId
|
||
service_id:
|
||
type: string
|
||
x-go-name: ServiceId
|
||
service_name:
|
||
description: 服务名称,例如keystone, glance, region等
|
||
type: string
|
||
x-go-name: ServiceName
|
||
service_type:
|
||
description: 服务类型,例如identity, image, compute等
|
||
type: string
|
||
x-go-name: ServiceType
|
||
signature_algorithm:
|
||
type: string
|
||
x-go-name: SignatureAlgorithm
|
||
subject_alternative_names:
|
||
type: string
|
||
x-go-name: SubjectAlternativeNames
|
||
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
|
||
url:
|
||
type: string
|
||
x-go-name: Url
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
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
|
||
GetIdpSamlMetadataOutput:
|
||
properties:
|
||
metadata:
|
||
description: SAML 2.0 SP metadata
|
||
type: string
|
||
x-go-name: Metadata
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
GetIdpSsoCallbackUriOutput:
|
||
properties:
|
||
driver:
|
||
description: Driver
|
||
type: string
|
||
x-go-name: Driver
|
||
redirect_uri:
|
||
description: SSO回调地址
|
||
type: string
|
||
x-go-name: RedirectUri
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
GetIdpSsoRedirectUriOutput:
|
||
properties:
|
||
driver:
|
||
description: Driver
|
||
type: string
|
||
x-go-name: Driver
|
||
uri:
|
||
description: SSO跳转URI
|
||
type: string
|
||
x-go-name: Uri
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
GroupCreateInput:
|
||
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
|
||
displayname:
|
||
description: display name
|
||
type: string
|
||
x-go-name: Displayname
|
||
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
|
||
project_domain_id:
|
||
description: 指定项目归属域名称或ID
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
required:
|
||
- name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
GroupDetails:
|
||
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
|
||
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
|
||
displayname:
|
||
description: 用户组的显示名称
|
||
type: string
|
||
x-go-name: Displayname
|
||
domain_id:
|
||
description: 域Id
|
||
type: string
|
||
x-go-name: DomainId
|
||
extra:
|
||
description: 额外信息
|
||
type: object
|
||
x-go-name: Extra
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
idp:
|
||
description: 认证源名称
|
||
type: string
|
||
x-go-name: Idp
|
||
idp_driver:
|
||
description: 认证源类型, 例如sql, cas, ldap等
|
||
type: string
|
||
x-go-name: IdpDriver
|
||
idp_entity_id:
|
||
description: 该资源在认证源的原始ID
|
||
type: string
|
||
x-go-name: IdpEntityId
|
||
idp_id:
|
||
description: 认证源ID
|
||
type: string
|
||
x-go-name: IdpId
|
||
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
|
||
project_count:
|
||
description: 项目数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: ProjectCount
|
||
project_domain:
|
||
description: 资源归属项目的域名称
|
||
type: string
|
||
x-go-name: ProjectDomain
|
||
template:
|
||
description: 认证源模板
|
||
type: string
|
||
x-go-name: Template
|
||
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
|
||
user_count:
|
||
description: 用户数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: UserCount
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
GroupUpdateInput:
|
||
properties:
|
||
description:
|
||
description: 资源描述
|
||
type: string
|
||
x-go-name: Description
|
||
displayname:
|
||
description: display name
|
||
type: string
|
||
x-go-name: Displayname
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
IdentityProviderCreateInput:
|
||
properties:
|
||
__meta__:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签列表,最多支持20个
|
||
example:
|
||
user:rd: op
|
||
type: object
|
||
x-go-name: Metadata
|
||
auto_create_project:
|
||
description: 新建域的时候是否自动新建第一个项目
|
||
type: boolean
|
||
x-go-name: AutoCreateProject
|
||
auto_create_user:
|
||
description: 当用户不存在时,是否自动新建用户
|
||
type: boolean
|
||
x-go-name: AutoCreateUser
|
||
config:
|
||
$ref: '#/definitions/TConfigs'
|
||
description:
|
||
description: 资源描述
|
||
example: test create network
|
||
type: string
|
||
x-go-name: Description
|
||
disabled:
|
||
description: 该资源是否被管理员*人为*禁用, 和enabled互斥
|
||
type: boolean
|
||
x-go-name: Disabled
|
||
driver:
|
||
description: 后端驱动名称
|
||
type: string
|
||
x-go-name: Driver
|
||
dry_run:
|
||
default: false
|
||
description: 预检验参数,若为true则仅检查参数,并不真正创建变更
|
||
type: boolean
|
||
x-go-name: DryRun
|
||
enabled:
|
||
description: 该资源是否被管理员*人为*启用或者禁用
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
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
|
||
icon_uri:
|
||
description: 图标URL
|
||
type: string
|
||
x-go-name: IconUri
|
||
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_domain_id:
|
||
description: 归属域
|
||
type: string
|
||
x-go-name: OwnerDomainId
|
||
status:
|
||
description: 用来存储资源的状态
|
||
type: string
|
||
x-go-name: Status
|
||
sync_interval_seconds:
|
||
description: 自动同步间隔,单位:秒
|
||
format: int64
|
||
type: integer
|
||
x-go-name: SyncIntervalSeconds
|
||
target_domain_id:
|
||
description: 默认导入用户和组的域
|
||
type: string
|
||
x-go-name: TargetDomainId
|
||
template:
|
||
description: 模板名称
|
||
type: string
|
||
x-go-name: Template
|
||
required:
|
||
- name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
IdentityProviderDetails:
|
||
properties:
|
||
auto_create_project:
|
||
description: 是否自动创建项目
|
||
type: boolean
|
||
x-go-name: AutoCreateProject
|
||
auto_create_user:
|
||
description: 是否自动创建用户
|
||
type: boolean
|
||
x-go-name: AutoCreateUser
|
||
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
|
||
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_count:
|
||
description: 该认证源关联的所有域的数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: DomainCount
|
||
domain_id:
|
||
description: 域Id
|
||
type: string
|
||
x-go-name: DomainId
|
||
driver:
|
||
type: string
|
||
x-go-name: Driver
|
||
enabled:
|
||
description: 资源是否启用
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
error_count:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: ErrorCount
|
||
group_count:
|
||
description: 该认证源关联的所有域的组数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: GroupCount
|
||
icon_uri:
|
||
description: 认证源图标
|
||
type: string
|
||
x-go-name: IconUri
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
is_default:
|
||
description: 是否是缺省SSO登录方式
|
||
type: boolean
|
||
x-go-name: IsDefault
|
||
is_emulated:
|
||
description: |-
|
||
是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
|
||
list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
is_sso:
|
||
description: 是否是SSO登录方式
|
||
type: boolean
|
||
x-go-name: IsSso
|
||
last_sync:
|
||
format: date-time
|
||
type: string
|
||
x-go-name: LastSync
|
||
last_sync_end_at:
|
||
description: = Column(DateTime, nullable=True)
|
||
format: date-time
|
||
type: string
|
||
x-go-name: LastSyncEndAt
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
policy_count:
|
||
description: 该认证源关联的所有域的权限策略数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: PolicyCount
|
||
progress:
|
||
description: 操作进度0-100
|
||
format: float
|
||
type: number
|
||
x-go-name: Progress
|
||
project_count:
|
||
description: 该认证源关联的所有域的项目数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: ProjectCount
|
||
project_domain:
|
||
description: 资源归属项目的域名称
|
||
type: string
|
||
x-go-name: ProjectDomain
|
||
role_count:
|
||
description: 该认证源关联的所有域的角色数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: RoleCount
|
||
status:
|
||
description: 资源状态
|
||
type: string
|
||
x-go-name: Status
|
||
sync_interval_seconds:
|
||
description: 认证源账号信息同步周期
|
||
format: int64
|
||
type: integer
|
||
x-go-name: SyncIntervalSeconds
|
||
sync_status:
|
||
type: string
|
||
x-go-name: SyncStatus
|
||
target_domain:
|
||
description: 认证源的目标域名称
|
||
type: string
|
||
x-go-name: TargetDomain
|
||
target_domain_id:
|
||
type: string
|
||
x-go-name: TargetDomainId
|
||
template:
|
||
type: string
|
||
x-go-name: Template
|
||
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
|
||
user_count:
|
||
description: 该认证源关联的所有域的用户数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: UserCount
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
IdentityProviderUpdateInput:
|
||
properties:
|
||
auto_create_project:
|
||
description: 当认证后用户加入项目不存在时是否自动创建项目
|
||
type: boolean
|
||
x-go-name: AutoCreateProject
|
||
auto_create_user:
|
||
description: 当认证后用户不存在时是否自动创建用户
|
||
type: boolean
|
||
x-go-name: AutoCreateUser
|
||
description:
|
||
description: 资源描述
|
||
type: string
|
||
x-go-name: Description
|
||
icon_uri:
|
||
description: 图标URL
|
||
type: string
|
||
x-go-name: IconUri
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
progress:
|
||
format: float
|
||
type: number
|
||
x-go-name: Progress
|
||
sync_interval_seconds:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: SyncIntervalSeconds
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
IdpResourceInfo:
|
||
properties:
|
||
idp:
|
||
description: 认证源名称
|
||
type: string
|
||
x-go-name: Idp
|
||
idp_driver:
|
||
description: 认证源类型, 例如sql, cas, ldap等
|
||
type: string
|
||
x-go-name: IdpDriver
|
||
idp_entity_id:
|
||
description: 该资源在认证源的原始ID
|
||
type: string
|
||
x-go-name: IdpEntityId
|
||
idp_id:
|
||
description: 认证源ID
|
||
type: string
|
||
x-go-name: IdpId
|
||
template:
|
||
description: 认证源模板
|
||
type: string
|
||
x-go-name: Template
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
KeystoneDomainV3:
|
||
$ref: '#/definitions/SIdentityObject'
|
||
KeystoneEndpointV2:
|
||
properties:
|
||
admin_url:
|
||
description: 管理URL
|
||
type: string
|
||
x-go-name: AdminURL
|
||
id:
|
||
description: 接口ID
|
||
type: string
|
||
x-go-name: Id
|
||
internal_url:
|
||
description: 内部URL
|
||
type: string
|
||
x-go-name: InternalURL
|
||
public_url:
|
||
description: 外部URL
|
||
type: string
|
||
x-go-name: PublicURL
|
||
region:
|
||
description: 区域ID
|
||
type: string
|
||
x-go-name: Region
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
KeystoneEndpointV3:
|
||
properties:
|
||
id:
|
||
description: endpoint ID
|
||
example: 75f4e36100184a5a8a3e36cb0f12aa87
|
||
type: string
|
||
x-go-name: Id
|
||
interface:
|
||
description: |-
|
||
endpoint接口类型,目前定义了一下集中类型
|
||
|
||
interface | 说明 |
|
||
-----------|--------------------------------------------------------|
|
||
internal | 内部接口,访问服务时默认用inernal类型的接口 |
|
||
public | 外部接口 |
|
||
admin | 管理类型接口,deprecated |
|
||
console | web控制台接口,指定显示在web控制台的外部服务的接口地址 |
|
||
type: string
|
||
x-go-name: Interface
|
||
name:
|
||
description: 接口名称
|
||
type: string
|
||
x-go-name: Name
|
||
region:
|
||
description: 区域名称
|
||
type: string
|
||
x-go-name: Region
|
||
region_id:
|
||
description: 区域ID
|
||
type: string
|
||
x-go-name: RegionId
|
||
url:
|
||
description: 接口URL
|
||
type: string
|
||
x-go-name: Url
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
KeystoneMetadataV2:
|
||
properties:
|
||
is_admin:
|
||
description: 是否为管理员
|
||
format: int64
|
||
type: integer
|
||
x-go-name: IsAdmin
|
||
roles:
|
||
description: 角色
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Roles
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
KeystonePolicy:
|
||
properties:
|
||
Domain:
|
||
description: 域范围的权限
|
||
items:
|
||
type: string
|
||
type: array
|
||
Project:
|
||
description: 项目范围的权限
|
||
items:
|
||
type: string
|
||
type: array
|
||
System:
|
||
description: 系统范围的权限
|
||
items:
|
||
type: string
|
||
type: array
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
KeystoneProjectV3:
|
||
properties:
|
||
Domain:
|
||
$ref: '#/definitions/KeystoneDomainV3'
|
||
Id:
|
||
description: 项目ID
|
||
type: string
|
||
Name:
|
||
description: 项目名称
|
||
type: string
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
KeystoneRoleV2:
|
||
properties:
|
||
id:
|
||
description: 角色ID
|
||
type: string
|
||
x-go-name: Id
|
||
name:
|
||
description: 角色名称
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
KeystoneRoleV3:
|
||
$ref: '#/definitions/SIdentityObject'
|
||
KeystoneServiceCatalogV2:
|
||
items:
|
||
$ref: '#/definitions/KeystoneServiceV2'
|
||
type: array
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
KeystoneServiceCatalogV3:
|
||
items:
|
||
$ref: '#/definitions/KeystoneServiceV3'
|
||
type: array
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
KeystoneServiceV2:
|
||
properties:
|
||
endpoints:
|
||
description: 服务接口地址列表
|
||
items:
|
||
$ref: '#/definitions/KeystoneEndpointV2'
|
||
type: array
|
||
x-go-name: Endpoints
|
||
name:
|
||
description: 服务名称
|
||
type: string
|
||
x-go-name: Name
|
||
type:
|
||
description: 服务类型
|
||
type: string
|
||
x-go-name: Type
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
KeystoneServiceV3:
|
||
properties:
|
||
endpoints:
|
||
description: service的访问endpoints
|
||
items:
|
||
$ref: '#/definitions/KeystoneEndpointV3'
|
||
type: array
|
||
x-go-name: Endpoints
|
||
id:
|
||
description: service ID
|
||
type: string
|
||
x-go-name: Id
|
||
name:
|
||
description: service Name
|
||
type: string
|
||
x-go-name: Name
|
||
type:
|
||
description: service Type,例如identity, compute等
|
||
type: string
|
||
x-go-name: Type
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
KeystoneTenantV2:
|
||
properties:
|
||
description:
|
||
description: 描述
|
||
type: string
|
||
x-go-name: Description
|
||
domain:
|
||
description: 项目归属域信息
|
||
properties:
|
||
id:
|
||
description: 域ID
|
||
type: string
|
||
x-go-name: Id
|
||
name:
|
||
description: 域名称
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-name: Domain
|
||
enabled:
|
||
description: 是否启用
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
id:
|
||
description: 项目ID
|
||
type: string
|
||
x-go-name: Id
|
||
name:
|
||
description: 项目名称
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
KeystoneTokenV2:
|
||
properties:
|
||
expires:
|
||
description: 过期时间(UTC)
|
||
format: date-time
|
||
type: string
|
||
x-go-name: Expires
|
||
id:
|
||
description: token
|
||
type: string
|
||
x-go-name: Id
|
||
tenant:
|
||
$ref: '#/definitions/KeystoneTenantV2'
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
KeystoneTokenV3:
|
||
properties:
|
||
access_key:
|
||
$ref: '#/definitions/SAccessKeySecretInfo'
|
||
catalog:
|
||
$ref: '#/definitions/KeystoneServiceCatalogV3'
|
||
context:
|
||
$ref: '#/definitions/SAuthContext'
|
||
expires_at:
|
||
description: token过期时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: ExpiresAt
|
||
is_domain:
|
||
description: 是否为域的token
|
||
type: boolean
|
||
x-go-name: IsDomain
|
||
issued_at:
|
||
description: token颁发时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: IssuedAt
|
||
methods:
|
||
description: 获取token的认证方式
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Methods
|
||
policies:
|
||
$ref: '#/definitions/KeystonePolicy'
|
||
project:
|
||
$ref: '#/definitions/KeystoneProjectV3'
|
||
projects:
|
||
description: 当用户认证时未指定scope时,会返回该用户所有的项目
|
||
items:
|
||
$ref: '#/definitions/KeystoneProjectV3'
|
||
type: array
|
||
x-go-name: Projects
|
||
role_assignments:
|
||
description: 返回用户在所有项目的所有角色信息
|
||
items:
|
||
$ref: '#/definitions/SRoleAssignment'
|
||
type: array
|
||
x-go-name: RoleAssignments
|
||
roles:
|
||
description: token的关联用户在关联项目的角色列表,只有项目scope的token才有这个属性
|
||
items:
|
||
$ref: '#/definitions/KeystoneRoleV3'
|
||
type: array
|
||
x-go-name: Roles
|
||
user:
|
||
$ref: '#/definitions/KeystoneUserV3'
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
KeystoneUserV2:
|
||
properties:
|
||
id:
|
||
description: 用户ID
|
||
type: string
|
||
x-go-name: Id
|
||
name:
|
||
description: 用户名
|
||
type: string
|
||
x-go-name: Name
|
||
roles:
|
||
description: 用户角色列表
|
||
items:
|
||
$ref: '#/definitions/KeystoneRoleV2'
|
||
type: array
|
||
x-go-name: Roles
|
||
username:
|
||
description: 用户username
|
||
type: string
|
||
x-go-name: Username
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
KeystoneUserV3:
|
||
properties:
|
||
Displayname:
|
||
description: 用户的显式名称,通常为中文名
|
||
type: string
|
||
Domain:
|
||
$ref: '#/definitions/KeystoneDomainV3'
|
||
Email:
|
||
description: 用户Email
|
||
type: string
|
||
Id:
|
||
description: 用户ID
|
||
type: string
|
||
Mobile:
|
||
description: 用户手机号
|
||
type: string
|
||
Name:
|
||
description: 用户名称
|
||
type: string
|
||
PasswordExpiresAt:
|
||
description: 用户密码过期时间
|
||
format: date-time
|
||
type: string
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
ModelBaseCreateInput:
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
ModelBaseDetails:
|
||
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
|
||
delete_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
update_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
ModelBaseUpdateInput:
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
PerformConfigInput:
|
||
properties:
|
||
action:
|
||
description: 更新配置的方式
|
||
example: update
|
||
type: string
|
||
x-go-name: Action
|
||
config:
|
||
$ref: '#/definitions/TConfigs'
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
PerformDefaultSsoInput:
|
||
properties:
|
||
enable:
|
||
type: boolean
|
||
x-go-name: Enable
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
PerformDisableInput:
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
PerformEnableInput:
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
PerformGroupAddUsersInput:
|
||
properties:
|
||
user_ids:
|
||
description: 待添加用户列表(ID或名称)
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: UserIds
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
PerformGroupRemoveUsersInput:
|
||
properties:
|
||
user_ids:
|
||
description: 待删除用户列表(ID或名称)
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: UserIds
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
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
|
||
PolicyBindRoleInput:
|
||
properties:
|
||
ips:
|
||
description: IP白名单
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Ips
|
||
project_id:
|
||
description: 项目ID
|
||
type: string
|
||
x-go-name: ProjectId
|
||
role_id:
|
||
description: 角色ID
|
||
type: string
|
||
x-go-name: RoleId
|
||
valid_since:
|
||
description: 权限有效开始时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: ValidSince
|
||
valid_until:
|
||
description: 权限有效结束时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: ValidUntil
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
PolicyCreateInput:
|
||
properties:
|
||
__meta__:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签列表,最多支持20个
|
||
example:
|
||
user:rd: op
|
||
type: object
|
||
x-go-name: Metadata
|
||
blob:
|
||
description: policy
|
||
type: object
|
||
x-go-name: Blob
|
||
description:
|
||
description: 资源描述
|
||
example: test create network
|
||
type: string
|
||
x-go-name: Description
|
||
domain_tags:
|
||
$ref: '#/definitions/TTagSet'
|
||
dry_run:
|
||
default: false
|
||
description: 预检验参数,若为true则仅检查参数,并不真正创建变更
|
||
type: boolean
|
||
x-go-name: DryRun
|
||
enabled:
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
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
|
||
is_system:
|
||
description: 是否为系统权限
|
||
type: boolean
|
||
x-go-name: IsSystem
|
||
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
|
||
project_tags:
|
||
$ref: '#/definitions/TTagSet'
|
||
public_scope:
|
||
description: 共享范围
|
||
type: string
|
||
x-go-name: PublicScope
|
||
resource_tags:
|
||
$ref: '#/definitions/TTagSet'
|
||
scope:
|
||
$ref: '#/definitions/TRbacScope'
|
||
required:
|
||
- name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
PolicyDetails:
|
||
properties:
|
||
blob:
|
||
description: 权限定义
|
||
type: object
|
||
x-go-name: Blob
|
||
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
|
||
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_tags:
|
||
description: 匹配的域标签
|
||
items:
|
||
$ref: '#/definitions/STag'
|
||
type: array
|
||
x-go-name: DomainTags
|
||
enabled:
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
extra:
|
||
description: 额外信息
|
||
type: object
|
||
x-go-name: Extra
|
||
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
|
||
is_system:
|
||
description: 是否为系统权限
|
||
type: boolean
|
||
x-go-name: IsSystem
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
object_tags:
|
||
description: 匹配的资源标签
|
||
items:
|
||
$ref: '#/definitions/STag'
|
||
type: array
|
||
x-go-name: ObjectTags
|
||
project_domain:
|
||
description: 资源归属项目的域名称
|
||
type: string
|
||
x-go-name: ProjectDomain
|
||
project_tags:
|
||
description: 匹配的项目标签
|
||
items:
|
||
$ref: '#/definitions/STag'
|
||
type: array
|
||
x-go-name: ProjectTags
|
||
public_scope:
|
||
description: 默认共享范围
|
||
type: string
|
||
x-go-name: PublicScope
|
||
public_src:
|
||
description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来'
|
||
example: local
|
||
type: string
|
||
x-go-name: PublicSrc
|
||
scope:
|
||
description: 权限范围
|
||
type: string
|
||
x-go-name: Scope
|
||
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
|
||
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/identity
|
||
PolicyUpdateInput:
|
||
properties:
|
||
blob:
|
||
description: Policy内容
|
||
type: object
|
||
x-go-name: Blob
|
||
description:
|
||
description: 资源描述
|
||
type: string
|
||
x-go-name: Description
|
||
domain_tags:
|
||
$ref: '#/definitions/TTagSet'
|
||
enabled:
|
||
description: 是否启用
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
is_system:
|
||
description: 是否为系统权限
|
||
type: boolean
|
||
x-go-name: IsSystem
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
object_tags:
|
||
$ref: '#/definitions/TTagSet'
|
||
project_tags:
|
||
$ref: '#/definitions/TTagSet'
|
||
scope:
|
||
$ref: '#/definitions/TRbacScope'
|
||
tag_update_policy:
|
||
description: Policy tag更新策略,可能的值为:add|remove|remove,默认为add
|
||
type: string
|
||
x-go-name: TagUpdatePolicy
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
ProjectCreateInput:
|
||
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
|
||
displayname:
|
||
description: 显示名称
|
||
type: string
|
||
x-go-name: Displayname
|
||
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
|
||
project_domain_id:
|
||
description: 指定项目归属域名称或ID
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
required:
|
||
- name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
ProjectDetails:
|
||
properties:
|
||
admin:
|
||
description: 项目管理员名称
|
||
type: string
|
||
x-go-name: Admin
|
||
admin_domain:
|
||
description: 项目管理员域名称
|
||
type: string
|
||
x-go-name: AdminDomain
|
||
admin_domain_id:
|
||
description: 项目管理员域ID
|
||
type: string
|
||
x-go-name: AdminDomainId
|
||
admin_id:
|
||
type: string
|
||
x-go-name: AdminId
|
||
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
|
||
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
|
||
ext_resource:
|
||
additionalProperties:
|
||
format: int64
|
||
type: integer
|
||
description: 外部资源统计信息(资源类别:数量)
|
||
type: object
|
||
x-go-name: ExtResource
|
||
ext_resources_last_update:
|
||
description: 外部资源统计信息上次更新时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: ExtResourcesLastUpdate
|
||
ext_resources_next_update:
|
||
description: 外部资源统计信息下次更新时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: ExtResourcesNextUpdate
|
||
extra:
|
||
description: 额外信息
|
||
type: object
|
||
x-go-name: Extra
|
||
group_count:
|
||
description: 加入项目的用户组数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: GroupCount
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
is_domain:
|
||
description: 该项目是否为域(domain)
|
||
type: boolean
|
||
x-go-name: IsDomain
|
||
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
|
||
parent_id:
|
||
description: 上级项目或域的ID
|
||
type: string
|
||
x-go-name: ParentId
|
||
project_domain:
|
||
description: 资源归属项目的域名称
|
||
type: string
|
||
x-go-name: ProjectDomain
|
||
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
|
||
user_count:
|
||
description: 加入项目的用户数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: UserCount
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
ProjectUpdateInput:
|
||
properties:
|
||
description:
|
||
description: 资源描述
|
||
type: string
|
||
x-go-name: Description
|
||
displayname:
|
||
description: 显示名称
|
||
type: string
|
||
x-go-name: Displayname
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
PurgeSplitTableInput:
|
||
properties:
|
||
tables:
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Tables
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
RegionDetails:
|
||
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
|
||
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
|
||
endpoint_count:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: EndpointCount
|
||
extra:
|
||
type: object
|
||
x-go-name: Extra
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
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
|
||
parent_region_id:
|
||
type: string
|
||
x-go-name: ParentRegionId
|
||
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/identity
|
||
ResetCredentialInput:
|
||
properties:
|
||
type:
|
||
description: 密钥的类型
|
||
type: string
|
||
x-go-name: Type
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
ResourceBaseCreateInput:
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
ResourceBaseUpdateInput:
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
RoleCreateInput:
|
||
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
|
||
required:
|
||
- name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
RoleDetails:
|
||
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
|
||
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
|
||
extra:
|
||
description: 额外信息
|
||
type: object
|
||
x-go-name: Extra
|
||
group_count:
|
||
description: 具有该角色的用户组数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: GroupCount
|
||
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
|
||
match_policies:
|
||
description: 该角色匹配的权限的名称列表
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: MatchPolicies
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
policies:
|
||
additionalProperties:
|
||
items:
|
||
type: string
|
||
type: array
|
||
description: 不同级别的权限的名称列表
|
||
type: object
|
||
x-go-name: Policies
|
||
project_count:
|
||
description: 有该角色的用户或组的项目的数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: ProjectCount
|
||
project_domain:
|
||
description: 资源归属项目的域名称
|
||
type: string
|
||
x-go-name: ProjectDomain
|
||
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
|
||
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
|
||
user_count:
|
||
description: 具有该角色的用户数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: UserCount
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
RolePerformAddPolicyInput:
|
||
properties:
|
||
ips:
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Ips
|
||
policy_id:
|
||
type: string
|
||
x-go-name: PolicyId
|
||
project_id:
|
||
type: string
|
||
x-go-name: ProjectId
|
||
valid_since:
|
||
format: date-time
|
||
type: string
|
||
x-go-name: ValidSince
|
||
valid_until:
|
||
format: date-time
|
||
type: string
|
||
x-go-name: ValidUntil
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
RolePerformRemovePolicyInput:
|
||
properties:
|
||
policy_id:
|
||
type: string
|
||
x-go-name: PolicyId
|
||
project_id:
|
||
type: string
|
||
x-go-name: ProjectId
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
RolePerformSetPoliciesInput:
|
||
properties:
|
||
action:
|
||
description: 操作:replace|update, 默认为replace
|
||
type: string
|
||
x-go-name: Action
|
||
policies:
|
||
description: 权限列表
|
||
items:
|
||
$ref: '#/definitions/RolePerformAddPolicyInput'
|
||
type: array
|
||
x-go-name: Policies
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
RolePolicyDetails:
|
||
properties:
|
||
auth:
|
||
description: 是否需要认证
|
||
type: boolean
|
||
x-go-name: Auth
|
||
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
|
||
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:
|
||
type: string
|
||
x-go-name: Description
|
||
id:
|
||
type: string
|
||
x-go-name: Id
|
||
ips:
|
||
description: 匹配的IP白名单
|
||
type: string
|
||
x-go-name: Ips
|
||
name:
|
||
type: string
|
||
x-go-name: Name
|
||
policy:
|
||
type: string
|
||
x-go-name: Policy
|
||
policy_id:
|
||
description: 权限ID, 主键
|
||
type: string
|
||
x-go-name: PolicyId
|
||
project:
|
||
type: string
|
||
x-go-name: Project
|
||
project_id:
|
||
description: 项目ID,主键
|
||
type: string
|
||
x-go-name: ProjectId
|
||
role:
|
||
type: string
|
||
x-go-name: Role
|
||
role_id:
|
||
description: 角色ID, 主键
|
||
type: string
|
||
x-go-name: RoleId
|
||
scope:
|
||
$ref: '#/definitions/TRbacScope'
|
||
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
|
||
valid_since:
|
||
description: 匹配开始时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: ValidSince
|
||
valid_until:
|
||
description: 匹配结束时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: ValidUntil
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
RoleUpdateInput:
|
||
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/identity
|
||
SAccessKeySecretInfo:
|
||
properties:
|
||
AccessKey:
|
||
type: string
|
||
expire:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Expire
|
||
secret:
|
||
type: string
|
||
x-go-name: Secret
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
SAuthContext:
|
||
properties:
|
||
ip:
|
||
description: 认证来源IP
|
||
type: string
|
||
x-go-name: Ip
|
||
source:
|
||
description: |-
|
||
认证来源类型, 可能的值有:
|
||
|
||
source | 说明 |
|
||
----------|---------------------------|
|
||
web | 通过web控制台认证 |
|
||
api | api调用认证 |
|
||
cli | climc客户端认证 |
|
||
srv | 作为服务认证 |
|
||
operator | 作为onecloud-operator认证 |
|
||
type: string
|
||
x-go-name: Source
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
SAuthenticateV2ResponseBody:
|
||
properties:
|
||
access:
|
||
$ref: '#/definitions/TokenCredentialV2'
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/keystone/tokens
|
||
SAuthenticationIdentity:
|
||
properties:
|
||
access_key_secret:
|
||
description: |-
|
||
当认证方式为aksk时,通过该字段提供客户端AK/SK信息
|
||
为了兼容不同版本的AK/SK认证方式,使用编码后的字符串传递该信息
|
||
type: string
|
||
x-go-name: AccessKeyRequest
|
||
cas_ticket:
|
||
description: 当认证方式为cas时,通过该字段提供CAS认证的ID
|
||
properties:
|
||
id:
|
||
type: string
|
||
x-go-name: Id
|
||
service:
|
||
type: string
|
||
x-go-name: Service
|
||
type: object
|
||
x-go-name: CASTicket
|
||
id:
|
||
description: ID of identity provider, optional
|
||
type: string
|
||
x-go-name: Id
|
||
methods:
|
||
description: |-
|
||
认证方式列表,支持认证方式如下:
|
||
|
||
method | 说明 |
|
||
----------|--------------------------------------------------------------------|
|
||
password | 用户名密码认证 |
|
||
token | token认证,已经通过其他方式获得token之后,可以用旧的token认证获得新的token |
|
||
aksk | Access Key/Secret key认证 |
|
||
cas | 通过SSO统一认证平台CAS认证 |
|
||
saml | 作为SAML 2.0 SP通过IDP认证 |
|
||
oidc | 作为OpenID Connect/OAuth2 Client认证 |
|
||
oauth2 | OAuth2认证 |
|
||
verify | 手机短信或邮箱认证 |
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Methods
|
||
mobile:
|
||
properties:
|
||
contact_type:
|
||
type: string
|
||
x-go-name: ContactType
|
||
uid:
|
||
type: string
|
||
x-go-name: Uid
|
||
verify_code:
|
||
type: string
|
||
x-go-name: VerifyCode
|
||
type: object
|
||
x-go-name: Verify
|
||
oauth2:
|
||
properties:
|
||
code:
|
||
type: string
|
||
x-go-name: Code
|
||
type: object
|
||
x-go-name: OAuth2
|
||
oidc_auth:
|
||
properties:
|
||
code:
|
||
type: string
|
||
x-go-name: Code
|
||
redirect_uri:
|
||
type: string
|
||
x-go-name: RedirectUri
|
||
type: object
|
||
x-go-name: OIDCAuth
|
||
password:
|
||
description: 当认证方式为password时,通过该字段提供密码认证信息
|
||
properties:
|
||
user:
|
||
properties:
|
||
Domain:
|
||
description: 用户所属域的信息
|
||
properties:
|
||
id:
|
||
description: 域ID
|
||
type: string
|
||
x-go-name: Id
|
||
name:
|
||
description: 域名称
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
id:
|
||
description: 用户ID
|
||
type: string
|
||
x-go-name: Id
|
||
name:
|
||
description: 用户名称
|
||
type: string
|
||
x-go-name: Name
|
||
password:
|
||
description: 密码
|
||
type: string
|
||
x-go-name: Password
|
||
type: object
|
||
x-go-name: User
|
||
type: object
|
||
x-go-name: Password
|
||
saml_auth:
|
||
description: 当认证方式为saml时,通过该字段提供SAML认证的Response信息
|
||
properties:
|
||
response:
|
||
type: string
|
||
x-go-name: Response
|
||
type: object
|
||
x-go-name: SAMLAuth
|
||
token:
|
||
description: 当认证方式为token时,通过该字段提供token认证信息
|
||
properties:
|
||
id:
|
||
description: token
|
||
type: string
|
||
x-go-name: Id
|
||
type: object
|
||
x-go-name: Token
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
SAuthenticationInputV2:
|
||
properties:
|
||
auth:
|
||
description: keystone v2 认证接口认证信息
|
||
properties:
|
||
context:
|
||
$ref: '#/definitions/SAuthContext'
|
||
passwordCredentials:
|
||
description: 如果使用用户名/密码认证,则需要设置passwordCredentials
|
||
properties:
|
||
password:
|
||
description: 用户密码
|
||
type: string
|
||
x-go-name: Password
|
||
username:
|
||
description: 用户名
|
||
type: string
|
||
x-go-name: Username
|
||
type: object
|
||
x-go-name: PasswordCredentials
|
||
tenantId:
|
||
description: 指定认证用户的所属项目ID,该字段和tenantName二选一,或者不设置。
|
||
type: string
|
||
x-go-name: TenantId
|
||
tenantName:
|
||
description: |-
|
||
指定认证用户的所属项目名称,该字段和tenantId二选一,或者不设置。
|
||
如果不提供tenantName和tenantId,则用户认证成功后,获得一个unscoped token
|
||
此时,如果用户需要访问具体项目的资源,还是需要用unscoped token进行认证,获得指定项目的token
|
||
type: string
|
||
x-go-name: TenantName
|
||
token:
|
||
description: 如果使用token认证,则需要设置token.Id
|
||
properties:
|
||
id:
|
||
description: token的字符串
|
||
type: string
|
||
x-go-name: Id
|
||
type: object
|
||
x-go-name: Token
|
||
type: object
|
||
x-go-name: Auth
|
||
required:
|
||
- auth
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
SAuthenticationInputV3:
|
||
properties:
|
||
auth:
|
||
description: keystone v3 认证接口认证信息
|
||
properties:
|
||
context:
|
||
$ref: '#/definitions/SAuthContext'
|
||
identity:
|
||
$ref: '#/definitions/SAuthenticationIdentity'
|
||
scope:
|
||
description: |-
|
||
指定认证范围, 该字段可选。如果未指定scope,则用户认证成功后获得一个unscoped token,
|
||
当用户需要访问指定项目的资源时,需要通过该unscope token进行认证,获得该项目scope的token
|
||
目前只支持Project scope的token
|
||
properties:
|
||
domain:
|
||
description: 指定token的scope为指定的域
|
||
properties:
|
||
id:
|
||
description: 指定domain的ID,ID和Name只需要指定其中一个
|
||
type: string
|
||
x-go-name: Id
|
||
name:
|
||
description: 指定Domain的Name
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-name: Domain
|
||
project:
|
||
description: 指定token的scope为指定的项目
|
||
properties:
|
||
domain:
|
||
description: 指定项目所在的域(domain)
|
||
properties:
|
||
id:
|
||
description: 指定项目所在域的ID,ID和Name只需要指定其中一个
|
||
type: string
|
||
x-go-name: Id
|
||
name:
|
||
description: 指定项目所在域的Name
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-name: Domain
|
||
id:
|
||
description: 指定项目的ID,由于ID全局唯一,因此指定ID后不需要指定项目所在的域(Domain),ID和Name只需要指定其中一个
|
||
type: string
|
||
x-go-name: Id
|
||
name:
|
||
description: 指定项目的Name,指定Name时,需要指定项目所在的域(domain)
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-name: Project
|
||
type: object
|
||
x-go-name: Scope
|
||
required:
|
||
- identity
|
||
type: object
|
||
x-go-name: Auth
|
||
required:
|
||
- auth
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
SDomainObject:
|
||
properties:
|
||
domain:
|
||
$ref: '#/definitions/SIdentityObject'
|
||
id:
|
||
description: UUID
|
||
type: string
|
||
x-go-name: Id
|
||
name:
|
||
description: 名称
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
SDomainObjectWithMetadata:
|
||
properties:
|
||
domain:
|
||
$ref: '#/definitions/SIdentityObject'
|
||
id:
|
||
description: UUID
|
||
type: string
|
||
x-go-name: Id
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签信息
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 名称
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
SFetchDomainObjectWithMetadata:
|
||
properties:
|
||
domain:
|
||
description: 归属域名称
|
||
type: string
|
||
x-go-name: Domain
|
||
domain_id:
|
||
description: 归属域ID
|
||
type: string
|
||
x-go-name: DomainId
|
||
id:
|
||
description: UUID
|
||
type: string
|
||
x-go-name: Id
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 项目标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
name:
|
||
description: 名称
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
SGroupRole:
|
||
properties:
|
||
Group:
|
||
type: string
|
||
Role:
|
||
type: string
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
SIdentityObject:
|
||
properties:
|
||
id:
|
||
description: UUID
|
||
type: string
|
||
x-go-name: Id
|
||
name:
|
||
description: 名称
|
||
type: string
|
||
x-go-name: Name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
SIdentityQuotaDetail:
|
||
description: 域的认证配额详情
|
||
properties:
|
||
created_at:
|
||
description: 资源创建时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: CreatedAt
|
||
deleted:
|
||
description: 资源是否被删除
|
||
type: boolean
|
||
x-go-name: Deleted
|
||
deleted_at:
|
||
description: 资源删除时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: DeletedAt
|
||
domain:
|
||
description: 配额适用的项目的域名称
|
||
type: string
|
||
x-go-name: Domain
|
||
domain_id:
|
||
description: 配额适用的域ID
|
||
type: string
|
||
x-go-name: DomainId
|
||
group:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Group
|
||
policy:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Policy
|
||
project:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Project
|
||
role:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Role
|
||
update_version:
|
||
description: 资源被更新次数
|
||
format: int64
|
||
type: integer
|
||
x-go-name: UpdateVersion
|
||
updated_at:
|
||
description: 资源更新时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: UpdatedAt
|
||
user:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: User
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/keystone/models
|
||
SJoinProjectsInput:
|
||
properties:
|
||
projects:
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Projects
|
||
roles:
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Roles
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
SLeaveProjectsInput:
|
||
properties:
|
||
project_roles:
|
||
items:
|
||
$ref: '#/definitions/SProjectRole'
|
||
type: array
|
||
x-go-name: ProjectRoles
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
SProjectAddUserGroupInput:
|
||
properties:
|
||
Groups:
|
||
items:
|
||
type: string
|
||
type: array
|
||
Roles:
|
||
items:
|
||
type: string
|
||
type: array
|
||
Users:
|
||
items:
|
||
type: string
|
||
type: array
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
SProjectRemoveUserGroupInput:
|
||
properties:
|
||
GroupRoles:
|
||
items:
|
||
$ref: '#/definitions/SGroupRole'
|
||
type: array
|
||
UserRoles:
|
||
items:
|
||
$ref: '#/definitions/SUserRole'
|
||
type: array
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
SProjectRole:
|
||
properties:
|
||
project:
|
||
type: string
|
||
x-go-name: Project
|
||
role:
|
||
type: string
|
||
x-go-name: Role
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
SProjectSetAdminInput:
|
||
properties:
|
||
UserId:
|
||
type: string
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
SRoleAssignment:
|
||
properties:
|
||
group:
|
||
$ref: '#/definitions/SDomainObject'
|
||
policies:
|
||
description: 用户角色关联的权限信息
|
||
properties:
|
||
domain:
|
||
description: 关联的域权限名称列表
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Domain
|
||
project:
|
||
description: 关联的项目权限名称列表
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: Project
|
||
system:
|
||
description: 关联的系统权限名称列表
|
||
items:
|
||
type: string
|
||
type: array
|
||
x-go-name: System
|
||
type: object
|
||
x-go-name: Policies
|
||
role:
|
||
$ref: '#/definitions/SDomainObject'
|
||
scope:
|
||
description: 归属范围
|
||
properties:
|
||
domain:
|
||
$ref: '#/definitions/SIdentityObject'
|
||
project:
|
||
$ref: '#/definitions/SDomainObjectWithMetadata'
|
||
type: object
|
||
x-go-name: Scope
|
||
user:
|
||
$ref: '#/definitions/SDomainObject'
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
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
|
||
SUserRole:
|
||
properties:
|
||
Role:
|
||
type: string
|
||
User:
|
||
type: string
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
ServiceDetails:
|
||
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
|
||
config_version:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: ConfigVersion
|
||
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
|
||
enabled:
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
endpoint_count:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: EndpointCount
|
||
extra:
|
||
type: object
|
||
x-go-name: Extra
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
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
|
||
type:
|
||
type: string
|
||
x-go-name: Type
|
||
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/identity
|
||
SetIdentityQuotaInput:
|
||
description: 设置域的认证配额输入参数
|
||
properties:
|
||
action:
|
||
description: |-
|
||
设置配额操作
|
||
|
||
action | 说明 |
|
||
---------|-------------------------------------------|
|
||
add | 增量增加配额 |
|
||
sub | 增量减少配额 |
|
||
reset | 重置所有配额为0 |
|
||
replace | 替换所有配额,对于不存在的配额项,设置为0 |
|
||
update | 更新存在的配额 |
|
||
delete | 删除配额 |
|
||
type: string
|
||
x-go-name: Action
|
||
created_at:
|
||
description: 资源创建时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: CreatedAt
|
||
deleted:
|
||
description: 资源是否被删除
|
||
type: boolean
|
||
x-go-name: Deleted
|
||
deleted_at:
|
||
description: 资源删除时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: DeletedAt
|
||
domain_id:
|
||
description: 配额适用的域ID
|
||
type: string
|
||
x-go-name: DomainId
|
||
group:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Group
|
||
policy:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Policy
|
||
project:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Project
|
||
role:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Role
|
||
update_version:
|
||
description: 资源被更新次数
|
||
format: int64
|
||
type: integer
|
||
x-go-name: UpdateVersion
|
||
updated_at:
|
||
description: 资源更新时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: UpdatedAt
|
||
user:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: User
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/keystone/models
|
||
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
|
||
StandaloneResourceBaseUpdateInput:
|
||
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
|
||
StandaloneResourceCreateInput:
|
||
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
|
||
required:
|
||
- name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis
|
||
StandaloneResourceDetails:
|
||
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
|
||
delete_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
update_fail_reason:
|
||
$ref: '#/definitions/Error'
|
||
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
|
||
TConfigs:
|
||
additionalProperties:
|
||
additionalProperties:
|
||
type: object
|
||
type: object
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
TRbacScope:
|
||
type: string
|
||
x-go-package: yunion.io/x/pkg/util/rbacscope
|
||
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
|
||
TokenCredentialV2:
|
||
description: Keystone token信息V2
|
||
properties:
|
||
context:
|
||
$ref: '#/definitions/SAuthContext'
|
||
metadata:
|
||
$ref: '#/definitions/KeystoneMetadataV2'
|
||
service_catalog:
|
||
$ref: '#/definitions/KeystoneServiceCatalogV2'
|
||
tenants:
|
||
description: 用户所属项目列表
|
||
items:
|
||
$ref: '#/definitions/KeystoneTenantV2'
|
||
type: array
|
||
x-go-name: Tenants
|
||
token:
|
||
$ref: '#/definitions/KeystoneTokenV2'
|
||
user:
|
||
$ref: '#/definitions/KeystoneUserV2'
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
TokenCredentialV3:
|
||
properties:
|
||
token:
|
||
$ref: '#/definitions/KeystoneTokenV3'
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/mcclient
|
||
UserCreateInput:
|
||
properties:
|
||
__meta__:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签列表,最多支持20个
|
||
example:
|
||
user:rd: op
|
||
type: object
|
||
x-go-name: Metadata
|
||
allow_web_console:
|
||
type: boolean
|
||
x-go-name: AllowWebConsole
|
||
description:
|
||
description: 资源描述
|
||
example: test create network
|
||
type: string
|
||
x-go-name: Description
|
||
displayname:
|
||
type: string
|
||
x-go-name: Displayname
|
||
dry_run:
|
||
default: false
|
||
description: 预检验参数,若为true则仅检查参数,并不真正创建变更
|
||
type: boolean
|
||
x-go-name: DryRun
|
||
email:
|
||
type: string
|
||
x-go-name: Email
|
||
enable_mfa:
|
||
type: boolean
|
||
x-go-name: EnableMfa
|
||
enabled:
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
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
|
||
idp_entity_id:
|
||
type: string
|
||
x-go-name: IdpEntityId
|
||
idp_id:
|
||
type: string
|
||
x-go-name: IdpId
|
||
is_emulated:
|
||
description: |-
|
||
资源是否为模拟资源
|
||
description: the resource is an emulated resource
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
is_system_account:
|
||
type: boolean
|
||
x-go-name: IsSystemAccount
|
||
lang:
|
||
type: string
|
||
x-go-name: Lang
|
||
mobile:
|
||
type: string
|
||
x-go-name: Mobile
|
||
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
|
||
password:
|
||
type: string
|
||
x-go-name: Password
|
||
project_domain_id:
|
||
description: 指定项目归属域名称或ID
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
skip_password_complexity_check:
|
||
type: boolean
|
||
x-go-name: SkipPasswordComplexityCheck
|
||
required:
|
||
- name
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
UserDetails:
|
||
properties:
|
||
allow_web_console:
|
||
description: 是否允许登录Web控制台,如果是用于API访问的用户,可禁用web控制台登录
|
||
type: boolean
|
||
x-go-name: AllowWebConsole
|
||
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
|
||
created_at:
|
||
description: 资源创建时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: CreatedAt
|
||
credential_count:
|
||
description: 归属该用户的密钥凭证(含AKSK,TOTP,Secret等)的数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: CredentialCount
|
||
default_project_id:
|
||
description: deprecated
|
||
type: string
|
||
x-go-name: DefaultProjectId
|
||
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
|
||
displayname:
|
||
description: 显示名称,用户登录后显示在右上角菜单入口
|
||
type: string
|
||
x-go-name: Displayname
|
||
domain_id:
|
||
description: 域Id
|
||
type: string
|
||
x-go-name: DomainId
|
||
email:
|
||
description: 用户邮箱
|
||
type: string
|
||
x-go-name: Email
|
||
enable_mfa:
|
||
description: 是否开启MFA
|
||
type: boolean
|
||
x-go-name: EnableMfa
|
||
enabled:
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
ext_resource:
|
||
additionalProperties:
|
||
format: int64
|
||
type: integer
|
||
description: 外部资源统计信息(资源类别:数量)
|
||
type: object
|
||
x-go-name: ExtResource
|
||
ext_resources_last_update:
|
||
description: 外部资源统计信息上次更新时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: ExtResourcesLastUpdate
|
||
ext_resources_next_update:
|
||
description: 外部资源统计信息下次更新时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: ExtResourcesNextUpdate
|
||
extra:
|
||
description: 额外信息
|
||
type: object
|
||
x-go-name: Extra
|
||
failed_auth_at:
|
||
description: 上传登录失败的时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: FailedAuthAt
|
||
failed_auth_count:
|
||
description: 连续登录失败的次数
|
||
format: int64
|
||
type: integer
|
||
x-go-name: FailedAuthCount
|
||
group_count:
|
||
description: 用户归属用户组的数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: GroupCount
|
||
id:
|
||
description: 资源UUID
|
||
type: string
|
||
x-go-name: Id
|
||
idps:
|
||
description: 该用户关联的外部认证源的认证信息
|
||
items:
|
||
$ref: '#/definitions/IdpResourceInfo'
|
||
type: array
|
||
x-go-name: Idps
|
||
is_emulated:
|
||
description: |-
|
||
是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
|
||
list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
|
||
type: boolean
|
||
x-go-name: IsEmulated
|
||
is_local:
|
||
description: 该用户是否为本地用户(SQL维护的用户)
|
||
type: boolean
|
||
x-go-name: IsLocal
|
||
is_system_account:
|
||
description: 是否为系统账号,系统账号不会检查密码复杂度,默认不在列表显示
|
||
type: boolean
|
||
x-go-name: IsSystemAccount
|
||
lang:
|
||
description: 用户的默认语言设置,默认是zh_CN
|
||
type: string
|
||
x-go-name: Lang
|
||
last_active_at:
|
||
description: 上次登录时间
|
||
format: date-time
|
||
type: string
|
||
x-go-name: LastActiveAt
|
||
last_login_ip:
|
||
description: 上次用户登录IP
|
||
type: string
|
||
x-go-name: LastLoginIp
|
||
last_login_source:
|
||
description: 上次用户登录方式,可能值有:web(web控制台),cli(命令行climc),API(api)
|
||
type: string
|
||
x-go-name: LastLoginSource
|
||
metadata:
|
||
additionalProperties:
|
||
type: string
|
||
description: 标签
|
||
type: object
|
||
x-go-name: Metadata
|
||
mobile:
|
||
description: 用户手机号
|
||
type: string
|
||
x-go-name: Mobile
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
need_reset_password:
|
||
description: 登录后是否需要重置密码
|
||
type: boolean
|
||
x-go-name: NeedResetPassword
|
||
password_expires_at:
|
||
description: 密码过期时间(如果开启了密码过期)
|
||
format: date-time
|
||
type: string
|
||
x-go-name: PasswordExpiresAt
|
||
password_reset_hint:
|
||
description: '重置密码原因: admin_reset|expire'
|
||
type: string
|
||
x-go-name: PasswordResetHint
|
||
project_count:
|
||
description: 用户归属项目的数量
|
||
format: int64
|
||
type: integer
|
||
x-go-name: ProjectCount
|
||
project_domain:
|
||
description: 资源归属项目的域名称
|
||
type: string
|
||
x-go-name: ProjectDomain
|
||
projects:
|
||
description: 用户归属的的项目信息
|
||
items:
|
||
$ref: '#/definitions/SFetchDomainObjectWithMetadata'
|
||
type: array
|
||
x-go-name: Projects
|
||
record_checksum:
|
||
type: string
|
||
x-go-name: RecordChecksum
|
||
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/identity
|
||
UserLinkIdpInput:
|
||
properties:
|
||
idp_entity_id:
|
||
type: string
|
||
x-go-name: IdpEntityId
|
||
idp_id:
|
||
type: string
|
||
x-go-name: IdpId
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
UserUnlinkIdpInput:
|
||
$ref: '#/definitions/UserLinkIdpInput'
|
||
UserUpdateInput:
|
||
properties:
|
||
allow_web_console:
|
||
type: boolean
|
||
x-go-name: AllowWebConsole
|
||
description:
|
||
description: 资源描述
|
||
type: string
|
||
x-go-name: Description
|
||
displayname:
|
||
type: string
|
||
x-go-name: Displayname
|
||
email:
|
||
type: string
|
||
x-go-name: Email
|
||
enable_mfa:
|
||
type: boolean
|
||
x-go-name: EnableMfa
|
||
enabled:
|
||
description: 是否启用
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
is_system_account:
|
||
type: boolean
|
||
x-go-name: IsSystemAccount
|
||
lang:
|
||
type: string
|
||
x-go-name: Lang
|
||
mobile:
|
||
type: string
|
||
x-go-name: Mobile
|
||
name:
|
||
description: 资源名称
|
||
type: string
|
||
x-go-name: Name
|
||
password:
|
||
type: string
|
||
x-go-name: Password
|
||
skip_password_complexity_check:
|
||
type: boolean
|
||
x-go-name: SkipPasswordComplexityCheck
|
||
type: object
|
||
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
|
||
host: '"127.0.0.1:8889"'
|
||
info:
|
||
contact:
|
||
email: lizexi@yunion.cn
|
||
name: Zexi Li
|
||
description: Identity API
|
||
license:
|
||
name: Apache 2.0
|
||
url: http://www.apache.org/licenses/LICENSE-2.0.html
|
||
version: "1.0"
|
||
paths:
|
||
/credentials:
|
||
get:
|
||
description: 列表
|
||
operationId: credential_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
|
||
name: user_domain_id
|
||
type: string
|
||
x-go-name: UserDomainId
|
||
- description: filter by user
|
||
in: query
|
||
name: user_id
|
||
type: string
|
||
x-go-name: UserId
|
||
- description: 项目归属域
|
||
in: query
|
||
name: project_domain_id
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
- description: 以项目(ID或Name)过滤列表结果
|
||
in: query
|
||
name: project_id
|
||
type: string
|
||
x-go-name: ProjectId
|
||
- in: query
|
||
items:
|
||
type: string
|
||
name: type
|
||
type: array
|
||
x-go-name: Type
|
||
- in: query
|
||
name: enabled
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/credential_ListItemFilterOutput'
|
||
summary: 用户信用凭证列表
|
||
tags:
|
||
- credential
|
||
post:
|
||
description: 新建
|
||
operationId: credential_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
credential:
|
||
$ref: '#/definitions/CredentialCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/credential_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- credential
|
||
/credentials/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: credential_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of credential
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/credential_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- credential
|
||
get:
|
||
description: 获取详情
|
||
operationId: credential_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of credential
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/credential_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- credential
|
||
put:
|
||
description: 更新
|
||
operationId: credential_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of credential
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
credential:
|
||
$ref: '#/definitions/CredentialUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/credential_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- credential
|
||
/credentials/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: credential_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of credential
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/credential_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- credential
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: credential_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of credential
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
credential:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/credential_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- credential
|
||
/credentials/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: credential_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 credential
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/credential_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- credential
|
||
/credentials/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: credential_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of credential
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
credential:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/credential_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- credential
|
||
/credentials/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: credential_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of credential
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
credential:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/credential_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- credential
|
||
/credentials/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: credential_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/credential_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- credential
|
||
/credentials/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: credential_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
credential:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/credential_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- credential
|
||
/credentials/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: credential_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/credential_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- credential
|
||
/credentials/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: credential_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/credential_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- credential
|
||
/credentials/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: credential_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/credential_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- credential
|
||
/credentials/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: credential_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/credential_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- credential
|
||
/domains:
|
||
get:
|
||
description: 列表
|
||
operationId: domain_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
|
||
- in: query
|
||
name: enabled
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
- description: 按IDP过滤
|
||
in: query
|
||
name: idp_id
|
||
type: string
|
||
x-go-name: IdpId
|
||
- description: 按IDP_ENTITY_ID过滤
|
||
in: query
|
||
name: idp_entity_id
|
||
type: string
|
||
x-go-name: IdpEntityId
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: domain tags filter imposed by policy
|
||
in: query
|
||
name: policy_domain_tags
|
||
x-go-name: PolicyDomainTags
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/domain_ListItemFilterOutput'
|
||
summary: 域列表
|
||
tags:
|
||
- domain
|
||
post:
|
||
description: 新建
|
||
operationId: domain_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
domain:
|
||
$ref: '#/definitions/DomainCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/domain_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- domain
|
||
/domains/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: domain_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of domain
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/domain_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- domain
|
||
get:
|
||
description: 获取详情
|
||
operationId: domain_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of domain
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/domain_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- domain
|
||
put:
|
||
description: 更新
|
||
operationId: domain_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of domain
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
domain:
|
||
$ref: '#/definitions/DomainUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/domain_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- domain
|
||
/domains/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: domain_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of domain
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/domain_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- domain
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: domain_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of domain
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
domain:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/domain_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- domain
|
||
/domains/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: domain_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 domain
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/domain_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- domain
|
||
/domains/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: domain_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of domain
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
domain:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/domain_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- domain
|
||
/domains/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: domain_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of domain
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
domain:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/domain_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- domain
|
||
/domains/{id}/unlink-idp:
|
||
post:
|
||
description: 执行操作UnlinkIdp
|
||
operationId: domain_PerformUnlinkIdp
|
||
parameters:
|
||
- description: The Id or Name of domain
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
domain:
|
||
$ref: '#/definitions/UserUnlinkIdpInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/domain_PerformUnlinkIdpOutput'
|
||
summary: domain和IDP的指定entityId解除关联
|
||
tags:
|
||
- domain
|
||
/domains/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: domain_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/domain_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- domain
|
||
/domains/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: domain_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
domain:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/domain_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- domain
|
||
/domains/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: domain_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/domain_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- domain
|
||
/domains/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: domain_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/domain_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- domain
|
||
/domains/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: domain_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/domain_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- domain
|
||
/domains/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: domain_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/domain_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- domain
|
||
/endpoints:
|
||
get:
|
||
description: 列表
|
||
operationId: endpoint_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
|
||
name: service_type
|
||
type: string
|
||
x-go-name: ServiceType
|
||
- description: 服务名称或ID过滤
|
||
in: query
|
||
name: service_id
|
||
type: string
|
||
x-go-name: ServiceId
|
||
- description: 以服务名称排序
|
||
in: query
|
||
name: order_by_service
|
||
type: string
|
||
x-go-name: OrderByService
|
||
- description: 以区域名称或ID过滤
|
||
in: query
|
||
name: region_id
|
||
type: string
|
||
x-go-name: RegionId
|
||
- description: '以Endpoint接口类型过滤,可能值为: internal, internalURL, public, publicURL,
|
||
admin, adminURL, console'
|
||
in: query
|
||
name: interface
|
||
type: string
|
||
x-go-name: Interface
|
||
- description: 是否启用
|
||
in: query
|
||
name: enabled
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/endpoint_ListItemFilterOutput'
|
||
summary: 服务地址列表
|
||
tags:
|
||
- endpoint
|
||
post:
|
||
description: 新建
|
||
operationId: endpoint_ValidateCreateData
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/endpoint_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- endpoint
|
||
/endpoints/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: endpoint_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of endpoint
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/endpoint_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- endpoint
|
||
get:
|
||
description: 获取详情
|
||
operationId: endpoint_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of endpoint
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/endpoint_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- endpoint
|
||
put:
|
||
description: 更新
|
||
operationId: endpoint_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of endpoint
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/endpoint_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- endpoint
|
||
/endpoints/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: endpoint_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of endpoint
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/endpoint_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- endpoint
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: endpoint_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of endpoint
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
endpoint:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/endpoint_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- endpoint
|
||
/endpoints/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: endpoint_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 endpoint
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/endpoint_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- endpoint
|
||
/endpoints/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: endpoint_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of endpoint
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
endpoint:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/endpoint_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- endpoint
|
||
/endpoints/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: endpoint_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of endpoint
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
endpoint:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/endpoint_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- endpoint
|
||
/endpoints/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: endpoint_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/endpoint_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- endpoint
|
||
/endpoints/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: endpoint_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
endpoint:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/endpoint_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- endpoint
|
||
/endpoints/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: endpoint_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/endpoint_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- endpoint
|
||
/endpoints/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: endpoint_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/endpoint_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- endpoint
|
||
/endpoints/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: endpoint_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/endpoint_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- endpoint
|
||
/endpoints/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: endpoint_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/endpoint_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- endpoint
|
||
/groups:
|
||
get:
|
||
description: 列表
|
||
operationId: group_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
|
||
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: user_domain_id
|
||
type: string
|
||
x-go-name: UserDomainId
|
||
- description: filter by user
|
||
in: query
|
||
name: user_id
|
||
type: string
|
||
x-go-name: UserId
|
||
- description: 项目归属域
|
||
in: query
|
||
name: project_domain_id
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
- description: 以项目(ID或Name)过滤列表结果
|
||
in: query
|
||
name: project_id
|
||
type: string
|
||
x-go-name: ProjectId
|
||
- description: 名称过滤
|
||
in: query
|
||
name: displayname
|
||
type: string
|
||
x-go-name: Displayname
|
||
- description: 按IDP过滤
|
||
in: query
|
||
name: idp_id
|
||
type: string
|
||
x-go-name: IdpId
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_ListItemFilterOutput'
|
||
summary: 用户组列表
|
||
tags:
|
||
- group
|
||
post:
|
||
description: 新建
|
||
operationId: group_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
group:
|
||
$ref: '#/definitions/GroupCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- group
|
||
/groups/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: group_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of group
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- group
|
||
get:
|
||
description: 获取详情
|
||
operationId: group_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of group
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- group
|
||
put:
|
||
description: 更新
|
||
operationId: group_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of group
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
group:
|
||
$ref: '#/definitions/GroupUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- group
|
||
/groups/{id}/add-users:
|
||
post:
|
||
description: 执行操作AddUsers
|
||
operationId: group_PerformAddUsers
|
||
parameters:
|
||
- description: The Id or Name of group
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
group:
|
||
$ref: '#/definitions/PerformGroupAddUsersInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_PerformAddUsersOutput'
|
||
summary: 组添加用户
|
||
tags:
|
||
- group
|
||
/groups/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: group_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of group
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- group
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: group_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of group
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
group:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- group
|
||
/groups/{id}/join:
|
||
post:
|
||
description: 执行操作Join
|
||
operationId: group_PerformJoin
|
||
parameters:
|
||
- description: The Id or Name of group
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
group:
|
||
$ref: '#/definitions/SJoinProjectsInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_PerformJoinOutput'
|
||
summary: 组加入项目
|
||
tags:
|
||
- group
|
||
/groups/{id}/leave:
|
||
post:
|
||
description: 执行操作Leave
|
||
operationId: group_PerformLeave
|
||
parameters:
|
||
- description: The Id or Name of group
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
group:
|
||
$ref: '#/definitions/SLeaveProjectsInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_PerformLeaveOutput'
|
||
summary: 组退出项目
|
||
tags:
|
||
- group
|
||
/groups/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: group_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 group
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- group
|
||
/groups/{id}/remove-users:
|
||
post:
|
||
description: 执行操作RemoveUsers
|
||
operationId: group_PerformRemoveUsers
|
||
parameters:
|
||
- description: The Id or Name of group
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
group:
|
||
$ref: '#/definitions/PerformGroupRemoveUsersInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_PerformRemoveUsersOutput'
|
||
summary: 组删除用户
|
||
tags:
|
||
- group
|
||
/groups/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: group_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of group
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
group:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- group
|
||
/groups/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: group_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of group
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
group:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- group
|
||
/groups/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: group_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- group
|
||
/groups/domain-tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValuePairs
|
||
operationId: group_GetPropertyDomainTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_GetPropertyDomainTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息DomainTagValuePairs
|
||
tags:
|
||
- group
|
||
/groups/domain-tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValueTree
|
||
operationId: group_GetPropertyDomainTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_GetPropertyDomainTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息DomainTagValueTree
|
||
tags:
|
||
- group
|
||
/groups/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: group_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
group:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- group
|
||
/groups/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: group_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- group
|
||
/groups/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: group_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/group_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- group
|
||
/groups/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: group_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- group
|
||
/groups/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: group_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/group_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- group
|
||
/identity_providers:
|
||
get:
|
||
description: 列表
|
||
operationId: identity_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: 以资源的状态过滤列表
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: status
|
||
type: array
|
||
x-go-name: Status
|
||
- description: 以资源是否启用/禁用过滤列表
|
||
in: query
|
||
name: enabled
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
- 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: driver
|
||
type: array
|
||
x-go-name: Driver
|
||
- description: 以模板过滤
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: template
|
||
type: array
|
||
x-go-name: Template
|
||
- description: 以同步状态过滤
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: sync_status
|
||
type: array
|
||
x-go-name: SyncStatus
|
||
- description: 过滤支持SSO的认证源,如果值为all,则列出所有的全局认证源,否则可出sso为域ID的域认证源
|
||
example: all
|
||
in: query
|
||
name: sso
|
||
type: string
|
||
x-go-name: SsoDomain
|
||
- in: query
|
||
name: auto_create_project
|
||
type: boolean
|
||
x-go-name: AutoCreateProject
|
||
- in: query
|
||
name: auto_create_user
|
||
type: boolean
|
||
x-go-name: AutoCreateUser
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_ListItemFilterOutput'
|
||
summary: 列表
|
||
tags:
|
||
- identity_provider
|
||
post:
|
||
description: 新建
|
||
operationId: identity_provider_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
identity_provider:
|
||
$ref: '#/definitions/IdentityProviderCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: identity_provider_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of identity_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- identity_provider
|
||
get:
|
||
description: 获取详情
|
||
operationId: identity_provider_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of identity_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- identity_provider
|
||
put:
|
||
description: 更新
|
||
operationId: identity_provider_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of identity_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
$ref: '#/definitions/IdentityProviderUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: identity_provider_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of identity_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- identity_provider
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: identity_provider_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of identity_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/{id}/config:
|
||
get:
|
||
description: 获取指定信息Config
|
||
operationId: identity_provider_GetDetailsConfig
|
||
parameters:
|
||
- description: The Id or Name of identity_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_GetDetailsConfigOutput'
|
||
summary: 获取指定信息Config
|
||
tags:
|
||
- identity_provider
|
||
post:
|
||
description: 执行操作Config
|
||
operationId: identity_provider_PerformConfig
|
||
parameters:
|
||
- description: The Id or Name of identity_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
$ref: '#/definitions/PerformConfigInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_PerformConfigOutput'
|
||
summary: 配置认证源
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/{id}/default-sso:
|
||
post:
|
||
description: 执行操作DefaultSso
|
||
operationId: identity_provider_PerformDefaultSso
|
||
parameters:
|
||
- description: The Id or Name of identity_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
$ref: '#/definitions/PerformDefaultSsoInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_PerformDefaultSsoOutput'
|
||
summary: 执行操作DefaultSso
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/{id}/disable:
|
||
post:
|
||
description: 执行操作Disable
|
||
operationId: identity_provider_PerformDisable
|
||
parameters:
|
||
- description: The Id or Name of identity_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
$ref: '#/definitions/PerformDisableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_PerformDisableOutput'
|
||
summary: 执行操作Disable
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/{id}/enable:
|
||
post:
|
||
description: 执行操作Enable
|
||
operationId: identity_provider_PerformEnable
|
||
parameters:
|
||
- description: The Id or Name of identity_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
$ref: '#/definitions/PerformEnableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_PerformEnableOutput'
|
||
summary: 执行操作Enable
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: identity_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 identity_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/{id}/saml-metadata:
|
||
get:
|
||
description: 获取指定信息SamlMetadata
|
||
operationId: identity_provider_GetDetailsSamlMetadata
|
||
parameters:
|
||
- description: 缩进展示SAML sp metadata
|
||
in: query
|
||
name: pretty
|
||
type: boolean
|
||
x-go-name: Pretty
|
||
- description: AssertionConsumer callback URL
|
||
in: query
|
||
name: redirect_uri
|
||
type: string
|
||
x-go-name: RedirectUri
|
||
- description: The Id or Name of identity_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_GetDetailsSamlMetadataOutput'
|
||
summary: 获取指定信息SamlMetadata
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: identity_provider_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of identity_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: identity_provider_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of identity_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/{id}/sso-callback-uri:
|
||
get:
|
||
description: 获取指定信息SsoCallbackUri
|
||
operationId: identity_provider_GetDetailsSsoCallbackUri
|
||
parameters:
|
||
- description: SSO回调地址
|
||
in: query
|
||
name: redirect_uri
|
||
type: string
|
||
x-go-name: RedirectUri
|
||
- description: The Id or Name of identity_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_GetDetailsSsoCallbackUriOutput'
|
||
summary: 获取指定信息SsoCallbackUri
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/{id}/sso-redirect-uri:
|
||
get:
|
||
description: 获取指定信息SsoRedirectUri
|
||
operationId: identity_provider_GetDetailsSsoRedirectUri
|
||
parameters:
|
||
- description: SSO回调地址
|
||
in: query
|
||
name: redirect_uri
|
||
type: string
|
||
x-go-name: RedirectUri
|
||
- description: SSO状态信息
|
||
in: query
|
||
name: state
|
||
type: string
|
||
x-go-name: State
|
||
- description: The Id or Name of identity_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_GetDetailsSsoRedirectUriOutput'
|
||
summary: 获取指定信息SsoRedirectUri
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/{id}/status:
|
||
get:
|
||
description: 获取指定信息Status
|
||
operationId: identity_provider_GetDetailsStatus
|
||
parameters:
|
||
- description: The Id or Name of identity_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_GetDetailsStatusOutput'
|
||
summary: 获取资源状态
|
||
tags:
|
||
- identity_provider
|
||
post:
|
||
description: 执行操作Status
|
||
operationId: identity_provider_PerformStatus
|
||
parameters:
|
||
- description: The Id or Name of identity_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
$ref: '#/definitions/PerformStatusInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_PerformStatusOutput'
|
||
summary: 更新资源状态
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/{id}/sync:
|
||
post:
|
||
description: 执行操作Sync
|
||
operationId: identity_provider_PerformSync
|
||
parameters:
|
||
- description: The Id or Name of identity_provider
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_PerformSyncOutput'
|
||
summary: 手动同步认证源
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: identity_provider_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: identity_provider_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: identity_provider_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: identity_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/identity_provider_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/statistics:
|
||
get:
|
||
description: 获取指定资源类的信息Statistics
|
||
operationId: identity_provider_GetPropertyStatistics
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_GetPropertyStatisticsOutput'
|
||
summary: 获取指定资源类的信息Statistics
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: identity_provider_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- identity_provider
|
||
/identity_providers/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: identity_provider_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/identity_provider_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- identity_provider
|
||
/identity_quotas/domains:
|
||
get:
|
||
description: 获取所有域的域配额
|
||
operationId: models_ListIdentityQuotas
|
||
parameters:
|
||
- description: |-
|
||
只列出主配额
|
||
require:false
|
||
in: query
|
||
name: primary
|
||
type: boolean
|
||
x-go-name: Primary
|
||
- description: |-
|
||
强制刷新使用量
|
||
require:false
|
||
in: query
|
||
name: refresh
|
||
type: boolean
|
||
x-go-name: Refresh
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/models_ListIdentityQuotasOutput'
|
||
summary: 获取所有域的域配额
|
||
tags:
|
||
- identity_quota
|
||
/identity_quotas/domains/{domainId}:
|
||
get:
|
||
description: 获取指定域的认证配额
|
||
operationId: models_GetIdentityQuota
|
||
parameters:
|
||
- description: |-
|
||
只列出主配额
|
||
require:false
|
||
in: query
|
||
name: primary
|
||
type: boolean
|
||
x-go-name: Primary
|
||
- description: |-
|
||
强制刷新使用量
|
||
require:false
|
||
in: query
|
||
name: refresh
|
||
type: boolean
|
||
x-go-name: Refresh
|
||
- description: 指定域的ID
|
||
in: path
|
||
name: domainId
|
||
required: true
|
||
type: string
|
||
x-go-name: DomainId
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/models_GetIdentityQuotaOutput'
|
||
summary: 获取指定域的认证配额
|
||
tags:
|
||
- identity_quota
|
||
post:
|
||
description: 设置域的认证配额
|
||
operationId: models_SetIdentityQuotas
|
||
parameters:
|
||
- description: 指定域的ID
|
||
in: path
|
||
name: domainId
|
||
required: true
|
||
type: string
|
||
x-go-name: DomainId
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
identity_quotas:
|
||
$ref: '#/definitions/SetIdentityQuotaInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/models_SetIdentityQuotasOutput'
|
||
summary: 设置域的认证配额
|
||
tags:
|
||
- identity_quota
|
||
/policies:
|
||
get:
|
||
description: 列表
|
||
operationId: policy_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: filter by enabled status
|
||
in: query
|
||
name: enabled
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
- 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: type
|
||
type: array
|
||
x-go-name: Type
|
||
- description: 是否显示系统权限
|
||
in: query
|
||
name: is_system
|
||
type: boolean
|
||
x-go-name: IsSystem
|
||
- description: filter policies by role id
|
||
in: query
|
||
name: role_id
|
||
type: string
|
||
x-go-name: RoleId
|
||
- description: |-
|
||
swagger: ignore
|
||
Deprecated
|
||
in: query
|
||
name: role
|
||
type: string
|
||
x-go-name: Role
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_ListItemFilterOutput'
|
||
summary: 权限策略列表
|
||
tags:
|
||
- policy
|
||
post:
|
||
description: 新建
|
||
operationId: policy_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
policy:
|
||
$ref: '#/definitions/PolicyCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- policy
|
||
/policies/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: policy_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of policy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- policy
|
||
get:
|
||
description: 获取详情
|
||
operationId: policy_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of policy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- policy
|
||
put:
|
||
description: 更新
|
||
operationId: policy_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of policy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
policy:
|
||
$ref: '#/definitions/PolicyUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- policy
|
||
/policies/{id}/bind-role:
|
||
post:
|
||
description: 执行操作BindRole
|
||
operationId: policy_PerformBindRole
|
||
parameters:
|
||
- description: The Id or Name of policy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
policy:
|
||
$ref: '#/definitions/PolicyBindRoleInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_PerformBindRoleOutput'
|
||
summary: 绑定角色
|
||
tags:
|
||
- policy
|
||
/policies/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: policy_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of policy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- policy
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: policy_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of policy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
policy:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- policy
|
||
/policies/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: policy_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 policy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- policy
|
||
/policies/{id}/private:
|
||
post:
|
||
description: 执行操作Private
|
||
operationId: policy_PerformPrivate
|
||
parameters:
|
||
- description: The Id or Name of policy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
policy:
|
||
$ref: '#/definitions/PerformPrivateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_PerformPrivateOutput'
|
||
summary: 设置policy为私有
|
||
tags:
|
||
- policy
|
||
/policies/{id}/public:
|
||
post:
|
||
description: 执行操作Public
|
||
operationId: policy_PerformPublic
|
||
parameters:
|
||
- description: The Id or Name of policy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
policy:
|
||
$ref: '#/definitions/PerformPublicDomainInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_PerformPublicOutput'
|
||
summary: 共享Policy
|
||
tags:
|
||
- policy
|
||
/policies/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: policy_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of policy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
policy:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- policy
|
||
/policies/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: policy_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of policy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
policy:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- policy
|
||
/policies/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: policy_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- policy
|
||
/policies/domain-tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValuePairs
|
||
operationId: policy_GetPropertyDomainTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_GetPropertyDomainTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息DomainTagValuePairs
|
||
tags:
|
||
- policy
|
||
/policies/domain-tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValueTree
|
||
operationId: policy_GetPropertyDomainTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_GetPropertyDomainTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息DomainTagValueTree
|
||
tags:
|
||
- policy
|
||
/policies/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: policy_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
policy:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- policy
|
||
/policies/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: policy_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- policy
|
||
/policies/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: policy_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/policy_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- policy
|
||
/policies/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: policy_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- policy
|
||
/policies/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: policy_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/policy_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- policy
|
||
/projects:
|
||
get:
|
||
description: 列表
|
||
operationId: project_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: user_domain_id
|
||
type: string
|
||
x-go-name: UserDomainId
|
||
- description: filter by user
|
||
in: query
|
||
name: user_id
|
||
type: string
|
||
x-go-name: UserId
|
||
- description: 组归属域
|
||
in: query
|
||
name: group_domain_id
|
||
type: string
|
||
x-go-name: GroupDomainId
|
||
- description: filter by group
|
||
in: query
|
||
name: group_id
|
||
type: string
|
||
x-go-name: GroupId
|
||
- description: filter projects by Identity Provider
|
||
in: query
|
||
name: idp_id
|
||
type: string
|
||
x-go-name: IdpId
|
||
- description: 过滤出指定用户或者组可以加入的项目
|
||
in: query
|
||
name: jointable
|
||
type: boolean
|
||
x-go-name: Jointable
|
||
- $ref: '#/definitions/TTagSetList'
|
||
description: project tags filter imposed by policy
|
||
in: query
|
||
name: policy_project_tags
|
||
x-go-name: PolicyProjectTags
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_ListItemFilterOutput'
|
||
summary: 项目列表
|
||
tags:
|
||
- project
|
||
post:
|
||
description: 新建
|
||
operationId: project_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
project:
|
||
$ref: '#/definitions/ProjectCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- project
|
||
/projects/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: project_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of project
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- project
|
||
get:
|
||
description: 获取详情
|
||
operationId: project_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of project
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- project
|
||
put:
|
||
description: 更新
|
||
operationId: project_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of project
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
project:
|
||
$ref: '#/definitions/ProjectUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- project
|
||
/projects/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: project_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of project
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- project
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: project_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of project
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
project:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- project
|
||
/projects/{id}/join:
|
||
post:
|
||
description: 执行操作Join
|
||
operationId: project_PerformJoin
|
||
parameters:
|
||
- description: The Id or Name of project
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
project:
|
||
$ref: '#/definitions/SProjectAddUserGroupInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_PerformJoinOutput'
|
||
summary: 将用户或组加入项目
|
||
tags:
|
||
- project
|
||
/projects/{id}/leave:
|
||
post:
|
||
description: 执行操作Leave
|
||
operationId: project_PerformLeave
|
||
parameters:
|
||
- description: The Id or Name of project
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
project:
|
||
$ref: '#/definitions/SProjectRemoveUserGroupInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_PerformLeaveOutput'
|
||
summary: 将用户或组移出项目
|
||
tags:
|
||
- project
|
||
/projects/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: project_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 project
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- project
|
||
/projects/{id}/set-admin:
|
||
post:
|
||
description: 执行操作SetAdmin
|
||
operationId: project_PerformSetAdmin
|
||
parameters:
|
||
- description: The Id or Name of project
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
project:
|
||
$ref: '#/definitions/SProjectSetAdminInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_PerformSetAdminOutput'
|
||
summary: 执行操作SetAdmin
|
||
tags:
|
||
- project
|
||
/projects/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: project_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of project
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
project:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- project
|
||
/projects/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: project_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of project
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
project:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- project
|
||
/projects/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: project_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- project
|
||
/projects/domain-tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValuePairs
|
||
operationId: project_GetPropertyDomainTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_GetPropertyDomainTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息DomainTagValuePairs
|
||
tags:
|
||
- project
|
||
/projects/domain-tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValueTree
|
||
operationId: project_GetPropertyDomainTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_GetPropertyDomainTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息DomainTagValueTree
|
||
tags:
|
||
- project
|
||
/projects/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: project_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
project:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- project
|
||
/projects/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: project_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- project
|
||
/projects/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: project_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/project_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- project
|
||
/projects/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: project_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- project
|
||
/projects/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: project_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/project_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- project
|
||
/regions:
|
||
get:
|
||
description: 列表
|
||
operationId: region_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
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/region_ListItemFilterOutput'
|
||
summary: 区域列表
|
||
tags:
|
||
- region
|
||
post:
|
||
description: 新建
|
||
operationId: region_ValidateCreateData
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/region_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- region
|
||
/regions/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: region_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of region
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/region_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- region
|
||
get:
|
||
description: 获取详情
|
||
operationId: region_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of region
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/region_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- region
|
||
put:
|
||
description: 更新
|
||
operationId: region_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of region
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
region:
|
||
$ref: '#/definitions/StandaloneResourceBaseUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/region_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- region
|
||
/regions/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: region_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of region
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/region_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- region
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: region_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of region
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
region:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/region_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- region
|
||
/regions/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: region_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 region
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/region_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- region
|
||
/regions/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: region_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of region
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
region:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/region_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- region
|
||
/regions/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: region_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of region
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
region:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/region_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- region
|
||
/regions/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: region_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/region_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- region
|
||
/regions/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: region_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
region:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/region_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- region
|
||
/regions/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: region_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/region_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- region
|
||
/regions/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: region_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/region_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- region
|
||
/regions/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: region_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/region_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- region
|
||
/regions/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: region_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/region_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- region
|
||
/role_policies:
|
||
get:
|
||
description: 列表
|
||
operationId: role_policy_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
|
||
- in: query
|
||
items:
|
||
type: string
|
||
name: role_ids
|
||
type: array
|
||
x-go-name: RoleIds
|
||
- in: query
|
||
name: project_id
|
||
type: string
|
||
x-go-name: ProjectId
|
||
- in: query
|
||
name: policy_id
|
||
type: string
|
||
x-go-name: PolicyId
|
||
- in: query
|
||
name: auth
|
||
type: boolean
|
||
x-go-name: Auth
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_policy_ListItemFilterOutput'
|
||
summary: 列表
|
||
tags:
|
||
- role_policy
|
||
post:
|
||
description: 新建
|
||
operationId: role_policy_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
role_policy:
|
||
$ref: '#/definitions/ResourceBaseCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_policy_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- role_policy
|
||
/role_policies/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: role_policy_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of role_policy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_policy_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- role_policy
|
||
get:
|
||
description: 获取详情
|
||
operationId: role_policy_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of role_policy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_policy_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- role_policy
|
||
put:
|
||
description: 更新
|
||
operationId: role_policy_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of role_policy
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
role_policy:
|
||
$ref: '#/definitions/ResourceBaseUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_policy_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- role_policy
|
||
/role_policies/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: role_policy_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_policy_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- role_policy
|
||
/role_policies/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: role_policy_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
role_policy:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_policy_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- role_policy
|
||
/role_policies/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: role_policy_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_policy_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- role_policy
|
||
/role_policies/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: role_policy_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/role_policy_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- role_policy
|
||
/roles:
|
||
get:
|
||
description: 列表
|
||
operationId: role_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
|
||
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
|
||
name: project_domain_id
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
- description: 以项目(ID或Name)过滤列表结果
|
||
in: query
|
||
name: project_id
|
||
type: string
|
||
x-go-name: ProjectId
|
||
- description: 用户归属域
|
||
in: query
|
||
name: user_domain_id
|
||
type: string
|
||
x-go-name: UserDomainId
|
||
- description: filter by user
|
||
in: query
|
||
name: user_id
|
||
type: string
|
||
x-go-name: UserId
|
||
- description: 组归属域
|
||
in: query
|
||
name: group_domain_id
|
||
type: string
|
||
x-go-name: GroupDomainId
|
||
- description: filter by group
|
||
in: query
|
||
name: group_id
|
||
type: string
|
||
x-go-name: GroupId
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_ListItemFilterOutput'
|
||
summary: 角色列表
|
||
tags:
|
||
- role
|
||
post:
|
||
description: 新建
|
||
operationId: role_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
role:
|
||
$ref: '#/definitions/RoleCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- role
|
||
/roles/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: role_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of role
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- role
|
||
get:
|
||
description: 获取详情
|
||
operationId: role_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of role
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- role
|
||
put:
|
||
description: 更新
|
||
operationId: role_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of role
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
role:
|
||
$ref: '#/definitions/RoleUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- role
|
||
/roles/{id}/add-policy:
|
||
post:
|
||
description: 执行操作AddPolicy
|
||
operationId: role_PerformAddPolicy
|
||
parameters:
|
||
- description: The Id or Name of role
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
role:
|
||
$ref: '#/definitions/RolePerformAddPolicyInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_PerformAddPolicyOutput'
|
||
summary: 执行操作AddPolicy
|
||
tags:
|
||
- role
|
||
/roles/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: role_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of role
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- role
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: role_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of role
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
role:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- role
|
||
/roles/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: role_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 role
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- role
|
||
/roles/{id}/private:
|
||
post:
|
||
description: 执行操作Private
|
||
operationId: role_PerformPrivate
|
||
parameters:
|
||
- description: The Id or Name of role
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
role:
|
||
$ref: '#/definitions/PerformPrivateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_PerformPrivateOutput'
|
||
summary: 执行操作Private
|
||
tags:
|
||
- role
|
||
/roles/{id}/public:
|
||
post:
|
||
description: 执行操作Public
|
||
operationId: role_PerformPublic
|
||
parameters:
|
||
- description: The Id or Name of role
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
role:
|
||
$ref: '#/definitions/PerformPublicDomainInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_PerformPublicOutput'
|
||
summary: 执行操作Public
|
||
tags:
|
||
- role
|
||
/roles/{id}/remove-policy:
|
||
post:
|
||
description: 执行操作RemovePolicy
|
||
operationId: role_PerformRemovePolicy
|
||
parameters:
|
||
- description: The Id or Name of role
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
role:
|
||
$ref: '#/definitions/RolePerformRemovePolicyInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_PerformRemovePolicyOutput'
|
||
summary: 执行操作RemovePolicy
|
||
tags:
|
||
- role
|
||
/roles/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: role_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of role
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
role:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- role
|
||
/roles/{id}/set-policies:
|
||
post:
|
||
description: 执行操作SetPolicies
|
||
operationId: role_PerformSetPolicies
|
||
parameters:
|
||
- description: The Id or Name of role
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
role:
|
||
$ref: '#/definitions/RolePerformSetPoliciesInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_PerformSetPoliciesOutput'
|
||
summary: 执行操作SetPolicies
|
||
tags:
|
||
- role
|
||
/roles/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: role_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of role
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
role:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- role
|
||
/roles/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: role_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- role
|
||
/roles/domain-tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValuePairs
|
||
operationId: role_GetPropertyDomainTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_GetPropertyDomainTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息DomainTagValuePairs
|
||
tags:
|
||
- role
|
||
/roles/domain-tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValueTree
|
||
operationId: role_GetPropertyDomainTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_GetPropertyDomainTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息DomainTagValueTree
|
||
tags:
|
||
- role
|
||
/roles/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: role_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
role:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- role
|
||
/roles/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: role_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- role
|
||
/roles/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: role_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/role_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- role
|
||
/roles/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: role_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- role
|
||
/roles/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: role_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/role_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- role
|
||
/scope_resources:
|
||
get:
|
||
description: 列表
|
||
operationId: scope_resource_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
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/scope_resource_ListItemFilterOutput'
|
||
summary: 列表
|
||
tags:
|
||
- scope_resource
|
||
post:
|
||
description: 新建
|
||
operationId: scope_resource_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
scope_resource:
|
||
$ref: '#/definitions/ModelBaseCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/scope_resource_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- scope_resource
|
||
/scope_resources/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: scope_resource_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of scope_resource
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/scope_resource_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- scope_resource
|
||
get:
|
||
description: 获取详情
|
||
operationId: scope_resource_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of scope_resource
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/scope_resource_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- scope_resource
|
||
put:
|
||
description: 更新
|
||
operationId: scope_resource_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of scope_resource
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
scope_resource:
|
||
$ref: '#/definitions/ModelBaseUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/scope_resource_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- scope_resource
|
||
/scope_resources/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: scope_resource_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/scope_resource_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- scope_resource
|
||
/scope_resources/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: scope_resource_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
scope_resource:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/scope_resource_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- scope_resource
|
||
/scope_resources/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: scope_resource_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/scope_resource_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- scope_resource
|
||
/scope_resources/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: scope_resource_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/scope_resource_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- scope_resource
|
||
/service_certificates:
|
||
get:
|
||
description: 列表
|
||
operationId: service_certificate_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
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_certificate_ListItemFilterOutput'
|
||
summary: 列表
|
||
tags:
|
||
- service_certificate
|
||
post:
|
||
description: 新建
|
||
operationId: service_certificate_ValidateCreateData
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_certificate_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- service_certificate
|
||
/service_certificates/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: service_certificate_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of service_certificate
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_certificate_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- service_certificate
|
||
get:
|
||
description: 获取详情
|
||
operationId: service_certificate_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of service_certificate
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_certificate_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- service_certificate
|
||
put:
|
||
description: 更新
|
||
operationId: service_certificate_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of service_certificate
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_certificate_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- service_certificate
|
||
/service_certificates/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: service_certificate_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of service_certificate
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_certificate_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- service_certificate
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: service_certificate_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of service_certificate
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
service_certificate:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_certificate_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- service_certificate
|
||
/service_certificates/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: service_certificate_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 service_certificate
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_certificate_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- service_certificate
|
||
/service_certificates/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: service_certificate_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of service_certificate
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
service_certificate:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_certificate_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- service_certificate
|
||
/service_certificates/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: service_certificate_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of service_certificate
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
service_certificate:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_certificate_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- service_certificate
|
||
/service_certificates/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: service_certificate_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_certificate_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- service_certificate
|
||
/service_certificates/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: service_certificate_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
service_certificate:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_certificate_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- service_certificate
|
||
/service_certificates/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: service_certificate_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_certificate_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- service_certificate
|
||
/service_certificates/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: service_certificate_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/service_certificate_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- service_certificate
|
||
/service_certificates/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: service_certificate_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_certificate_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- service_certificate
|
||
/service_certificates/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: service_certificate_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_certificate_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- service_certificate
|
||
/services:
|
||
get:
|
||
description: 列表
|
||
operationId: service_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: 以Service Type过滤
|
||
in: query
|
||
items:
|
||
type: string
|
||
name: type
|
||
type: array
|
||
x-go-name: Type
|
||
- description: 是否启用/禁用
|
||
in: query
|
||
name: enabled
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_ListItemFilterOutput'
|
||
summary: 服务列表
|
||
tags:
|
||
- service
|
||
post:
|
||
description: 新建
|
||
operationId: service_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
service:
|
||
$ref: '#/definitions/StandaloneResourceCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- service
|
||
/services/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: service_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of service
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- service
|
||
get:
|
||
description: 获取详情
|
||
operationId: service_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of service
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- service
|
||
put:
|
||
description: 更新
|
||
operationId: service_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of service
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
service:
|
||
$ref: '#/definitions/StandaloneResourceBaseUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- service
|
||
/services/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: service_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of service
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- service
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: service_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of service
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
service:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- service
|
||
/services/{id}/config:
|
||
get:
|
||
description: 获取指定信息Config
|
||
operationId: service_GetDetailsConfig
|
||
parameters:
|
||
- description: The Id or Name of service
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_GetDetailsConfigOutput'
|
||
summary: 获取指定信息Config
|
||
tags:
|
||
- service
|
||
post:
|
||
description: 执行操作Config
|
||
operationId: service_PerformConfig
|
||
parameters:
|
||
- description: The Id or Name of service
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
service:
|
||
$ref: '#/definitions/PerformConfigInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_PerformConfigOutput'
|
||
summary: 执行操作Config
|
||
tags:
|
||
- service
|
||
/services/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: service_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 service
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- service
|
||
/services/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: service_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of service
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
service:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- service
|
||
/services/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: service_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of service
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
service:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- service
|
||
/services/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: service_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- service
|
||
/services/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: service_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
service:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- service
|
||
/services/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: service_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- service
|
||
/services/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: service_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/service_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- service
|
||
/services/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: service_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- service
|
||
/services/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: service_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/service_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- service
|
||
/users:
|
||
get:
|
||
description: 列表
|
||
operationId: user_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
|
||
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: filter by enabled status
|
||
in: query
|
||
name: enabled
|
||
type: boolean
|
||
x-go-name: Enabled
|
||
- description: 组归属域
|
||
in: query
|
||
name: group_domain_id
|
||
type: string
|
||
x-go-name: GroupDomainId
|
||
- description: filter by group
|
||
in: query
|
||
name: group_id
|
||
type: string
|
||
x-go-name: GroupId
|
||
- description: 项目归属域
|
||
in: query
|
||
name: project_domain_id
|
||
type: string
|
||
x-go-name: ProjectDomainId
|
||
- description: 以项目(ID或Name)过滤列表结果
|
||
in: query
|
||
name: project_id
|
||
type: string
|
||
x-go-name: ProjectId
|
||
- description: 角色归属域
|
||
in: query
|
||
name: role_domain_id
|
||
type: string
|
||
x-go-name: RoleDomainId
|
||
- description: filter by role
|
||
in: query
|
||
name: role_id
|
||
type: string
|
||
x-go-name: RoleId
|
||
- description: 角色生效所在的域
|
||
in: query
|
||
name: role_assignment_domain_id
|
||
type: string
|
||
x-go-name: RoleAssignmentDomainId
|
||
- description: 角色生效所在的项目
|
||
in: query
|
||
name: role_assignment_project_id
|
||
type: string
|
||
x-go-name: RoleAssignmentProjectId
|
||
- description: email
|
||
in: query
|
||
name: email
|
||
type: string
|
||
x-go-name: Email
|
||
- description: mobile
|
||
in: query
|
||
name: mobile
|
||
type: string
|
||
x-go-name: Mobile
|
||
- description: displayname
|
||
in: query
|
||
name: displayname
|
||
type: string
|
||
x-go-name: Displayname
|
||
- description: 是否允许web控制台登录
|
||
in: query
|
||
name: allow_web_console
|
||
type: boolean
|
||
x-go-name: AllowWebConsole
|
||
- description: 是否开启MFA认证
|
||
in: query
|
||
name: enable_mfa
|
||
type: boolean
|
||
x-go-name: EnableMfa
|
||
- description: 关联IDP
|
||
in: query
|
||
name: idp_id
|
||
type: string
|
||
x-go-name: IdpId
|
||
- description: 按IDP_ENTITY_ID过滤
|
||
in: query
|
||
name: idp_entity_id
|
||
type: string
|
||
x-go-name: IdpEntityId
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_ListItemFilterOutput'
|
||
summary: 用户列表
|
||
tags:
|
||
- user
|
||
post:
|
||
description: 新建
|
||
operationId: user_ValidateCreateData
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
count:
|
||
default: 1
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Count
|
||
user:
|
||
$ref: '#/definitions/UserCreateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_ValidateCreateDataOutput'
|
||
summary: 新建
|
||
tags:
|
||
- user
|
||
/users/{id}:
|
||
delete:
|
||
description: 删除
|
||
operationId: user_CustomizeDelete
|
||
parameters:
|
||
- description: The Id or Name of user
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_CustomizeDeleteOutput'
|
||
summary: 删除
|
||
tags:
|
||
- user
|
||
get:
|
||
description: 获取详情
|
||
operationId: user_FetchCustomizeColumns
|
||
parameters:
|
||
- description: The Id or Name of user
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_FetchCustomizeColumnsOutput'
|
||
summary: 获取详情
|
||
tags:
|
||
- user
|
||
put:
|
||
description: 更新
|
||
operationId: user_ValidateUpdateData
|
||
parameters:
|
||
- description: The Id or Name of user
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
user:
|
||
$ref: '#/definitions/UserUpdateInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_ValidateUpdateDataOutput'
|
||
summary: 更新
|
||
tags:
|
||
- user
|
||
/users/{id}/class-metadata:
|
||
get:
|
||
description: 获取指定信息ClassMetadata
|
||
operationId: user_GetDetailsClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of user
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_GetDetailsClassMetadataOutput'
|
||
summary: 获取指定信息ClassMetadata
|
||
tags:
|
||
- user
|
||
post:
|
||
description: 执行操作ClassMetadata
|
||
operationId: user_PerformClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of user
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
user:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_PerformClassMetadataOutput'
|
||
summary: 更新资源的 class 标签
|
||
tags:
|
||
- user
|
||
/users/{id}/join:
|
||
post:
|
||
description: 执行操作Join
|
||
operationId: user_PerformJoin
|
||
parameters:
|
||
- description: The Id or Name of user
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
user:
|
||
$ref: '#/definitions/SJoinProjectsInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_PerformJoinOutput'
|
||
summary: 用户加入项目
|
||
tags:
|
||
- user
|
||
/users/{id}/leave:
|
||
post:
|
||
description: 执行操作Leave
|
||
operationId: user_PerformLeave
|
||
parameters:
|
||
- description: The Id or Name of user
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
user:
|
||
$ref: '#/definitions/SLeaveProjectsInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_PerformLeaveOutput'
|
||
summary: 用户退出项目
|
||
tags:
|
||
- user
|
||
/users/{id}/link-idp:
|
||
post:
|
||
description: 执行操作LinkIdp
|
||
operationId: user_PerformLinkIdp
|
||
parameters:
|
||
- description: The Id or Name of user
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
user:
|
||
$ref: '#/definitions/UserLinkIdpInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_PerformLinkIdpOutput'
|
||
summary: 用户和IDP的指定entityId关联
|
||
tags:
|
||
- user
|
||
/users/{id}/metadata:
|
||
get:
|
||
description: 获取指定信息Metadata
|
||
operationId: user_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 user
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_GetDetailsMetadataOutput'
|
||
summary: 获取资源标签(元数据)
|
||
tags:
|
||
- user
|
||
/users/{id}/reset-credentials:
|
||
post:
|
||
description: 执行操作ResetCredentials
|
||
operationId: user_PerformResetCredentials
|
||
parameters:
|
||
- description: The Id or Name of user
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
user:
|
||
$ref: '#/definitions/ResetCredentialInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_PerformResetCredentialsOutput'
|
||
summary: 用户加入项目
|
||
tags:
|
||
- user
|
||
/users/{id}/set-class-metadata:
|
||
post:
|
||
description: 执行操作SetClassMetadata
|
||
operationId: user_PerformSetClassMetadata
|
||
parameters:
|
||
- description: The Id or Name of user
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
user:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_PerformSetClassMetadataOutput'
|
||
summary: 全量替换资源的所有 class 标签
|
||
tags:
|
||
- user
|
||
/users/{id}/set-user-metadata:
|
||
post:
|
||
description: 执行操作SetUserMetadata
|
||
operationId: user_PerformSetUserMetadata
|
||
parameters:
|
||
- description: The Id or Name of user
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
user:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Input
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_PerformSetUserMetadataOutput'
|
||
summary: 全量替换资源的所有用户标签
|
||
tags:
|
||
- user
|
||
/users/{id}/unlink-idp:
|
||
post:
|
||
description: 执行操作UnlinkIdp
|
||
operationId: user_PerformUnlinkIdp
|
||
parameters:
|
||
- description: The Id or Name of user
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: string
|
||
x-go-name: Id
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
user:
|
||
$ref: '#/definitions/UserUnlinkIdpInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_PerformUnlinkIdpOutput'
|
||
summary: 用户和IDP的指定entityId解除关联
|
||
tags:
|
||
- user
|
||
/users/distinct-field:
|
||
get:
|
||
description: 获取指定资源类的信息DistinctField
|
||
operationId: user_GetPropertyDistinctField
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_GetPropertyDistinctFieldOutput'
|
||
summary: 获取指定资源类的信息DistinctField
|
||
tags:
|
||
- user
|
||
/users/domain-tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValuePairs
|
||
operationId: user_GetPropertyDomainTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_GetPropertyDomainTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息DomainTagValuePairs
|
||
tags:
|
||
- user
|
||
/users/domain-tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息DomainTagValueTree
|
||
operationId: user_GetPropertyDomainTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_GetPropertyDomainTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息DomainTagValueTree
|
||
tags:
|
||
- user
|
||
/users/purge-splitable:
|
||
post:
|
||
description: 执行操作PurgeSplitable
|
||
operationId: user_PerformPurgeSplitable
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
properties:
|
||
user:
|
||
$ref: '#/definitions/PurgeSplitTableInput'
|
||
type: object
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_PerformPurgeSplitableOutput'
|
||
summary: 执行操作PurgeSplitable
|
||
tags:
|
||
- user
|
||
/users/splitable:
|
||
get:
|
||
description: 获取指定资源类的信息Splitable
|
||
operationId: user_GetPropertySplitable
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_GetPropertySplitableOutput'
|
||
summary: 获取指定资源类的信息Splitable
|
||
tags:
|
||
- user
|
||
/users/splitable-export:
|
||
get:
|
||
description: 获取指定资源类的信息SplitableExport
|
||
operationId: user_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/user_GetPropertySplitableExportOutput'
|
||
summary: 获取指定资源类的信息SplitableExport
|
||
tags:
|
||
- user
|
||
/users/tag-value-pairs:
|
||
get:
|
||
description: 获取指定资源类的信息TagValuePairs
|
||
operationId: user_GetPropertyTagValuePairs
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_GetPropertyTagValuePairsOutput'
|
||
summary: 获取指定资源类的信息TagValuePairs
|
||
tags:
|
||
- user
|
||
/users/tag-value-tree:
|
||
get:
|
||
description: 获取指定资源类的信息TagValueTree
|
||
operationId: user_GetPropertyTagValueTree
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/user_GetPropertyTagValueTreeOutput'
|
||
summary: 获取指定资源类的信息TagValueTree
|
||
tags:
|
||
- user
|
||
/v2.0/tokens:
|
||
post:
|
||
description: keystone v2 认证接口,通过用户名/密码或者 token 认证
|
||
operationId: tokens_AuthenticateV2
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
$ref: '#/definitions/SAuthenticationInputV2'
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/tokens_AuthenticateV2Output'
|
||
summary: keystone v2 认证接口,通过用户名/密码或者 token 认证
|
||
tags:
|
||
- authentication
|
||
/v2.0/tokens/{token}:
|
||
get:
|
||
description: keystone v2验证token API
|
||
operationId: verifyTokensV2
|
||
parameters:
|
||
- description: keystone V2验证token
|
||
in: path
|
||
name: Token
|
||
required: true
|
||
type: string
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/tokens_AuthenticateV2Output'
|
||
summary: keystone v2验证token API
|
||
tags:
|
||
- authentication
|
||
/v3/auth/tokens:
|
||
get:
|
||
description: keystone v3验证token API
|
||
operationId: verifyTokensV3
|
||
parameters:
|
||
- description: keystone V3验证token
|
||
in: header
|
||
name: X-Subject-Token
|
||
required: true
|
||
type: string
|
||
x-go-name: Token
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/tokens_AuthenticateV3Output'
|
||
summary: keystone v3验证token API
|
||
tags:
|
||
- authentication
|
||
post:
|
||
description: keystone v3认证API
|
||
operationId: tokens_AuthenticateV3
|
||
parameters:
|
||
- in: body
|
||
name: body
|
||
schema:
|
||
$ref: '#/definitions/SAuthenticationInputV3'
|
||
x-go-name: Body
|
||
responses:
|
||
"200":
|
||
$ref: '#/responses/tokens_AuthenticateV3Output'
|
||
summary: keystone v3认证API
|
||
tags:
|
||
- authentication
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
credential_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
credential:
|
||
$ref: '#/definitions/CredentialDetails'
|
||
type: object
|
||
credential_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
credential:
|
||
$ref: '#/definitions/CredentialDetails'
|
||
type: object
|
||
credential_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
credential:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
credential_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
credential:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
credential_GetPropertyDistinctFieldOutput: {}
|
||
credential_GetPropertySplitableExportOutput: {}
|
||
credential_GetPropertySplitableOutput: {}
|
||
credential_GetPropertyTagValuePairsOutput: {}
|
||
credential_GetPropertyTagValueTreeOutput: {}
|
||
credential_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
credentials:
|
||
items:
|
||
$ref: '#/definitions/CredentialDetails'
|
||
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
|
||
credential_PerformClassMetadataOutput: {}
|
||
credential_PerformPurgeSplitableOutput: {}
|
||
credential_PerformSetClassMetadataOutput: {}
|
||
credential_PerformSetUserMetadataOutput: {}
|
||
credential_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
credential:
|
||
$ref: '#/definitions/CredentialDetails'
|
||
type: object
|
||
credential_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
credential:
|
||
$ref: '#/definitions/CredentialDetails'
|
||
type: object
|
||
domain_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
domain:
|
||
$ref: '#/definitions/DomainDetails'
|
||
type: object
|
||
domain_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
domain:
|
||
$ref: '#/definitions/DomainDetails'
|
||
type: object
|
||
domain_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
domain:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
domain_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
domain:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
domain_GetPropertyDistinctFieldOutput: {}
|
||
domain_GetPropertySplitableExportOutput: {}
|
||
domain_GetPropertySplitableOutput: {}
|
||
domain_GetPropertyTagValuePairsOutput: {}
|
||
domain_GetPropertyTagValueTreeOutput: {}
|
||
domain_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
domains:
|
||
items:
|
||
$ref: '#/definitions/DomainDetails'
|
||
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
|
||
domain_PerformClassMetadataOutput: {}
|
||
domain_PerformPurgeSplitableOutput: {}
|
||
domain_PerformSetClassMetadataOutput: {}
|
||
domain_PerformSetUserMetadataOutput: {}
|
||
domain_PerformUnlinkIdpOutput: {}
|
||
domain_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
domain:
|
||
$ref: '#/definitions/DomainDetails'
|
||
type: object
|
||
domain_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
domain:
|
||
$ref: '#/definitions/DomainDetails'
|
||
type: object
|
||
endpoint_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
endpoint:
|
||
$ref: '#/definitions/EndpointDetails'
|
||
type: object
|
||
endpoint_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
endpoint:
|
||
$ref: '#/definitions/EndpointDetails'
|
||
type: object
|
||
endpoint_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
endpoint:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
endpoint_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
endpoint:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
endpoint_GetPropertyDistinctFieldOutput: {}
|
||
endpoint_GetPropertySplitableExportOutput: {}
|
||
endpoint_GetPropertySplitableOutput: {}
|
||
endpoint_GetPropertyTagValuePairsOutput: {}
|
||
endpoint_GetPropertyTagValueTreeOutput: {}
|
||
endpoint_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
endpoints:
|
||
items:
|
||
$ref: '#/definitions/EndpointDetails'
|
||
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
|
||
endpoint_PerformClassMetadataOutput: {}
|
||
endpoint_PerformPurgeSplitableOutput: {}
|
||
endpoint_PerformSetClassMetadataOutput: {}
|
||
endpoint_PerformSetUserMetadataOutput: {}
|
||
endpoint_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
endpoint:
|
||
$ref: '#/definitions/EndpointDetails'
|
||
type: object
|
||
endpoint_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
endpoint:
|
||
$ref: '#/definitions/EndpointDetails'
|
||
type: object
|
||
group_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
group:
|
||
$ref: '#/definitions/GroupDetails'
|
||
type: object
|
||
group_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
group:
|
||
$ref: '#/definitions/GroupDetails'
|
||
type: object
|
||
group_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
group:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
group_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
group:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
group_GetPropertyDistinctFieldOutput: {}
|
||
group_GetPropertyDomainTagValuePairsOutput: {}
|
||
group_GetPropertyDomainTagValueTreeOutput: {}
|
||
group_GetPropertySplitableExportOutput: {}
|
||
group_GetPropertySplitableOutput: {}
|
||
group_GetPropertyTagValuePairsOutput: {}
|
||
group_GetPropertyTagValueTreeOutput: {}
|
||
group_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
groups:
|
||
items:
|
||
$ref: '#/definitions/GroupDetails'
|
||
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
|
||
group_PerformAddUsersOutput: {}
|
||
group_PerformClassMetadataOutput: {}
|
||
group_PerformJoinOutput: {}
|
||
group_PerformLeaveOutput: {}
|
||
group_PerformPurgeSplitableOutput: {}
|
||
group_PerformRemoveUsersOutput: {}
|
||
group_PerformSetClassMetadataOutput: {}
|
||
group_PerformSetUserMetadataOutput: {}
|
||
group_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
group:
|
||
$ref: '#/definitions/GroupDetails'
|
||
type: object
|
||
group_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
group:
|
||
$ref: '#/definitions/GroupDetails'
|
||
type: object
|
||
identity_provider_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
$ref: '#/definitions/IdentityProviderDetails'
|
||
type: object
|
||
identity_provider_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
$ref: '#/definitions/IdentityProviderDetails'
|
||
type: object
|
||
identity_provider_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
identity_provider_GetDetailsConfigOutput: {}
|
||
identity_provider_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
identity_provider_GetDetailsSamlMetadataOutput:
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
$ref: '#/definitions/GetIdpSamlMetadataOutput'
|
||
type: object
|
||
identity_provider_GetDetailsSsoCallbackUriOutput:
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
$ref: '#/definitions/GetIdpSsoCallbackUriOutput'
|
||
type: object
|
||
identity_provider_GetDetailsSsoRedirectUriOutput:
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
$ref: '#/definitions/GetIdpSsoRedirectUriOutput'
|
||
type: object
|
||
identity_provider_GetDetailsStatusOutput:
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
$ref: '#/definitions/GetDetailsStatusOutput'
|
||
type: object
|
||
identity_provider_GetPropertyDistinctFieldOutput: {}
|
||
identity_provider_GetPropertySplitableExportOutput: {}
|
||
identity_provider_GetPropertySplitableOutput: {}
|
||
identity_provider_GetPropertyStatisticsOutput:
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
$ref: '#/definitions/StatusStatistic'
|
||
type: object
|
||
identity_provider_GetPropertyTagValuePairsOutput: {}
|
||
identity_provider_GetPropertyTagValueTreeOutput: {}
|
||
identity_provider_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
identity_providers:
|
||
items:
|
||
$ref: '#/definitions/IdentityProviderDetails'
|
||
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
|
||
identity_provider_PerformClassMetadataOutput: {}
|
||
identity_provider_PerformConfigOutput: {}
|
||
identity_provider_PerformDefaultSsoOutput: {}
|
||
identity_provider_PerformDisableOutput: {}
|
||
identity_provider_PerformEnableOutput: {}
|
||
identity_provider_PerformPurgeSplitableOutput: {}
|
||
identity_provider_PerformSetClassMetadataOutput: {}
|
||
identity_provider_PerformSetUserMetadataOutput: {}
|
||
identity_provider_PerformStatusOutput: {}
|
||
identity_provider_PerformSyncOutput: {}
|
||
identity_provider_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
$ref: '#/definitions/IdentityProviderDetails'
|
||
type: object
|
||
identity_provider_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
identity_provider:
|
||
$ref: '#/definitions/IdentityProviderDetails'
|
||
type: object
|
||
models_GetIdentityQuotaOutput:
|
||
schema:
|
||
properties:
|
||
identity_quotas:
|
||
items:
|
||
$ref: '#/definitions/SIdentityQuotaDetail'
|
||
type: array
|
||
x-go-name: Output
|
||
type: object
|
||
models_ListIdentityQuotasOutput:
|
||
schema:
|
||
properties:
|
||
identity_quotas:
|
||
items:
|
||
$ref: '#/definitions/SIdentityQuotaDetail'
|
||
type: array
|
||
x-go-name: Output
|
||
type: object
|
||
models_SetIdentityQuotasOutput:
|
||
schema:
|
||
properties:
|
||
identity_quotas:
|
||
items:
|
||
$ref: '#/definitions/SIdentityQuotaDetail'
|
||
type: array
|
||
x-go-name: Output
|
||
type: object
|
||
policy_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
policy:
|
||
$ref: '#/definitions/PolicyDetails'
|
||
type: object
|
||
policy_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
policy:
|
||
$ref: '#/definitions/PolicyDetails'
|
||
type: object
|
||
policy_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
policy:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
policy_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
policy:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
policy_GetPropertyDistinctFieldOutput: {}
|
||
policy_GetPropertyDomainTagValuePairsOutput: {}
|
||
policy_GetPropertyDomainTagValueTreeOutput: {}
|
||
policy_GetPropertySplitableExportOutput: {}
|
||
policy_GetPropertySplitableOutput: {}
|
||
policy_GetPropertyTagValuePairsOutput: {}
|
||
policy_GetPropertyTagValueTreeOutput: {}
|
||
policy_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
policies:
|
||
items:
|
||
$ref: '#/definitions/PolicyDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
policy_PerformBindRoleOutput: {}
|
||
policy_PerformClassMetadataOutput: {}
|
||
policy_PerformPrivateOutput: {}
|
||
policy_PerformPublicOutput: {}
|
||
policy_PerformPurgeSplitableOutput: {}
|
||
policy_PerformSetClassMetadataOutput: {}
|
||
policy_PerformSetUserMetadataOutput: {}
|
||
policy_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
policy:
|
||
$ref: '#/definitions/PolicyDetails'
|
||
type: object
|
||
policy_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
policy:
|
||
$ref: '#/definitions/PolicyDetails'
|
||
type: object
|
||
project_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
project:
|
||
$ref: '#/definitions/ProjectDetails'
|
||
type: object
|
||
project_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
project:
|
||
$ref: '#/definitions/ProjectDetails'
|
||
type: object
|
||
project_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
project:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
project_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
project:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
project_GetPropertyDistinctFieldOutput: {}
|
||
project_GetPropertyDomainTagValuePairsOutput: {}
|
||
project_GetPropertyDomainTagValueTreeOutput: {}
|
||
project_GetPropertySplitableExportOutput: {}
|
||
project_GetPropertySplitableOutput: {}
|
||
project_GetPropertyTagValuePairsOutput: {}
|
||
project_GetPropertyTagValueTreeOutput: {}
|
||
project_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
projects:
|
||
items:
|
||
$ref: '#/definitions/ProjectDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
project_PerformClassMetadataOutput: {}
|
||
project_PerformJoinOutput: {}
|
||
project_PerformLeaveOutput: {}
|
||
project_PerformPurgeSplitableOutput: {}
|
||
project_PerformSetAdminOutput: {}
|
||
project_PerformSetClassMetadataOutput: {}
|
||
project_PerformSetUserMetadataOutput: {}
|
||
project_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
project:
|
||
$ref: '#/definitions/ProjectDetails'
|
||
type: object
|
||
project_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
project:
|
||
$ref: '#/definitions/ProjectDetails'
|
||
type: object
|
||
region_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
region:
|
||
$ref: '#/definitions/RegionDetails'
|
||
type: object
|
||
region_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
region:
|
||
$ref: '#/definitions/RegionDetails'
|
||
type: object
|
||
region_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
region:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
region_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
region:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
region_GetPropertyDistinctFieldOutput: {}
|
||
region_GetPropertySplitableExportOutput: {}
|
||
region_GetPropertySplitableOutput: {}
|
||
region_GetPropertyTagValuePairsOutput: {}
|
||
region_GetPropertyTagValueTreeOutput: {}
|
||
region_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
regions:
|
||
items:
|
||
$ref: '#/definitions/RegionDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
region_PerformClassMetadataOutput: {}
|
||
region_PerformPurgeSplitableOutput: {}
|
||
region_PerformSetClassMetadataOutput: {}
|
||
region_PerformSetUserMetadataOutput: {}
|
||
region_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
region:
|
||
$ref: '#/definitions/RegionDetails'
|
||
type: object
|
||
region_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
region:
|
||
$ref: '#/definitions/RegionDetails'
|
||
type: object
|
||
role_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
role:
|
||
$ref: '#/definitions/RoleDetails'
|
||
type: object
|
||
role_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
role:
|
||
$ref: '#/definitions/RoleDetails'
|
||
type: object
|
||
role_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
role:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
role_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
role:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
role_GetPropertyDistinctFieldOutput: {}
|
||
role_GetPropertyDomainTagValuePairsOutput: {}
|
||
role_GetPropertyDomainTagValueTreeOutput: {}
|
||
role_GetPropertySplitableExportOutput: {}
|
||
role_GetPropertySplitableOutput: {}
|
||
role_GetPropertyTagValuePairsOutput: {}
|
||
role_GetPropertyTagValueTreeOutput: {}
|
||
role_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
roles:
|
||
items:
|
||
$ref: '#/definitions/RoleDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
role_PerformAddPolicyOutput: {}
|
||
role_PerformClassMetadataOutput: {}
|
||
role_PerformPrivateOutput: {}
|
||
role_PerformPublicOutput: {}
|
||
role_PerformPurgeSplitableOutput: {}
|
||
role_PerformRemovePolicyOutput: {}
|
||
role_PerformSetClassMetadataOutput: {}
|
||
role_PerformSetPoliciesOutput: {}
|
||
role_PerformSetUserMetadataOutput: {}
|
||
role_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
role:
|
||
$ref: '#/definitions/RoleDetails'
|
||
type: object
|
||
role_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
role:
|
||
$ref: '#/definitions/RoleDetails'
|
||
type: object
|
||
role_policy_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
role_policy:
|
||
$ref: '#/definitions/RolePolicyDetails'
|
||
type: object
|
||
role_policy_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
role_policy:
|
||
$ref: '#/definitions/RolePolicyDetails'
|
||
type: object
|
||
role_policy_GetPropertyDistinctFieldOutput: {}
|
||
role_policy_GetPropertySplitableExportOutput: {}
|
||
role_policy_GetPropertySplitableOutput: {}
|
||
role_policy_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
role_policies:
|
||
items:
|
||
$ref: '#/definitions/RolePolicyDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
role_policy_PerformPurgeSplitableOutput: {}
|
||
role_policy_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
role_policy:
|
||
$ref: '#/definitions/RolePolicyDetails'
|
||
type: object
|
||
role_policy_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
role_policy:
|
||
$ref: '#/definitions/RolePolicyDetails'
|
||
type: object
|
||
scope_resource_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
scope_resource:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
type: object
|
||
scope_resource_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
scope_resource:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
type: object
|
||
scope_resource_GetPropertyDistinctFieldOutput: {}
|
||
scope_resource_GetPropertySplitableExportOutput: {}
|
||
scope_resource_GetPropertySplitableOutput: {}
|
||
scope_resource_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
scope_resources:
|
||
items:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
scope_resource_PerformPurgeSplitableOutput: {}
|
||
scope_resource_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
scope_resource:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
type: object
|
||
scope_resource_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
scope_resource:
|
||
$ref: '#/definitions/ModelBaseDetails'
|
||
type: object
|
||
service_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
service:
|
||
$ref: '#/definitions/ServiceDetails'
|
||
type: object
|
||
service_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
service:
|
||
$ref: '#/definitions/ServiceDetails'
|
||
type: object
|
||
service_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
service:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
service_GetDetailsConfigOutput: {}
|
||
service_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
service:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
service_GetPropertyDistinctFieldOutput: {}
|
||
service_GetPropertySplitableExportOutput: {}
|
||
service_GetPropertySplitableOutput: {}
|
||
service_GetPropertyTagValuePairsOutput: {}
|
||
service_GetPropertyTagValueTreeOutput: {}
|
||
service_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
services:
|
||
items:
|
||
$ref: '#/definitions/ServiceDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
service_PerformClassMetadataOutput: {}
|
||
service_PerformConfigOutput: {}
|
||
service_PerformPurgeSplitableOutput: {}
|
||
service_PerformSetClassMetadataOutput: {}
|
||
service_PerformSetUserMetadataOutput: {}
|
||
service_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
service:
|
||
$ref: '#/definitions/ServiceDetails'
|
||
type: object
|
||
service_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
service:
|
||
$ref: '#/definitions/ServiceDetails'
|
||
type: object
|
||
service_certificate_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
service_certificate:
|
||
$ref: '#/definitions/StandaloneResourceDetails'
|
||
type: object
|
||
service_certificate_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
service_certificate:
|
||
$ref: '#/definitions/StandaloneResourceDetails'
|
||
type: object
|
||
service_certificate_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
service_certificate:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
service_certificate_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
service_certificate:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
service_certificate_GetPropertyDistinctFieldOutput: {}
|
||
service_certificate_GetPropertySplitableExportOutput: {}
|
||
service_certificate_GetPropertySplitableOutput: {}
|
||
service_certificate_GetPropertyTagValuePairsOutput: {}
|
||
service_certificate_GetPropertyTagValueTreeOutput: {}
|
||
service_certificate_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
limit:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Limit
|
||
offset:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Offset
|
||
service_certificates:
|
||
items:
|
||
$ref: '#/definitions/StandaloneResourceDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
total:
|
||
format: int64
|
||
type: integer
|
||
x-go-name: Total
|
||
type: object
|
||
service_certificate_PerformClassMetadataOutput: {}
|
||
service_certificate_PerformPurgeSplitableOutput: {}
|
||
service_certificate_PerformSetClassMetadataOutput: {}
|
||
service_certificate_PerformSetUserMetadataOutput: {}
|
||
service_certificate_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
service_certificate:
|
||
$ref: '#/definitions/StandaloneResourceDetails'
|
||
type: object
|
||
service_certificate_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
service_certificate:
|
||
$ref: '#/definitions/StandaloneResourceDetails'
|
||
type: object
|
||
tokens_AuthenticateV2Output:
|
||
schema:
|
||
$ref: '#/definitions/SAuthenticateV2ResponseBody'
|
||
tokens_AuthenticateV3Output:
|
||
headers:
|
||
X-Subject-Token:
|
||
description: |-
|
||
验证成功的keystone V3 token
|
||
in:header
|
||
type: string
|
||
schema:
|
||
$ref: '#/definitions/TokenCredentialV3'
|
||
user_CustomizeDeleteOutput:
|
||
schema:
|
||
properties:
|
||
user:
|
||
$ref: '#/definitions/UserDetails'
|
||
type: object
|
||
user_FetchCustomizeColumnsOutput:
|
||
schema:
|
||
properties:
|
||
user:
|
||
$ref: '#/definitions/UserDetails'
|
||
type: object
|
||
user_GetDetailsClassMetadataOutput:
|
||
schema:
|
||
properties:
|
||
user:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
user_GetDetailsMetadataOutput:
|
||
schema:
|
||
properties:
|
||
user:
|
||
additionalProperties:
|
||
type: string
|
||
type: object
|
||
x-go-name: Output
|
||
type: object
|
||
user_GetPropertyDistinctFieldOutput: {}
|
||
user_GetPropertyDomainTagValuePairsOutput: {}
|
||
user_GetPropertyDomainTagValueTreeOutput: {}
|
||
user_GetPropertySplitableExportOutput: {}
|
||
user_GetPropertySplitableOutput: {}
|
||
user_GetPropertyTagValuePairsOutput: {}
|
||
user_GetPropertyTagValueTreeOutput: {}
|
||
user_ListItemFilterOutput:
|
||
schema:
|
||
properties:
|
||
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
|
||
users:
|
||
items:
|
||
$ref: '#/definitions/UserDetails'
|
||
type: array
|
||
x-go-name: Output
|
||
type: object
|
||
user_PerformClassMetadataOutput: {}
|
||
user_PerformJoinOutput: {}
|
||
user_PerformLeaveOutput: {}
|
||
user_PerformLinkIdpOutput: {}
|
||
user_PerformPurgeSplitableOutput: {}
|
||
user_PerformResetCredentialsOutput: {}
|
||
user_PerformSetClassMetadataOutput: {}
|
||
user_PerformSetUserMetadataOutput: {}
|
||
user_PerformUnlinkIdpOutput: {}
|
||
user_ValidateCreateDataOutput:
|
||
schema:
|
||
properties:
|
||
user:
|
||
$ref: '#/definitions/UserDetails'
|
||
type: object
|
||
user_ValidateUpdateDataOutput:
|
||
schema:
|
||
properties:
|
||
user:
|
||
$ref: '#/definitions/UserDetails'
|
||
type: object
|
||
schemes:
|
||
- https
|
||
- http
|
||
securityDefinitions:
|
||
keystone:
|
||
in: header
|
||
name: X-Auth-Token
|
||
type: apiKey
|
||
swagger: "2.0"
|